From 7008bbb2966dd630560f3b279a7859e3dc071ef1 Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Tue, 1 Apr 2025 09:21:28 -0300 Subject: [PATCH 01/11] v1 --- README.md | 764 +--- docs/v1/Core/models/AnyTypeDict.md | 11 - ...ttachmentTypeDict.md => AttachmentType.md} | 2 +- docs/v1/Core/models/BinaryTypeDict.md | 11 - docs/v1/Core/models/BooleanTypeDict.md | 11 - docs/v1/Core/models/ByteTypeDict.md | 11 - docs/v1/Core/models/CipherTextTypeDict.md | 12 - docs/v1/Core/models/DateTypeDict.md | 11 - docs/v1/Core/models/DecimalTypeDict.md | 13 - docs/v1/Core/models/DoubleTypeDict.md | 11 - docs/v1/Core/models/FloatTypeDict.md | 11 - docs/v1/Core/models/IntegerTypeDict.md | 11 - docs/v1/Core/models/LongTypeDict.md | 11 - docs/v1/Core/models/MarkingTypeDict.md | 11 - .../models/{NullTypeDict.md => NullType.md} | 2 +- docs/v1/Core/models/ShortTypeDict.md | 11 - docs/v1/Core/models/StringTypeDict.md | 11 - docs/v1/Core/models/TimestampTypeDict.md | 11 - docs/v1/Core/models/UnsupportedTypeDict.md | 12 - docs/v1/Datasets/Branch.md | 59 - docs/v1/Datasets/File.md | 96 - docs/v1/Datasets/models/BranchDict.md | 13 - docs/v1/Datasets/models/DatasetDict.md | 13 - docs/v1/Datasets/models/FileDict.md | 14 - .../models/ListBranchesResponseDict.md | 12 - .../Datasets/models/ListFilesResponseDict.md | 12 - docs/v1/Datasets/models/TransactionDict.md | 16 - docs/v1/Ontologies/Action.md | 4 +- docs/v1/Ontologies/ActionType.md | 62 - docs/v1/Ontologies/ObjectType.md | 126 - docs/v1/Ontologies/OntologyObject.md | 204 +- docs/v1/Ontologies/QueryType.md | 62 - docs/v1/Ontologies/models/ActionTypeDict.md | 17 - .../models/AggregateObjectsResponseDict.md | 13 - .../AggregateObjectsResponseItemDict.md | 12 - docs/v1/Ontologies/models/AggregationDict.md | 20 - .../models/AggregationDurationGroupingDict.md | 15 - .../models/AggregationExactGroupingDict.md | 13 - .../AggregationFixedWidthGroupingDict.md | 13 - .../models/AggregationGroupByDict.md | 18 - .../models/AggregationMetricResultDict.md | 12 - .../Ontologies/models/AggregationRangeDict.md | 14 - .../models/AggregationRangesGroupingDict.md | 13 - .../v1/Ontologies/models/AllTermsQueryDict.md | 16 - docs/v1/Ontologies/models/AndQueryDict.md | 12 - docs/v1/Ontologies/models/AnyTermQueryDict.md | 16 - .../models/ApplyActionRequestDict.md | 11 - .../models/ApplyActionRequestOptionsDict.md | 12 - .../models/ApplyActionResponseDict.md | 10 - .../ApproximateDistinctAggregationDict.md | 13 - .../models/ArraySizeConstraintDict.md | 16 - docs/v1/Ontologies/models/AttachmentDict.md | 14 - .../Ontologies/models/AvgAggregationDict.md | 13 - .../models/BatchApplyActionResponseDict.md | 10 - .../v1/Ontologies/models/ContainsQueryDict.md | 13 - .../Ontologies/models/CountAggregationDict.md | 12 - .../models/CreateInterfaceObjectRuleDict.md | 12 - .../Ontologies/models/CreateLinkRuleDict.md | 15 - .../Ontologies/models/CreateObjectRuleDict.md | 12 - .../models/DeleteInterfaceObjectRuleDict.md | 12 - .../Ontologies/models/DeleteLinkRuleDict.md | 15 - .../Ontologies/models/DeleteObjectRuleDict.md | 12 - .../{EntrySetTypeDict.md => EntrySetType.md} | 6 +- docs/v1/Ontologies/models/EqualsQueryDict.md | 13 - .../models/ExecuteQueryResponseDict.md | 11 - .../models/GroupMemberConstraintDict.md | 12 - docs/v1/Ontologies/models/GtQueryDict.md | 13 - docs/v1/Ontologies/models/GteQueryDict.md | 13 - docs/v1/Ontologies/models/IsNullQueryDict.md | 13 - docs/v1/Ontologies/models/LinkTypeSideDict.md | 16 - .../models/ListActionTypesResponseDict.md | 12 - .../models/ListLinkedObjectsResponseDict.md | 12 - .../models/ListObjectTypesResponseDict.md | 12 - .../models/ListObjectsResponseDict.md | 13 - .../models/ListOntologiesResponseDict.md | 11 - .../ListOutgoingLinkTypesResponseDict.md | 12 - .../models/ListQueryTypesResponseDict.md | 12 - docs/v1/Ontologies/models/LogicRuleDict.md | 22 - docs/v1/Ontologies/models/LtQueryDict.md | 13 - docs/v1/Ontologies/models/LteQueryDict.md | 13 - .../Ontologies/models/MaxAggregationDict.md | 13 - .../Ontologies/models/MinAggregationDict.md | 13 - .../models/ModifyInterfaceObjectRuleDict.md | 12 - .../Ontologies/models/ModifyObjectRuleDict.md | 12 - docs/v1/Ontologies/models/NotQueryDict.md | 12 - .../ObjectPropertyValueConstraintDict.md | 12 - .../models/ObjectQueryResultConstraintDict.md | 12 - docs/v1/Ontologies/models/ObjectTypeDict.md | 18 - .../Ontologies/models/OneOfConstraintDict.md | 14 - .../models/OntologyArrayTypeDict.md | 12 - .../Ontologies/models/OntologyDataTypeDict.md | 37 - docs/v1/Ontologies/models/OntologyDict.md | 14 - .../Ontologies/models/OntologyMapTypeDict.md | 13 - .../Ontologies/models/OntologyObjectDict.md | 12 - .../models/OntologyObjectSetTypeDict.md | 13 - .../models/OntologyObjectTypeDict.md | 13 - .../Ontologies/models/OntologySetTypeDict.md | 12 - .../models/OntologyStructFieldDict.md | 13 - .../models/OntologyStructTypeDict.md | 12 - docs/v1/Ontologies/models/OrQueryDict.md | 12 - docs/v1/Ontologies/models/ParameterDict.md | 14 - .../ParameterEvaluatedConstraintDict.md | 40 - .../models/ParameterEvaluationResultDict.md | 13 - .../Ontologies/models/ParameterOptionDict.md | 13 - docs/v1/Ontologies/models/PhraseQueryDict.md | 13 - docs/v1/Ontologies/models/PrefixQueryDict.md | 13 - docs/v1/Ontologies/models/PropertyDict.md | 13 - ...TypeDict.md => QueryAggregationKeyType.md} | 16 +- ...ict.md => QueryAggregationRangeSubType.md} | 10 +- ...peDict.md => QueryAggregationRangeType.md} | 4 +- ...peDict.md => QueryAggregationValueType.md} | 8 +- ...ueryArrayTypeDict.md => QueryArrayType.md} | 4 +- docs/v1/Ontologies/models/QueryDataType.md | 35 + .../v1/Ontologies/models/QueryDataTypeDict.md | 35 - .../{QuerySetTypeDict.md => QuerySetType.md} | 4 +- ...StructFieldDict.md => QueryStructField.md} | 4 +- ...ryStructTypeDict.md => QueryStructType.md} | 4 +- docs/v1/Ontologies/models/QueryTypeDict.md | 17 - ...ueryUnionTypeDict.md => QueryUnionType.md} | 4 +- .../Ontologies/models/RangeConstraintDict.md | 16 - .../Ontologies/models/SearchJsonQueryDict.md | 28 - .../models/SearchObjectsResponseDict.md | 13 - .../v1/Ontologies/models/SearchOrderByDict.md | 11 - .../Ontologies/models/SearchOrderingDict.md | 12 - .../models/StringLengthConstraintDict.md | 17 - .../models/StringRegexMatchConstraintDict.md | 14 - .../SubmissionCriteriaEvaluationDict.md | 15 - .../Ontologies/models/SumAggregationDict.md | 13 - ...Dict.md => ThreeDimensionalAggregation.md} | 6 +- ...onDict.md => TwoDimensionalAggregation.md} | 6 +- .../models/UnevaluableConstraintDict.md | 13 - .../models/ValidateActionResponseDict.md | 13 - docs/v2/Admin/Group.md | 61 +- docs/v2/Admin/GroupMember.md | 66 - docs/v2/Admin/GroupMembership.md | 66 - docs/v2/Admin/Host.md | 61 - docs/v2/Admin/Marking.md | 64 +- docs/v2/Admin/MarkingCategory.md | 56 - docs/v2/Admin/MarkingMember.md | 68 - docs/v2/Admin/MarkingRoleAssignment.md | 68 +- docs/v2/Admin/User.md | 61 +- .../models/AuthenticationProviderDict.md | 17 - docs/v2/Admin/models/CertificateInfoDict.md | 14 - docs/v2/Admin/models/EnrollmentDict.md | 13 - .../GetGroupsBatchRequestElementDict.md | 11 - .../models/GetGroupsBatchResponseDict.md | 11 - .../GetMarkingsBatchRequestElementDict.md | 11 - .../models/GetMarkingsBatchResponseDict.md | 11 - .../models/GetUserMarkingsResponseDict.md | 11 - .../models/GetUsersBatchRequestElementDict.md | 11 - .../Admin/models/GetUsersBatchResponseDict.md | 11 - docs/v2/Admin/models/GroupDict.md | 16 - docs/v2/Admin/models/GroupMemberDict.md | 12 - docs/v2/Admin/models/GroupMembershipDict.md | 11 - docs/v2/Admin/models/GroupProviderInfoDict.md | 11 - docs/v2/Admin/models/GroupSearchFilterDict.md | 12 - docs/v2/Admin/models/HostDict.md | 11 - ...ListAuthenticationProvidersResponseDict.md | 12 - .../models/ListGroupMembersResponseDict.md | 12 - .../ListGroupMembershipsResponseDict.md | 12 - .../v2/Admin/models/ListGroupsResponseDict.md | 12 - docs/v2/Admin/models/ListHostsResponseDict.md | 12 - .../ListMarkingCategoriesResponseDict.md | 12 - .../models/ListMarkingMembersResponseDict.md | 12 - .../ListMarkingRoleAssignmentsResponseDict.md | 12 - .../Admin/models/ListMarkingsResponseDict.md | 12 - docs/v2/Admin/models/ListUsersResponseDict.md | 12 - docs/v2/Admin/models/MarkingCategoryDict.md | 18 - docs/v2/Admin/models/MarkingDict.md | 17 - docs/v2/Admin/models/MarkingMemberDict.md | 12 - .../Admin/models/MarkingRoleAssignmentDict.md | 13 - docs/v2/Admin/models/MarkingRoleUpdateDict.md | 12 - .../models/OidcAuthenticationProtocolDict.md | 11 - docs/v2/Admin/models/OrganizationDict.md | 15 - .../models/SamlAuthenticationProtocolDict.md | 12 - .../models/SamlServiceProviderMetadataDict.md | 15 - .../Admin/models/SearchGroupsResponseDict.md | 12 - .../Admin/models/SearchUsersResponseDict.md | 12 - docs/v2/Admin/models/UserDict.md | 18 - docs/v2/Admin/models/UserProviderInfoDict.md | 11 - docs/v2/Admin/models/UserSearchFilterDict.md | 12 - docs/v2/AipAgents/Agent.md | 58 - docs/v2/AipAgents/AgentVersion.md | 61 - docs/v2/AipAgents/Session.md | 95 +- docs/v2/AipAgents/models/AgentDict.md | 14 - docs/v2/AipAgents/models/AgentMetadataDict.md | 14 - .../AgentSessionRagContextResponseDict.md | 13 - .../models/AgentVersionDetailsDict.md | 12 - docs/v2/AipAgents/models/AgentVersionDict.md | 12 - .../models/AgentsSessionsPageDict.md | 14 - .../models/CancelSessionResponseDict.md | 11 - docs/v2/AipAgents/models/ContentDict.md | 11 - .../models/FunctionRetrievedContextDict.md | 15 - docs/v2/AipAgents/models/InputContextDict.md | 17 - .../models/ListAgentVersionsResponseDict.md | 12 - .../models/ListSessionsResponseDict.md | 12 - docs/v2/AipAgents/models/ObjectContextDict.md | 14 - .../models/ObjectSetParameterDict.md | 12 - .../models/ObjectSetParameterValueDict.md | 13 - .../ObjectSetParameterValueUpdateDict.md | 12 - docs/v2/AipAgents/models/ParameterDict.md | 14 - docs/v2/AipAgents/models/ParameterTypeDict.md | 16 - .../v2/AipAgents/models/ParameterValueDict.md | 17 - .../models/ParameterValueUpdateDict.md | 19 - docs/v2/AipAgents/models/SessionDict.md | 14 - .../models/SessionExchangeContextsDict.md | 12 - .../AipAgents/models/SessionExchangeDict.md | 13 - .../models/SessionExchangeResultDict.md | 14 - .../AipAgents/models/SessionMetadataDict.md | 15 - .../AipAgents/models/StringParameterDict.md | 12 - .../models/StringParameterValueDict.md | 12 - docs/v2/AipAgents/models/UserTextInputDict.md | 11 - docs/v2/Connectivity/Connection.md | 4 +- docs/v2/Connectivity/FileImport.md | 69 +- docs/v2/Connectivity/TableImport.md | 65 +- .../models/ApiKeyAuthenticationDict.md | 15 - .../models/AsPlaintextValueDict.md | 12 - .../Connectivity/models/AsSecretNameDict.md | 12 - .../Connectivity/models/AwsAccessKeyDict.md | 18 - .../models/AwsOidcAuthenticationDict.md | 16 - .../models/BasicCredentialsDict.md | 13 - .../v2/Connectivity/models/BearerTokenDict.md | 12 - .../Connectivity/models/CloudIdentityDict.md | 14 - .../models/ConnectionConfigurationDict.md | 17 - docs/v2/Connectivity/models/ConnectionDict.md | 14 - ...ctionRequestConnectionConfigurationDict.md | 17 - ...nRequestJdbcConnectionConfigurationDict.md | 15 - ...nRequestRestConnectionConfigurationDict.md | 14 - ...ionRequestS3ConnectionConfigurationDict.md | 25 - ...eTableImportRequestJdbcImportConfigDict.md | 12 - ...tRequestMicrosoftAccessImportConfigDict.md | 12 - ...questMicrosoftSqlServerImportConfigDict.md | 12 - ...ableImportRequestOracleImportConfigDict.md | 12 - ...ImportRequestPostgreSqlImportConfigDict.md | 12 - ...TableImportRequestTableImportConfigDict.md | 20 - docs/v2/Connectivity/models/DomainDict.md | 14 - .../models/EncryptedPropertyDict.md | 21 - .../models/FileAnyPathMatchesFilterDict.md | 13 - .../models/FileAtLeastCountFilterDict.md | 12 - .../FileChangedSinceLastUploadFilterDict.md | 14 - .../models/FileImportCustomFilterDict.md | 14 - docs/v2/Connectivity/models/FileImportDict.md | 18 - .../models/FileImportFilterDict.md | 25 - .../models/FileLastModifiedAfterFilterDict.md | 13 - .../models/FilePathMatchesFilterDict.md | 22 - .../models/FilePathNotMatchesFilterDict.md | 23 - .../Connectivity/models/FileSizeFilterDict.md | 16 - .../models/FilesCountLimitFilterDict.md | 15 - .../Connectivity/models/HeaderApiKeyDict.md | 12 - .../models/JdbcConnectionConfigurationDict.md | 16 - .../models/JdbcImportConfigDict.md | 13 - .../models/ListFileImportsResponseDict.md | 12 - .../models/ListTableImportsResponseDict.md | 12 - .../models/MicrosoftAccessImportConfigDict.md | 13 - .../MicrosoftSqlServerImportConfigDict.md | 13 - .../models/OracleImportConfigDict.md | 13 - .../models/PostgreSqlImportConfigDict.md | 13 - .../models/QueryParameterApiKeyDict.md | 12 - .../models/RestAuthenticationModeDict.md | 18 - .../RestConnectionAdditionalSecretsDict.md | 18 - .../models/RestConnectionConfigurationDict.md | 14 - .../models/RestConnectionOAuth2Dict.md | 13 - .../models/RestRequestApiKeyLocationDict.md | 16 - .../models/S3AuthenticationModeDict.md | 17 - .../models/S3ConnectionConfigurationDict.md | 27 - .../models/S3KmsConfigurationDict.md | 12 - .../models/S3ProxyConfigurationDict.md | 15 - .../Connectivity/models/SecretsNamesDict.md | 14 - .../models/SecretsWithPlaintextValuesDict.md | 14 - .../models/StsRoleConfigurationDict.md | 15 - .../models/TableImportConfigDict.md | 20 - .../v2/Connectivity/models/TableImportDict.md | 18 - docs/v2/Core/models/AnyTypeDict.md | 11 - docs/v2/Core/models/ArrayFieldTypeDict.md | 12 - docs/v2/Core/models/AttachmentTypeDict.md | 11 - docs/v2/Core/models/BinaryTypeDict.md | 11 - docs/v2/Core/models/BooleanTypeDict.md | 11 - docs/v2/Core/models/ByteTypeDict.md | 11 - .../ChangeDataCaptureConfigurationDict.md | 16 - docs/v2/Core/models/CipherTextTypeDict.md | 12 - docs/v2/Core/models/DateTypeDict.md | 11 - docs/v2/Core/models/DecimalTypeDict.md | 13 - docs/v2/Core/models/DistanceDict.md | 12 - docs/v2/Core/models/DoubleTypeDict.md | 11 - docs/v2/Core/models/DurationDict.md | 12 - docs/v2/Core/models/EmbeddingModelDict.md | 16 - docs/v2/Core/models/FieldDataTypeDict.md | 29 - docs/v2/Core/models/FieldDict.md | 14 - docs/v2/Core/models/FieldSchemaDict.md | 14 - ...rBinaryTypeDict.md => FilterBinaryType.md} | 2 +- ...ooleanTypeDict.md => FilterBooleanType.md} | 2 +- ...eTimeTypeDict.md => FilterDateTimeType.md} | 2 +- ...ilterDateTypeDict.md => FilterDateType.md} | 2 +- ...rDoubleTypeDict.md => FilterDoubleType.md} | 2 +- ...ilterEnumTypeDict.md => FilterEnumType.md} | 2 +- ...terFloatTypeDict.md => FilterFloatType.md} | 2 +- ...ntegerTypeDict.md => FilterIntegerType.md} | 2 +- ...ilterLongTypeDict.md => FilterLongType.md} | 2 +- ...{FilterRidTypeDict.md => FilterRidType.md} | 2 +- ...rStringTypeDict.md => FilterStringType.md} | 2 +- .../models/FilterType.md} | 18 +- docs/v2/Core/models/FilterTypeDict.md | 26 - ...ilterUuidTypeDict.md => FilterUuidType.md} | 2 +- docs/v2/Core/models/FloatTypeDict.md | 11 - .../Core/models/FoundryLiveDeploymentDict.md | 14 - ...llRowChangeDataCaptureConfigurationDict.md | 16 - docs/v2/Core/models/GeoPointTypeDict.md | 11 - docs/v2/Core/models/GeoShapeTypeDict.md | 11 - .../models/GeotimeSeriesReferenceTypeDict.md | 11 - docs/v2/Core/models/IntegerTypeDict.md | 11 - docs/v2/Core/models/LmsEmbeddingModelDict.md | 12 - docs/v2/Core/models/LongTypeDict.md | 11 - docs/v2/Core/models/MapFieldTypeDict.md | 13 - docs/v2/Core/models/MarkingTypeDict.md | 11 - docs/v2/Core/models/MediaReferenceDict.md | 12 - docs/v2/Core/models/MediaReferenceTypeDict.md | 11 - docs/v2/Core/models/MediaSetViewItemDict.md | 14 - .../models/MediaSetViewItemWrapperDict.md | 12 - docs/v2/Core/models/NullTypeDict.md | 11 - docs/v2/Core/models/ReferenceDict.md | 12 - docs/v2/Core/models/ShortTypeDict.md | 11 - docs/v2/Core/models/StreamSchemaDict.md | 14 - docs/v2/Core/models/StringTypeDict.md | 11 - docs/v2/Core/models/StructFieldTypeDict.md | 12 - docs/v2/Core/models/TimeSeriesItemTypeDict.md | 17 - docs/v2/Core/models/TimeseriesTypeDict.md | 12 - docs/v2/Core/models/TimestampTypeDict.md | 11 - docs/v2/Core/models/UnsupportedTypeDict.md | 12 - .../models/VectorSimilarityFunctionDict.md | 13 - docs/v2/Core/models/VectorTypeDict.md | 14 - docs/v2/Datasets/Branch.md | 57 - docs/v2/Datasets/File.md | 88 - docs/v2/Datasets/models/BranchDict.md | 12 - docs/v2/Datasets/models/DatasetDict.md | 13 - docs/v2/Datasets/models/FileDict.md | 14 - .../models/ListBranchesResponseDict.md | 12 - .../Datasets/models/ListFilesResponseDict.md | 12 - docs/v2/Datasets/models/TransactionDict.md | 15 - docs/v2/Filesystem/Folder.md | 63 - docs/v2/Filesystem/Project.md | 65 +- docs/v2/Filesystem/Resource.md | 61 - docs/v2/Filesystem/ResourceRole.md | 75 +- docs/v2/Filesystem/Space.md | 58 - .../models/AccessRequirementsDict.md | 14 - docs/v2/Filesystem/models/EveryoneDict.md | 11 - docs/v2/Filesystem/models/FolderDict.md | 24 - .../ListChildrenOfFolderResponseDict.md | 12 - .../ListMarkingsOfResourceResponseDict.md | 12 - .../ListOrganizationsOfProjectResponseDict.md | 12 - .../models/ListResourceRolesResponseDict.md | 12 - .../models/ListSpacesResponseDict.md | 12 - docs/v2/Filesystem/models/MarkingDict.md | 16 - docs/v2/Filesystem/models/OrganizationDict.md | 18 - .../Filesystem/models/PrincipalWithIdDict.md | 13 - docs/v2/Filesystem/models/ProjectDict.md | 21 - docs/v2/Filesystem/models/ResourceDict.md | 24 - docs/v2/Filesystem/models/ResourceRoleDict.md | 12 - .../models/ResourceRolePrincipalDict.md | 16 - docs/v2/Filesystem/models/SpaceDict.md | 17 - .../models/ExecuteQueryResponseDict.md | 11 - docs/v2/Functions/models/ParameterDict.md | 12 - .../models/QueryAggregationKeyTypeDict.md | 22 - .../QueryAggregationRangeSubTypeDict.md | 19 - .../models/QueryAggregationRangeTypeDict.md | 12 - .../models/QueryAggregationValueTypeDict.md | 18 - .../v2/Functions/models/QueryArrayTypeDict.md | 12 - docs/v2/Functions/models/QueryDataTypeDict.md | 33 - docs/v2/Functions/models/QueryDict.md | 17 - docs/v2/Functions/models/QuerySetTypeDict.md | 12 - .../Functions/models/QueryStructFieldDict.md | 12 - .../Functions/models/QueryStructTypeDict.md | 12 - .../v2/Functions/models/QueryUnionTypeDict.md | 12 - .../models/ThreeDimensionalAggregationDict.md | 13 - .../models/TwoDimensionalAggregationDict.md | 13 - .../models/ValueTypeDataTypeArrayTypeDict.md | 12 - .../models/ValueTypeDataTypeBinaryTypeDict.md | 11 - .../ValueTypeDataTypeBooleanTypeDict.md | 11 - .../models/ValueTypeDataTypeByteTypeDict.md | 11 - .../models/ValueTypeDataTypeDateTypeDict.md | 11 - .../ValueTypeDataTypeDecimalTypeDict.md | 11 - .../Functions/models/ValueTypeDataTypeDict.md | 33 - .../models/ValueTypeDataTypeDoubleTypeDict.md | 11 - .../models/ValueTypeDataTypeFloatTypeDict.md | 11 - .../ValueTypeDataTypeIntegerTypeDict.md | 11 - .../models/ValueTypeDataTypeLongTypeDict.md | 11 - .../models/ValueTypeDataTypeMapTypeDict.md | 13 - .../ValueTypeDataTypeOptionalTypeDict.md | 12 - .../models/ValueTypeDataTypeShortTypeDict.md | 11 - .../models/ValueTypeDataTypeStringTypeDict.md | 11 - .../ValueTypeDataTypeStructElementDict.md | 12 - .../models/ValueTypeDataTypeStructTypeDict.md | 12 - .../ValueTypeDataTypeTimestampTypeDict.md | 11 - .../models/ValueTypeDataTypeUnionTypeDict.md | 12 - ...ValueTypeDataTypeValueTypeReferenceDict.md | 13 - docs/v2/Functions/models/ValueTypeDict.md | 17 - .../models/ValueTypeReferenceDict.md | 14 - docs/v2/Functions/models/VersionIdDict.md | 17 - docs/v2/Geo/models/FeatureCollectionDict.md | 13 - .../Geo/models/FeatureCollectionTypesDict.md | 11 - docs/v2/Geo/models/FeatureDict.md | 15 - docs/v2/Geo/models/GeoPointDict.md | 13 - docs/v2/Geo/models/GeometryCollectionDict.md | 19 - docs/v2/Geo/models/GeometryDict.md | 21 - docs/v2/Geo/models/LineStringDict.md | 13 - docs/v2/Geo/models/MultiLineStringDict.md | 13 - docs/v2/Geo/models/MultiPointDict.md | 13 - docs/v2/Geo/models/MultiPolygonDict.md | 13 - docs/v2/Geo/models/PolygonDict.md | 13 - .../models/GetMediaItemInfoResponseDict.md | 14 - .../MediaSets/models/MediaAttributionDict.md | 12 - .../models/PutMediaItemResponseDict.md | 11 - docs/v2/Ontologies/Action.md | 12 +- docs/v2/Ontologies/ActionType.md | 62 - docs/v2/Ontologies/LinkedObject.md | 105 - docs/v2/Ontologies/ObjectType.md | 126 - docs/v2/Ontologies/OntologyInterface.md | 90 +- docs/v2/Ontologies/OntologyObject.md | 117 +- docs/v2/Ontologies/OntologyObjectSet.md | 40 +- docs/v2/Ontologies/QueryType.md | 62 - docs/v2/Ontologies/TimeSeriesPropertyV2.md | 8 +- .../Ontologies/TimeSeriesValueBankProperty.md | 4 +- .../models/AbsoluteTimeRangeDict.md | 13 - .../AbsoluteValuePropertyExpressionDict.md | 13 - .../models/ActionParameterArrayTypeDict.md | 12 - .../models/ActionParameterTypeDict.md | 31 - .../models/ActionParameterV2Dict.md | 14 - .../v2/Ontologies/models/ActionResultsDict.md | 16 - docs/v2/Ontologies/models/ActionTypeV2Dict.md | 17 - .../models/ActivePropertyTypeStatusDict.md | 13 - docs/v2/Ontologies/models/AddLinkDict.md | 15 - docs/v2/Ontologies/models/AddObjectDict.md | 13 - .../models/AddPropertyExpressionDict.md | 13 - .../AggregateObjectsResponseItemV2Dict.md | 12 - .../models/AggregateObjectsResponseV2Dict.md | 13 - .../models/AggregateTimeSeriesDict.md | 12 - .../AggregationDurationGroupingV2Dict.md | 16 - .../models/AggregationExactGroupingV2Dict.md | 14 - .../AggregationFixedWidthGroupingV2Dict.md | 13 - .../models/AggregationGroupByV2Dict.md | 18 - .../models/AggregationMetricResultV2Dict.md | 12 - .../models/AggregationRangeV2Dict.md | 12 - .../models/AggregationRangesGroupingV2Dict.md | 13 - .../v2/Ontologies/models/AggregationV2Dict.md | 22 - docs/v2/Ontologies/models/AndQueryV2Dict.md | 12 - .../models/ApplyActionRequestOptionsDict.md | 12 - .../ApproximateDistinctAggregationV2Dict.md | 14 - .../ApproximatePercentileAggregationV2Dict.md | 15 - .../models/ArraySizeConstraintDict.md | 16 - .../models/AttachmentMetadataResponseDict.md | 16 - docs/v2/Ontologies/models/AttachmentV2Dict.md | 15 - .../Ontologies/models/AvgAggregationV2Dict.md | 14 - .../models/BatchActionObjectEditDict.md | 17 - .../models/BatchActionObjectEditsDict.md | 17 - .../models/BatchActionResultsDict.md | 16 - .../models/BatchApplyActionRequestItemDict.md | 11 - .../BatchApplyActionRequestOptionsDict.md | 11 - .../models/BatchApplyActionResponseV2Dict.md | 11 - .../v2/Ontologies/models/BlueprintIconDict.md | 13 - .../Ontologies/models/BoundingBoxValueDict.md | 13 - docs/v2/Ontologies/models/CenterPointDict.md | 13 - .../Ontologies/models/CenterPointTypesDict.md | 11 - ...ntainsAllTermsInOrderPrefixLastTermDict.md | 18 - .../ContainsAllTermsInOrderQueryDict.md | 17 - .../models/ContainsAllTermsQueryDict.md | 18 - .../models/ContainsAnyTermQueryDict.md | 18 - .../Ontologies/models/ContainsQueryV2Dict.md | 16 - .../models/CountAggregationV2Dict.md | 13 - .../models/CountObjectsResponseV2Dict.md | 11 - .../models/CreateInterfaceObjectRuleDict.md | 12 - .../Ontologies/models/CreateLinkRuleDict.md | 15 - .../Ontologies/models/CreateObjectRuleDict.md | 12 - .../CreateTemporaryObjectSetResponseV2Dict.md | 11 - .../models/DeleteInterfaceObjectRuleDict.md | 12 - docs/v2/Ontologies/models/DeleteLinkDict.md | 15 - .../Ontologies/models/DeleteLinkRuleDict.md | 15 - docs/v2/Ontologies/models/DeleteObjectDict.md | 13 - .../Ontologies/models/DeleteObjectRuleDict.md | 12 - .../DeprecatedPropertyTypeStatusDict.md | 16 - .../models/DerivedPropertyDefinitionDict.md | 26 - .../models/DividePropertyExpressionDict.md | 14 - .../DoesNotIntersectBoundingBoxQueryDict.md | 17 - .../DoesNotIntersectPolygonQueryDict.md | 17 - docs/v2/Ontologies/models/DoubleVectorDict.md | 14 - docs/v2/Ontologies/models/EntrySetTypeDict.md | 13 - .../v2/Ontologies/models/EqualsQueryV2Dict.md | 16 - .../models/ExactDistinctAggregationV2Dict.md | 14 - .../models/ExamplePropertyTypeStatusDict.md | 13 - .../models/ExecuteQueryResponseDict.md | 11 - .../ExperimentalPropertyTypeStatusDict.md | 11 - .../models/ExtractPropertyExpressionDict.md | 14 - .../GetSelectedPropertyOperationDict.md | 16 - .../models/GreatestPropertyExpressionDict.md | 13 - .../models/GroupMemberConstraintDict.md | 12 - docs/v2/Ontologies/models/GtQueryV2Dict.md | 16 - docs/v2/Ontologies/models/GteQueryV2Dict.md | 16 - docs/v2/Ontologies/models/IconDict.md | 11 - docs/v2/Ontologies/models/InQueryDict.md | 17 - .../models/InterfaceLinkTypeDict.md | 19 - ...nterfaceLinkTypeLinkedEntityApiNameDict.md | 16 - .../models/InterfaceSharedPropertyTypeDict.md | 18 - .../v2/Ontologies/models/InterfaceTypeDict.md | 21 - .../models/IntersectsBoundingBoxQueryDict.md | 16 - .../models/IntersectsPolygonQueryDict.md | 16 - .../v2/Ontologies/models/IsNullQueryV2Dict.md | 16 - .../models/LeastPropertyExpressionDict.md | 13 - .../Ontologies/models/LinkSideObjectDict.md | 12 - .../Ontologies/models/LinkTypeSideV2Dict.md | 17 - .../models/LinkedInterfaceTypeApiNameDict.md | 12 - .../models/LinkedObjectTypeApiNameDict.md | 12 - .../models/ListActionTypesResponseV2Dict.md | 12 - .../models/ListAttachmentsResponseV2Dict.md | 13 - .../models/ListInterfaceTypesResponseDict.md | 12 - .../models/ListLinkedObjectsResponseV2Dict.md | 12 - .../models/ListObjectTypesV2ResponseDict.md | 12 - .../models/ListObjectsResponseV2Dict.md | 13 - .../models/ListOntologiesV2ResponseDict.md | 11 - .../ListOutgoingLinkTypesResponseV2Dict.md | 12 - .../models/ListQueryTypesResponseV2Dict.md | 12 - .../models/LoadObjectSetResponseV2Dict.md | 13 - ...ectSetV2MultipleObjectTypesResponseDict.md | 22 - ...ectSetV2ObjectsOrInterfacesResponseDict.md | 15 - docs/v2/Ontologies/models/LogicRuleDict.md | 22 - docs/v2/Ontologies/models/LtQueryV2Dict.md | 16 - docs/v2/Ontologies/models/LteQueryV2Dict.md | 16 - .../Ontologies/models/MaxAggregationV2Dict.md | 14 - .../v2/Ontologies/models/MediaMetadataDict.md | 13 - .../Ontologies/models/MethodObjectSetDict.md | 11 - .../Ontologies/models/MinAggregationV2Dict.md | 14 - .../models/ModifyInterfaceObjectRuleDict.md | 12 - docs/v2/Ontologies/models/ModifyObjectDict.md | 13 - .../Ontologies/models/ModifyObjectRuleDict.md | 12 - .../models/MultiplyPropertyExpressionDict.md | 13 - .../models/NearestNeighborsQueryDict.md | 18 - .../models/NearestNeighborsQueryTextDict.md | 13 - .../models/NegatePropertyExpressionDict.md | 13 - docs/v2/Ontologies/models/NotQueryV2Dict.md | 12 - docs/v2/Ontologies/models/ObjectEditDict.md | 19 - docs/v2/Ontologies/models/ObjectEditsDict.md | 17 - .../models/ObjectPropertyTypeDict.md | 37 - .../ObjectPropertyValueConstraintDict.md | 12 - .../models/ObjectQueryResultConstraintDict.md | 12 - .../ObjectSetAsBaseObjectTypesTypeDict.md | 15 - .../models/ObjectSetAsTypeTypeDict.md | 16 - .../models/ObjectSetBaseTypeDict.md | 12 - docs/v2/Ontologies/models/ObjectSetDict.md | 28 - .../models/ObjectSetFilterTypeDict.md | 13 - .../models/ObjectSetInterfaceBaseTypeDict.md | 13 - .../models/ObjectSetIntersectionTypeDict.md | 12 - .../models/ObjectSetMethodInputTypeDict.md | 14 - .../ObjectSetNearestNeighborsTypeDict.md | 24 - .../models/ObjectSetReferenceTypeDict.md | 12 - .../models/ObjectSetSearchAroundTypeDict.md | 13 - .../models/ObjectSetStaticTypeDict.md | 12 - .../models/ObjectSetSubtractTypeDict.md | 12 - .../models/ObjectSetUnionTypeDict.md | 12 - .../models/ObjectSetWithPropertiesTypeDict.md | 16 - .../Ontologies/models/ObjectTypeEditsDict.md | 12 - .../models/ObjectTypeFullMetadataDict.md | 15 - .../ObjectTypeInterfaceImplementationDict.md | 11 - docs/v2/Ontologies/models/ObjectTypeV2Dict.md | 21 - .../Ontologies/models/OneOfConstraintDict.md | 14 - .../models/OntologyArrayTypeDict.md | 12 - .../Ontologies/models/OntologyDataTypeDict.md | 37 - .../models/OntologyFullMetadataDict.md | 16 - .../models/OntologyInterfaceObjectTypeDict.md | 12 - .../Ontologies/models/OntologyMapTypeDict.md | 13 - .../models/OntologyObjectArrayTypeDict.md | 12 - .../models/OntologyObjectSetTypeDict.md | 13 - .../models/OntologyObjectTypeDict.md | 13 - .../OntologyObjectTypeReferenceTypeDict.md | 11 - .../Ontologies/models/OntologySetTypeDict.md | 12 - .../models/OntologyStructFieldDict.md | 13 - .../models/OntologyStructTypeDict.md | 12 - docs/v2/Ontologies/models/OntologyV2Dict.md | 14 - docs/v2/Ontologies/models/OrQueryV2Dict.md | 12 - .../ParameterEvaluatedConstraintDict.md | 40 - .../models/ParameterEvaluationResultDict.md | 13 - .../Ontologies/models/ParameterOptionDict.md | 13 - docs/v2/Ontologies/models/PolygonValueDict.md | 11 - .../Ontologies/models/PreciseDurationDict.md | 13 - .../models/PropertyApiNameSelectorDict.md | 12 - .../models/PropertyIdentifierDict.md | 16 - .../models/PropertyTypeStatusDict.md | 19 - docs/v2/Ontologies/models/PropertyV2Dict.md | 16 - .../models/QueryAggregationKeyTypeDict.md | 22 - .../QueryAggregationRangeSubTypeDict.md | 19 - .../models/QueryAggregationRangeTypeDict.md | 12 - .../models/QueryAggregationValueTypeDict.md | 18 - .../Ontologies/models/QueryArrayTypeDict.md | 12 - .../v2/Ontologies/models/QueryDataTypeDict.md | 35 - .../Ontologies/models/QueryParameterV2Dict.md | 12 - docs/v2/Ontologies/models/QuerySetTypeDict.md | 12 - .../Ontologies/models/QueryStructFieldDict.md | 12 - .../Ontologies/models/QueryStructTypeDict.md | 12 - docs/v2/Ontologies/models/QueryTypeV2Dict.md | 17 - .../Ontologies/models/QueryUnionTypeDict.md | 12 - .../Ontologies/models/RangeConstraintDict.md | 16 - docs/v2/Ontologies/models/RelativeTimeDict.md | 14 - .../models/RelativeTimeRangeDict.md | 14 - .../RollingAggregateWindowPointsDict.md | 12 - .../models/SearchJsonQueryV2Dict.md | 37 - .../models/SearchObjectsResponseV2Dict.md | 13 - .../Ontologies/models/SearchOrderByV2Dict.md | 12 - .../Ontologies/models/SearchOrderingV2Dict.md | 12 - ...pertyApproximateDistinctAggregationDict.md | 12 - ...rtyApproximatePercentileAggregationDict.md | 13 - .../SelectedPropertyAvgAggregationDict.md | 12 - ...ectedPropertyCollectListAggregationDict.md | 20 - ...lectedPropertyCollectSetAggregationDict.md | 20 - .../SelectedPropertyCountAggregationDict.md | 11 - ...tedPropertyExactDistinctAggregationDict.md | 13 - .../models/SelectedPropertyExpressionDict.md | 13 - .../SelectedPropertyMaxAggregationDict.md | 12 - .../SelectedPropertyMinAggregationDict.md | 12 - .../models/SelectedPropertyOperationDict.md | 26 - .../SelectedPropertySumAggregationDict.md | 12 - .../models/SharedPropertyTypeDict.md | 15 - .../Ontologies/models/StartsWithQueryDict.md | 16 - .../models/StringLengthConstraintDict.md | 17 - .../models/StringRegexMatchConstraintDict.md | 14 - .../models/StructFieldSelectorDict.md | 17 - .../Ontologies/models/StructFieldTypeDict.md | 12 - docs/v2/Ontologies/models/StructTypeDict.md | 12 - .../SubmissionCriteriaEvaluationDict.md | 15 - .../models/SubtractPropertyExpressionDict.md | 14 - .../Ontologies/models/SumAggregationV2Dict.md | 14 - .../models/SyncApplyActionResponseV2Dict.md | 12 - .../models/ThreeDimensionalAggregationDict.md | 13 - docs/v2/Ontologies/models/TimeRangeDict.md | 16 - .../TimeSeriesAggregationStrategyDict.md | 21 - .../TimeSeriesCumulativeAggregateDict.md | 13 - .../models/TimeSeriesPeriodicAggregateDict.md | 23 - .../Ontologies/models/TimeSeriesPointDict.md | 13 - .../models/TimeSeriesRollingAggregateDict.md | 12 - .../TimeSeriesRollingAggregateWindowDict.md | 22 - .../Ontologies/models/TimeseriesEntryDict.md | 13 - .../models/TwoDimensionalAggregationDict.md | 13 - .../models/UnevaluableConstraintDict.md | 13 - .../models/ValidateActionResponseV2Dict.md | 13 - .../models/WithinBoundingBoxPointDict.md | 11 - .../models/WithinBoundingBoxQueryDict.md | 17 - .../models/WithinDistanceOfQueryDict.md | 17 - .../models/WithinPolygonQueryDict.md | 17 - docs/v2/Orchestration/Build.md | 79 +- docs/v2/Orchestration/Job.md | 4 +- docs/v2/Orchestration/Schedule.md | 84 +- docs/v2/Orchestration/models/ActionDict.md | 18 - .../v2/Orchestration/models/AndTriggerDict.md | 12 - docs/v2/Orchestration/models/BuildDict.md | 20 - .../Orchestration/models/BuildTargetDict.md | 17 - .../models/ConnectingTargetDict.md | 16 - .../models/CreateScheduleRequestActionDict.md | 18 - .../CreateScheduleRequestBuildTargetDict.md | 17 - ...eateScheduleRequestConnectingTargetDict.md | 14 - .../CreateScheduleRequestManualTargetDict.md | 12 - .../CreateScheduleRequestProjectScopeDict.md | 12 - .../CreateScheduleRequestScopeModeDict.md | 16 - ...CreateScheduleRequestUpstreamTargetDict.md | 13 - .../CreateScheduleRequestUserScopeDict.md | 11 - .../models/DatasetJobOutputDict.md | 13 - .../models/DatasetUpdatedTriggerDict.md | 15 - .../GetBuildsBatchRequestElementDict.md | 11 - .../models/GetBuildsBatchResponseDict.md | 11 - .../models/GetJobsBatchRequestElementDict.md | 11 - .../models/GetJobsBatchResponseDict.md | 11 - docs/v2/Orchestration/models/JobDict.md | 16 - docs/v2/Orchestration/models/JobOutputDict.md | 17 - .../models/JobSucceededTriggerDict.md | 15 - .../models/ListJobsOfBuildResponseDict.md | 12 - .../models/ListRunsOfScheduleResponseDict.md | 12 - .../Orchestration/models/ManualTargetDict.md | 12 - .../models/MediaSetUpdatedTriggerDict.md | 17 - .../models/NewLogicTriggerDict.md | 15 - docs/v2/Orchestration/models/OrTriggerDict.md | 12 - .../Orchestration/models/ProjectScopeDict.md | 13 - .../ReplaceScheduleRequestActionDict.md | 18 - .../ReplaceScheduleRequestBuildTargetDict.md | 17 - ...laceScheduleRequestConnectingTargetDict.md | 14 - .../ReplaceScheduleRequestManualTargetDict.md | 12 - .../ReplaceScheduleRequestProjectScopeDict.md | 12 - .../ReplaceScheduleRequestScopeModeDict.md | 16 - ...eplaceScheduleRequestUpstreamTargetDict.md | 13 - .../ReplaceScheduleRequestUserScopeDict.md | 11 - .../models/RetryBackoffDurationDict.md | 12 - docs/v2/Orchestration/models/ScheduleDict.md | 22 - .../Orchestration/models/ScheduleRunDict.md | 16 - .../models/ScheduleRunErrorDict.md | 13 - .../models/ScheduleRunIgnoredDict.md | 12 - .../models/ScheduleRunResultDict.md | 19 - .../models/ScheduleRunSubmittedDict.md | 12 - .../models/ScheduleSucceededTriggerDict.md | 14 - .../models/ScheduleVersionDict.md | 17 - docs/v2/Orchestration/models/ScopeModeDict.md | 16 - .../models/SearchBuildsAndFilterDict.md | 12 - .../models/SearchBuildsEqualsFilterDict.md | 13 - .../models/SearchBuildsFilterDict.md | 20 - .../models/SearchBuildsGteFilterDict.md | 13 - .../models/SearchBuildsLtFilterDict.md | 13 - .../models/SearchBuildsNotFilterDict.md | 12 - .../models/SearchBuildsOrFilterDict.md | 12 - .../models/SearchBuildsOrderByDict.md | 11 - .../models/SearchBuildsOrderByItemDict.md | 12 - .../models/SearchBuildsResponseDict.md | 12 - .../Orchestration/models/TimeTriggerDict.md | 13 - .../TransactionalMediaSetJobOutputDict.md | 13 - docs/v2/Orchestration/models/TriggerDict.md | 22 - .../models/UpstreamTargetDict.md | 13 - docs/v2/Orchestration/models/UserScopeDict.md | 13 - .../models/CanceledQueryStatusDict.md | 11 - .../models/FailedQueryStatusDict.md | 12 - docs/v2/SqlQueries/models/QueryStatusDict.md | 18 - .../models/RunningQueryStatusDict.md | 12 - .../models/SucceededQueryStatusDict.md | 12 - docs/v2/Streams/Dataset.md | 4 +- docs/v2/Streams/Stream.md | 8 +- .../CreateStreamRequestStreamSchemaDict.md | 13 - docs/v2/Streams/models/DatasetDict.md | 13 - docs/v2/Streams/models/StreamDict.md | 16 - docs/v2/ThirdPartyApplications/Version.md | 62 - .../models/ListVersionsResponseDict.md | 12 - .../models/ThirdPartyApplicationDict.md | 11 - .../models/VersionDict.md | 11 - .../models/WebsiteDict.md | 12 - foundry/_core/__init__.py | 2 +- foundry/_core/api_client.py | 9 - foundry/_core/compute_module_pipeline_auth.py | 4 +- ...th_client.py => user_token_auth_client.py} | 0 foundry/v1/cli.py | 380 -- foundry/v1/core/models.py | 241 +- foundry/v1/datasets/branch.py | 63 - foundry/v1/datasets/client.py | 20 - foundry/v1/datasets/file.py | 98 - foundry/v1/datasets/models.py | 97 +- foundry/v1/ontologies/action.py | 15 +- foundry/v1/ontologies/action_type.py | 66 - foundry/v1/ontologies/client.py | 20 - foundry/v1/ontologies/errors.py | 2 +- foundry/v1/ontologies/models.py | 1712 ++----- foundry/v1/ontologies/object_type.py | 138 - foundry/v1/ontologies/ontology_object.py | 253 +- foundry/v1/ontologies/query_type.py | 66 - foundry/v2/admin/client.py | 20 - foundry/v2/admin/group.py | 76 +- foundry/v2/admin/group_member.py | 71 - foundry/v2/admin/group_membership.py | 71 - foundry/v2/admin/host.py | 72 - foundry/v2/admin/marking.py | 82 +- foundry/v2/admin/marking_category.py | 59 - foundry/v2/admin/marking_member.py | 74 - foundry/v2/admin/marking_role_assignment.py | 89 +- foundry/v2/admin/models.py | 703 +-- foundry/v2/admin/user.py | 76 +- foundry/v2/aip_agents/agent.py | 67 - foundry/v2/aip_agents/agent_version.py | 66 - foundry/v2/aip_agents/client.py | 20 - foundry/v2/aip_agents/models.py | 527 +-- foundry/v2/aip_agents/session.py | 165 +- foundry/v2/cli.py | 1456 +----- foundry/v2/connectivity/client.py | 20 - foundry/v2/connectivity/connection.py | 12 +- foundry/v2/connectivity/file_import.py | 96 +- foundry/v2/connectivity/models.py | 1395 +----- foundry/v2/connectivity/table_import.py | 82 +- foundry/v2/core/errors.py | 2 +- foundry/v2/core/models.py | 836 +--- foundry/v2/datasets/branch.py | 67 - foundry/v2/datasets/client.py | 20 - foundry/v2/datasets/file.py | 96 - foundry/v2/datasets/models.py | 97 +- foundry/v2/filesystem/client.py | 20 - foundry/v2/filesystem/folder.py | 68 - foundry/v2/filesystem/models.py | 352 +- foundry/v2/filesystem/project.py | 87 +- foundry/v2/filesystem/resource.py | 66 - foundry/v2/filesystem/resource_role.py | 93 +- foundry/v2/filesystem/space.py | 61 - foundry/v2/functions/client.py | 20 - foundry/v2/functions/errors.py | 2 +- foundry/v2/functions/models.py | 618 +-- foundry/v2/geo/models.py | 181 +- foundry/v2/media_sets/client.py | 20 - foundry/v2/media_sets/models.py | 49 +- foundry/v2/ontologies/action.py | 46 +- foundry/v2/ontologies/action_type.py | 66 - foundry/v2/ontologies/client.py | 20 - foundry/v2/ontologies/errors.py | 2 +- foundry/v2/ontologies/linked_object.py | 111 - foundry/v2/ontologies/models.py | 3988 ++--------------- foundry/v2/ontologies/object_type.py | 138 - foundry/v2/ontologies/ontology_interface.py | 145 +- foundry/v2/ontologies/ontology_object.py | 169 +- foundry/v2/ontologies/ontology_object_set.py | 106 +- foundry/v2/ontologies/query_type.py | 66 - .../v2/ontologies/time_series_property_v2.py | 27 +- .../time_series_value_bank_property.py | 12 +- foundry/v2/orchestration/build.py | 126 +- foundry/v2/orchestration/client.py | 20 - foundry/v2/orchestration/job.py | 11 +- foundry/v2/orchestration/models.py | 1084 +---- foundry/v2/orchestration/schedule.py | 141 +- foundry/v2/sql_queries/client.py | 20 - foundry/v2/sql_queries/models.py | 77 +- foundry/v2/streams/client.py | 20 - foundry/v2/streams/dataset.py | 8 +- foundry/v2/streams/models.py | 89 +- foundry/v2/streams/stream.py | 22 +- foundry/v2/third_party_applications/client.py | 20 - foundry/v2/third_party_applications/models.py | 64 +- .../v2/third_party_applications/version.py | 62 - ...ient.py => test_user_auth_token_client.py} | 0 tests/utils.py | 80 - 811 files changed, 1966 insertions(+), 29042 deletions(-) delete mode 100644 docs/v1/Core/models/AnyTypeDict.md rename docs/v1/Core/models/{AttachmentTypeDict.md => AttachmentType.md} (94%) delete mode 100644 docs/v1/Core/models/BinaryTypeDict.md delete mode 100644 docs/v1/Core/models/BooleanTypeDict.md delete mode 100644 docs/v1/Core/models/ByteTypeDict.md delete mode 100644 docs/v1/Core/models/CipherTextTypeDict.md delete mode 100644 docs/v1/Core/models/DateTypeDict.md delete mode 100644 docs/v1/Core/models/DecimalTypeDict.md delete mode 100644 docs/v1/Core/models/DoubleTypeDict.md delete mode 100644 docs/v1/Core/models/FloatTypeDict.md delete mode 100644 docs/v1/Core/models/IntegerTypeDict.md delete mode 100644 docs/v1/Core/models/LongTypeDict.md delete mode 100644 docs/v1/Core/models/MarkingTypeDict.md rename docs/v1/Core/models/{NullTypeDict.md => NullType.md} (95%) delete mode 100644 docs/v1/Core/models/ShortTypeDict.md delete mode 100644 docs/v1/Core/models/StringTypeDict.md delete mode 100644 docs/v1/Core/models/TimestampTypeDict.md delete mode 100644 docs/v1/Core/models/UnsupportedTypeDict.md delete mode 100644 docs/v1/Datasets/models/BranchDict.md delete mode 100644 docs/v1/Datasets/models/DatasetDict.md delete mode 100644 docs/v1/Datasets/models/FileDict.md delete mode 100644 docs/v1/Datasets/models/ListBranchesResponseDict.md delete mode 100644 docs/v1/Datasets/models/ListFilesResponseDict.md delete mode 100644 docs/v1/Datasets/models/TransactionDict.md delete mode 100644 docs/v1/Ontologies/models/ActionTypeDict.md delete mode 100644 docs/v1/Ontologies/models/AggregateObjectsResponseDict.md delete mode 100644 docs/v1/Ontologies/models/AggregateObjectsResponseItemDict.md delete mode 100644 docs/v1/Ontologies/models/AggregationDict.md delete mode 100644 docs/v1/Ontologies/models/AggregationDurationGroupingDict.md delete mode 100644 docs/v1/Ontologies/models/AggregationExactGroupingDict.md delete mode 100644 docs/v1/Ontologies/models/AggregationFixedWidthGroupingDict.md delete mode 100644 docs/v1/Ontologies/models/AggregationGroupByDict.md delete mode 100644 docs/v1/Ontologies/models/AggregationMetricResultDict.md delete mode 100644 docs/v1/Ontologies/models/AggregationRangeDict.md delete mode 100644 docs/v1/Ontologies/models/AggregationRangesGroupingDict.md delete mode 100644 docs/v1/Ontologies/models/AllTermsQueryDict.md delete mode 100644 docs/v1/Ontologies/models/AndQueryDict.md delete mode 100644 docs/v1/Ontologies/models/AnyTermQueryDict.md delete mode 100644 docs/v1/Ontologies/models/ApplyActionRequestDict.md delete mode 100644 docs/v1/Ontologies/models/ApplyActionRequestOptionsDict.md delete mode 100644 docs/v1/Ontologies/models/ApplyActionResponseDict.md delete mode 100644 docs/v1/Ontologies/models/ApproximateDistinctAggregationDict.md delete mode 100644 docs/v1/Ontologies/models/ArraySizeConstraintDict.md delete mode 100644 docs/v1/Ontologies/models/AttachmentDict.md delete mode 100644 docs/v1/Ontologies/models/AvgAggregationDict.md delete mode 100644 docs/v1/Ontologies/models/BatchApplyActionResponseDict.md delete mode 100644 docs/v1/Ontologies/models/ContainsQueryDict.md delete mode 100644 docs/v1/Ontologies/models/CountAggregationDict.md delete mode 100644 docs/v1/Ontologies/models/CreateInterfaceObjectRuleDict.md delete mode 100644 docs/v1/Ontologies/models/CreateLinkRuleDict.md delete mode 100644 docs/v1/Ontologies/models/CreateObjectRuleDict.md delete mode 100644 docs/v1/Ontologies/models/DeleteInterfaceObjectRuleDict.md delete mode 100644 docs/v1/Ontologies/models/DeleteLinkRuleDict.md delete mode 100644 docs/v1/Ontologies/models/DeleteObjectRuleDict.md rename docs/v1/Ontologies/models/{EntrySetTypeDict.md => EntrySetType.md} (76%) delete mode 100644 docs/v1/Ontologies/models/EqualsQueryDict.md delete mode 100644 docs/v1/Ontologies/models/ExecuteQueryResponseDict.md delete mode 100644 docs/v1/Ontologies/models/GroupMemberConstraintDict.md delete mode 100644 docs/v1/Ontologies/models/GtQueryDict.md delete mode 100644 docs/v1/Ontologies/models/GteQueryDict.md delete mode 100644 docs/v1/Ontologies/models/IsNullQueryDict.md delete mode 100644 docs/v1/Ontologies/models/LinkTypeSideDict.md delete mode 100644 docs/v1/Ontologies/models/ListActionTypesResponseDict.md delete mode 100644 docs/v1/Ontologies/models/ListLinkedObjectsResponseDict.md delete mode 100644 docs/v1/Ontologies/models/ListObjectTypesResponseDict.md delete mode 100644 docs/v1/Ontologies/models/ListObjectsResponseDict.md delete mode 100644 docs/v1/Ontologies/models/ListOntologiesResponseDict.md delete mode 100644 docs/v1/Ontologies/models/ListOutgoingLinkTypesResponseDict.md delete mode 100644 docs/v1/Ontologies/models/ListQueryTypesResponseDict.md delete mode 100644 docs/v1/Ontologies/models/LogicRuleDict.md delete mode 100644 docs/v1/Ontologies/models/LtQueryDict.md delete mode 100644 docs/v1/Ontologies/models/LteQueryDict.md delete mode 100644 docs/v1/Ontologies/models/MaxAggregationDict.md delete mode 100644 docs/v1/Ontologies/models/MinAggregationDict.md delete mode 100644 docs/v1/Ontologies/models/ModifyInterfaceObjectRuleDict.md delete mode 100644 docs/v1/Ontologies/models/ModifyObjectRuleDict.md delete mode 100644 docs/v1/Ontologies/models/NotQueryDict.md delete mode 100644 docs/v1/Ontologies/models/ObjectPropertyValueConstraintDict.md delete mode 100644 docs/v1/Ontologies/models/ObjectQueryResultConstraintDict.md delete mode 100644 docs/v1/Ontologies/models/ObjectTypeDict.md delete mode 100644 docs/v1/Ontologies/models/OneOfConstraintDict.md delete mode 100644 docs/v1/Ontologies/models/OntologyArrayTypeDict.md delete mode 100644 docs/v1/Ontologies/models/OntologyDataTypeDict.md delete mode 100644 docs/v1/Ontologies/models/OntologyDict.md delete mode 100644 docs/v1/Ontologies/models/OntologyMapTypeDict.md delete mode 100644 docs/v1/Ontologies/models/OntologyObjectDict.md delete mode 100644 docs/v1/Ontologies/models/OntologyObjectSetTypeDict.md delete mode 100644 docs/v1/Ontologies/models/OntologyObjectTypeDict.md delete mode 100644 docs/v1/Ontologies/models/OntologySetTypeDict.md delete mode 100644 docs/v1/Ontologies/models/OntologyStructFieldDict.md delete mode 100644 docs/v1/Ontologies/models/OntologyStructTypeDict.md delete mode 100644 docs/v1/Ontologies/models/OrQueryDict.md delete mode 100644 docs/v1/Ontologies/models/ParameterDict.md delete mode 100644 docs/v1/Ontologies/models/ParameterEvaluatedConstraintDict.md delete mode 100644 docs/v1/Ontologies/models/ParameterEvaluationResultDict.md delete mode 100644 docs/v1/Ontologies/models/ParameterOptionDict.md delete mode 100644 docs/v1/Ontologies/models/PhraseQueryDict.md delete mode 100644 docs/v1/Ontologies/models/PrefixQueryDict.md delete mode 100644 docs/v1/Ontologies/models/PropertyDict.md rename docs/v1/Ontologies/models/{QueryAggregationKeyTypeDict.md => QueryAggregationKeyType.md} (68%) rename docs/v1/Ontologies/models/{QueryAggregationRangeSubTypeDict.md => QueryAggregationRangeSubType.md} (77%) rename docs/v1/Ontologies/models/{QueryAggregationRangeTypeDict.md => QueryAggregationRangeType.md} (79%) rename docs/v1/Ontologies/models/{QueryAggregationValueTypeDict.md => QueryAggregationValueType.md} (81%) rename docs/v1/Ontologies/models/{QueryArrayTypeDict.md => QueryArrayType.md} (84%) create mode 100644 docs/v1/Ontologies/models/QueryDataType.md delete mode 100644 docs/v1/Ontologies/models/QueryDataTypeDict.md rename docs/v1/Ontologies/models/{QuerySetTypeDict.md => QuerySetType.md} (84%) rename docs/v1/Ontologies/models/{QueryStructFieldDict.md => QueryStructField.md} (83%) rename docs/v1/Ontologies/models/{QueryStructTypeDict.md => QueryStructType.md} (82%) delete mode 100644 docs/v1/Ontologies/models/QueryTypeDict.md rename docs/v1/Ontologies/models/{QueryUnionTypeDict.md => QueryUnionType.md} (82%) delete mode 100644 docs/v1/Ontologies/models/RangeConstraintDict.md delete mode 100644 docs/v1/Ontologies/models/SearchJsonQueryDict.md delete mode 100644 docs/v1/Ontologies/models/SearchObjectsResponseDict.md delete mode 100644 docs/v1/Ontologies/models/SearchOrderByDict.md delete mode 100644 docs/v1/Ontologies/models/SearchOrderingDict.md delete mode 100644 docs/v1/Ontologies/models/StringLengthConstraintDict.md delete mode 100644 docs/v1/Ontologies/models/StringRegexMatchConstraintDict.md delete mode 100644 docs/v1/Ontologies/models/SubmissionCriteriaEvaluationDict.md delete mode 100644 docs/v1/Ontologies/models/SumAggregationDict.md rename docs/v1/Ontologies/models/{ThreeDimensionalAggregationDict.md => ThreeDimensionalAggregation.md} (72%) rename docs/v1/Ontologies/models/{TwoDimensionalAggregationDict.md => TwoDimensionalAggregation.md} (72%) delete mode 100644 docs/v1/Ontologies/models/UnevaluableConstraintDict.md delete mode 100644 docs/v1/Ontologies/models/ValidateActionResponseDict.md delete mode 100644 docs/v2/Admin/models/AuthenticationProviderDict.md delete mode 100644 docs/v2/Admin/models/CertificateInfoDict.md delete mode 100644 docs/v2/Admin/models/EnrollmentDict.md delete mode 100644 docs/v2/Admin/models/GetGroupsBatchRequestElementDict.md delete mode 100644 docs/v2/Admin/models/GetGroupsBatchResponseDict.md delete mode 100644 docs/v2/Admin/models/GetMarkingsBatchRequestElementDict.md delete mode 100644 docs/v2/Admin/models/GetMarkingsBatchResponseDict.md delete mode 100644 docs/v2/Admin/models/GetUserMarkingsResponseDict.md delete mode 100644 docs/v2/Admin/models/GetUsersBatchRequestElementDict.md delete mode 100644 docs/v2/Admin/models/GetUsersBatchResponseDict.md delete mode 100644 docs/v2/Admin/models/GroupDict.md delete mode 100644 docs/v2/Admin/models/GroupMemberDict.md delete mode 100644 docs/v2/Admin/models/GroupMembershipDict.md delete mode 100644 docs/v2/Admin/models/GroupProviderInfoDict.md delete mode 100644 docs/v2/Admin/models/GroupSearchFilterDict.md delete mode 100644 docs/v2/Admin/models/HostDict.md delete mode 100644 docs/v2/Admin/models/ListAuthenticationProvidersResponseDict.md delete mode 100644 docs/v2/Admin/models/ListGroupMembersResponseDict.md delete mode 100644 docs/v2/Admin/models/ListGroupMembershipsResponseDict.md delete mode 100644 docs/v2/Admin/models/ListGroupsResponseDict.md delete mode 100644 docs/v2/Admin/models/ListHostsResponseDict.md delete mode 100644 docs/v2/Admin/models/ListMarkingCategoriesResponseDict.md delete mode 100644 docs/v2/Admin/models/ListMarkingMembersResponseDict.md delete mode 100644 docs/v2/Admin/models/ListMarkingRoleAssignmentsResponseDict.md delete mode 100644 docs/v2/Admin/models/ListMarkingsResponseDict.md delete mode 100644 docs/v2/Admin/models/ListUsersResponseDict.md delete mode 100644 docs/v2/Admin/models/MarkingCategoryDict.md delete mode 100644 docs/v2/Admin/models/MarkingDict.md delete mode 100644 docs/v2/Admin/models/MarkingMemberDict.md delete mode 100644 docs/v2/Admin/models/MarkingRoleAssignmentDict.md delete mode 100644 docs/v2/Admin/models/MarkingRoleUpdateDict.md delete mode 100644 docs/v2/Admin/models/OidcAuthenticationProtocolDict.md delete mode 100644 docs/v2/Admin/models/OrganizationDict.md delete mode 100644 docs/v2/Admin/models/SamlAuthenticationProtocolDict.md delete mode 100644 docs/v2/Admin/models/SamlServiceProviderMetadataDict.md delete mode 100644 docs/v2/Admin/models/SearchGroupsResponseDict.md delete mode 100644 docs/v2/Admin/models/SearchUsersResponseDict.md delete mode 100644 docs/v2/Admin/models/UserDict.md delete mode 100644 docs/v2/Admin/models/UserProviderInfoDict.md delete mode 100644 docs/v2/Admin/models/UserSearchFilterDict.md delete mode 100644 docs/v2/AipAgents/models/AgentDict.md delete mode 100644 docs/v2/AipAgents/models/AgentMetadataDict.md delete mode 100644 docs/v2/AipAgents/models/AgentSessionRagContextResponseDict.md delete mode 100644 docs/v2/AipAgents/models/AgentVersionDetailsDict.md delete mode 100644 docs/v2/AipAgents/models/AgentVersionDict.md delete mode 100644 docs/v2/AipAgents/models/AgentsSessionsPageDict.md delete mode 100644 docs/v2/AipAgents/models/CancelSessionResponseDict.md delete mode 100644 docs/v2/AipAgents/models/ContentDict.md delete mode 100644 docs/v2/AipAgents/models/FunctionRetrievedContextDict.md delete mode 100644 docs/v2/AipAgents/models/InputContextDict.md delete mode 100644 docs/v2/AipAgents/models/ListAgentVersionsResponseDict.md delete mode 100644 docs/v2/AipAgents/models/ListSessionsResponseDict.md delete mode 100644 docs/v2/AipAgents/models/ObjectContextDict.md delete mode 100644 docs/v2/AipAgents/models/ObjectSetParameterDict.md delete mode 100644 docs/v2/AipAgents/models/ObjectSetParameterValueDict.md delete mode 100644 docs/v2/AipAgents/models/ObjectSetParameterValueUpdateDict.md delete mode 100644 docs/v2/AipAgents/models/ParameterDict.md delete mode 100644 docs/v2/AipAgents/models/ParameterTypeDict.md delete mode 100644 docs/v2/AipAgents/models/ParameterValueDict.md delete mode 100644 docs/v2/AipAgents/models/ParameterValueUpdateDict.md delete mode 100644 docs/v2/AipAgents/models/SessionDict.md delete mode 100644 docs/v2/AipAgents/models/SessionExchangeContextsDict.md delete mode 100644 docs/v2/AipAgents/models/SessionExchangeDict.md delete mode 100644 docs/v2/AipAgents/models/SessionExchangeResultDict.md delete mode 100644 docs/v2/AipAgents/models/SessionMetadataDict.md delete mode 100644 docs/v2/AipAgents/models/StringParameterDict.md delete mode 100644 docs/v2/AipAgents/models/StringParameterValueDict.md delete mode 100644 docs/v2/AipAgents/models/UserTextInputDict.md delete mode 100644 docs/v2/Connectivity/models/ApiKeyAuthenticationDict.md delete mode 100644 docs/v2/Connectivity/models/AsPlaintextValueDict.md delete mode 100644 docs/v2/Connectivity/models/AsSecretNameDict.md delete mode 100644 docs/v2/Connectivity/models/AwsAccessKeyDict.md delete mode 100644 docs/v2/Connectivity/models/AwsOidcAuthenticationDict.md delete mode 100644 docs/v2/Connectivity/models/BasicCredentialsDict.md delete mode 100644 docs/v2/Connectivity/models/BearerTokenDict.md delete mode 100644 docs/v2/Connectivity/models/CloudIdentityDict.md delete mode 100644 docs/v2/Connectivity/models/ConnectionConfigurationDict.md delete mode 100644 docs/v2/Connectivity/models/ConnectionDict.md delete mode 100644 docs/v2/Connectivity/models/CreateConnectionRequestConnectionConfigurationDict.md delete mode 100644 docs/v2/Connectivity/models/CreateConnectionRequestJdbcConnectionConfigurationDict.md delete mode 100644 docs/v2/Connectivity/models/CreateConnectionRequestRestConnectionConfigurationDict.md delete mode 100644 docs/v2/Connectivity/models/CreateConnectionRequestS3ConnectionConfigurationDict.md delete mode 100644 docs/v2/Connectivity/models/CreateTableImportRequestJdbcImportConfigDict.md delete mode 100644 docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfigDict.md delete mode 100644 docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfigDict.md delete mode 100644 docs/v2/Connectivity/models/CreateTableImportRequestOracleImportConfigDict.md delete mode 100644 docs/v2/Connectivity/models/CreateTableImportRequestPostgreSqlImportConfigDict.md delete mode 100644 docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfigDict.md delete mode 100644 docs/v2/Connectivity/models/DomainDict.md delete mode 100644 docs/v2/Connectivity/models/EncryptedPropertyDict.md delete mode 100644 docs/v2/Connectivity/models/FileAnyPathMatchesFilterDict.md delete mode 100644 docs/v2/Connectivity/models/FileAtLeastCountFilterDict.md delete mode 100644 docs/v2/Connectivity/models/FileChangedSinceLastUploadFilterDict.md delete mode 100644 docs/v2/Connectivity/models/FileImportCustomFilterDict.md delete mode 100644 docs/v2/Connectivity/models/FileImportDict.md delete mode 100644 docs/v2/Connectivity/models/FileImportFilterDict.md delete mode 100644 docs/v2/Connectivity/models/FileLastModifiedAfterFilterDict.md delete mode 100644 docs/v2/Connectivity/models/FilePathMatchesFilterDict.md delete mode 100644 docs/v2/Connectivity/models/FilePathNotMatchesFilterDict.md delete mode 100644 docs/v2/Connectivity/models/FileSizeFilterDict.md delete mode 100644 docs/v2/Connectivity/models/FilesCountLimitFilterDict.md delete mode 100644 docs/v2/Connectivity/models/HeaderApiKeyDict.md delete mode 100644 docs/v2/Connectivity/models/JdbcConnectionConfigurationDict.md delete mode 100644 docs/v2/Connectivity/models/JdbcImportConfigDict.md delete mode 100644 docs/v2/Connectivity/models/ListFileImportsResponseDict.md delete mode 100644 docs/v2/Connectivity/models/ListTableImportsResponseDict.md delete mode 100644 docs/v2/Connectivity/models/MicrosoftAccessImportConfigDict.md delete mode 100644 docs/v2/Connectivity/models/MicrosoftSqlServerImportConfigDict.md delete mode 100644 docs/v2/Connectivity/models/OracleImportConfigDict.md delete mode 100644 docs/v2/Connectivity/models/PostgreSqlImportConfigDict.md delete mode 100644 docs/v2/Connectivity/models/QueryParameterApiKeyDict.md delete mode 100644 docs/v2/Connectivity/models/RestAuthenticationModeDict.md delete mode 100644 docs/v2/Connectivity/models/RestConnectionAdditionalSecretsDict.md delete mode 100644 docs/v2/Connectivity/models/RestConnectionConfigurationDict.md delete mode 100644 docs/v2/Connectivity/models/RestConnectionOAuth2Dict.md delete mode 100644 docs/v2/Connectivity/models/RestRequestApiKeyLocationDict.md delete mode 100644 docs/v2/Connectivity/models/S3AuthenticationModeDict.md delete mode 100644 docs/v2/Connectivity/models/S3ConnectionConfigurationDict.md delete mode 100644 docs/v2/Connectivity/models/S3KmsConfigurationDict.md delete mode 100644 docs/v2/Connectivity/models/S3ProxyConfigurationDict.md delete mode 100644 docs/v2/Connectivity/models/SecretsNamesDict.md delete mode 100644 docs/v2/Connectivity/models/SecretsWithPlaintextValuesDict.md delete mode 100644 docs/v2/Connectivity/models/StsRoleConfigurationDict.md delete mode 100644 docs/v2/Connectivity/models/TableImportConfigDict.md delete mode 100644 docs/v2/Connectivity/models/TableImportDict.md delete mode 100644 docs/v2/Core/models/AnyTypeDict.md delete mode 100644 docs/v2/Core/models/ArrayFieldTypeDict.md delete mode 100644 docs/v2/Core/models/AttachmentTypeDict.md delete mode 100644 docs/v2/Core/models/BinaryTypeDict.md delete mode 100644 docs/v2/Core/models/BooleanTypeDict.md delete mode 100644 docs/v2/Core/models/ByteTypeDict.md delete mode 100644 docs/v2/Core/models/ChangeDataCaptureConfigurationDict.md delete mode 100644 docs/v2/Core/models/CipherTextTypeDict.md delete mode 100644 docs/v2/Core/models/DateTypeDict.md delete mode 100644 docs/v2/Core/models/DecimalTypeDict.md delete mode 100644 docs/v2/Core/models/DistanceDict.md delete mode 100644 docs/v2/Core/models/DoubleTypeDict.md delete mode 100644 docs/v2/Core/models/DurationDict.md delete mode 100644 docs/v2/Core/models/EmbeddingModelDict.md delete mode 100644 docs/v2/Core/models/FieldDataTypeDict.md delete mode 100644 docs/v2/Core/models/FieldDict.md delete mode 100644 docs/v2/Core/models/FieldSchemaDict.md rename docs/v2/Core/models/{FilterBinaryTypeDict.md => FilterBinaryType.md} (93%) rename docs/v2/Core/models/{FilterBooleanTypeDict.md => FilterBooleanType.md} (93%) rename docs/v2/Core/models/{FilterDateTimeTypeDict.md => FilterDateTimeType.md} (93%) rename docs/v2/Core/models/{FilterDateTypeDict.md => FilterDateType.md} (94%) rename docs/v2/Core/models/{FilterDoubleTypeDict.md => FilterDoubleType.md} (93%) rename docs/v2/Core/models/{FilterEnumTypeDict.md => FilterEnumType.md} (95%) rename docs/v2/Core/models/{FilterFloatTypeDict.md => FilterFloatType.md} (93%) rename docs/v2/Core/models/{FilterIntegerTypeDict.md => FilterIntegerType.md} (93%) rename docs/v2/Core/models/{FilterLongTypeDict.md => FilterLongType.md} (94%) rename docs/v2/Core/models/{FilterRidTypeDict.md => FilterRidType.md} (94%) rename docs/v2/Core/models/{FilterStringTypeDict.md => FilterStringType.md} (93%) rename docs/v2/{Admin/models/AuthenticationProtocolDict.md => Core/models/FilterType.md} (56%) delete mode 100644 docs/v2/Core/models/FilterTypeDict.md rename docs/v2/Core/models/{FilterUuidTypeDict.md => FilterUuidType.md} (94%) delete mode 100644 docs/v2/Core/models/FloatTypeDict.md delete mode 100644 docs/v2/Core/models/FoundryLiveDeploymentDict.md delete mode 100644 docs/v2/Core/models/FullRowChangeDataCaptureConfigurationDict.md delete mode 100644 docs/v2/Core/models/GeoPointTypeDict.md delete mode 100644 docs/v2/Core/models/GeoShapeTypeDict.md delete mode 100644 docs/v2/Core/models/GeotimeSeriesReferenceTypeDict.md delete mode 100644 docs/v2/Core/models/IntegerTypeDict.md delete mode 100644 docs/v2/Core/models/LmsEmbeddingModelDict.md delete mode 100644 docs/v2/Core/models/LongTypeDict.md delete mode 100644 docs/v2/Core/models/MapFieldTypeDict.md delete mode 100644 docs/v2/Core/models/MarkingTypeDict.md delete mode 100644 docs/v2/Core/models/MediaReferenceDict.md delete mode 100644 docs/v2/Core/models/MediaReferenceTypeDict.md delete mode 100644 docs/v2/Core/models/MediaSetViewItemDict.md delete mode 100644 docs/v2/Core/models/MediaSetViewItemWrapperDict.md delete mode 100644 docs/v2/Core/models/NullTypeDict.md delete mode 100644 docs/v2/Core/models/ReferenceDict.md delete mode 100644 docs/v2/Core/models/ShortTypeDict.md delete mode 100644 docs/v2/Core/models/StreamSchemaDict.md delete mode 100644 docs/v2/Core/models/StringTypeDict.md delete mode 100644 docs/v2/Core/models/StructFieldTypeDict.md delete mode 100644 docs/v2/Core/models/TimeSeriesItemTypeDict.md delete mode 100644 docs/v2/Core/models/TimeseriesTypeDict.md delete mode 100644 docs/v2/Core/models/TimestampTypeDict.md delete mode 100644 docs/v2/Core/models/UnsupportedTypeDict.md delete mode 100644 docs/v2/Core/models/VectorSimilarityFunctionDict.md delete mode 100644 docs/v2/Core/models/VectorTypeDict.md delete mode 100644 docs/v2/Datasets/models/BranchDict.md delete mode 100644 docs/v2/Datasets/models/DatasetDict.md delete mode 100644 docs/v2/Datasets/models/FileDict.md delete mode 100644 docs/v2/Datasets/models/ListBranchesResponseDict.md delete mode 100644 docs/v2/Datasets/models/ListFilesResponseDict.md delete mode 100644 docs/v2/Datasets/models/TransactionDict.md delete mode 100644 docs/v2/Filesystem/models/AccessRequirementsDict.md delete mode 100644 docs/v2/Filesystem/models/EveryoneDict.md delete mode 100644 docs/v2/Filesystem/models/FolderDict.md delete mode 100644 docs/v2/Filesystem/models/ListChildrenOfFolderResponseDict.md delete mode 100644 docs/v2/Filesystem/models/ListMarkingsOfResourceResponseDict.md delete mode 100644 docs/v2/Filesystem/models/ListOrganizationsOfProjectResponseDict.md delete mode 100644 docs/v2/Filesystem/models/ListResourceRolesResponseDict.md delete mode 100644 docs/v2/Filesystem/models/ListSpacesResponseDict.md delete mode 100644 docs/v2/Filesystem/models/MarkingDict.md delete mode 100644 docs/v2/Filesystem/models/OrganizationDict.md delete mode 100644 docs/v2/Filesystem/models/PrincipalWithIdDict.md delete mode 100644 docs/v2/Filesystem/models/ProjectDict.md delete mode 100644 docs/v2/Filesystem/models/ResourceDict.md delete mode 100644 docs/v2/Filesystem/models/ResourceRoleDict.md delete mode 100644 docs/v2/Filesystem/models/ResourceRolePrincipalDict.md delete mode 100644 docs/v2/Filesystem/models/SpaceDict.md delete mode 100644 docs/v2/Functions/models/ExecuteQueryResponseDict.md delete mode 100644 docs/v2/Functions/models/ParameterDict.md delete mode 100644 docs/v2/Functions/models/QueryAggregationKeyTypeDict.md delete mode 100644 docs/v2/Functions/models/QueryAggregationRangeSubTypeDict.md delete mode 100644 docs/v2/Functions/models/QueryAggregationRangeTypeDict.md delete mode 100644 docs/v2/Functions/models/QueryAggregationValueTypeDict.md delete mode 100644 docs/v2/Functions/models/QueryArrayTypeDict.md delete mode 100644 docs/v2/Functions/models/QueryDataTypeDict.md delete mode 100644 docs/v2/Functions/models/QueryDict.md delete mode 100644 docs/v2/Functions/models/QuerySetTypeDict.md delete mode 100644 docs/v2/Functions/models/QueryStructFieldDict.md delete mode 100644 docs/v2/Functions/models/QueryStructTypeDict.md delete mode 100644 docs/v2/Functions/models/QueryUnionTypeDict.md delete mode 100644 docs/v2/Functions/models/ThreeDimensionalAggregationDict.md delete mode 100644 docs/v2/Functions/models/TwoDimensionalAggregationDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeArrayTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeBinaryTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeBooleanTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeByteTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeDateTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeDecimalTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeDoubleTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeFloatTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeIntegerTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeLongTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeMapTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeOptionalTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeShortTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeStringTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeStructElementDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeStructTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeTimestampTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeUnionTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDataTypeValueTypeReferenceDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeDict.md delete mode 100644 docs/v2/Functions/models/ValueTypeReferenceDict.md delete mode 100644 docs/v2/Functions/models/VersionIdDict.md delete mode 100644 docs/v2/Geo/models/FeatureCollectionDict.md delete mode 100644 docs/v2/Geo/models/FeatureCollectionTypesDict.md delete mode 100644 docs/v2/Geo/models/FeatureDict.md delete mode 100644 docs/v2/Geo/models/GeoPointDict.md delete mode 100644 docs/v2/Geo/models/GeometryCollectionDict.md delete mode 100644 docs/v2/Geo/models/GeometryDict.md delete mode 100644 docs/v2/Geo/models/LineStringDict.md delete mode 100644 docs/v2/Geo/models/MultiLineStringDict.md delete mode 100644 docs/v2/Geo/models/MultiPointDict.md delete mode 100644 docs/v2/Geo/models/MultiPolygonDict.md delete mode 100644 docs/v2/Geo/models/PolygonDict.md delete mode 100644 docs/v2/MediaSets/models/GetMediaItemInfoResponseDict.md delete mode 100644 docs/v2/MediaSets/models/MediaAttributionDict.md delete mode 100644 docs/v2/MediaSets/models/PutMediaItemResponseDict.md delete mode 100644 docs/v2/Ontologies/models/AbsoluteTimeRangeDict.md delete mode 100644 docs/v2/Ontologies/models/AbsoluteValuePropertyExpressionDict.md delete mode 100644 docs/v2/Ontologies/models/ActionParameterArrayTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ActionParameterTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ActionParameterV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ActionResultsDict.md delete mode 100644 docs/v2/Ontologies/models/ActionTypeV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ActivePropertyTypeStatusDict.md delete mode 100644 docs/v2/Ontologies/models/AddLinkDict.md delete mode 100644 docs/v2/Ontologies/models/AddObjectDict.md delete mode 100644 docs/v2/Ontologies/models/AddPropertyExpressionDict.md delete mode 100644 docs/v2/Ontologies/models/AggregateObjectsResponseItemV2Dict.md delete mode 100644 docs/v2/Ontologies/models/AggregateObjectsResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/AggregateTimeSeriesDict.md delete mode 100644 docs/v2/Ontologies/models/AggregationDurationGroupingV2Dict.md delete mode 100644 docs/v2/Ontologies/models/AggregationExactGroupingV2Dict.md delete mode 100644 docs/v2/Ontologies/models/AggregationFixedWidthGroupingV2Dict.md delete mode 100644 docs/v2/Ontologies/models/AggregationGroupByV2Dict.md delete mode 100644 docs/v2/Ontologies/models/AggregationMetricResultV2Dict.md delete mode 100644 docs/v2/Ontologies/models/AggregationRangeV2Dict.md delete mode 100644 docs/v2/Ontologies/models/AggregationRangesGroupingV2Dict.md delete mode 100644 docs/v2/Ontologies/models/AggregationV2Dict.md delete mode 100644 docs/v2/Ontologies/models/AndQueryV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ApplyActionRequestOptionsDict.md delete mode 100644 docs/v2/Ontologies/models/ApproximateDistinctAggregationV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ApproximatePercentileAggregationV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ArraySizeConstraintDict.md delete mode 100644 docs/v2/Ontologies/models/AttachmentMetadataResponseDict.md delete mode 100644 docs/v2/Ontologies/models/AttachmentV2Dict.md delete mode 100644 docs/v2/Ontologies/models/AvgAggregationV2Dict.md delete mode 100644 docs/v2/Ontologies/models/BatchActionObjectEditDict.md delete mode 100644 docs/v2/Ontologies/models/BatchActionObjectEditsDict.md delete mode 100644 docs/v2/Ontologies/models/BatchActionResultsDict.md delete mode 100644 docs/v2/Ontologies/models/BatchApplyActionRequestItemDict.md delete mode 100644 docs/v2/Ontologies/models/BatchApplyActionRequestOptionsDict.md delete mode 100644 docs/v2/Ontologies/models/BatchApplyActionResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/BlueprintIconDict.md delete mode 100644 docs/v2/Ontologies/models/BoundingBoxValueDict.md delete mode 100644 docs/v2/Ontologies/models/CenterPointDict.md delete mode 100644 docs/v2/Ontologies/models/CenterPointTypesDict.md delete mode 100644 docs/v2/Ontologies/models/ContainsAllTermsInOrderPrefixLastTermDict.md delete mode 100644 docs/v2/Ontologies/models/ContainsAllTermsInOrderQueryDict.md delete mode 100644 docs/v2/Ontologies/models/ContainsAllTermsQueryDict.md delete mode 100644 docs/v2/Ontologies/models/ContainsAnyTermQueryDict.md delete mode 100644 docs/v2/Ontologies/models/ContainsQueryV2Dict.md delete mode 100644 docs/v2/Ontologies/models/CountAggregationV2Dict.md delete mode 100644 docs/v2/Ontologies/models/CountObjectsResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/CreateInterfaceObjectRuleDict.md delete mode 100644 docs/v2/Ontologies/models/CreateLinkRuleDict.md delete mode 100644 docs/v2/Ontologies/models/CreateObjectRuleDict.md delete mode 100644 docs/v2/Ontologies/models/CreateTemporaryObjectSetResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/DeleteInterfaceObjectRuleDict.md delete mode 100644 docs/v2/Ontologies/models/DeleteLinkDict.md delete mode 100644 docs/v2/Ontologies/models/DeleteLinkRuleDict.md delete mode 100644 docs/v2/Ontologies/models/DeleteObjectDict.md delete mode 100644 docs/v2/Ontologies/models/DeleteObjectRuleDict.md delete mode 100644 docs/v2/Ontologies/models/DeprecatedPropertyTypeStatusDict.md delete mode 100644 docs/v2/Ontologies/models/DerivedPropertyDefinitionDict.md delete mode 100644 docs/v2/Ontologies/models/DividePropertyExpressionDict.md delete mode 100644 docs/v2/Ontologies/models/DoesNotIntersectBoundingBoxQueryDict.md delete mode 100644 docs/v2/Ontologies/models/DoesNotIntersectPolygonQueryDict.md delete mode 100644 docs/v2/Ontologies/models/DoubleVectorDict.md delete mode 100644 docs/v2/Ontologies/models/EntrySetTypeDict.md delete mode 100644 docs/v2/Ontologies/models/EqualsQueryV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ExactDistinctAggregationV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ExamplePropertyTypeStatusDict.md delete mode 100644 docs/v2/Ontologies/models/ExecuteQueryResponseDict.md delete mode 100644 docs/v2/Ontologies/models/ExperimentalPropertyTypeStatusDict.md delete mode 100644 docs/v2/Ontologies/models/ExtractPropertyExpressionDict.md delete mode 100644 docs/v2/Ontologies/models/GetSelectedPropertyOperationDict.md delete mode 100644 docs/v2/Ontologies/models/GreatestPropertyExpressionDict.md delete mode 100644 docs/v2/Ontologies/models/GroupMemberConstraintDict.md delete mode 100644 docs/v2/Ontologies/models/GtQueryV2Dict.md delete mode 100644 docs/v2/Ontologies/models/GteQueryV2Dict.md delete mode 100644 docs/v2/Ontologies/models/IconDict.md delete mode 100644 docs/v2/Ontologies/models/InQueryDict.md delete mode 100644 docs/v2/Ontologies/models/InterfaceLinkTypeDict.md delete mode 100644 docs/v2/Ontologies/models/InterfaceLinkTypeLinkedEntityApiNameDict.md delete mode 100644 docs/v2/Ontologies/models/InterfaceSharedPropertyTypeDict.md delete mode 100644 docs/v2/Ontologies/models/InterfaceTypeDict.md delete mode 100644 docs/v2/Ontologies/models/IntersectsBoundingBoxQueryDict.md delete mode 100644 docs/v2/Ontologies/models/IntersectsPolygonQueryDict.md delete mode 100644 docs/v2/Ontologies/models/IsNullQueryV2Dict.md delete mode 100644 docs/v2/Ontologies/models/LeastPropertyExpressionDict.md delete mode 100644 docs/v2/Ontologies/models/LinkSideObjectDict.md delete mode 100644 docs/v2/Ontologies/models/LinkTypeSideV2Dict.md delete mode 100644 docs/v2/Ontologies/models/LinkedInterfaceTypeApiNameDict.md delete mode 100644 docs/v2/Ontologies/models/LinkedObjectTypeApiNameDict.md delete mode 100644 docs/v2/Ontologies/models/ListActionTypesResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ListAttachmentsResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ListInterfaceTypesResponseDict.md delete mode 100644 docs/v2/Ontologies/models/ListLinkedObjectsResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ListObjectTypesV2ResponseDict.md delete mode 100644 docs/v2/Ontologies/models/ListObjectsResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ListOntologiesV2ResponseDict.md delete mode 100644 docs/v2/Ontologies/models/ListOutgoingLinkTypesResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ListQueryTypesResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/LoadObjectSetResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponseDict.md delete mode 100644 docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesResponseDict.md delete mode 100644 docs/v2/Ontologies/models/LogicRuleDict.md delete mode 100644 docs/v2/Ontologies/models/LtQueryV2Dict.md delete mode 100644 docs/v2/Ontologies/models/LteQueryV2Dict.md delete mode 100644 docs/v2/Ontologies/models/MaxAggregationV2Dict.md delete mode 100644 docs/v2/Ontologies/models/MediaMetadataDict.md delete mode 100644 docs/v2/Ontologies/models/MethodObjectSetDict.md delete mode 100644 docs/v2/Ontologies/models/MinAggregationV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ModifyInterfaceObjectRuleDict.md delete mode 100644 docs/v2/Ontologies/models/ModifyObjectDict.md delete mode 100644 docs/v2/Ontologies/models/ModifyObjectRuleDict.md delete mode 100644 docs/v2/Ontologies/models/MultiplyPropertyExpressionDict.md delete mode 100644 docs/v2/Ontologies/models/NearestNeighborsQueryDict.md delete mode 100644 docs/v2/Ontologies/models/NearestNeighborsQueryTextDict.md delete mode 100644 docs/v2/Ontologies/models/NegatePropertyExpressionDict.md delete mode 100644 docs/v2/Ontologies/models/NotQueryV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ObjectEditDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectEditsDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectPropertyTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectPropertyValueConstraintDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectQueryResultConstraintDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetAsBaseObjectTypesTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetAsTypeTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetBaseTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetFilterTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetInterfaceBaseTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetIntersectionTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetMethodInputTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetNearestNeighborsTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetReferenceTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetSearchAroundTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetStaticTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetSubtractTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetUnionTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectSetWithPropertiesTypeDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectTypeEditsDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectTypeFullMetadataDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectTypeInterfaceImplementationDict.md delete mode 100644 docs/v2/Ontologies/models/ObjectTypeV2Dict.md delete mode 100644 docs/v2/Ontologies/models/OneOfConstraintDict.md delete mode 100644 docs/v2/Ontologies/models/OntologyArrayTypeDict.md delete mode 100644 docs/v2/Ontologies/models/OntologyDataTypeDict.md delete mode 100644 docs/v2/Ontologies/models/OntologyFullMetadataDict.md delete mode 100644 docs/v2/Ontologies/models/OntologyInterfaceObjectTypeDict.md delete mode 100644 docs/v2/Ontologies/models/OntologyMapTypeDict.md delete mode 100644 docs/v2/Ontologies/models/OntologyObjectArrayTypeDict.md delete mode 100644 docs/v2/Ontologies/models/OntologyObjectSetTypeDict.md delete mode 100644 docs/v2/Ontologies/models/OntologyObjectTypeDict.md delete mode 100644 docs/v2/Ontologies/models/OntologyObjectTypeReferenceTypeDict.md delete mode 100644 docs/v2/Ontologies/models/OntologySetTypeDict.md delete mode 100644 docs/v2/Ontologies/models/OntologyStructFieldDict.md delete mode 100644 docs/v2/Ontologies/models/OntologyStructTypeDict.md delete mode 100644 docs/v2/Ontologies/models/OntologyV2Dict.md delete mode 100644 docs/v2/Ontologies/models/OrQueryV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ParameterEvaluatedConstraintDict.md delete mode 100644 docs/v2/Ontologies/models/ParameterEvaluationResultDict.md delete mode 100644 docs/v2/Ontologies/models/ParameterOptionDict.md delete mode 100644 docs/v2/Ontologies/models/PolygonValueDict.md delete mode 100644 docs/v2/Ontologies/models/PreciseDurationDict.md delete mode 100644 docs/v2/Ontologies/models/PropertyApiNameSelectorDict.md delete mode 100644 docs/v2/Ontologies/models/PropertyIdentifierDict.md delete mode 100644 docs/v2/Ontologies/models/PropertyTypeStatusDict.md delete mode 100644 docs/v2/Ontologies/models/PropertyV2Dict.md delete mode 100644 docs/v2/Ontologies/models/QueryAggregationKeyTypeDict.md delete mode 100644 docs/v2/Ontologies/models/QueryAggregationRangeSubTypeDict.md delete mode 100644 docs/v2/Ontologies/models/QueryAggregationRangeTypeDict.md delete mode 100644 docs/v2/Ontologies/models/QueryAggregationValueTypeDict.md delete mode 100644 docs/v2/Ontologies/models/QueryArrayTypeDict.md delete mode 100644 docs/v2/Ontologies/models/QueryDataTypeDict.md delete mode 100644 docs/v2/Ontologies/models/QueryParameterV2Dict.md delete mode 100644 docs/v2/Ontologies/models/QuerySetTypeDict.md delete mode 100644 docs/v2/Ontologies/models/QueryStructFieldDict.md delete mode 100644 docs/v2/Ontologies/models/QueryStructTypeDict.md delete mode 100644 docs/v2/Ontologies/models/QueryTypeV2Dict.md delete mode 100644 docs/v2/Ontologies/models/QueryUnionTypeDict.md delete mode 100644 docs/v2/Ontologies/models/RangeConstraintDict.md delete mode 100644 docs/v2/Ontologies/models/RelativeTimeDict.md delete mode 100644 docs/v2/Ontologies/models/RelativeTimeRangeDict.md delete mode 100644 docs/v2/Ontologies/models/RollingAggregateWindowPointsDict.md delete mode 100644 docs/v2/Ontologies/models/SearchJsonQueryV2Dict.md delete mode 100644 docs/v2/Ontologies/models/SearchObjectsResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/SearchOrderByV2Dict.md delete mode 100644 docs/v2/Ontologies/models/SearchOrderingV2Dict.md delete mode 100644 docs/v2/Ontologies/models/SelectedPropertyApproximateDistinctAggregationDict.md delete mode 100644 docs/v2/Ontologies/models/SelectedPropertyApproximatePercentileAggregationDict.md delete mode 100644 docs/v2/Ontologies/models/SelectedPropertyAvgAggregationDict.md delete mode 100644 docs/v2/Ontologies/models/SelectedPropertyCollectListAggregationDict.md delete mode 100644 docs/v2/Ontologies/models/SelectedPropertyCollectSetAggregationDict.md delete mode 100644 docs/v2/Ontologies/models/SelectedPropertyCountAggregationDict.md delete mode 100644 docs/v2/Ontologies/models/SelectedPropertyExactDistinctAggregationDict.md delete mode 100644 docs/v2/Ontologies/models/SelectedPropertyExpressionDict.md delete mode 100644 docs/v2/Ontologies/models/SelectedPropertyMaxAggregationDict.md delete mode 100644 docs/v2/Ontologies/models/SelectedPropertyMinAggregationDict.md delete mode 100644 docs/v2/Ontologies/models/SelectedPropertyOperationDict.md delete mode 100644 docs/v2/Ontologies/models/SelectedPropertySumAggregationDict.md delete mode 100644 docs/v2/Ontologies/models/SharedPropertyTypeDict.md delete mode 100644 docs/v2/Ontologies/models/StartsWithQueryDict.md delete mode 100644 docs/v2/Ontologies/models/StringLengthConstraintDict.md delete mode 100644 docs/v2/Ontologies/models/StringRegexMatchConstraintDict.md delete mode 100644 docs/v2/Ontologies/models/StructFieldSelectorDict.md delete mode 100644 docs/v2/Ontologies/models/StructFieldTypeDict.md delete mode 100644 docs/v2/Ontologies/models/StructTypeDict.md delete mode 100644 docs/v2/Ontologies/models/SubmissionCriteriaEvaluationDict.md delete mode 100644 docs/v2/Ontologies/models/SubtractPropertyExpressionDict.md delete mode 100644 docs/v2/Ontologies/models/SumAggregationV2Dict.md delete mode 100644 docs/v2/Ontologies/models/SyncApplyActionResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/ThreeDimensionalAggregationDict.md delete mode 100644 docs/v2/Ontologies/models/TimeRangeDict.md delete mode 100644 docs/v2/Ontologies/models/TimeSeriesAggregationStrategyDict.md delete mode 100644 docs/v2/Ontologies/models/TimeSeriesCumulativeAggregateDict.md delete mode 100644 docs/v2/Ontologies/models/TimeSeriesPeriodicAggregateDict.md delete mode 100644 docs/v2/Ontologies/models/TimeSeriesPointDict.md delete mode 100644 docs/v2/Ontologies/models/TimeSeriesRollingAggregateDict.md delete mode 100644 docs/v2/Ontologies/models/TimeSeriesRollingAggregateWindowDict.md delete mode 100644 docs/v2/Ontologies/models/TimeseriesEntryDict.md delete mode 100644 docs/v2/Ontologies/models/TwoDimensionalAggregationDict.md delete mode 100644 docs/v2/Ontologies/models/UnevaluableConstraintDict.md delete mode 100644 docs/v2/Ontologies/models/ValidateActionResponseV2Dict.md delete mode 100644 docs/v2/Ontologies/models/WithinBoundingBoxPointDict.md delete mode 100644 docs/v2/Ontologies/models/WithinBoundingBoxQueryDict.md delete mode 100644 docs/v2/Ontologies/models/WithinDistanceOfQueryDict.md delete mode 100644 docs/v2/Ontologies/models/WithinPolygonQueryDict.md delete mode 100644 docs/v2/Orchestration/models/ActionDict.md delete mode 100644 docs/v2/Orchestration/models/AndTriggerDict.md delete mode 100644 docs/v2/Orchestration/models/BuildDict.md delete mode 100644 docs/v2/Orchestration/models/BuildTargetDict.md delete mode 100644 docs/v2/Orchestration/models/ConnectingTargetDict.md delete mode 100644 docs/v2/Orchestration/models/CreateScheduleRequestActionDict.md delete mode 100644 docs/v2/Orchestration/models/CreateScheduleRequestBuildTargetDict.md delete mode 100644 docs/v2/Orchestration/models/CreateScheduleRequestConnectingTargetDict.md delete mode 100644 docs/v2/Orchestration/models/CreateScheduleRequestManualTargetDict.md delete mode 100644 docs/v2/Orchestration/models/CreateScheduleRequestProjectScopeDict.md delete mode 100644 docs/v2/Orchestration/models/CreateScheduleRequestScopeModeDict.md delete mode 100644 docs/v2/Orchestration/models/CreateScheduleRequestUpstreamTargetDict.md delete mode 100644 docs/v2/Orchestration/models/CreateScheduleRequestUserScopeDict.md delete mode 100644 docs/v2/Orchestration/models/DatasetJobOutputDict.md delete mode 100644 docs/v2/Orchestration/models/DatasetUpdatedTriggerDict.md delete mode 100644 docs/v2/Orchestration/models/GetBuildsBatchRequestElementDict.md delete mode 100644 docs/v2/Orchestration/models/GetBuildsBatchResponseDict.md delete mode 100644 docs/v2/Orchestration/models/GetJobsBatchRequestElementDict.md delete mode 100644 docs/v2/Orchestration/models/GetJobsBatchResponseDict.md delete mode 100644 docs/v2/Orchestration/models/JobDict.md delete mode 100644 docs/v2/Orchestration/models/JobOutputDict.md delete mode 100644 docs/v2/Orchestration/models/JobSucceededTriggerDict.md delete mode 100644 docs/v2/Orchestration/models/ListJobsOfBuildResponseDict.md delete mode 100644 docs/v2/Orchestration/models/ListRunsOfScheduleResponseDict.md delete mode 100644 docs/v2/Orchestration/models/ManualTargetDict.md delete mode 100644 docs/v2/Orchestration/models/MediaSetUpdatedTriggerDict.md delete mode 100644 docs/v2/Orchestration/models/NewLogicTriggerDict.md delete mode 100644 docs/v2/Orchestration/models/OrTriggerDict.md delete mode 100644 docs/v2/Orchestration/models/ProjectScopeDict.md delete mode 100644 docs/v2/Orchestration/models/ReplaceScheduleRequestActionDict.md delete mode 100644 docs/v2/Orchestration/models/ReplaceScheduleRequestBuildTargetDict.md delete mode 100644 docs/v2/Orchestration/models/ReplaceScheduleRequestConnectingTargetDict.md delete mode 100644 docs/v2/Orchestration/models/ReplaceScheduleRequestManualTargetDict.md delete mode 100644 docs/v2/Orchestration/models/ReplaceScheduleRequestProjectScopeDict.md delete mode 100644 docs/v2/Orchestration/models/ReplaceScheduleRequestScopeModeDict.md delete mode 100644 docs/v2/Orchestration/models/ReplaceScheduleRequestUpstreamTargetDict.md delete mode 100644 docs/v2/Orchestration/models/ReplaceScheduleRequestUserScopeDict.md delete mode 100644 docs/v2/Orchestration/models/RetryBackoffDurationDict.md delete mode 100644 docs/v2/Orchestration/models/ScheduleDict.md delete mode 100644 docs/v2/Orchestration/models/ScheduleRunDict.md delete mode 100644 docs/v2/Orchestration/models/ScheduleRunErrorDict.md delete mode 100644 docs/v2/Orchestration/models/ScheduleRunIgnoredDict.md delete mode 100644 docs/v2/Orchestration/models/ScheduleRunResultDict.md delete mode 100644 docs/v2/Orchestration/models/ScheduleRunSubmittedDict.md delete mode 100644 docs/v2/Orchestration/models/ScheduleSucceededTriggerDict.md delete mode 100644 docs/v2/Orchestration/models/ScheduleVersionDict.md delete mode 100644 docs/v2/Orchestration/models/ScopeModeDict.md delete mode 100644 docs/v2/Orchestration/models/SearchBuildsAndFilterDict.md delete mode 100644 docs/v2/Orchestration/models/SearchBuildsEqualsFilterDict.md delete mode 100644 docs/v2/Orchestration/models/SearchBuildsFilterDict.md delete mode 100644 docs/v2/Orchestration/models/SearchBuildsGteFilterDict.md delete mode 100644 docs/v2/Orchestration/models/SearchBuildsLtFilterDict.md delete mode 100644 docs/v2/Orchestration/models/SearchBuildsNotFilterDict.md delete mode 100644 docs/v2/Orchestration/models/SearchBuildsOrFilterDict.md delete mode 100644 docs/v2/Orchestration/models/SearchBuildsOrderByDict.md delete mode 100644 docs/v2/Orchestration/models/SearchBuildsOrderByItemDict.md delete mode 100644 docs/v2/Orchestration/models/SearchBuildsResponseDict.md delete mode 100644 docs/v2/Orchestration/models/TimeTriggerDict.md delete mode 100644 docs/v2/Orchestration/models/TransactionalMediaSetJobOutputDict.md delete mode 100644 docs/v2/Orchestration/models/TriggerDict.md delete mode 100644 docs/v2/Orchestration/models/UpstreamTargetDict.md delete mode 100644 docs/v2/Orchestration/models/UserScopeDict.md delete mode 100644 docs/v2/SqlQueries/models/CanceledQueryStatusDict.md delete mode 100644 docs/v2/SqlQueries/models/FailedQueryStatusDict.md delete mode 100644 docs/v2/SqlQueries/models/QueryStatusDict.md delete mode 100644 docs/v2/SqlQueries/models/RunningQueryStatusDict.md delete mode 100644 docs/v2/SqlQueries/models/SucceededQueryStatusDict.md delete mode 100644 docs/v2/Streams/models/CreateStreamRequestStreamSchemaDict.md delete mode 100644 docs/v2/Streams/models/DatasetDict.md delete mode 100644 docs/v2/Streams/models/StreamDict.md delete mode 100644 docs/v2/ThirdPartyApplications/models/ListVersionsResponseDict.md delete mode 100644 docs/v2/ThirdPartyApplications/models/ThirdPartyApplicationDict.md delete mode 100644 docs/v2/ThirdPartyApplications/models/VersionDict.md delete mode 100644 docs/v2/ThirdPartyApplications/models/WebsiteDict.md rename foundry/_core/{foundry_token_auth_client.py => user_token_auth_client.py} (100%) delete mode 100644 foundry/v1/datasets/client.py delete mode 100644 foundry/v1/ontologies/client.py delete mode 100644 foundry/v2/admin/client.py delete mode 100644 foundry/v2/aip_agents/client.py delete mode 100644 foundry/v2/connectivity/client.py delete mode 100644 foundry/v2/datasets/client.py delete mode 100644 foundry/v2/filesystem/client.py delete mode 100644 foundry/v2/functions/client.py delete mode 100644 foundry/v2/media_sets/client.py delete mode 100644 foundry/v2/ontologies/client.py delete mode 100644 foundry/v2/orchestration/client.py delete mode 100644 foundry/v2/sql_queries/client.py delete mode 100644 foundry/v2/streams/client.py delete mode 100644 foundry/v2/third_party_applications/client.py rename tests/auth/{test_foundry_auth_token_client.py => test_user_auth_token_client.py} (100%) delete mode 100644 tests/utils.py diff --git a/README.md b/README.md index 9a7b26345..ee66e14d1 100644 --- a/README.md +++ b/README.md @@ -351,9 +351,10 @@ with open("result.png", "wb") as f: ## Static type analysis This library uses [Pydantic](https://docs.pydantic.dev) for creating and validating data models which you will see in the -method definitions (see [Documentation for Models](#models-link) below for a full list of models). All request parameters with nested -fields are typed as a `Union` between a Pydantic [BaseModel](https://docs.pydantic.dev/latest/api/base_model/) class and a [TypedDict](https://docs.python.org/3/library/typing.html#typing.TypedDict) whereas responses use `Pydantic` -class. For example, here is how `Group.search` method is defined in the `Admin` namespace: +method definitions (see [Documentation for Models](#models-link) below for a full list of models). +All request parameters and responses with nested fields are typed using a Pydantic +[`BaseModel`](https://docs.pydantic.dev/latest/api/base_model/) class. For example, here is how +`Group.search` method is defined in the `Admin` namespace: ```python @pydantic.validate_call @@ -361,7 +362,7 @@ class. For example, here is how `Group.search` method is defined in the `Admin` def search( self, *, - where: Union[GroupSearchFilter, GroupSearchFilterDict], + where: GroupSearchFilter, page_size: Optional[PageSize] = None, page_token: Optional[PageToken] = None, preview: Optional[PreviewMode] = None, @@ -371,28 +372,17 @@ class. For example, here is how `Group.search` method is defined in the `Admin` ``` -In this example, `GroupSearchFilter` is a `BaseModel` class and `GroupSearchFilterDict` is a `TypedDict` class. When calling this method, -you can choose whether to pass in a class instance or a dict. - ```python import foundry.v2 from foundry.v2.admin.models import GroupSearchFilter client = foundry.v2.FoundryClient(...) -# Class instance result = client.admin.Group.search(where=GroupSearchFilter(type="queryString", value="John Doe")) - -# Dict -result = client.admin.Group.search(where={"type": "queryString", "value": "John Doe"}) +print(result.data) ``` -> [!TIP] -> A `Pydantic` model can be converted into its `TypedDict` representation using the `to_dict` method. For example, if you handle -> a variable of type `Branch` and you called `to_dict()` on that variable you would receive a `BranchDict` -> variable. - If you are using a static type checker (for example, [mypy](https://mypy-lang.org), [pyright](https://github.com/microsoft/pyright)), you get static type analysis for the arguments you provide to the function and with the response. For example, if you pass an `int` to `name` but `name` expects a string or if you try to access `branchName` on the returned [`Branch`](docs/Branch.md) object (the @@ -483,31 +473,24 @@ Namespace | Resource | Operation | HTTP request | **Admin** | Group | [**get**](docs/v2/Admin/Group.md#get) | **GET** /v2/admin/groups/{groupId} | **Admin** | Group | [**get_batch**](docs/v2/Admin/Group.md#get_batch) | **POST** /v2/admin/groups/getBatch | **Admin** | Group | [**list**](docs/v2/Admin/Group.md#list) | **GET** /v2/admin/groups | -**Admin** | Group | [**page**](docs/v2/Admin/Group.md#page) | **GET** /v2/admin/groups | **Admin** | Group | [**search**](docs/v2/Admin/Group.md#search) | **POST** /v2/admin/groups/search | **Admin** | GroupMember | [**add**](docs/v2/Admin/GroupMember.md#add) | **POST** /v2/admin/groups/{groupId}/groupMembers/add | **Admin** | GroupMember | [**list**](docs/v2/Admin/GroupMember.md#list) | **GET** /v2/admin/groups/{groupId}/groupMembers | -**Admin** | GroupMember | [**page**](docs/v2/Admin/GroupMember.md#page) | **GET** /v2/admin/groups/{groupId}/groupMembers | **Admin** | GroupMember | [**remove**](docs/v2/Admin/GroupMember.md#remove) | **POST** /v2/admin/groups/{groupId}/groupMembers/remove | **Admin** | GroupMembership | [**list**](docs/v2/Admin/GroupMembership.md#list) | **GET** /v2/admin/users/{userId}/groupMemberships | -**Admin** | GroupMembership | [**page**](docs/v2/Admin/GroupMembership.md#page) | **GET** /v2/admin/users/{userId}/groupMemberships | **Admin** | GroupProviderInfo | [**get**](docs/v2/Admin/GroupProviderInfo.md#get) | **GET** /v2/admin/groups/{groupId}/providerInfo | **Admin** | GroupProviderInfo | [**replace**](docs/v2/Admin/GroupProviderInfo.md#replace) | **PUT** /v2/admin/groups/{groupId}/providerInfo | **Admin** | Marking | [**create**](docs/v2/Admin/Marking.md#create) | **POST** /v2/admin/markings | **Admin** | Marking | [**get**](docs/v2/Admin/Marking.md#get) | **GET** /v2/admin/markings/{markingId} | **Admin** | Marking | [**get_batch**](docs/v2/Admin/Marking.md#get_batch) | **POST** /v2/admin/markings/getBatch | **Admin** | Marking | [**list**](docs/v2/Admin/Marking.md#list) | **GET** /v2/admin/markings | -**Admin** | Marking | [**page**](docs/v2/Admin/Marking.md#page) | **GET** /v2/admin/markings | **Admin** | MarkingCategory | [**get**](docs/v2/Admin/MarkingCategory.md#get) | **GET** /v2/admin/markingCategories/{markingCategoryId} | **Admin** | MarkingCategory | [**list**](docs/v2/Admin/MarkingCategory.md#list) | **GET** /v2/admin/markingCategories | -**Admin** | MarkingCategory | [**page**](docs/v2/Admin/MarkingCategory.md#page) | **GET** /v2/admin/markingCategories | **Admin** | MarkingMember | [**add**](docs/v2/Admin/MarkingMember.md#add) | **POST** /v2/admin/markings/{markingId}/markingMembers/add | **Admin** | MarkingMember | [**list**](docs/v2/Admin/MarkingMember.md#list) | **GET** /v2/admin/markings/{markingId}/markingMembers | -**Admin** | MarkingMember | [**page**](docs/v2/Admin/MarkingMember.md#page) | **GET** /v2/admin/markings/{markingId}/markingMembers | **Admin** | MarkingMember | [**remove**](docs/v2/Admin/MarkingMember.md#remove) | **POST** /v2/admin/markings/{markingId}/markingMembers/remove | **Admin** | MarkingRoleAssignment | [**add**](docs/v2/Admin/MarkingRoleAssignment.md#add) | **POST** /v2/admin/markings/{markingId}/roleAssignments/add | **Admin** | MarkingRoleAssignment | [**list**](docs/v2/Admin/MarkingRoleAssignment.md#list) | **GET** /v2/admin/markings/{markingId}/roleAssignments | -**Admin** | MarkingRoleAssignment | [**page**](docs/v2/Admin/MarkingRoleAssignment.md#page) | **GET** /v2/admin/markings/{markingId}/roleAssignments | **Admin** | MarkingRoleAssignment | [**remove**](docs/v2/Admin/MarkingRoleAssignment.md#remove) | **POST** /v2/admin/markings/{markingId}/roleAssignments/remove | **Admin** | Organization | [**get**](docs/v2/Admin/Organization.md#get) | **GET** /v2/admin/organizations/{organizationRid} | **Admin** | Organization | [**replace**](docs/v2/Admin/Organization.md#replace) | **PUT** /v2/admin/organizations/{organizationRid} | @@ -517,24 +500,20 @@ Namespace | Resource | Operation | HTTP request | **Admin** | User | [**get_current**](docs/v2/Admin/User.md#get_current) | **GET** /v2/admin/users/getCurrent | **Admin** | User | [**get_markings**](docs/v2/Admin/User.md#get_markings) | **GET** /v2/admin/users/{userId}/getMarkings | **Admin** | User | [**list**](docs/v2/Admin/User.md#list) | **GET** /v2/admin/users | -**Admin** | User | [**page**](docs/v2/Admin/User.md#page) | **GET** /v2/admin/users | **Admin** | User | [**profile_picture**](docs/v2/Admin/User.md#profile_picture) | **GET** /v2/admin/users/{userId}/profilePicture | **Admin** | User | [**search**](docs/v2/Admin/User.md#search) | **POST** /v2/admin/users/search | **Admin** | UserProviderInfo | [**get**](docs/v2/Admin/UserProviderInfo.md#get) | **GET** /v2/admin/users/{userId}/providerInfo | **Admin** | UserProviderInfo | [**replace**](docs/v2/Admin/UserProviderInfo.md#replace) | **PUT** /v2/admin/users/{userId}/providerInfo | **AipAgents** | Agent | [**all_sessions**](docs/v2/AipAgents/Agent.md#all_sessions) | **GET** /v2/aipAgents/agents/allSessions | -**AipAgents** | Agent | [**all_sessions_page**](docs/v2/AipAgents/Agent.md#all_sessions_page) | **GET** /v2/aipAgents/agents/allSessions | **AipAgents** | Agent | [**get**](docs/v2/AipAgents/Agent.md#get) | **GET** /v2/aipAgents/agents/{agentRid} | **AipAgents** | AgentVersion | [**get**](docs/v2/AipAgents/AgentVersion.md#get) | **GET** /v2/aipAgents/agents/{agentRid}/agentVersions/{agentVersionString} | **AipAgents** | AgentVersion | [**list**](docs/v2/AipAgents/AgentVersion.md#list) | **GET** /v2/aipAgents/agents/{agentRid}/agentVersions | -**AipAgents** | AgentVersion | [**page**](docs/v2/AipAgents/AgentVersion.md#page) | **GET** /v2/aipAgents/agents/{agentRid}/agentVersions | **AipAgents** | Content | [**get**](docs/v2/AipAgents/Content.md#get) | **GET** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/content | **AipAgents** | Session | [**blocking_continue**](docs/v2/AipAgents/Session.md#blocking_continue) | **POST** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/blockingContinue | **AipAgents** | Session | [**cancel**](docs/v2/AipAgents/Session.md#cancel) | **POST** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/cancel | **AipAgents** | Session | [**create**](docs/v2/AipAgents/Session.md#create) | **POST** /v2/aipAgents/agents/{agentRid}/sessions | **AipAgents** | Session | [**get**](docs/v2/AipAgents/Session.md#get) | **GET** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid} | **AipAgents** | Session | [**list**](docs/v2/AipAgents/Session.md#list) | **GET** /v2/aipAgents/agents/{agentRid}/sessions | -**AipAgents** | Session | [**page**](docs/v2/AipAgents/Session.md#page) | **GET** /v2/aipAgents/agents/{agentRid}/sessions | **AipAgents** | Session | [**rag_context**](docs/v2/AipAgents/Session.md#rag_context) | **PUT** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/ragContext | **AipAgents** | Session | [**streaming_continue**](docs/v2/AipAgents/Session.md#streaming_continue) | **POST** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/streamingContinue | **AipAgents** | Session | [**update_title**](docs/v2/AipAgents/Session.md#update_title) | **PUT** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/updateTitle | @@ -544,18 +523,15 @@ Namespace | Resource | Operation | HTTP request | **Connectivity** | FileImport | [**execute**](docs/v2/Connectivity/FileImport.md#execute) | **POST** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}/execute | **Connectivity** | FileImport | [**get**](docs/v2/Connectivity/FileImport.md#get) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid} | **Connectivity** | FileImport | [**list**](docs/v2/Connectivity/FileImport.md#list) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports | -**Connectivity** | FileImport | [**page**](docs/v2/Connectivity/FileImport.md#page) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports | **Connectivity** | TableImport | [**create**](docs/v2/Connectivity/TableImport.md#create) | **POST** /v2/connectivity/connections/{connectionRid}/tableImports | **Connectivity** | TableImport | [**delete**](docs/v2/Connectivity/TableImport.md#delete) | **DELETE** /v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid} | **Connectivity** | TableImport | [**execute**](docs/v2/Connectivity/TableImport.md#execute) | **POST** /v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}/execute | **Connectivity** | TableImport | [**get**](docs/v2/Connectivity/TableImport.md#get) | **GET** /v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid} | **Connectivity** | TableImport | [**list**](docs/v2/Connectivity/TableImport.md#list) | **GET** /v2/connectivity/connections/{connectionRid}/tableImports | -**Connectivity** | TableImport | [**page**](docs/v2/Connectivity/TableImport.md#page) | **GET** /v2/connectivity/connections/{connectionRid}/tableImports | **Datasets** | Branch | [**create**](docs/v2/Datasets/Branch.md#create) | **POST** /v2/datasets/{datasetRid}/branches | **Datasets** | Branch | [**delete**](docs/v2/Datasets/Branch.md#delete) | **DELETE** /v2/datasets/{datasetRid}/branches/{branchName} | **Datasets** | Branch | [**get**](docs/v2/Datasets/Branch.md#get) | **GET** /v2/datasets/{datasetRid}/branches/{branchName} | **Datasets** | Branch | [**list**](docs/v2/Datasets/Branch.md#list) | **GET** /v2/datasets/{datasetRid}/branches | -**Datasets** | Branch | [**page**](docs/v2/Datasets/Branch.md#page) | **GET** /v2/datasets/{datasetRid}/branches | **Datasets** | Dataset | [**create**](docs/v2/Datasets/Dataset.md#create) | **POST** /v2/datasets | **Datasets** | Dataset | [**get**](docs/v2/Datasets/Dataset.md#get) | **GET** /v2/datasets/{datasetRid} | **Datasets** | Dataset | [**read_table**](docs/v2/Datasets/Dataset.md#read_table) | **GET** /v2/datasets/{datasetRid}/readTable | @@ -563,21 +539,18 @@ Namespace | Resource | Operation | HTTP request | **Datasets** | File | [**delete**](docs/v2/Datasets/File.md#delete) | **DELETE** /v2/datasets/{datasetRid}/files/{filePath} | **Datasets** | File | [**get**](docs/v2/Datasets/File.md#get) | **GET** /v2/datasets/{datasetRid}/files/{filePath} | **Datasets** | File | [**list**](docs/v2/Datasets/File.md#list) | **GET** /v2/datasets/{datasetRid}/files | -**Datasets** | File | [**page**](docs/v2/Datasets/File.md#page) | **GET** /v2/datasets/{datasetRid}/files | **Datasets** | File | [**upload**](docs/v2/Datasets/File.md#upload) | **POST** /v2/datasets/{datasetRid}/files/{filePath}/upload | **Datasets** | Transaction | [**abort**](docs/v2/Datasets/Transaction.md#abort) | **POST** /v2/datasets/{datasetRid}/transactions/{transactionRid}/abort | **Datasets** | Transaction | [**commit**](docs/v2/Datasets/Transaction.md#commit) | **POST** /v2/datasets/{datasetRid}/transactions/{transactionRid}/commit | **Datasets** | Transaction | [**create**](docs/v2/Datasets/Transaction.md#create) | **POST** /v2/datasets/{datasetRid}/transactions | **Datasets** | Transaction | [**get**](docs/v2/Datasets/Transaction.md#get) | **GET** /v2/datasets/{datasetRid}/transactions/{transactionRid} | **Filesystem** | Folder | [**children**](docs/v2/Filesystem/Folder.md#children) | **GET** /v2/filesystem/folders/{folderRid}/children | -**Filesystem** | Folder | [**children_page**](docs/v2/Filesystem/Folder.md#children_page) | **GET** /v2/filesystem/folders/{folderRid}/children | **Filesystem** | Folder | [**create**](docs/v2/Filesystem/Folder.md#create) | **POST** /v2/filesystem/folders | **Filesystem** | Folder | [**get**](docs/v2/Filesystem/Folder.md#get) | **GET** /v2/filesystem/folders/{folderRid} | **Filesystem** | Project | [**add_organizations**](docs/v2/Filesystem/Project.md#add_organizations) | **POST** /v2/filesystem/projects/{projectRid}/addOrganizations | **Filesystem** | Project | [**create**](docs/v2/Filesystem/Project.md#create) | **POST** /v2/filesystem/projects/create | **Filesystem** | Project | [**get**](docs/v2/Filesystem/Project.md#get) | **GET** /v2/filesystem/projects/{projectRid} | **Filesystem** | Project | [**organizations**](docs/v2/Filesystem/Project.md#organizations) | **GET** /v2/filesystem/projects/{projectRid}/organizations | -**Filesystem** | Project | [**organizations_page**](docs/v2/Filesystem/Project.md#organizations_page) | **GET** /v2/filesystem/projects/{projectRid}/organizations | **Filesystem** | Project | [**remove_organizations**](docs/v2/Filesystem/Project.md#remove_organizations) | **POST** /v2/filesystem/projects/{projectRid}/removeOrganizations | **Filesystem** | Resource | [**add_markings**](docs/v2/Filesystem/Resource.md#add_markings) | **POST** /v2/filesystem/resources/{resourceRid}/addMarkings | **Filesystem** | Resource | [**delete**](docs/v2/Filesystem/Resource.md#delete) | **DELETE** /v2/filesystem/resources/{resourceRid} | @@ -585,16 +558,13 @@ Namespace | Resource | Operation | HTTP request | **Filesystem** | Resource | [**get_access_requirements**](docs/v2/Filesystem/Resource.md#get_access_requirements) | **GET** /v2/filesystem/resources/{resourceRid}/getAccessRequirements | **Filesystem** | Resource | [**get_by_path**](docs/v2/Filesystem/Resource.md#get_by_path) | **GET** /v2/filesystem/resources/getByPath | **Filesystem** | Resource | [**markings**](docs/v2/Filesystem/Resource.md#markings) | **GET** /v2/filesystem/resources/{resourceRid}/markings | -**Filesystem** | Resource | [**markings_page**](docs/v2/Filesystem/Resource.md#markings_page) | **GET** /v2/filesystem/resources/{resourceRid}/markings | **Filesystem** | Resource | [**permanently_delete**](docs/v2/Filesystem/Resource.md#permanently_delete) | **POST** /v2/filesystem/resources/{resourceRid}/permanentlyDelete | **Filesystem** | Resource | [**remove_markings**](docs/v2/Filesystem/Resource.md#remove_markings) | **POST** /v2/filesystem/resources/{resourceRid}/removeMarkings | **Filesystem** | Resource | [**restore**](docs/v2/Filesystem/Resource.md#restore) | **POST** /v2/filesystem/resources/{resourceRid}/restore | **Filesystem** | ResourceRole | [**add**](docs/v2/Filesystem/ResourceRole.md#add) | **POST** /v2/filesystem/resources/{resourceRid}/roles/add | **Filesystem** | ResourceRole | [**list**](docs/v2/Filesystem/ResourceRole.md#list) | **GET** /v2/filesystem/resources/{resourceRid}/roles | -**Filesystem** | ResourceRole | [**page**](docs/v2/Filesystem/ResourceRole.md#page) | **GET** /v2/filesystem/resources/{resourceRid}/roles | **Filesystem** | ResourceRole | [**remove**](docs/v2/Filesystem/ResourceRole.md#remove) | **POST** /v2/filesystem/resources/{resourceRid}/roles/remove | **Filesystem** | Space | [**list**](docs/v2/Filesystem/Space.md#list) | **GET** /v2/filesystem/spaces | -**Filesystem** | Space | [**page**](docs/v2/Filesystem/Space.md#page) | **GET** /v2/filesystem/spaces | **MediaSets** | MediaSet | [**abort**](docs/v2/MediaSets/MediaSet.md#abort) | **POST** /v2/mediasets/{mediaSetRid}/transactions/{transactionId}/abort | **MediaSets** | MediaSet | [**commit**](docs/v2/MediaSets/MediaSet.md#commit) | **POST** /v2/mediasets/{mediaSetRid}/transactions/{transactionId}/commit | **MediaSets** | MediaSet | [**create**](docs/v2/MediaSets/MediaSet.md#create) | **POST** /v2/mediasets/{mediaSetRid}/transactions | @@ -608,7 +578,6 @@ Namespace | Resource | Operation | HTTP request | **Ontologies** | ActionType | [**get**](docs/v2/Ontologies/ActionType.md#get) | **GET** /v2/ontologies/{ontology}/actionTypes/{actionType} | **Ontologies** | ActionType | [**get_by_rid**](docs/v2/Ontologies/ActionType.md#get_by_rid) | **GET** /v2/ontologies/{ontology}/actionTypes/byRid/{actionTypeRid} | **Ontologies** | ActionType | [**list**](docs/v2/Ontologies/ActionType.md#list) | **GET** /v2/ontologies/{ontology}/actionTypes | -**Ontologies** | ActionType | [**page**](docs/v2/Ontologies/ActionType.md#page) | **GET** /v2/ontologies/{ontology}/actionTypes | **Ontologies** | Attachment | [**get**](docs/v2/Ontologies/Attachment.md#get) | **GET** /v2/ontologies/attachments/{attachmentRid} | **Ontologies** | Attachment | [**read**](docs/v2/Ontologies/Attachment.md#read) | **GET** /v2/ontologies/attachments/{attachmentRid}/content | **Ontologies** | Attachment | [**upload**](docs/v2/Ontologies/Attachment.md#upload) | **POST** /v2/ontologies/attachments/upload | @@ -618,25 +587,20 @@ Namespace | Resource | Operation | HTTP request | **Ontologies** | AttachmentProperty | [**read_attachment_by_rid**](docs/v2/Ontologies/AttachmentProperty.md#read_attachment_by_rid) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content | **Ontologies** | LinkedObject | [**get_linked_object**](docs/v2/Ontologies/LinkedObject.md#get_linked_object) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} | **Ontologies** | LinkedObject | [**list_linked_objects**](docs/v2/Ontologies/LinkedObject.md#list_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} | -**Ontologies** | LinkedObject | [**page_linked_objects**](docs/v2/Ontologies/LinkedObject.md#page_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} | **Ontologies** | MediaReferenceProperty | [**get_media_content**](docs/v2/Ontologies/MediaReferenceProperty.md#get_media_content) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/media/{property}/content | **Ontologies** | MediaReferenceProperty | [**upload**](docs/v2/Ontologies/MediaReferenceProperty.md#upload) | **POST** /v2/ontologies/{ontology}/objectTypes/{objectType}/media/{property}/upload | **Ontologies** | ObjectType | [**get**](docs/v2/Ontologies/ObjectType.md#get) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType} | **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 | [**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** | ObjectType | [**page**](docs/v2/Ontologies/ObjectType.md#page) | **GET** /v2/ontologies/{ontology}/objectTypes | -**Ontologies** | ObjectType | [**page_outgoing_link_types**](docs/v2/Ontologies/ObjectType.md#page_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | **Ontologies** | Ontology | [**get**](docs/v2/Ontologies/Ontology.md#get) | **GET** /v2/ontologies/{ontology} | **Ontologies** | Ontology | [**get_full_metadata**](docs/v2/Ontologies/Ontology.md#get_full_metadata) | **GET** /v2/ontologies/{ontology}/fullMetadata | **Ontologies** | Ontology | [**list**](docs/v2/Ontologies/Ontology.md#list) | **GET** /v2/ontologies | **Ontologies** | OntologyInterface | [**get**](docs/v2/Ontologies/OntologyInterface.md#get) | **GET** /v2/ontologies/{ontology}/interfaceTypes/{interfaceType} | **Ontologies** | OntologyInterface | [**list**](docs/v2/Ontologies/OntologyInterface.md#list) | **GET** /v2/ontologies/{ontology}/interfaceTypes | -**Ontologies** | OntologyInterface | [**page**](docs/v2/Ontologies/OntologyInterface.md#page) | **GET** /v2/ontologies/{ontology}/interfaceTypes | **Ontologies** | OntologyObject | [**aggregate**](docs/v2/Ontologies/OntologyObject.md#aggregate) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/aggregate | **Ontologies** | OntologyObject | [**get**](docs/v2/Ontologies/OntologyObject.md#get) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey} | **Ontologies** | OntologyObject | [**list**](docs/v2/Ontologies/OntologyObject.md#list) | **GET** /v2/ontologies/{ontology}/objects/{objectType} | -**Ontologies** | OntologyObject | [**page**](docs/v2/Ontologies/OntologyObject.md#page) | **GET** /v2/ontologies/{ontology}/objects/{objectType} | **Ontologies** | OntologyObject | [**search**](docs/v2/Ontologies/OntologyObject.md#search) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/search | **Ontologies** | OntologyObjectSet | [**aggregate**](docs/v2/Ontologies/OntologyObjectSet.md#aggregate) | **POST** /v2/ontologies/{ontology}/objectSets/aggregate | **Ontologies** | OntologyObjectSet | [**create_temporary**](docs/v2/Ontologies/OntologyObjectSet.md#create_temporary) | **POST** /v2/ontologies/{ontology}/objectSets/createTemporary | @@ -646,7 +610,6 @@ Namespace | Resource | Operation | HTTP request | **Ontologies** | Query | [**execute**](docs/v2/Ontologies/Query.md#execute) | **POST** /v2/ontologies/{ontology}/queries/{queryApiName}/execute | **Ontologies** | QueryType | [**get**](docs/v2/Ontologies/QueryType.md#get) | **GET** /v2/ontologies/{ontology}/queryTypes/{queryApiName} | **Ontologies** | QueryType | [**list**](docs/v2/Ontologies/QueryType.md#list) | **GET** /v2/ontologies/{ontology}/queryTypes | -**Ontologies** | QueryType | [**page**](docs/v2/Ontologies/QueryType.md#page) | **GET** /v2/ontologies/{ontology}/queryTypes | **Ontologies** | TimeSeriesPropertyV2 | [**get_first_point**](docs/v2/Ontologies/TimeSeriesPropertyV2.md#get_first_point) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint | **Ontologies** | TimeSeriesPropertyV2 | [**get_last_point**](docs/v2/Ontologies/TimeSeriesPropertyV2.md#get_last_point) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint | **Ontologies** | TimeSeriesPropertyV2 | [**stream_points**](docs/v2/Ontologies/TimeSeriesPropertyV2.md#stream_points) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints | @@ -657,7 +620,6 @@ Namespace | Resource | Operation | HTTP request | **Orchestration** | Build | [**get**](docs/v2/Orchestration/Build.md#get) | **GET** /v2/orchestration/builds/{buildRid} | **Orchestration** | Build | [**get_batch**](docs/v2/Orchestration/Build.md#get_batch) | **POST** /v2/orchestration/builds/getBatch | **Orchestration** | Build | [**jobs**](docs/v2/Orchestration/Build.md#jobs) | **GET** /v2/orchestration/builds/{buildRid}/jobs | -**Orchestration** | Build | [**jobs_page**](docs/v2/Orchestration/Build.md#jobs_page) | **GET** /v2/orchestration/builds/{buildRid}/jobs | **Orchestration** | Job | [**get**](docs/v2/Orchestration/Job.md#get) | **GET** /v2/orchestration/jobs/{jobRid} | **Orchestration** | Job | [**get_batch**](docs/v2/Orchestration/Job.md#get_batch) | **POST** /v2/orchestration/jobs/getBatch | **Orchestration** | Schedule | [**create**](docs/v2/Orchestration/Schedule.md#create) | **POST** /v2/orchestration/schedules | @@ -667,7 +629,6 @@ Namespace | Resource | Operation | HTTP request | **Orchestration** | Schedule | [**replace**](docs/v2/Orchestration/Schedule.md#replace) | **PUT** /v2/orchestration/schedules/{scheduleRid} | **Orchestration** | Schedule | [**run**](docs/v2/Orchestration/Schedule.md#run) | **POST** /v2/orchestration/schedules/{scheduleRid}/run | **Orchestration** | Schedule | [**runs**](docs/v2/Orchestration/Schedule.md#runs) | **GET** /v2/orchestration/schedules/{scheduleRid}/runs | -**Orchestration** | Schedule | [**runs_page**](docs/v2/Orchestration/Schedule.md#runs_page) | **GET** /v2/orchestration/schedules/{scheduleRid}/runs | **Orchestration** | Schedule | [**unpause**](docs/v2/Orchestration/Schedule.md#unpause) | **POST** /v2/orchestration/schedules/{scheduleRid}/unpause | **Orchestration** | ScheduleVersion | [**get**](docs/v2/Orchestration/ScheduleVersion.md#get) | **GET** /v2/orchestration/scheduleVersions/{scheduleVersionRid} | **Orchestration** | ScheduleVersion | [**schedule**](docs/v2/Orchestration/ScheduleVersion.md#schedule) | **GET** /v2/orchestration/scheduleVersions/{scheduleVersionRid}/schedule | @@ -681,7 +642,6 @@ Namespace | Resource | Operation | HTTP request | **ThirdPartyApplications** | Version | [**delete**](docs/v2/ThirdPartyApplications/Version.md#delete) | **DELETE** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | **ThirdPartyApplications** | Version | [**get**](docs/v2/ThirdPartyApplications/Version.md#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | **ThirdPartyApplications** | Version | [**list**](docs/v2/ThirdPartyApplications/Version.md#list) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions | -**ThirdPartyApplications** | Version | [**page**](docs/v2/ThirdPartyApplications/Version.md#page) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions | **ThirdPartyApplications** | Version | [**upload**](docs/v2/ThirdPartyApplications/Version.md#upload) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/upload | **ThirdPartyApplications** | Website | [**deploy**](docs/v2/ThirdPartyApplications/Website.md#deploy) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/deploy | **ThirdPartyApplications** | Website | [**get**](docs/v2/ThirdPartyApplications/Website.md#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website | @@ -695,14 +655,12 @@ Namespace | Resource | Operation | HTTP request | **Datasets** | Branch | [**delete**](docs/v1/Datasets/Branch.md#delete) | **DELETE** /v1/datasets/{datasetRid}/branches/{branchId} | **Datasets** | Branch | [**get**](docs/v1/Datasets/Branch.md#get) | **GET** /v1/datasets/{datasetRid}/branches/{branchId} | **Datasets** | Branch | [**list**](docs/v1/Datasets/Branch.md#list) | **GET** /v1/datasets/{datasetRid}/branches | -**Datasets** | Branch | [**page**](docs/v1/Datasets/Branch.md#page) | **GET** /v1/datasets/{datasetRid}/branches | **Datasets** | Dataset | [**create**](docs/v1/Datasets/Dataset.md#create) | **POST** /v1/datasets | **Datasets** | Dataset | [**get**](docs/v1/Datasets/Dataset.md#get) | **GET** /v1/datasets/{datasetRid} | **Datasets** | Dataset | [**read**](docs/v1/Datasets/Dataset.md#read) | **GET** /v1/datasets/{datasetRid}/readTable | **Datasets** | File | [**delete**](docs/v1/Datasets/File.md#delete) | **DELETE** /v1/datasets/{datasetRid}/files/{filePath} | **Datasets** | File | [**get**](docs/v1/Datasets/File.md#get) | **GET** /v1/datasets/{datasetRid}/files/{filePath} | **Datasets** | File | [**list**](docs/v1/Datasets/File.md#list) | **GET** /v1/datasets/{datasetRid}/files | -**Datasets** | File | [**page**](docs/v1/Datasets/File.md#page) | **GET** /v1/datasets/{datasetRid}/files | **Datasets** | File | [**read**](docs/v1/Datasets/File.md#read) | **GET** /v1/datasets/{datasetRid}/files/{filePath}/content | **Datasets** | File | [**upload**](docs/v1/Datasets/File.md#upload) | **POST** /v1/datasets/{datasetRid}/files:upload | **Datasets** | Transaction | [**abort**](docs/v1/Datasets/Transaction.md#abort) | **POST** /v1/datasets/{datasetRid}/transactions/{transactionRid}/abort | @@ -714,7 +672,6 @@ Namespace | Resource | Operation | HTTP request | **Ontologies** | Action | [**validate**](docs/v1/Ontologies/Action.md#validate) | **POST** /v1/ontologies/{ontologyRid}/actions/{actionType}/validate | **Ontologies** | ActionType | [**get**](docs/v1/Ontologies/ActionType.md#get) | **GET** /v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName} | **Ontologies** | ActionType | [**list**](docs/v1/Ontologies/ActionType.md#list) | **GET** /v1/ontologies/{ontologyRid}/actionTypes | -**Ontologies** | ActionType | [**page**](docs/v1/Ontologies/ActionType.md#page) | **GET** /v1/ontologies/{ontologyRid}/actionTypes | **Ontologies** | Attachment | [**get**](docs/v1/Ontologies/Attachment.md#get) | **GET** /v1/attachments/{attachmentRid} | **Ontologies** | Attachment | [**read**](docs/v1/Ontologies/Attachment.md#read) | **GET** /v1/attachments/{attachmentRid}/content | **Ontologies** | Attachment | [**upload**](docs/v1/Ontologies/Attachment.md#upload) | **POST** /v1/attachments/upload | @@ -722,8 +679,6 @@ Namespace | Resource | Operation | HTTP request | **Ontologies** | ObjectType | [**get_outgoing_link_type**](docs/v1/Ontologies/ObjectType.md#get_outgoing_link_type) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | **Ontologies** | ObjectType | [**list**](docs/v1/Ontologies/ObjectType.md#list) | **GET** /v1/ontologies/{ontologyRid}/objectTypes | **Ontologies** | ObjectType | [**list_outgoing_link_types**](docs/v1/Ontologies/ObjectType.md#list_outgoing_link_types) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes | -**Ontologies** | ObjectType | [**page**](docs/v1/Ontologies/ObjectType.md#page) | **GET** /v1/ontologies/{ontologyRid}/objectTypes | -**Ontologies** | ObjectType | [**page_outgoing_link_types**](docs/v1/Ontologies/ObjectType.md#page_outgoing_link_types) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes | **Ontologies** | Ontology | [**get**](docs/v1/Ontologies/Ontology.md#get) | **GET** /v1/ontologies/{ontologyRid} | **Ontologies** | Ontology | [**list**](docs/v1/Ontologies/Ontology.md#list) | **GET** /v1/ontologies | **Ontologies** | OntologyObject | [**aggregate**](docs/v1/Ontologies/OntologyObject.md#aggregate) | **POST** /v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate | @@ -731,13 +686,10 @@ Namespace | Resource | Operation | HTTP request | **Ontologies** | OntologyObject | [**get_linked_object**](docs/v1/Ontologies/OntologyObject.md#get_linked_object) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} | **Ontologies** | OntologyObject | [**list**](docs/v1/Ontologies/OntologyObject.md#list) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType} | **Ontologies** | OntologyObject | [**list_linked_objects**](docs/v1/Ontologies/OntologyObject.md#list_linked_objects) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType} | -**Ontologies** | OntologyObject | [**page**](docs/v1/Ontologies/OntologyObject.md#page) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType} | -**Ontologies** | OntologyObject | [**page_linked_objects**](docs/v1/Ontologies/OntologyObject.md#page_linked_objects) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType} | **Ontologies** | OntologyObject | [**search**](docs/v1/Ontologies/OntologyObject.md#search) | **POST** /v1/ontologies/{ontologyRid}/objects/{objectType}/search | **Ontologies** | Query | [**execute**](docs/v1/Ontologies/Query.md#execute) | **POST** /v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute | **Ontologies** | QueryType | [**get**](docs/v1/Ontologies/QueryType.md#get) | **GET** /v1/ontologies/{ontologyRid}/queryTypes/{queryApiName} | **Ontologies** | QueryType | [**list**](docs/v1/Ontologies/QueryType.md#list) | **GET** /v1/ontologies/{ontologyRid}/queryTypes | -**Ontologies** | QueryType | [**page**](docs/v1/Ontologies/QueryType.md#page) | **GET** /v1/ontologies/{ontologyRid}/queryTypes | @@ -750,401 +702,242 @@ Namespace | Name | Import | **Admin** | [AttributeValue](docs/v2/Admin/models/AttributeValue.md) | `from foundry.v2.admin.models import AttributeValue` | **Admin** | [AttributeValues](docs/v2/Admin/models/AttributeValues.md) | `from foundry.v2.admin.models import AttributeValues` | **Admin** | [AuthenticationProtocol](docs/v2/Admin/models/AuthenticationProtocol.md) | `from foundry.v2.admin.models import AuthenticationProtocol` | -**Admin** | [AuthenticationProtocolDict](docs/v2/Admin/models/AuthenticationProtocolDict.md) | `from foundry.v2.admin.models import AuthenticationProtocolDict` | **Admin** | [AuthenticationProvider](docs/v2/Admin/models/AuthenticationProvider.md) | `from foundry.v2.admin.models import AuthenticationProvider` | -**Admin** | [AuthenticationProviderDict](docs/v2/Admin/models/AuthenticationProviderDict.md) | `from foundry.v2.admin.models import AuthenticationProviderDict` | **Admin** | [AuthenticationProviderEnabled](docs/v2/Admin/models/AuthenticationProviderEnabled.md) | `from foundry.v2.admin.models import AuthenticationProviderEnabled` | **Admin** | [AuthenticationProviderName](docs/v2/Admin/models/AuthenticationProviderName.md) | `from foundry.v2.admin.models import AuthenticationProviderName` | **Admin** | [AuthenticationProviderRid](docs/v2/Admin/models/AuthenticationProviderRid.md) | `from foundry.v2.admin.models import AuthenticationProviderRid` | **Admin** | [CertificateInfo](docs/v2/Admin/models/CertificateInfo.md) | `from foundry.v2.admin.models import CertificateInfo` | -**Admin** | [CertificateInfoDict](docs/v2/Admin/models/CertificateInfoDict.md) | `from foundry.v2.admin.models import CertificateInfoDict` | **Admin** | [CertificateUsageType](docs/v2/Admin/models/CertificateUsageType.md) | `from foundry.v2.admin.models import CertificateUsageType` | **Admin** | [Enrollment](docs/v2/Admin/models/Enrollment.md) | `from foundry.v2.admin.models import Enrollment` | -**Admin** | [EnrollmentDict](docs/v2/Admin/models/EnrollmentDict.md) | `from foundry.v2.admin.models import EnrollmentDict` | **Admin** | [EnrollmentName](docs/v2/Admin/models/EnrollmentName.md) | `from foundry.v2.admin.models import EnrollmentName` | **Admin** | [GetGroupsBatchRequestElement](docs/v2/Admin/models/GetGroupsBatchRequestElement.md) | `from foundry.v2.admin.models import GetGroupsBatchRequestElement` | -**Admin** | [GetGroupsBatchRequestElementDict](docs/v2/Admin/models/GetGroupsBatchRequestElementDict.md) | `from foundry.v2.admin.models import GetGroupsBatchRequestElementDict` | **Admin** | [GetGroupsBatchResponse](docs/v2/Admin/models/GetGroupsBatchResponse.md) | `from foundry.v2.admin.models import GetGroupsBatchResponse` | -**Admin** | [GetGroupsBatchResponseDict](docs/v2/Admin/models/GetGroupsBatchResponseDict.md) | `from foundry.v2.admin.models import GetGroupsBatchResponseDict` | **Admin** | [GetMarkingsBatchRequestElement](docs/v2/Admin/models/GetMarkingsBatchRequestElement.md) | `from foundry.v2.admin.models import GetMarkingsBatchRequestElement` | -**Admin** | [GetMarkingsBatchRequestElementDict](docs/v2/Admin/models/GetMarkingsBatchRequestElementDict.md) | `from foundry.v2.admin.models import GetMarkingsBatchRequestElementDict` | **Admin** | [GetMarkingsBatchResponse](docs/v2/Admin/models/GetMarkingsBatchResponse.md) | `from foundry.v2.admin.models import GetMarkingsBatchResponse` | -**Admin** | [GetMarkingsBatchResponseDict](docs/v2/Admin/models/GetMarkingsBatchResponseDict.md) | `from foundry.v2.admin.models import GetMarkingsBatchResponseDict` | **Admin** | [GetUserMarkingsResponse](docs/v2/Admin/models/GetUserMarkingsResponse.md) | `from foundry.v2.admin.models import GetUserMarkingsResponse` | -**Admin** | [GetUserMarkingsResponseDict](docs/v2/Admin/models/GetUserMarkingsResponseDict.md) | `from foundry.v2.admin.models import GetUserMarkingsResponseDict` | **Admin** | [GetUsersBatchRequestElement](docs/v2/Admin/models/GetUsersBatchRequestElement.md) | `from foundry.v2.admin.models import GetUsersBatchRequestElement` | -**Admin** | [GetUsersBatchRequestElementDict](docs/v2/Admin/models/GetUsersBatchRequestElementDict.md) | `from foundry.v2.admin.models import GetUsersBatchRequestElementDict` | **Admin** | [GetUsersBatchResponse](docs/v2/Admin/models/GetUsersBatchResponse.md) | `from foundry.v2.admin.models import GetUsersBatchResponse` | -**Admin** | [GetUsersBatchResponseDict](docs/v2/Admin/models/GetUsersBatchResponseDict.md) | `from foundry.v2.admin.models import GetUsersBatchResponseDict` | **Admin** | [Group](docs/v2/Admin/models/Group.md) | `from foundry.v2.admin.models import Group` | -**Admin** | [GroupDict](docs/v2/Admin/models/GroupDict.md) | `from foundry.v2.admin.models import GroupDict` | **Admin** | [GroupMember](docs/v2/Admin/models/GroupMember.md) | `from foundry.v2.admin.models import GroupMember` | -**Admin** | [GroupMemberDict](docs/v2/Admin/models/GroupMemberDict.md) | `from foundry.v2.admin.models import GroupMemberDict` | **Admin** | [GroupMembership](docs/v2/Admin/models/GroupMembership.md) | `from foundry.v2.admin.models import GroupMembership` | -**Admin** | [GroupMembershipDict](docs/v2/Admin/models/GroupMembershipDict.md) | `from foundry.v2.admin.models import GroupMembershipDict` | **Admin** | [GroupMembershipExpiration](docs/v2/Admin/models/GroupMembershipExpiration.md) | `from foundry.v2.admin.models import GroupMembershipExpiration` | **Admin** | [GroupName](docs/v2/Admin/models/GroupName.md) | `from foundry.v2.admin.models import GroupName` | **Admin** | [GroupProviderInfo](docs/v2/Admin/models/GroupProviderInfo.md) | `from foundry.v2.admin.models import GroupProviderInfo` | -**Admin** | [GroupProviderInfoDict](docs/v2/Admin/models/GroupProviderInfoDict.md) | `from foundry.v2.admin.models import GroupProviderInfoDict` | **Admin** | [GroupSearchFilter](docs/v2/Admin/models/GroupSearchFilter.md) | `from foundry.v2.admin.models import GroupSearchFilter` | -**Admin** | [GroupSearchFilterDict](docs/v2/Admin/models/GroupSearchFilterDict.md) | `from foundry.v2.admin.models import GroupSearchFilterDict` | **Admin** | [Host](docs/v2/Admin/models/Host.md) | `from foundry.v2.admin.models import Host` | -**Admin** | [HostDict](docs/v2/Admin/models/HostDict.md) | `from foundry.v2.admin.models import HostDict` | **Admin** | [HostName](docs/v2/Admin/models/HostName.md) | `from foundry.v2.admin.models import HostName` | **Admin** | [ListAuthenticationProvidersResponse](docs/v2/Admin/models/ListAuthenticationProvidersResponse.md) | `from foundry.v2.admin.models import ListAuthenticationProvidersResponse` | -**Admin** | [ListAuthenticationProvidersResponseDict](docs/v2/Admin/models/ListAuthenticationProvidersResponseDict.md) | `from foundry.v2.admin.models import ListAuthenticationProvidersResponseDict` | **Admin** | [ListGroupMembershipsResponse](docs/v2/Admin/models/ListGroupMembershipsResponse.md) | `from foundry.v2.admin.models import ListGroupMembershipsResponse` | -**Admin** | [ListGroupMembershipsResponseDict](docs/v2/Admin/models/ListGroupMembershipsResponseDict.md) | `from foundry.v2.admin.models import ListGroupMembershipsResponseDict` | **Admin** | [ListGroupMembersResponse](docs/v2/Admin/models/ListGroupMembersResponse.md) | `from foundry.v2.admin.models import ListGroupMembersResponse` | -**Admin** | [ListGroupMembersResponseDict](docs/v2/Admin/models/ListGroupMembersResponseDict.md) | `from foundry.v2.admin.models import ListGroupMembersResponseDict` | **Admin** | [ListGroupsResponse](docs/v2/Admin/models/ListGroupsResponse.md) | `from foundry.v2.admin.models import ListGroupsResponse` | -**Admin** | [ListGroupsResponseDict](docs/v2/Admin/models/ListGroupsResponseDict.md) | `from foundry.v2.admin.models import ListGroupsResponseDict` | **Admin** | [ListHostsResponse](docs/v2/Admin/models/ListHostsResponse.md) | `from foundry.v2.admin.models import ListHostsResponse` | -**Admin** | [ListHostsResponseDict](docs/v2/Admin/models/ListHostsResponseDict.md) | `from foundry.v2.admin.models import ListHostsResponseDict` | **Admin** | [ListMarkingCategoriesResponse](docs/v2/Admin/models/ListMarkingCategoriesResponse.md) | `from foundry.v2.admin.models import ListMarkingCategoriesResponse` | -**Admin** | [ListMarkingCategoriesResponseDict](docs/v2/Admin/models/ListMarkingCategoriesResponseDict.md) | `from foundry.v2.admin.models import ListMarkingCategoriesResponseDict` | **Admin** | [ListMarkingMembersResponse](docs/v2/Admin/models/ListMarkingMembersResponse.md) | `from foundry.v2.admin.models import ListMarkingMembersResponse` | -**Admin** | [ListMarkingMembersResponseDict](docs/v2/Admin/models/ListMarkingMembersResponseDict.md) | `from foundry.v2.admin.models import ListMarkingMembersResponseDict` | **Admin** | [ListMarkingRoleAssignmentsResponse](docs/v2/Admin/models/ListMarkingRoleAssignmentsResponse.md) | `from foundry.v2.admin.models import ListMarkingRoleAssignmentsResponse` | -**Admin** | [ListMarkingRoleAssignmentsResponseDict](docs/v2/Admin/models/ListMarkingRoleAssignmentsResponseDict.md) | `from foundry.v2.admin.models import ListMarkingRoleAssignmentsResponseDict` | **Admin** | [ListMarkingsResponse](docs/v2/Admin/models/ListMarkingsResponse.md) | `from foundry.v2.admin.models import ListMarkingsResponse` | -**Admin** | [ListMarkingsResponseDict](docs/v2/Admin/models/ListMarkingsResponseDict.md) | `from foundry.v2.admin.models import ListMarkingsResponseDict` | **Admin** | [ListUsersResponse](docs/v2/Admin/models/ListUsersResponse.md) | `from foundry.v2.admin.models import ListUsersResponse` | -**Admin** | [ListUsersResponseDict](docs/v2/Admin/models/ListUsersResponseDict.md) | `from foundry.v2.admin.models import ListUsersResponseDict` | **Admin** | [Marking](docs/v2/Admin/models/Marking.md) | `from foundry.v2.admin.models import Marking` | **Admin** | [MarkingCategory](docs/v2/Admin/models/MarkingCategory.md) | `from foundry.v2.admin.models import MarkingCategory` | -**Admin** | [MarkingCategoryDict](docs/v2/Admin/models/MarkingCategoryDict.md) | `from foundry.v2.admin.models import MarkingCategoryDict` | **Admin** | [MarkingCategoryId](docs/v2/Admin/models/MarkingCategoryId.md) | `from foundry.v2.admin.models import MarkingCategoryId` | **Admin** | [MarkingCategoryName](docs/v2/Admin/models/MarkingCategoryName.md) | `from foundry.v2.admin.models import MarkingCategoryName` | **Admin** | [MarkingCategoryType](docs/v2/Admin/models/MarkingCategoryType.md) | `from foundry.v2.admin.models import MarkingCategoryType` | -**Admin** | [MarkingDict](docs/v2/Admin/models/MarkingDict.md) | `from foundry.v2.admin.models import MarkingDict` | **Admin** | [MarkingMember](docs/v2/Admin/models/MarkingMember.md) | `from foundry.v2.admin.models import MarkingMember` | -**Admin** | [MarkingMemberDict](docs/v2/Admin/models/MarkingMemberDict.md) | `from foundry.v2.admin.models import MarkingMemberDict` | **Admin** | [MarkingName](docs/v2/Admin/models/MarkingName.md) | `from foundry.v2.admin.models import MarkingName` | **Admin** | [MarkingRole](docs/v2/Admin/models/MarkingRole.md) | `from foundry.v2.admin.models import MarkingRole` | **Admin** | [MarkingRoleAssignment](docs/v2/Admin/models/MarkingRoleAssignment.md) | `from foundry.v2.admin.models import MarkingRoleAssignment` | -**Admin** | [MarkingRoleAssignmentDict](docs/v2/Admin/models/MarkingRoleAssignmentDict.md) | `from foundry.v2.admin.models import MarkingRoleAssignmentDict` | **Admin** | [MarkingRoleUpdate](docs/v2/Admin/models/MarkingRoleUpdate.md) | `from foundry.v2.admin.models import MarkingRoleUpdate` | -**Admin** | [MarkingRoleUpdateDict](docs/v2/Admin/models/MarkingRoleUpdateDict.md) | `from foundry.v2.admin.models import MarkingRoleUpdateDict` | **Admin** | [MarkingType](docs/v2/Admin/models/MarkingType.md) | `from foundry.v2.admin.models import MarkingType` | **Admin** | [OidcAuthenticationProtocol](docs/v2/Admin/models/OidcAuthenticationProtocol.md) | `from foundry.v2.admin.models import OidcAuthenticationProtocol` | -**Admin** | [OidcAuthenticationProtocolDict](docs/v2/Admin/models/OidcAuthenticationProtocolDict.md) | `from foundry.v2.admin.models import OidcAuthenticationProtocolDict` | **Admin** | [Organization](docs/v2/Admin/models/Organization.md) | `from foundry.v2.admin.models import Organization` | -**Admin** | [OrganizationDict](docs/v2/Admin/models/OrganizationDict.md) | `from foundry.v2.admin.models import OrganizationDict` | **Admin** | [OrganizationName](docs/v2/Admin/models/OrganizationName.md) | `from foundry.v2.admin.models import OrganizationName` | **Admin** | [PrincipalFilterType](docs/v2/Admin/models/PrincipalFilterType.md) | `from foundry.v2.admin.models import PrincipalFilterType` | **Admin** | [ProviderId](docs/v2/Admin/models/ProviderId.md) | `from foundry.v2.admin.models import ProviderId` | **Admin** | [SamlAuthenticationProtocol](docs/v2/Admin/models/SamlAuthenticationProtocol.md) | `from foundry.v2.admin.models import SamlAuthenticationProtocol` | -**Admin** | [SamlAuthenticationProtocolDict](docs/v2/Admin/models/SamlAuthenticationProtocolDict.md) | `from foundry.v2.admin.models import SamlAuthenticationProtocolDict` | **Admin** | [SamlServiceProviderMetadata](docs/v2/Admin/models/SamlServiceProviderMetadata.md) | `from foundry.v2.admin.models import SamlServiceProviderMetadata` | -**Admin** | [SamlServiceProviderMetadataDict](docs/v2/Admin/models/SamlServiceProviderMetadataDict.md) | `from foundry.v2.admin.models import SamlServiceProviderMetadataDict` | **Admin** | [SearchGroupsResponse](docs/v2/Admin/models/SearchGroupsResponse.md) | `from foundry.v2.admin.models import SearchGroupsResponse` | -**Admin** | [SearchGroupsResponseDict](docs/v2/Admin/models/SearchGroupsResponseDict.md) | `from foundry.v2.admin.models import SearchGroupsResponseDict` | **Admin** | [SearchUsersResponse](docs/v2/Admin/models/SearchUsersResponse.md) | `from foundry.v2.admin.models import SearchUsersResponse` | -**Admin** | [SearchUsersResponseDict](docs/v2/Admin/models/SearchUsersResponseDict.md) | `from foundry.v2.admin.models import SearchUsersResponseDict` | **Admin** | [User](docs/v2/Admin/models/User.md) | `from foundry.v2.admin.models import User` | -**Admin** | [UserDict](docs/v2/Admin/models/UserDict.md) | `from foundry.v2.admin.models import UserDict` | **Admin** | [UserProviderInfo](docs/v2/Admin/models/UserProviderInfo.md) | `from foundry.v2.admin.models import UserProviderInfo` | -**Admin** | [UserProviderInfoDict](docs/v2/Admin/models/UserProviderInfoDict.md) | `from foundry.v2.admin.models import UserProviderInfoDict` | **Admin** | [UserSearchFilter](docs/v2/Admin/models/UserSearchFilter.md) | `from foundry.v2.admin.models import UserSearchFilter` | -**Admin** | [UserSearchFilterDict](docs/v2/Admin/models/UserSearchFilterDict.md) | `from foundry.v2.admin.models import UserSearchFilterDict` | **Admin** | [UserUsername](docs/v2/Admin/models/UserUsername.md) | `from foundry.v2.admin.models import UserUsername` | **AipAgents** | [Agent](docs/v2/AipAgents/models/Agent.md) | `from foundry.v2.aip_agents.models import Agent` | -**AipAgents** | [AgentDict](docs/v2/AipAgents/models/AgentDict.md) | `from foundry.v2.aip_agents.models import AgentDict` | **AipAgents** | [AgentMarkdownResponse](docs/v2/AipAgents/models/AgentMarkdownResponse.md) | `from foundry.v2.aip_agents.models import AgentMarkdownResponse` | **AipAgents** | [AgentMetadata](docs/v2/AipAgents/models/AgentMetadata.md) | `from foundry.v2.aip_agents.models import AgentMetadata` | -**AipAgents** | [AgentMetadataDict](docs/v2/AipAgents/models/AgentMetadataDict.md) | `from foundry.v2.aip_agents.models import AgentMetadataDict` | **AipAgents** | [AgentRid](docs/v2/AipAgents/models/AgentRid.md) | `from foundry.v2.aip_agents.models import AgentRid` | **AipAgents** | [AgentSessionRagContextResponse](docs/v2/AipAgents/models/AgentSessionRagContextResponse.md) | `from foundry.v2.aip_agents.models import AgentSessionRagContextResponse` | -**AipAgents** | [AgentSessionRagContextResponseDict](docs/v2/AipAgents/models/AgentSessionRagContextResponseDict.md) | `from foundry.v2.aip_agents.models import AgentSessionRagContextResponseDict` | **AipAgents** | [AgentsSessionsPage](docs/v2/AipAgents/models/AgentsSessionsPage.md) | `from foundry.v2.aip_agents.models import AgentsSessionsPage` | -**AipAgents** | [AgentsSessionsPageDict](docs/v2/AipAgents/models/AgentsSessionsPageDict.md) | `from foundry.v2.aip_agents.models import AgentsSessionsPageDict` | **AipAgents** | [AgentVersion](docs/v2/AipAgents/models/AgentVersion.md) | `from foundry.v2.aip_agents.models import AgentVersion` | **AipAgents** | [AgentVersionDetails](docs/v2/AipAgents/models/AgentVersionDetails.md) | `from foundry.v2.aip_agents.models import AgentVersionDetails` | -**AipAgents** | [AgentVersionDetailsDict](docs/v2/AipAgents/models/AgentVersionDetailsDict.md) | `from foundry.v2.aip_agents.models import AgentVersionDetailsDict` | -**AipAgents** | [AgentVersionDict](docs/v2/AipAgents/models/AgentVersionDict.md) | `from foundry.v2.aip_agents.models import AgentVersionDict` | **AipAgents** | [AgentVersionString](docs/v2/AipAgents/models/AgentVersionString.md) | `from foundry.v2.aip_agents.models import AgentVersionString` | **AipAgents** | [CancelSessionResponse](docs/v2/AipAgents/models/CancelSessionResponse.md) | `from foundry.v2.aip_agents.models import CancelSessionResponse` | -**AipAgents** | [CancelSessionResponseDict](docs/v2/AipAgents/models/CancelSessionResponseDict.md) | `from foundry.v2.aip_agents.models import CancelSessionResponseDict` | **AipAgents** | [Content](docs/v2/AipAgents/models/Content.md) | `from foundry.v2.aip_agents.models import Content` | -**AipAgents** | [ContentDict](docs/v2/AipAgents/models/ContentDict.md) | `from foundry.v2.aip_agents.models import ContentDict` | **AipAgents** | [FunctionRetrievedContext](docs/v2/AipAgents/models/FunctionRetrievedContext.md) | `from foundry.v2.aip_agents.models import FunctionRetrievedContext` | -**AipAgents** | [FunctionRetrievedContextDict](docs/v2/AipAgents/models/FunctionRetrievedContextDict.md) | `from foundry.v2.aip_agents.models import FunctionRetrievedContextDict` | **AipAgents** | [InputContext](docs/v2/AipAgents/models/InputContext.md) | `from foundry.v2.aip_agents.models import InputContext` | -**AipAgents** | [InputContextDict](docs/v2/AipAgents/models/InputContextDict.md) | `from foundry.v2.aip_agents.models import InputContextDict` | **AipAgents** | [ListAgentVersionsResponse](docs/v2/AipAgents/models/ListAgentVersionsResponse.md) | `from foundry.v2.aip_agents.models import ListAgentVersionsResponse` | -**AipAgents** | [ListAgentVersionsResponseDict](docs/v2/AipAgents/models/ListAgentVersionsResponseDict.md) | `from foundry.v2.aip_agents.models import ListAgentVersionsResponseDict` | **AipAgents** | [ListSessionsResponse](docs/v2/AipAgents/models/ListSessionsResponse.md) | `from foundry.v2.aip_agents.models import ListSessionsResponse` | -**AipAgents** | [ListSessionsResponseDict](docs/v2/AipAgents/models/ListSessionsResponseDict.md) | `from foundry.v2.aip_agents.models import ListSessionsResponseDict` | **AipAgents** | [MessageId](docs/v2/AipAgents/models/MessageId.md) | `from foundry.v2.aip_agents.models import MessageId` | **AipAgents** | [ObjectContext](docs/v2/AipAgents/models/ObjectContext.md) | `from foundry.v2.aip_agents.models import ObjectContext` | -**AipAgents** | [ObjectContextDict](docs/v2/AipAgents/models/ObjectContextDict.md) | `from foundry.v2.aip_agents.models import ObjectContextDict` | **AipAgents** | [ObjectSetParameter](docs/v2/AipAgents/models/ObjectSetParameter.md) | `from foundry.v2.aip_agents.models import ObjectSetParameter` | -**AipAgents** | [ObjectSetParameterDict](docs/v2/AipAgents/models/ObjectSetParameterDict.md) | `from foundry.v2.aip_agents.models import ObjectSetParameterDict` | **AipAgents** | [ObjectSetParameterValue](docs/v2/AipAgents/models/ObjectSetParameterValue.md) | `from foundry.v2.aip_agents.models import ObjectSetParameterValue` | -**AipAgents** | [ObjectSetParameterValueDict](docs/v2/AipAgents/models/ObjectSetParameterValueDict.md) | `from foundry.v2.aip_agents.models import ObjectSetParameterValueDict` | **AipAgents** | [ObjectSetParameterValueUpdate](docs/v2/AipAgents/models/ObjectSetParameterValueUpdate.md) | `from foundry.v2.aip_agents.models import ObjectSetParameterValueUpdate` | -**AipAgents** | [ObjectSetParameterValueUpdateDict](docs/v2/AipAgents/models/ObjectSetParameterValueUpdateDict.md) | `from foundry.v2.aip_agents.models import ObjectSetParameterValueUpdateDict` | **AipAgents** | [Parameter](docs/v2/AipAgents/models/Parameter.md) | `from foundry.v2.aip_agents.models import Parameter` | **AipAgents** | [ParameterAccessMode](docs/v2/AipAgents/models/ParameterAccessMode.md) | `from foundry.v2.aip_agents.models import ParameterAccessMode` | -**AipAgents** | [ParameterDict](docs/v2/AipAgents/models/ParameterDict.md) | `from foundry.v2.aip_agents.models import ParameterDict` | **AipAgents** | [ParameterId](docs/v2/AipAgents/models/ParameterId.md) | `from foundry.v2.aip_agents.models import ParameterId` | **AipAgents** | [ParameterType](docs/v2/AipAgents/models/ParameterType.md) | `from foundry.v2.aip_agents.models import ParameterType` | -**AipAgents** | [ParameterTypeDict](docs/v2/AipAgents/models/ParameterTypeDict.md) | `from foundry.v2.aip_agents.models import ParameterTypeDict` | **AipAgents** | [ParameterValue](docs/v2/AipAgents/models/ParameterValue.md) | `from foundry.v2.aip_agents.models import ParameterValue` | -**AipAgents** | [ParameterValueDict](docs/v2/AipAgents/models/ParameterValueDict.md) | `from foundry.v2.aip_agents.models import ParameterValueDict` | **AipAgents** | [ParameterValueUpdate](docs/v2/AipAgents/models/ParameterValueUpdate.md) | `from foundry.v2.aip_agents.models import ParameterValueUpdate` | -**AipAgents** | [ParameterValueUpdateDict](docs/v2/AipAgents/models/ParameterValueUpdateDict.md) | `from foundry.v2.aip_agents.models import ParameterValueUpdateDict` | **AipAgents** | [Session](docs/v2/AipAgents/models/Session.md) | `from foundry.v2.aip_agents.models import Session` | -**AipAgents** | [SessionDict](docs/v2/AipAgents/models/SessionDict.md) | `from foundry.v2.aip_agents.models import SessionDict` | **AipAgents** | [SessionExchange](docs/v2/AipAgents/models/SessionExchange.md) | `from foundry.v2.aip_agents.models import SessionExchange` | **AipAgents** | [SessionExchangeContexts](docs/v2/AipAgents/models/SessionExchangeContexts.md) | `from foundry.v2.aip_agents.models import SessionExchangeContexts` | -**AipAgents** | [SessionExchangeContextsDict](docs/v2/AipAgents/models/SessionExchangeContextsDict.md) | `from foundry.v2.aip_agents.models import SessionExchangeContextsDict` | -**AipAgents** | [SessionExchangeDict](docs/v2/AipAgents/models/SessionExchangeDict.md) | `from foundry.v2.aip_agents.models import SessionExchangeDict` | **AipAgents** | [SessionExchangeResult](docs/v2/AipAgents/models/SessionExchangeResult.md) | `from foundry.v2.aip_agents.models import SessionExchangeResult` | -**AipAgents** | [SessionExchangeResultDict](docs/v2/AipAgents/models/SessionExchangeResultDict.md) | `from foundry.v2.aip_agents.models import SessionExchangeResultDict` | **AipAgents** | [SessionMetadata](docs/v2/AipAgents/models/SessionMetadata.md) | `from foundry.v2.aip_agents.models import SessionMetadata` | -**AipAgents** | [SessionMetadataDict](docs/v2/AipAgents/models/SessionMetadataDict.md) | `from foundry.v2.aip_agents.models import SessionMetadataDict` | **AipAgents** | [SessionRid](docs/v2/AipAgents/models/SessionRid.md) | `from foundry.v2.aip_agents.models import SessionRid` | **AipAgents** | [StringParameter](docs/v2/AipAgents/models/StringParameter.md) | `from foundry.v2.aip_agents.models import StringParameter` | -**AipAgents** | [StringParameterDict](docs/v2/AipAgents/models/StringParameterDict.md) | `from foundry.v2.aip_agents.models import StringParameterDict` | **AipAgents** | [StringParameterValue](docs/v2/AipAgents/models/StringParameterValue.md) | `from foundry.v2.aip_agents.models import StringParameterValue` | -**AipAgents** | [StringParameterValueDict](docs/v2/AipAgents/models/StringParameterValueDict.md) | `from foundry.v2.aip_agents.models import StringParameterValueDict` | **AipAgents** | [UserTextInput](docs/v2/AipAgents/models/UserTextInput.md) | `from foundry.v2.aip_agents.models import UserTextInput` | -**AipAgents** | [UserTextInputDict](docs/v2/AipAgents/models/UserTextInputDict.md) | `from foundry.v2.aip_agents.models import UserTextInputDict` | **Connectivity** | [ApiKeyAuthentication](docs/v2/Connectivity/models/ApiKeyAuthentication.md) | `from foundry.v2.connectivity.models import ApiKeyAuthentication` | -**Connectivity** | [ApiKeyAuthenticationDict](docs/v2/Connectivity/models/ApiKeyAuthenticationDict.md) | `from foundry.v2.connectivity.models import ApiKeyAuthenticationDict` | **Connectivity** | [AsPlaintextValue](docs/v2/Connectivity/models/AsPlaintextValue.md) | `from foundry.v2.connectivity.models import AsPlaintextValue` | -**Connectivity** | [AsPlaintextValueDict](docs/v2/Connectivity/models/AsPlaintextValueDict.md) | `from foundry.v2.connectivity.models import AsPlaintextValueDict` | **Connectivity** | [AsSecretName](docs/v2/Connectivity/models/AsSecretName.md) | `from foundry.v2.connectivity.models import AsSecretName` | -**Connectivity** | [AsSecretNameDict](docs/v2/Connectivity/models/AsSecretNameDict.md) | `from foundry.v2.connectivity.models import AsSecretNameDict` | **Connectivity** | [AwsAccessKey](docs/v2/Connectivity/models/AwsAccessKey.md) | `from foundry.v2.connectivity.models import AwsAccessKey` | -**Connectivity** | [AwsAccessKeyDict](docs/v2/Connectivity/models/AwsAccessKeyDict.md) | `from foundry.v2.connectivity.models import AwsAccessKeyDict` | **Connectivity** | [AwsOidcAuthentication](docs/v2/Connectivity/models/AwsOidcAuthentication.md) | `from foundry.v2.connectivity.models import AwsOidcAuthentication` | -**Connectivity** | [AwsOidcAuthenticationDict](docs/v2/Connectivity/models/AwsOidcAuthenticationDict.md) | `from foundry.v2.connectivity.models import AwsOidcAuthenticationDict` | **Connectivity** | [BasicCredentials](docs/v2/Connectivity/models/BasicCredentials.md) | `from foundry.v2.connectivity.models import BasicCredentials` | -**Connectivity** | [BasicCredentialsDict](docs/v2/Connectivity/models/BasicCredentialsDict.md) | `from foundry.v2.connectivity.models import BasicCredentialsDict` | **Connectivity** | [BearerToken](docs/v2/Connectivity/models/BearerToken.md) | `from foundry.v2.connectivity.models import BearerToken` | -**Connectivity** | [BearerTokenDict](docs/v2/Connectivity/models/BearerTokenDict.md) | `from foundry.v2.connectivity.models import BearerTokenDict` | **Connectivity** | [CloudIdentity](docs/v2/Connectivity/models/CloudIdentity.md) | `from foundry.v2.connectivity.models import CloudIdentity` | -**Connectivity** | [CloudIdentityDict](docs/v2/Connectivity/models/CloudIdentityDict.md) | `from foundry.v2.connectivity.models import CloudIdentityDict` | **Connectivity** | [CloudIdentityRid](docs/v2/Connectivity/models/CloudIdentityRid.md) | `from foundry.v2.connectivity.models import CloudIdentityRid` | **Connectivity** | [Connection](docs/v2/Connectivity/models/Connection.md) | `from foundry.v2.connectivity.models import Connection` | **Connectivity** | [ConnectionConfiguration](docs/v2/Connectivity/models/ConnectionConfiguration.md) | `from foundry.v2.connectivity.models import ConnectionConfiguration` | -**Connectivity** | [ConnectionConfigurationDict](docs/v2/Connectivity/models/ConnectionConfigurationDict.md) | `from foundry.v2.connectivity.models import ConnectionConfigurationDict` | -**Connectivity** | [ConnectionDict](docs/v2/Connectivity/models/ConnectionDict.md) | `from foundry.v2.connectivity.models import ConnectionDict` | **Connectivity** | [ConnectionDisplayName](docs/v2/Connectivity/models/ConnectionDisplayName.md) | `from foundry.v2.connectivity.models import ConnectionDisplayName` | **Connectivity** | [ConnectionRid](docs/v2/Connectivity/models/ConnectionRid.md) | `from foundry.v2.connectivity.models import ConnectionRid` | **Connectivity** | [CreateConnectionRequestConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestConnectionConfiguration.md) | `from foundry.v2.connectivity.models import CreateConnectionRequestConnectionConfiguration` | -**Connectivity** | [CreateConnectionRequestConnectionConfigurationDict](docs/v2/Connectivity/models/CreateConnectionRequestConnectionConfigurationDict.md) | `from foundry.v2.connectivity.models import CreateConnectionRequestConnectionConfigurationDict` | **Connectivity** | [CreateConnectionRequestJdbcConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestJdbcConnectionConfiguration.md) | `from foundry.v2.connectivity.models import CreateConnectionRequestJdbcConnectionConfiguration` | -**Connectivity** | [CreateConnectionRequestJdbcConnectionConfigurationDict](docs/v2/Connectivity/models/CreateConnectionRequestJdbcConnectionConfigurationDict.md) | `from foundry.v2.connectivity.models import CreateConnectionRequestJdbcConnectionConfigurationDict` | **Connectivity** | [CreateConnectionRequestRestConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestRestConnectionConfiguration.md) | `from foundry.v2.connectivity.models import CreateConnectionRequestRestConnectionConfiguration` | -**Connectivity** | [CreateConnectionRequestRestConnectionConfigurationDict](docs/v2/Connectivity/models/CreateConnectionRequestRestConnectionConfigurationDict.md) | `from foundry.v2.connectivity.models import CreateConnectionRequestRestConnectionConfigurationDict` | **Connectivity** | [CreateConnectionRequestS3ConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestS3ConnectionConfiguration.md) | `from foundry.v2.connectivity.models import CreateConnectionRequestS3ConnectionConfiguration` | -**Connectivity** | [CreateConnectionRequestS3ConnectionConfigurationDict](docs/v2/Connectivity/models/CreateConnectionRequestS3ConnectionConfigurationDict.md) | `from foundry.v2.connectivity.models import CreateConnectionRequestS3ConnectionConfigurationDict` | **Connectivity** | [CreateTableImportRequestJdbcImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestJdbcImportConfig.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestJdbcImportConfig` | -**Connectivity** | [CreateTableImportRequestJdbcImportConfigDict](docs/v2/Connectivity/models/CreateTableImportRequestJdbcImportConfigDict.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestJdbcImportConfigDict` | **Connectivity** | [CreateTableImportRequestMicrosoftAccessImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfig.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestMicrosoftAccessImportConfig` | -**Connectivity** | [CreateTableImportRequestMicrosoftAccessImportConfigDict](docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfigDict.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestMicrosoftAccessImportConfigDict` | **Connectivity** | [CreateTableImportRequestMicrosoftSqlServerImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfig.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestMicrosoftSqlServerImportConfig` | -**Connectivity** | [CreateTableImportRequestMicrosoftSqlServerImportConfigDict](docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfigDict.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestMicrosoftSqlServerImportConfigDict` | **Connectivity** | [CreateTableImportRequestOracleImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestOracleImportConfig.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestOracleImportConfig` | -**Connectivity** | [CreateTableImportRequestOracleImportConfigDict](docs/v2/Connectivity/models/CreateTableImportRequestOracleImportConfigDict.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestOracleImportConfigDict` | **Connectivity** | [CreateTableImportRequestPostgreSqlImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestPostgreSqlImportConfig.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestPostgreSqlImportConfig` | -**Connectivity** | [CreateTableImportRequestPostgreSqlImportConfigDict](docs/v2/Connectivity/models/CreateTableImportRequestPostgreSqlImportConfigDict.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestPostgreSqlImportConfigDict` | **Connectivity** | [CreateTableImportRequestTableImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfig.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestTableImportConfig` | -**Connectivity** | [CreateTableImportRequestTableImportConfigDict](docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfigDict.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestTableImportConfigDict` | **Connectivity** | [Domain](docs/v2/Connectivity/models/Domain.md) | `from foundry.v2.connectivity.models import Domain` | -**Connectivity** | [DomainDict](docs/v2/Connectivity/models/DomainDict.md) | `from foundry.v2.connectivity.models import DomainDict` | **Connectivity** | [EncryptedProperty](docs/v2/Connectivity/models/EncryptedProperty.md) | `from foundry.v2.connectivity.models import EncryptedProperty` | -**Connectivity** | [EncryptedPropertyDict](docs/v2/Connectivity/models/EncryptedPropertyDict.md) | `from foundry.v2.connectivity.models import EncryptedPropertyDict` | **Connectivity** | [FileAnyPathMatchesFilter](docs/v2/Connectivity/models/FileAnyPathMatchesFilter.md) | `from foundry.v2.connectivity.models import FileAnyPathMatchesFilter` | -**Connectivity** | [FileAnyPathMatchesFilterDict](docs/v2/Connectivity/models/FileAnyPathMatchesFilterDict.md) | `from foundry.v2.connectivity.models import FileAnyPathMatchesFilterDict` | **Connectivity** | [FileAtLeastCountFilter](docs/v2/Connectivity/models/FileAtLeastCountFilter.md) | `from foundry.v2.connectivity.models import FileAtLeastCountFilter` | -**Connectivity** | [FileAtLeastCountFilterDict](docs/v2/Connectivity/models/FileAtLeastCountFilterDict.md) | `from foundry.v2.connectivity.models import FileAtLeastCountFilterDict` | **Connectivity** | [FileChangedSinceLastUploadFilter](docs/v2/Connectivity/models/FileChangedSinceLastUploadFilter.md) | `from foundry.v2.connectivity.models import FileChangedSinceLastUploadFilter` | -**Connectivity** | [FileChangedSinceLastUploadFilterDict](docs/v2/Connectivity/models/FileChangedSinceLastUploadFilterDict.md) | `from foundry.v2.connectivity.models import FileChangedSinceLastUploadFilterDict` | **Connectivity** | [FileImport](docs/v2/Connectivity/models/FileImport.md) | `from foundry.v2.connectivity.models import FileImport` | **Connectivity** | [FileImportCustomFilter](docs/v2/Connectivity/models/FileImportCustomFilter.md) | `from foundry.v2.connectivity.models import FileImportCustomFilter` | -**Connectivity** | [FileImportCustomFilterDict](docs/v2/Connectivity/models/FileImportCustomFilterDict.md) | `from foundry.v2.connectivity.models import FileImportCustomFilterDict` | -**Connectivity** | [FileImportDict](docs/v2/Connectivity/models/FileImportDict.md) | `from foundry.v2.connectivity.models import FileImportDict` | **Connectivity** | [FileImportDisplayName](docs/v2/Connectivity/models/FileImportDisplayName.md) | `from foundry.v2.connectivity.models import FileImportDisplayName` | **Connectivity** | [FileImportFilter](docs/v2/Connectivity/models/FileImportFilter.md) | `from foundry.v2.connectivity.models import FileImportFilter` | -**Connectivity** | [FileImportFilterDict](docs/v2/Connectivity/models/FileImportFilterDict.md) | `from foundry.v2.connectivity.models import FileImportFilterDict` | **Connectivity** | [FileImportMode](docs/v2/Connectivity/models/FileImportMode.md) | `from foundry.v2.connectivity.models import FileImportMode` | **Connectivity** | [FileImportRid](docs/v2/Connectivity/models/FileImportRid.md) | `from foundry.v2.connectivity.models import FileImportRid` | **Connectivity** | [FileLastModifiedAfterFilter](docs/v2/Connectivity/models/FileLastModifiedAfterFilter.md) | `from foundry.v2.connectivity.models import FileLastModifiedAfterFilter` | -**Connectivity** | [FileLastModifiedAfterFilterDict](docs/v2/Connectivity/models/FileLastModifiedAfterFilterDict.md) | `from foundry.v2.connectivity.models import FileLastModifiedAfterFilterDict` | **Connectivity** | [FilePathMatchesFilter](docs/v2/Connectivity/models/FilePathMatchesFilter.md) | `from foundry.v2.connectivity.models import FilePathMatchesFilter` | -**Connectivity** | [FilePathMatchesFilterDict](docs/v2/Connectivity/models/FilePathMatchesFilterDict.md) | `from foundry.v2.connectivity.models import FilePathMatchesFilterDict` | **Connectivity** | [FilePathNotMatchesFilter](docs/v2/Connectivity/models/FilePathNotMatchesFilter.md) | `from foundry.v2.connectivity.models import FilePathNotMatchesFilter` | -**Connectivity** | [FilePathNotMatchesFilterDict](docs/v2/Connectivity/models/FilePathNotMatchesFilterDict.md) | `from foundry.v2.connectivity.models import FilePathNotMatchesFilterDict` | **Connectivity** | [FileProperty](docs/v2/Connectivity/models/FileProperty.md) | `from foundry.v2.connectivity.models import FileProperty` | **Connectivity** | [FilesCountLimitFilter](docs/v2/Connectivity/models/FilesCountLimitFilter.md) | `from foundry.v2.connectivity.models import FilesCountLimitFilter` | -**Connectivity** | [FilesCountLimitFilterDict](docs/v2/Connectivity/models/FilesCountLimitFilterDict.md) | `from foundry.v2.connectivity.models import FilesCountLimitFilterDict` | **Connectivity** | [FileSizeFilter](docs/v2/Connectivity/models/FileSizeFilter.md) | `from foundry.v2.connectivity.models import FileSizeFilter` | -**Connectivity** | [FileSizeFilterDict](docs/v2/Connectivity/models/FileSizeFilterDict.md) | `from foundry.v2.connectivity.models import FileSizeFilterDict` | **Connectivity** | [HeaderApiKey](docs/v2/Connectivity/models/HeaderApiKey.md) | `from foundry.v2.connectivity.models import HeaderApiKey` | -**Connectivity** | [HeaderApiKeyDict](docs/v2/Connectivity/models/HeaderApiKeyDict.md) | `from foundry.v2.connectivity.models import HeaderApiKeyDict` | **Connectivity** | [JdbcConnectionConfiguration](docs/v2/Connectivity/models/JdbcConnectionConfiguration.md) | `from foundry.v2.connectivity.models import JdbcConnectionConfiguration` | -**Connectivity** | [JdbcConnectionConfigurationDict](docs/v2/Connectivity/models/JdbcConnectionConfigurationDict.md) | `from foundry.v2.connectivity.models import JdbcConnectionConfigurationDict` | **Connectivity** | [JdbcImportConfig](docs/v2/Connectivity/models/JdbcImportConfig.md) | `from foundry.v2.connectivity.models import JdbcImportConfig` | -**Connectivity** | [JdbcImportConfigDict](docs/v2/Connectivity/models/JdbcImportConfigDict.md) | `from foundry.v2.connectivity.models import JdbcImportConfigDict` | **Connectivity** | [ListFileImportsResponse](docs/v2/Connectivity/models/ListFileImportsResponse.md) | `from foundry.v2.connectivity.models import ListFileImportsResponse` | -**Connectivity** | [ListFileImportsResponseDict](docs/v2/Connectivity/models/ListFileImportsResponseDict.md) | `from foundry.v2.connectivity.models import ListFileImportsResponseDict` | **Connectivity** | [ListTableImportsResponse](docs/v2/Connectivity/models/ListTableImportsResponse.md) | `from foundry.v2.connectivity.models import ListTableImportsResponse` | -**Connectivity** | [ListTableImportsResponseDict](docs/v2/Connectivity/models/ListTableImportsResponseDict.md) | `from foundry.v2.connectivity.models import ListTableImportsResponseDict` | **Connectivity** | [MicrosoftAccessImportConfig](docs/v2/Connectivity/models/MicrosoftAccessImportConfig.md) | `from foundry.v2.connectivity.models import MicrosoftAccessImportConfig` | -**Connectivity** | [MicrosoftAccessImportConfigDict](docs/v2/Connectivity/models/MicrosoftAccessImportConfigDict.md) | `from foundry.v2.connectivity.models import MicrosoftAccessImportConfigDict` | **Connectivity** | [MicrosoftSqlServerImportConfig](docs/v2/Connectivity/models/MicrosoftSqlServerImportConfig.md) | `from foundry.v2.connectivity.models import MicrosoftSqlServerImportConfig` | -**Connectivity** | [MicrosoftSqlServerImportConfigDict](docs/v2/Connectivity/models/MicrosoftSqlServerImportConfigDict.md) | `from foundry.v2.connectivity.models import MicrosoftSqlServerImportConfigDict` | **Connectivity** | [OracleImportConfig](docs/v2/Connectivity/models/OracleImportConfig.md) | `from foundry.v2.connectivity.models import OracleImportConfig` | -**Connectivity** | [OracleImportConfigDict](docs/v2/Connectivity/models/OracleImportConfigDict.md) | `from foundry.v2.connectivity.models import OracleImportConfigDict` | **Connectivity** | [PlaintextValue](docs/v2/Connectivity/models/PlaintextValue.md) | `from foundry.v2.connectivity.models import PlaintextValue` | **Connectivity** | [PostgreSqlImportConfig](docs/v2/Connectivity/models/PostgreSqlImportConfig.md) | `from foundry.v2.connectivity.models import PostgreSqlImportConfig` | -**Connectivity** | [PostgreSqlImportConfigDict](docs/v2/Connectivity/models/PostgreSqlImportConfigDict.md) | `from foundry.v2.connectivity.models import PostgreSqlImportConfigDict` | **Connectivity** | [Protocol](docs/v2/Connectivity/models/Protocol.md) | `from foundry.v2.connectivity.models import Protocol` | **Connectivity** | [QueryParameterApiKey](docs/v2/Connectivity/models/QueryParameterApiKey.md) | `from foundry.v2.connectivity.models import QueryParameterApiKey` | -**Connectivity** | [QueryParameterApiKeyDict](docs/v2/Connectivity/models/QueryParameterApiKeyDict.md) | `from foundry.v2.connectivity.models import QueryParameterApiKeyDict` | **Connectivity** | [Region](docs/v2/Connectivity/models/Region.md) | `from foundry.v2.connectivity.models import Region` | **Connectivity** | [RestAuthenticationMode](docs/v2/Connectivity/models/RestAuthenticationMode.md) | `from foundry.v2.connectivity.models import RestAuthenticationMode` | -**Connectivity** | [RestAuthenticationModeDict](docs/v2/Connectivity/models/RestAuthenticationModeDict.md) | `from foundry.v2.connectivity.models import RestAuthenticationModeDict` | **Connectivity** | [RestConnectionAdditionalSecrets](docs/v2/Connectivity/models/RestConnectionAdditionalSecrets.md) | `from foundry.v2.connectivity.models import RestConnectionAdditionalSecrets` | -**Connectivity** | [RestConnectionAdditionalSecretsDict](docs/v2/Connectivity/models/RestConnectionAdditionalSecretsDict.md) | `from foundry.v2.connectivity.models import RestConnectionAdditionalSecretsDict` | **Connectivity** | [RestConnectionConfiguration](docs/v2/Connectivity/models/RestConnectionConfiguration.md) | `from foundry.v2.connectivity.models import RestConnectionConfiguration` | -**Connectivity** | [RestConnectionConfigurationDict](docs/v2/Connectivity/models/RestConnectionConfigurationDict.md) | `from foundry.v2.connectivity.models import RestConnectionConfigurationDict` | **Connectivity** | [RestConnectionOAuth2](docs/v2/Connectivity/models/RestConnectionOAuth2.md) | `from foundry.v2.connectivity.models import RestConnectionOAuth2` | -**Connectivity** | [RestConnectionOAuth2Dict](docs/v2/Connectivity/models/RestConnectionOAuth2Dict.md) | `from foundry.v2.connectivity.models import RestConnectionOAuth2Dict` | **Connectivity** | [RestRequestApiKeyLocation](docs/v2/Connectivity/models/RestRequestApiKeyLocation.md) | `from foundry.v2.connectivity.models import RestRequestApiKeyLocation` | -**Connectivity** | [RestRequestApiKeyLocationDict](docs/v2/Connectivity/models/RestRequestApiKeyLocationDict.md) | `from foundry.v2.connectivity.models import RestRequestApiKeyLocationDict` | **Connectivity** | [S3AuthenticationMode](docs/v2/Connectivity/models/S3AuthenticationMode.md) | `from foundry.v2.connectivity.models import S3AuthenticationMode` | -**Connectivity** | [S3AuthenticationModeDict](docs/v2/Connectivity/models/S3AuthenticationModeDict.md) | `from foundry.v2.connectivity.models import S3AuthenticationModeDict` | **Connectivity** | [S3ConnectionConfiguration](docs/v2/Connectivity/models/S3ConnectionConfiguration.md) | `from foundry.v2.connectivity.models import S3ConnectionConfiguration` | -**Connectivity** | [S3ConnectionConfigurationDict](docs/v2/Connectivity/models/S3ConnectionConfigurationDict.md) | `from foundry.v2.connectivity.models import S3ConnectionConfigurationDict` | **Connectivity** | [S3KmsConfiguration](docs/v2/Connectivity/models/S3KmsConfiguration.md) | `from foundry.v2.connectivity.models import S3KmsConfiguration` | -**Connectivity** | [S3KmsConfigurationDict](docs/v2/Connectivity/models/S3KmsConfigurationDict.md) | `from foundry.v2.connectivity.models import S3KmsConfigurationDict` | **Connectivity** | [S3ProxyConfiguration](docs/v2/Connectivity/models/S3ProxyConfiguration.md) | `from foundry.v2.connectivity.models import S3ProxyConfiguration` | -**Connectivity** | [S3ProxyConfigurationDict](docs/v2/Connectivity/models/S3ProxyConfigurationDict.md) | `from foundry.v2.connectivity.models import S3ProxyConfigurationDict` | **Connectivity** | [SecretName](docs/v2/Connectivity/models/SecretName.md) | `from foundry.v2.connectivity.models import SecretName` | **Connectivity** | [SecretsNames](docs/v2/Connectivity/models/SecretsNames.md) | `from foundry.v2.connectivity.models import SecretsNames` | -**Connectivity** | [SecretsNamesDict](docs/v2/Connectivity/models/SecretsNamesDict.md) | `from foundry.v2.connectivity.models import SecretsNamesDict` | **Connectivity** | [SecretsWithPlaintextValues](docs/v2/Connectivity/models/SecretsWithPlaintextValues.md) | `from foundry.v2.connectivity.models import SecretsWithPlaintextValues` | -**Connectivity** | [SecretsWithPlaintextValuesDict](docs/v2/Connectivity/models/SecretsWithPlaintextValuesDict.md) | `from foundry.v2.connectivity.models import SecretsWithPlaintextValuesDict` | **Connectivity** | [StsRoleConfiguration](docs/v2/Connectivity/models/StsRoleConfiguration.md) | `from foundry.v2.connectivity.models import StsRoleConfiguration` | -**Connectivity** | [StsRoleConfigurationDict](docs/v2/Connectivity/models/StsRoleConfigurationDict.md) | `from foundry.v2.connectivity.models import StsRoleConfigurationDict` | **Connectivity** | [TableImport](docs/v2/Connectivity/models/TableImport.md) | `from foundry.v2.connectivity.models import TableImport` | **Connectivity** | [TableImportAllowSchemaChanges](docs/v2/Connectivity/models/TableImportAllowSchemaChanges.md) | `from foundry.v2.connectivity.models import TableImportAllowSchemaChanges` | **Connectivity** | [TableImportConfig](docs/v2/Connectivity/models/TableImportConfig.md) | `from foundry.v2.connectivity.models import TableImportConfig` | -**Connectivity** | [TableImportConfigDict](docs/v2/Connectivity/models/TableImportConfigDict.md) | `from foundry.v2.connectivity.models import TableImportConfigDict` | -**Connectivity** | [TableImportDict](docs/v2/Connectivity/models/TableImportDict.md) | `from foundry.v2.connectivity.models import TableImportDict` | **Connectivity** | [TableImportDisplayName](docs/v2/Connectivity/models/TableImportDisplayName.md) | `from foundry.v2.connectivity.models import TableImportDisplayName` | **Connectivity** | [TableImportMode](docs/v2/Connectivity/models/TableImportMode.md) | `from foundry.v2.connectivity.models import TableImportMode` | **Connectivity** | [TableImportRid](docs/v2/Connectivity/models/TableImportRid.md) | `from foundry.v2.connectivity.models import TableImportRid` | **Connectivity** | [UriScheme](docs/v2/Connectivity/models/UriScheme.md) | `from foundry.v2.connectivity.models import UriScheme` | **Core** | [AnyType](docs/v2/Core/models/AnyType.md) | `from foundry.v2.core.models import AnyType` | -**Core** | [AnyTypeDict](docs/v2/Core/models/AnyTypeDict.md) | `from foundry.v2.core.models import AnyTypeDict` | **Core** | [ArrayFieldType](docs/v2/Core/models/ArrayFieldType.md) | `from foundry.v2.core.models import ArrayFieldType` | -**Core** | [ArrayFieldTypeDict](docs/v2/Core/models/ArrayFieldTypeDict.md) | `from foundry.v2.core.models import ArrayFieldTypeDict` | **Core** | [AttachmentType](docs/v2/Core/models/AttachmentType.md) | `from foundry.v2.core.models import AttachmentType` | -**Core** | [AttachmentTypeDict](docs/v2/Core/models/AttachmentTypeDict.md) | `from foundry.v2.core.models import AttachmentTypeDict` | **Core** | [BinaryType](docs/v2/Core/models/BinaryType.md) | `from foundry.v2.core.models import BinaryType` | -**Core** | [BinaryTypeDict](docs/v2/Core/models/BinaryTypeDict.md) | `from foundry.v2.core.models import BinaryTypeDict` | **Core** | [BooleanType](docs/v2/Core/models/BooleanType.md) | `from foundry.v2.core.models import BooleanType` | -**Core** | [BooleanTypeDict](docs/v2/Core/models/BooleanTypeDict.md) | `from foundry.v2.core.models import BooleanTypeDict` | **Core** | [BuildRid](docs/v2/Core/models/BuildRid.md) | `from foundry.v2.core.models import BuildRid` | **Core** | [ByteType](docs/v2/Core/models/ByteType.md) | `from foundry.v2.core.models import ByteType` | -**Core** | [ByteTypeDict](docs/v2/Core/models/ByteTypeDict.md) | `from foundry.v2.core.models import ByteTypeDict` | **Core** | [ChangeDataCaptureConfiguration](docs/v2/Core/models/ChangeDataCaptureConfiguration.md) | `from foundry.v2.core.models import ChangeDataCaptureConfiguration` | -**Core** | [ChangeDataCaptureConfigurationDict](docs/v2/Core/models/ChangeDataCaptureConfigurationDict.md) | `from foundry.v2.core.models import ChangeDataCaptureConfigurationDict` | **Core** | [CipherTextType](docs/v2/Core/models/CipherTextType.md) | `from foundry.v2.core.models import CipherTextType` | -**Core** | [CipherTextTypeDict](docs/v2/Core/models/CipherTextTypeDict.md) | `from foundry.v2.core.models import CipherTextTypeDict` | **Core** | [ContentLength](docs/v2/Core/models/ContentLength.md) | `from foundry.v2.core.models import ContentLength` | **Core** | [ContentType](docs/v2/Core/models/ContentType.md) | `from foundry.v2.core.models import ContentType` | **Core** | [CreatedBy](docs/v2/Core/models/CreatedBy.md) | `from foundry.v2.core.models import CreatedBy` | **Core** | [CreatedTime](docs/v2/Core/models/CreatedTime.md) | `from foundry.v2.core.models import CreatedTime` | **Core** | [CustomMetadata](docs/v2/Core/models/CustomMetadata.md) | `from foundry.v2.core.models import CustomMetadata` | **Core** | [DateType](docs/v2/Core/models/DateType.md) | `from foundry.v2.core.models import DateType` | -**Core** | [DateTypeDict](docs/v2/Core/models/DateTypeDict.md) | `from foundry.v2.core.models import DateTypeDict` | **Core** | [DecimalType](docs/v2/Core/models/DecimalType.md) | `from foundry.v2.core.models import DecimalType` | -**Core** | [DecimalTypeDict](docs/v2/Core/models/DecimalTypeDict.md) | `from foundry.v2.core.models import DecimalTypeDict` | **Core** | [DisplayName](docs/v2/Core/models/DisplayName.md) | `from foundry.v2.core.models import DisplayName` | **Core** | [Distance](docs/v2/Core/models/Distance.md) | `from foundry.v2.core.models import Distance` | -**Core** | [DistanceDict](docs/v2/Core/models/DistanceDict.md) | `from foundry.v2.core.models import DistanceDict` | **Core** | [DistanceUnit](docs/v2/Core/models/DistanceUnit.md) | `from foundry.v2.core.models import DistanceUnit` | **Core** | [DoubleType](docs/v2/Core/models/DoubleType.md) | `from foundry.v2.core.models import DoubleType` | -**Core** | [DoubleTypeDict](docs/v2/Core/models/DoubleTypeDict.md) | `from foundry.v2.core.models import DoubleTypeDict` | **Core** | [Duration](docs/v2/Core/models/Duration.md) | `from foundry.v2.core.models import Duration` | -**Core** | [DurationDict](docs/v2/Core/models/DurationDict.md) | `from foundry.v2.core.models import DurationDict` | **Core** | [EmbeddingModel](docs/v2/Core/models/EmbeddingModel.md) | `from foundry.v2.core.models import EmbeddingModel` | -**Core** | [EmbeddingModelDict](docs/v2/Core/models/EmbeddingModelDict.md) | `from foundry.v2.core.models import EmbeddingModelDict` | **Core** | [EnrollmentRid](docs/v2/Core/models/EnrollmentRid.md) | `from foundry.v2.core.models import EnrollmentRid` | **Core** | [Field](docs/v2/Core/models/Field.md) | `from foundry.v2.core.models import Field` | **Core** | [FieldDataType](docs/v2/Core/models/FieldDataType.md) | `from foundry.v2.core.models import FieldDataType` | -**Core** | [FieldDataTypeDict](docs/v2/Core/models/FieldDataTypeDict.md) | `from foundry.v2.core.models import FieldDataTypeDict` | -**Core** | [FieldDict](docs/v2/Core/models/FieldDict.md) | `from foundry.v2.core.models import FieldDict` | **Core** | [FieldName](docs/v2/Core/models/FieldName.md) | `from foundry.v2.core.models import FieldName` | **Core** | [FieldSchema](docs/v2/Core/models/FieldSchema.md) | `from foundry.v2.core.models import FieldSchema` | -**Core** | [FieldSchemaDict](docs/v2/Core/models/FieldSchemaDict.md) | `from foundry.v2.core.models import FieldSchemaDict` | **Core** | [Filename](docs/v2/Core/models/Filename.md) | `from foundry.v2.core.models import Filename` | **Core** | [FilePath](docs/v2/Core/models/FilePath.md) | `from foundry.v2.core.models import FilePath` | -**Core** | [FilterBinaryTypeDict](docs/v2/Core/models/FilterBinaryTypeDict.md) | `from foundry.v2.core.models import FilterBinaryTypeDict` | -**Core** | [FilterBooleanTypeDict](docs/v2/Core/models/FilterBooleanTypeDict.md) | `from foundry.v2.core.models import FilterBooleanTypeDict` | -**Core** | [FilterDateTimeTypeDict](docs/v2/Core/models/FilterDateTimeTypeDict.md) | `from foundry.v2.core.models import FilterDateTimeTypeDict` | -**Core** | [FilterDateTypeDict](docs/v2/Core/models/FilterDateTypeDict.md) | `from foundry.v2.core.models import FilterDateTypeDict` | -**Core** | [FilterDoubleTypeDict](docs/v2/Core/models/FilterDoubleTypeDict.md) | `from foundry.v2.core.models import FilterDoubleTypeDict` | -**Core** | [FilterEnumTypeDict](docs/v2/Core/models/FilterEnumTypeDict.md) | `from foundry.v2.core.models import FilterEnumTypeDict` | -**Core** | [FilterFloatTypeDict](docs/v2/Core/models/FilterFloatTypeDict.md) | `from foundry.v2.core.models import FilterFloatTypeDict` | -**Core** | [FilterIntegerTypeDict](docs/v2/Core/models/FilterIntegerTypeDict.md) | `from foundry.v2.core.models import FilterIntegerTypeDict` | -**Core** | [FilterLongTypeDict](docs/v2/Core/models/FilterLongTypeDict.md) | `from foundry.v2.core.models import FilterLongTypeDict` | -**Core** | [FilterRidTypeDict](docs/v2/Core/models/FilterRidTypeDict.md) | `from foundry.v2.core.models import FilterRidTypeDict` | -**Core** | [FilterStringTypeDict](docs/v2/Core/models/FilterStringTypeDict.md) | `from foundry.v2.core.models import FilterStringTypeDict` | -**Core** | [FilterTypeDict](docs/v2/Core/models/FilterTypeDict.md) | `from foundry.v2.core.models import FilterTypeDict` | -**Core** | [FilterUuidTypeDict](docs/v2/Core/models/FilterUuidTypeDict.md) | `from foundry.v2.core.models import FilterUuidTypeDict` | +**Core** | [FilterBinaryType](docs/v2/Core/models/FilterBinaryType.md) | `from foundry.v2.core.models import FilterBinaryType` | +**Core** | [FilterBooleanType](docs/v2/Core/models/FilterBooleanType.md) | `from foundry.v2.core.models import FilterBooleanType` | +**Core** | [FilterDateTimeType](docs/v2/Core/models/FilterDateTimeType.md) | `from foundry.v2.core.models import FilterDateTimeType` | +**Core** | [FilterDateType](docs/v2/Core/models/FilterDateType.md) | `from foundry.v2.core.models import FilterDateType` | +**Core** | [FilterDoubleType](docs/v2/Core/models/FilterDoubleType.md) | `from foundry.v2.core.models import FilterDoubleType` | +**Core** | [FilterEnumType](docs/v2/Core/models/FilterEnumType.md) | `from foundry.v2.core.models import FilterEnumType` | +**Core** | [FilterFloatType](docs/v2/Core/models/FilterFloatType.md) | `from foundry.v2.core.models import FilterFloatType` | +**Core** | [FilterIntegerType](docs/v2/Core/models/FilterIntegerType.md) | `from foundry.v2.core.models import FilterIntegerType` | +**Core** | [FilterLongType](docs/v2/Core/models/FilterLongType.md) | `from foundry.v2.core.models import FilterLongType` | +**Core** | [FilterRidType](docs/v2/Core/models/FilterRidType.md) | `from foundry.v2.core.models import FilterRidType` | +**Core** | [FilterStringType](docs/v2/Core/models/FilterStringType.md) | `from foundry.v2.core.models import FilterStringType` | +**Core** | [FilterType](docs/v2/Core/models/FilterType.md) | `from foundry.v2.core.models import FilterType` | +**Core** | [FilterUuidType](docs/v2/Core/models/FilterUuidType.md) | `from foundry.v2.core.models import FilterUuidType` | **Core** | [FloatType](docs/v2/Core/models/FloatType.md) | `from foundry.v2.core.models import FloatType` | -**Core** | [FloatTypeDict](docs/v2/Core/models/FloatTypeDict.md) | `from foundry.v2.core.models import FloatTypeDict` | **Core** | [FolderRid](docs/v2/Core/models/FolderRid.md) | `from foundry.v2.core.models import FolderRid` | **Core** | [FoundryLiveDeployment](docs/v2/Core/models/FoundryLiveDeployment.md) | `from foundry.v2.core.models import FoundryLiveDeployment` | -**Core** | [FoundryLiveDeploymentDict](docs/v2/Core/models/FoundryLiveDeploymentDict.md) | `from foundry.v2.core.models import FoundryLiveDeploymentDict` | **Core** | [FullRowChangeDataCaptureConfiguration](docs/v2/Core/models/FullRowChangeDataCaptureConfiguration.md) | `from foundry.v2.core.models import FullRowChangeDataCaptureConfiguration` | -**Core** | [FullRowChangeDataCaptureConfigurationDict](docs/v2/Core/models/FullRowChangeDataCaptureConfigurationDict.md) | `from foundry.v2.core.models import FullRowChangeDataCaptureConfigurationDict` | **Core** | [GeoPointType](docs/v2/Core/models/GeoPointType.md) | `from foundry.v2.core.models import GeoPointType` | -**Core** | [GeoPointTypeDict](docs/v2/Core/models/GeoPointTypeDict.md) | `from foundry.v2.core.models import GeoPointTypeDict` | **Core** | [GeoShapeType](docs/v2/Core/models/GeoShapeType.md) | `from foundry.v2.core.models import GeoShapeType` | -**Core** | [GeoShapeTypeDict](docs/v2/Core/models/GeoShapeTypeDict.md) | `from foundry.v2.core.models import GeoShapeTypeDict` | **Core** | [GeotimeSeriesReferenceType](docs/v2/Core/models/GeotimeSeriesReferenceType.md) | `from foundry.v2.core.models import GeotimeSeriesReferenceType` | -**Core** | [GeotimeSeriesReferenceTypeDict](docs/v2/Core/models/GeotimeSeriesReferenceTypeDict.md) | `from foundry.v2.core.models import GeotimeSeriesReferenceTypeDict` | **Core** | [GroupName](docs/v2/Core/models/GroupName.md) | `from foundry.v2.core.models import GroupName` | **Core** | [GroupRid](docs/v2/Core/models/GroupRid.md) | `from foundry.v2.core.models import GroupRid` | **Core** | [IntegerType](docs/v2/Core/models/IntegerType.md) | `from foundry.v2.core.models import IntegerType` | -**Core** | [IntegerTypeDict](docs/v2/Core/models/IntegerTypeDict.md) | `from foundry.v2.core.models import IntegerTypeDict` | **Core** | [JobRid](docs/v2/Core/models/JobRid.md) | `from foundry.v2.core.models import JobRid` | **Core** | [LmsEmbeddingModel](docs/v2/Core/models/LmsEmbeddingModel.md) | `from foundry.v2.core.models import LmsEmbeddingModel` | -**Core** | [LmsEmbeddingModelDict](docs/v2/Core/models/LmsEmbeddingModelDict.md) | `from foundry.v2.core.models import LmsEmbeddingModelDict` | **Core** | [LmsEmbeddingModelValue](docs/v2/Core/models/LmsEmbeddingModelValue.md) | `from foundry.v2.core.models import LmsEmbeddingModelValue` | **Core** | [LongType](docs/v2/Core/models/LongType.md) | `from foundry.v2.core.models import LongType` | -**Core** | [LongTypeDict](docs/v2/Core/models/LongTypeDict.md) | `from foundry.v2.core.models import LongTypeDict` | **Core** | [MapFieldType](docs/v2/Core/models/MapFieldType.md) | `from foundry.v2.core.models import MapFieldType` | -**Core** | [MapFieldTypeDict](docs/v2/Core/models/MapFieldTypeDict.md) | `from foundry.v2.core.models import MapFieldTypeDict` | **Core** | [MarkingId](docs/v2/Core/models/MarkingId.md) | `from foundry.v2.core.models import MarkingId` | **Core** | [MarkingType](docs/v2/Core/models/MarkingType.md) | `from foundry.v2.core.models import MarkingType` | -**Core** | [MarkingTypeDict](docs/v2/Core/models/MarkingTypeDict.md) | `from foundry.v2.core.models import MarkingTypeDict` | **Core** | [MediaItemPath](docs/v2/Core/models/MediaItemPath.md) | `from foundry.v2.core.models import MediaItemPath` | **Core** | [MediaItemReadToken](docs/v2/Core/models/MediaItemReadToken.md) | `from foundry.v2.core.models import MediaItemReadToken` | **Core** | [MediaItemRid](docs/v2/Core/models/MediaItemRid.md) | `from foundry.v2.core.models import MediaItemRid` | **Core** | [MediaReference](docs/v2/Core/models/MediaReference.md) | `from foundry.v2.core.models import MediaReference` | -**Core** | [MediaReferenceDict](docs/v2/Core/models/MediaReferenceDict.md) | `from foundry.v2.core.models import MediaReferenceDict` | **Core** | [MediaReferenceType](docs/v2/Core/models/MediaReferenceType.md) | `from foundry.v2.core.models import MediaReferenceType` | -**Core** | [MediaReferenceTypeDict](docs/v2/Core/models/MediaReferenceTypeDict.md) | `from foundry.v2.core.models import MediaReferenceTypeDict` | **Core** | [MediaSetRid](docs/v2/Core/models/MediaSetRid.md) | `from foundry.v2.core.models import MediaSetRid` | **Core** | [MediaSetViewItem](docs/v2/Core/models/MediaSetViewItem.md) | `from foundry.v2.core.models import MediaSetViewItem` | -**Core** | [MediaSetViewItemDict](docs/v2/Core/models/MediaSetViewItemDict.md) | `from foundry.v2.core.models import MediaSetViewItemDict` | **Core** | [MediaSetViewItemWrapper](docs/v2/Core/models/MediaSetViewItemWrapper.md) | `from foundry.v2.core.models import MediaSetViewItemWrapper` | -**Core** | [MediaSetViewItemWrapperDict](docs/v2/Core/models/MediaSetViewItemWrapperDict.md) | `from foundry.v2.core.models import MediaSetViewItemWrapperDict` | **Core** | [MediaSetViewRid](docs/v2/Core/models/MediaSetViewRid.md) | `from foundry.v2.core.models import MediaSetViewRid` | **Core** | [MediaType](docs/v2/Core/models/MediaType.md) | `from foundry.v2.core.models import MediaType` | **Core** | [NullType](docs/v2/Core/models/NullType.md) | `from foundry.v2.core.models import NullType` | -**Core** | [NullTypeDict](docs/v2/Core/models/NullTypeDict.md) | `from foundry.v2.core.models import NullTypeDict` | **Core** | [OperationScope](docs/v2/Core/models/OperationScope.md) | `from foundry.v2.core.models import OperationScope` | **Core** | [OrderByDirection](docs/v2/Core/models/OrderByDirection.md) | `from foundry.v2.core.models import OrderByDirection` | **Core** | [OrganizationRid](docs/v2/Core/models/OrganizationRid.md) | `from foundry.v2.core.models import OrganizationRid` | @@ -1155,921 +948,540 @@ Namespace | Name | Import | **Core** | [PrincipalType](docs/v2/Core/models/PrincipalType.md) | `from foundry.v2.core.models import PrincipalType` | **Core** | [Realm](docs/v2/Core/models/Realm.md) | `from foundry.v2.core.models import Realm` | **Core** | [Reference](docs/v2/Core/models/Reference.md) | `from foundry.v2.core.models import Reference` | -**Core** | [ReferenceDict](docs/v2/Core/models/ReferenceDict.md) | `from foundry.v2.core.models import ReferenceDict` | **Core** | [ReleaseStatus](docs/v2/Core/models/ReleaseStatus.md) | `from foundry.v2.core.models import ReleaseStatus` | **Core** | [RoleId](docs/v2/Core/models/RoleId.md) | `from foundry.v2.core.models import RoleId` | **Core** | [ShortType](docs/v2/Core/models/ShortType.md) | `from foundry.v2.core.models import ShortType` | -**Core** | [ShortTypeDict](docs/v2/Core/models/ShortTypeDict.md) | `from foundry.v2.core.models import ShortTypeDict` | **Core** | [SizeBytes](docs/v2/Core/models/SizeBytes.md) | `from foundry.v2.core.models import SizeBytes` | **Core** | [StreamSchema](docs/v2/Core/models/StreamSchema.md) | `from foundry.v2.core.models import StreamSchema` | -**Core** | [StreamSchemaDict](docs/v2/Core/models/StreamSchemaDict.md) | `from foundry.v2.core.models import StreamSchemaDict` | **Core** | [StringType](docs/v2/Core/models/StringType.md) | `from foundry.v2.core.models import StringType` | -**Core** | [StringTypeDict](docs/v2/Core/models/StringTypeDict.md) | `from foundry.v2.core.models import StringTypeDict` | **Core** | [StructFieldName](docs/v2/Core/models/StructFieldName.md) | `from foundry.v2.core.models import StructFieldName` | **Core** | [StructFieldType](docs/v2/Core/models/StructFieldType.md) | `from foundry.v2.core.models import StructFieldType` | -**Core** | [StructFieldTypeDict](docs/v2/Core/models/StructFieldTypeDict.md) | `from foundry.v2.core.models import StructFieldTypeDict` | **Core** | [TimeSeriesItemType](docs/v2/Core/models/TimeSeriesItemType.md) | `from foundry.v2.core.models import TimeSeriesItemType` | -**Core** | [TimeSeriesItemTypeDict](docs/v2/Core/models/TimeSeriesItemTypeDict.md) | `from foundry.v2.core.models import TimeSeriesItemTypeDict` | **Core** | [TimeseriesType](docs/v2/Core/models/TimeseriesType.md) | `from foundry.v2.core.models import TimeseriesType` | -**Core** | [TimeseriesTypeDict](docs/v2/Core/models/TimeseriesTypeDict.md) | `from foundry.v2.core.models import TimeseriesTypeDict` | **Core** | [TimestampType](docs/v2/Core/models/TimestampType.md) | `from foundry.v2.core.models import TimestampType` | -**Core** | [TimestampTypeDict](docs/v2/Core/models/TimestampTypeDict.md) | `from foundry.v2.core.models import TimestampTypeDict` | **Core** | [TimeUnit](docs/v2/Core/models/TimeUnit.md) | `from foundry.v2.core.models import TimeUnit` | **Core** | [TotalCount](docs/v2/Core/models/TotalCount.md) | `from foundry.v2.core.models import TotalCount` | **Core** | [UnsupportedType](docs/v2/Core/models/UnsupportedType.md) | `from foundry.v2.core.models import UnsupportedType` | -**Core** | [UnsupportedTypeDict](docs/v2/Core/models/UnsupportedTypeDict.md) | `from foundry.v2.core.models import UnsupportedTypeDict` | **Core** | [UpdatedBy](docs/v2/Core/models/UpdatedBy.md) | `from foundry.v2.core.models import UpdatedBy` | **Core** | [UpdatedTime](docs/v2/Core/models/UpdatedTime.md) | `from foundry.v2.core.models import UpdatedTime` | **Core** | [UserId](docs/v2/Core/models/UserId.md) | `from foundry.v2.core.models import UserId` | **Core** | [VectorSimilarityFunction](docs/v2/Core/models/VectorSimilarityFunction.md) | `from foundry.v2.core.models import VectorSimilarityFunction` | -**Core** | [VectorSimilarityFunctionDict](docs/v2/Core/models/VectorSimilarityFunctionDict.md) | `from foundry.v2.core.models import VectorSimilarityFunctionDict` | **Core** | [VectorSimilarityFunctionValue](docs/v2/Core/models/VectorSimilarityFunctionValue.md) | `from foundry.v2.core.models import VectorSimilarityFunctionValue` | **Core** | [VectorType](docs/v2/Core/models/VectorType.md) | `from foundry.v2.core.models import VectorType` | -**Core** | [VectorTypeDict](docs/v2/Core/models/VectorTypeDict.md) | `from foundry.v2.core.models import VectorTypeDict` | **Core** | [ZoneId](docs/v2/Core/models/ZoneId.md) | `from foundry.v2.core.models import ZoneId` | **Datasets** | [Branch](docs/v2/Datasets/models/Branch.md) | `from foundry.v2.datasets.models import Branch` | -**Datasets** | [BranchDict](docs/v2/Datasets/models/BranchDict.md) | `from foundry.v2.datasets.models import BranchDict` | **Datasets** | [BranchName](docs/v2/Datasets/models/BranchName.md) | `from foundry.v2.datasets.models import BranchName` | **Datasets** | [Dataset](docs/v2/Datasets/models/Dataset.md) | `from foundry.v2.datasets.models import Dataset` | -**Datasets** | [DatasetDict](docs/v2/Datasets/models/DatasetDict.md) | `from foundry.v2.datasets.models import DatasetDict` | **Datasets** | [DatasetName](docs/v2/Datasets/models/DatasetName.md) | `from foundry.v2.datasets.models import DatasetName` | **Datasets** | [DatasetRid](docs/v2/Datasets/models/DatasetRid.md) | `from foundry.v2.datasets.models import DatasetRid` | **Datasets** | [File](docs/v2/Datasets/models/File.md) | `from foundry.v2.datasets.models import File` | -**Datasets** | [FileDict](docs/v2/Datasets/models/FileDict.md) | `from foundry.v2.datasets.models import FileDict` | **Datasets** | [FileUpdatedTime](docs/v2/Datasets/models/FileUpdatedTime.md) | `from foundry.v2.datasets.models import FileUpdatedTime` | **Datasets** | [ListBranchesResponse](docs/v2/Datasets/models/ListBranchesResponse.md) | `from foundry.v2.datasets.models import ListBranchesResponse` | -**Datasets** | [ListBranchesResponseDict](docs/v2/Datasets/models/ListBranchesResponseDict.md) | `from foundry.v2.datasets.models import ListBranchesResponseDict` | **Datasets** | [ListFilesResponse](docs/v2/Datasets/models/ListFilesResponse.md) | `from foundry.v2.datasets.models import ListFilesResponse` | -**Datasets** | [ListFilesResponseDict](docs/v2/Datasets/models/ListFilesResponseDict.md) | `from foundry.v2.datasets.models import ListFilesResponseDict` | **Datasets** | [TableExportFormat](docs/v2/Datasets/models/TableExportFormat.md) | `from foundry.v2.datasets.models import TableExportFormat` | **Datasets** | [Transaction](docs/v2/Datasets/models/Transaction.md) | `from foundry.v2.datasets.models import Transaction` | **Datasets** | [TransactionCreatedTime](docs/v2/Datasets/models/TransactionCreatedTime.md) | `from foundry.v2.datasets.models import TransactionCreatedTime` | -**Datasets** | [TransactionDict](docs/v2/Datasets/models/TransactionDict.md) | `from foundry.v2.datasets.models import TransactionDict` | **Datasets** | [TransactionRid](docs/v2/Datasets/models/TransactionRid.md) | `from foundry.v2.datasets.models import TransactionRid` | **Datasets** | [TransactionStatus](docs/v2/Datasets/models/TransactionStatus.md) | `from foundry.v2.datasets.models import TransactionStatus` | **Datasets** | [TransactionType](docs/v2/Datasets/models/TransactionType.md) | `from foundry.v2.datasets.models import TransactionType` | **Filesystem** | [AccessRequirements](docs/v2/Filesystem/models/AccessRequirements.md) | `from foundry.v2.filesystem.models import AccessRequirements` | -**Filesystem** | [AccessRequirementsDict](docs/v2/Filesystem/models/AccessRequirementsDict.md) | `from foundry.v2.filesystem.models import AccessRequirementsDict` | **Filesystem** | [Everyone](docs/v2/Filesystem/models/Everyone.md) | `from foundry.v2.filesystem.models import Everyone` | -**Filesystem** | [EveryoneDict](docs/v2/Filesystem/models/EveryoneDict.md) | `from foundry.v2.filesystem.models import EveryoneDict` | **Filesystem** | [FileSystemId](docs/v2/Filesystem/models/FileSystemId.md) | `from foundry.v2.filesystem.models import FileSystemId` | **Filesystem** | [Folder](docs/v2/Filesystem/models/Folder.md) | `from foundry.v2.filesystem.models import Folder` | -**Filesystem** | [FolderDict](docs/v2/Filesystem/models/FolderDict.md) | `from foundry.v2.filesystem.models import FolderDict` | **Filesystem** | [FolderRid](docs/v2/Filesystem/models/FolderRid.md) | `from foundry.v2.filesystem.models import FolderRid` | **Filesystem** | [FolderType](docs/v2/Filesystem/models/FolderType.md) | `from foundry.v2.filesystem.models import FolderType` | **Filesystem** | [IsDirectlyApplied](docs/v2/Filesystem/models/IsDirectlyApplied.md) | `from foundry.v2.filesystem.models import IsDirectlyApplied` | **Filesystem** | [ListChildrenOfFolderResponse](docs/v2/Filesystem/models/ListChildrenOfFolderResponse.md) | `from foundry.v2.filesystem.models import ListChildrenOfFolderResponse` | -**Filesystem** | [ListChildrenOfFolderResponseDict](docs/v2/Filesystem/models/ListChildrenOfFolderResponseDict.md) | `from foundry.v2.filesystem.models import ListChildrenOfFolderResponseDict` | **Filesystem** | [ListMarkingsOfResourceResponse](docs/v2/Filesystem/models/ListMarkingsOfResourceResponse.md) | `from foundry.v2.filesystem.models import ListMarkingsOfResourceResponse` | -**Filesystem** | [ListMarkingsOfResourceResponseDict](docs/v2/Filesystem/models/ListMarkingsOfResourceResponseDict.md) | `from foundry.v2.filesystem.models import ListMarkingsOfResourceResponseDict` | **Filesystem** | [ListOrganizationsOfProjectResponse](docs/v2/Filesystem/models/ListOrganizationsOfProjectResponse.md) | `from foundry.v2.filesystem.models import ListOrganizationsOfProjectResponse` | -**Filesystem** | [ListOrganizationsOfProjectResponseDict](docs/v2/Filesystem/models/ListOrganizationsOfProjectResponseDict.md) | `from foundry.v2.filesystem.models import ListOrganizationsOfProjectResponseDict` | **Filesystem** | [ListResourceRolesResponse](docs/v2/Filesystem/models/ListResourceRolesResponse.md) | `from foundry.v2.filesystem.models import ListResourceRolesResponse` | -**Filesystem** | [ListResourceRolesResponseDict](docs/v2/Filesystem/models/ListResourceRolesResponseDict.md) | `from foundry.v2.filesystem.models import ListResourceRolesResponseDict` | **Filesystem** | [ListSpacesResponse](docs/v2/Filesystem/models/ListSpacesResponse.md) | `from foundry.v2.filesystem.models import ListSpacesResponse` | -**Filesystem** | [ListSpacesResponseDict](docs/v2/Filesystem/models/ListSpacesResponseDict.md) | `from foundry.v2.filesystem.models import ListSpacesResponseDict` | **Filesystem** | [Marking](docs/v2/Filesystem/models/Marking.md) | `from foundry.v2.filesystem.models import Marking` | -**Filesystem** | [MarkingDict](docs/v2/Filesystem/models/MarkingDict.md) | `from foundry.v2.filesystem.models import MarkingDict` | **Filesystem** | [Organization](docs/v2/Filesystem/models/Organization.md) | `from foundry.v2.filesystem.models import Organization` | -**Filesystem** | [OrganizationDict](docs/v2/Filesystem/models/OrganizationDict.md) | `from foundry.v2.filesystem.models import OrganizationDict` | **Filesystem** | [PrincipalWithId](docs/v2/Filesystem/models/PrincipalWithId.md) | `from foundry.v2.filesystem.models import PrincipalWithId` | -**Filesystem** | [PrincipalWithIdDict](docs/v2/Filesystem/models/PrincipalWithIdDict.md) | `from foundry.v2.filesystem.models import PrincipalWithIdDict` | **Filesystem** | [Project](docs/v2/Filesystem/models/Project.md) | `from foundry.v2.filesystem.models import Project` | -**Filesystem** | [ProjectDict](docs/v2/Filesystem/models/ProjectDict.md) | `from foundry.v2.filesystem.models import ProjectDict` | **Filesystem** | [ProjectRid](docs/v2/Filesystem/models/ProjectRid.md) | `from foundry.v2.filesystem.models import ProjectRid` | **Filesystem** | [ProjectTemplateRid](docs/v2/Filesystem/models/ProjectTemplateRid.md) | `from foundry.v2.filesystem.models import ProjectTemplateRid` | **Filesystem** | [ProjectTemplateVariableId](docs/v2/Filesystem/models/ProjectTemplateVariableId.md) | `from foundry.v2.filesystem.models import ProjectTemplateVariableId` | **Filesystem** | [ProjectTemplateVariableValue](docs/v2/Filesystem/models/ProjectTemplateVariableValue.md) | `from foundry.v2.filesystem.models import ProjectTemplateVariableValue` | **Filesystem** | [Resource](docs/v2/Filesystem/models/Resource.md) | `from foundry.v2.filesystem.models import Resource` | -**Filesystem** | [ResourceDict](docs/v2/Filesystem/models/ResourceDict.md) | `from foundry.v2.filesystem.models import ResourceDict` | **Filesystem** | [ResourceDisplayName](docs/v2/Filesystem/models/ResourceDisplayName.md) | `from foundry.v2.filesystem.models import ResourceDisplayName` | **Filesystem** | [ResourcePath](docs/v2/Filesystem/models/ResourcePath.md) | `from foundry.v2.filesystem.models import ResourcePath` | **Filesystem** | [ResourceRid](docs/v2/Filesystem/models/ResourceRid.md) | `from foundry.v2.filesystem.models import ResourceRid` | **Filesystem** | [ResourceRole](docs/v2/Filesystem/models/ResourceRole.md) | `from foundry.v2.filesystem.models import ResourceRole` | -**Filesystem** | [ResourceRoleDict](docs/v2/Filesystem/models/ResourceRoleDict.md) | `from foundry.v2.filesystem.models import ResourceRoleDict` | **Filesystem** | [ResourceRolePrincipal](docs/v2/Filesystem/models/ResourceRolePrincipal.md) | `from foundry.v2.filesystem.models import ResourceRolePrincipal` | -**Filesystem** | [ResourceRolePrincipalDict](docs/v2/Filesystem/models/ResourceRolePrincipalDict.md) | `from foundry.v2.filesystem.models import ResourceRolePrincipalDict` | **Filesystem** | [ResourceType](docs/v2/Filesystem/models/ResourceType.md) | `from foundry.v2.filesystem.models import ResourceType` | **Filesystem** | [Space](docs/v2/Filesystem/models/Space.md) | `from foundry.v2.filesystem.models import Space` | -**Filesystem** | [SpaceDict](docs/v2/Filesystem/models/SpaceDict.md) | `from foundry.v2.filesystem.models import SpaceDict` | **Filesystem** | [SpaceRid](docs/v2/Filesystem/models/SpaceRid.md) | `from foundry.v2.filesystem.models import SpaceRid` | **Filesystem** | [TrashStatus](docs/v2/Filesystem/models/TrashStatus.md) | `from foundry.v2.filesystem.models import TrashStatus` | **Filesystem** | [UsageAccountRid](docs/v2/Filesystem/models/UsageAccountRid.md) | `from foundry.v2.filesystem.models import UsageAccountRid` | **Functions** | [DataValue](docs/v2/Functions/models/DataValue.md) | `from foundry.v2.functions.models import DataValue` | **Functions** | [ExecuteQueryResponse](docs/v2/Functions/models/ExecuteQueryResponse.md) | `from foundry.v2.functions.models import ExecuteQueryResponse` | -**Functions** | [ExecuteQueryResponseDict](docs/v2/Functions/models/ExecuteQueryResponseDict.md) | `from foundry.v2.functions.models import ExecuteQueryResponseDict` | **Functions** | [FunctionRid](docs/v2/Functions/models/FunctionRid.md) | `from foundry.v2.functions.models import FunctionRid` | **Functions** | [FunctionVersion](docs/v2/Functions/models/FunctionVersion.md) | `from foundry.v2.functions.models import FunctionVersion` | **Functions** | [Parameter](docs/v2/Functions/models/Parameter.md) | `from foundry.v2.functions.models import Parameter` | -**Functions** | [ParameterDict](docs/v2/Functions/models/ParameterDict.md) | `from foundry.v2.functions.models import ParameterDict` | **Functions** | [ParameterId](docs/v2/Functions/models/ParameterId.md) | `from foundry.v2.functions.models import ParameterId` | **Functions** | [Query](docs/v2/Functions/models/Query.md) | `from foundry.v2.functions.models import Query` | **Functions** | [QueryAggregationKeyType](docs/v2/Functions/models/QueryAggregationKeyType.md) | `from foundry.v2.functions.models import QueryAggregationKeyType` | -**Functions** | [QueryAggregationKeyTypeDict](docs/v2/Functions/models/QueryAggregationKeyTypeDict.md) | `from foundry.v2.functions.models import QueryAggregationKeyTypeDict` | **Functions** | [QueryAggregationRangeSubType](docs/v2/Functions/models/QueryAggregationRangeSubType.md) | `from foundry.v2.functions.models import QueryAggregationRangeSubType` | -**Functions** | [QueryAggregationRangeSubTypeDict](docs/v2/Functions/models/QueryAggregationRangeSubTypeDict.md) | `from foundry.v2.functions.models import QueryAggregationRangeSubTypeDict` | **Functions** | [QueryAggregationRangeType](docs/v2/Functions/models/QueryAggregationRangeType.md) | `from foundry.v2.functions.models import QueryAggregationRangeType` | -**Functions** | [QueryAggregationRangeTypeDict](docs/v2/Functions/models/QueryAggregationRangeTypeDict.md) | `from foundry.v2.functions.models import QueryAggregationRangeTypeDict` | **Functions** | [QueryAggregationValueType](docs/v2/Functions/models/QueryAggregationValueType.md) | `from foundry.v2.functions.models import QueryAggregationValueType` | -**Functions** | [QueryAggregationValueTypeDict](docs/v2/Functions/models/QueryAggregationValueTypeDict.md) | `from foundry.v2.functions.models import QueryAggregationValueTypeDict` | **Functions** | [QueryApiName](docs/v2/Functions/models/QueryApiName.md) | `from foundry.v2.functions.models import QueryApiName` | **Functions** | [QueryArrayType](docs/v2/Functions/models/QueryArrayType.md) | `from foundry.v2.functions.models import QueryArrayType` | -**Functions** | [QueryArrayTypeDict](docs/v2/Functions/models/QueryArrayTypeDict.md) | `from foundry.v2.functions.models import QueryArrayTypeDict` | **Functions** | [QueryDataType](docs/v2/Functions/models/QueryDataType.md) | `from foundry.v2.functions.models import QueryDataType` | -**Functions** | [QueryDataTypeDict](docs/v2/Functions/models/QueryDataTypeDict.md) | `from foundry.v2.functions.models import QueryDataTypeDict` | -**Functions** | [QueryDict](docs/v2/Functions/models/QueryDict.md) | `from foundry.v2.functions.models import QueryDict` | **Functions** | [QueryRuntimeErrorParameter](docs/v2/Functions/models/QueryRuntimeErrorParameter.md) | `from foundry.v2.functions.models import QueryRuntimeErrorParameter` | **Functions** | [QuerySetType](docs/v2/Functions/models/QuerySetType.md) | `from foundry.v2.functions.models import QuerySetType` | -**Functions** | [QuerySetTypeDict](docs/v2/Functions/models/QuerySetTypeDict.md) | `from foundry.v2.functions.models import QuerySetTypeDict` | **Functions** | [QueryStructField](docs/v2/Functions/models/QueryStructField.md) | `from foundry.v2.functions.models import QueryStructField` | -**Functions** | [QueryStructFieldDict](docs/v2/Functions/models/QueryStructFieldDict.md) | `from foundry.v2.functions.models import QueryStructFieldDict` | **Functions** | [QueryStructType](docs/v2/Functions/models/QueryStructType.md) | `from foundry.v2.functions.models import QueryStructType` | -**Functions** | [QueryStructTypeDict](docs/v2/Functions/models/QueryStructTypeDict.md) | `from foundry.v2.functions.models import QueryStructTypeDict` | **Functions** | [QueryUnionType](docs/v2/Functions/models/QueryUnionType.md) | `from foundry.v2.functions.models import QueryUnionType` | -**Functions** | [QueryUnionTypeDict](docs/v2/Functions/models/QueryUnionTypeDict.md) | `from foundry.v2.functions.models import QueryUnionTypeDict` | **Functions** | [StructFieldName](docs/v2/Functions/models/StructFieldName.md) | `from foundry.v2.functions.models import StructFieldName` | **Functions** | [ThreeDimensionalAggregation](docs/v2/Functions/models/ThreeDimensionalAggregation.md) | `from foundry.v2.functions.models import ThreeDimensionalAggregation` | -**Functions** | [ThreeDimensionalAggregationDict](docs/v2/Functions/models/ThreeDimensionalAggregationDict.md) | `from foundry.v2.functions.models import ThreeDimensionalAggregationDict` | **Functions** | [TwoDimensionalAggregation](docs/v2/Functions/models/TwoDimensionalAggregation.md) | `from foundry.v2.functions.models import TwoDimensionalAggregation` | -**Functions** | [TwoDimensionalAggregationDict](docs/v2/Functions/models/TwoDimensionalAggregationDict.md) | `from foundry.v2.functions.models import TwoDimensionalAggregationDict` | **Functions** | [ValueType](docs/v2/Functions/models/ValueType.md) | `from foundry.v2.functions.models import ValueType` | **Functions** | [ValueTypeApiName](docs/v2/Functions/models/ValueTypeApiName.md) | `from foundry.v2.functions.models import ValueTypeApiName` | **Functions** | [ValueTypeDataType](docs/v2/Functions/models/ValueTypeDataType.md) | `from foundry.v2.functions.models import ValueTypeDataType` | **Functions** | [ValueTypeDataTypeArrayType](docs/v2/Functions/models/ValueTypeDataTypeArrayType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeArrayType` | -**Functions** | [ValueTypeDataTypeArrayTypeDict](docs/v2/Functions/models/ValueTypeDataTypeArrayTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeArrayTypeDict` | **Functions** | [ValueTypeDataTypeBinaryType](docs/v2/Functions/models/ValueTypeDataTypeBinaryType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeBinaryType` | -**Functions** | [ValueTypeDataTypeBinaryTypeDict](docs/v2/Functions/models/ValueTypeDataTypeBinaryTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeBinaryTypeDict` | **Functions** | [ValueTypeDataTypeBooleanType](docs/v2/Functions/models/ValueTypeDataTypeBooleanType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeBooleanType` | -**Functions** | [ValueTypeDataTypeBooleanTypeDict](docs/v2/Functions/models/ValueTypeDataTypeBooleanTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeBooleanTypeDict` | **Functions** | [ValueTypeDataTypeByteType](docs/v2/Functions/models/ValueTypeDataTypeByteType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeByteType` | -**Functions** | [ValueTypeDataTypeByteTypeDict](docs/v2/Functions/models/ValueTypeDataTypeByteTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeByteTypeDict` | **Functions** | [ValueTypeDataTypeDateType](docs/v2/Functions/models/ValueTypeDataTypeDateType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeDateType` | -**Functions** | [ValueTypeDataTypeDateTypeDict](docs/v2/Functions/models/ValueTypeDataTypeDateTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeDateTypeDict` | **Functions** | [ValueTypeDataTypeDecimalType](docs/v2/Functions/models/ValueTypeDataTypeDecimalType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeDecimalType` | -**Functions** | [ValueTypeDataTypeDecimalTypeDict](docs/v2/Functions/models/ValueTypeDataTypeDecimalTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeDecimalTypeDict` | -**Functions** | [ValueTypeDataTypeDict](docs/v2/Functions/models/ValueTypeDataTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeDict` | **Functions** | [ValueTypeDataTypeDoubleType](docs/v2/Functions/models/ValueTypeDataTypeDoubleType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeDoubleType` | -**Functions** | [ValueTypeDataTypeDoubleTypeDict](docs/v2/Functions/models/ValueTypeDataTypeDoubleTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeDoubleTypeDict` | **Functions** | [ValueTypeDataTypeFloatType](docs/v2/Functions/models/ValueTypeDataTypeFloatType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeFloatType` | -**Functions** | [ValueTypeDataTypeFloatTypeDict](docs/v2/Functions/models/ValueTypeDataTypeFloatTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeFloatTypeDict` | **Functions** | [ValueTypeDataTypeIntegerType](docs/v2/Functions/models/ValueTypeDataTypeIntegerType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeIntegerType` | -**Functions** | [ValueTypeDataTypeIntegerTypeDict](docs/v2/Functions/models/ValueTypeDataTypeIntegerTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeIntegerTypeDict` | **Functions** | [ValueTypeDataTypeLongType](docs/v2/Functions/models/ValueTypeDataTypeLongType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeLongType` | -**Functions** | [ValueTypeDataTypeLongTypeDict](docs/v2/Functions/models/ValueTypeDataTypeLongTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeLongTypeDict` | **Functions** | [ValueTypeDataTypeMapType](docs/v2/Functions/models/ValueTypeDataTypeMapType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeMapType` | -**Functions** | [ValueTypeDataTypeMapTypeDict](docs/v2/Functions/models/ValueTypeDataTypeMapTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeMapTypeDict` | **Functions** | [ValueTypeDataTypeOptionalType](docs/v2/Functions/models/ValueTypeDataTypeOptionalType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeOptionalType` | -**Functions** | [ValueTypeDataTypeOptionalTypeDict](docs/v2/Functions/models/ValueTypeDataTypeOptionalTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeOptionalTypeDict` | **Functions** | [ValueTypeDataTypeShortType](docs/v2/Functions/models/ValueTypeDataTypeShortType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeShortType` | -**Functions** | [ValueTypeDataTypeShortTypeDict](docs/v2/Functions/models/ValueTypeDataTypeShortTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeShortTypeDict` | **Functions** | [ValueTypeDataTypeStringType](docs/v2/Functions/models/ValueTypeDataTypeStringType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeStringType` | -**Functions** | [ValueTypeDataTypeStringTypeDict](docs/v2/Functions/models/ValueTypeDataTypeStringTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeStringTypeDict` | **Functions** | [ValueTypeDataTypeStructElement](docs/v2/Functions/models/ValueTypeDataTypeStructElement.md) | `from foundry.v2.functions.models import ValueTypeDataTypeStructElement` | -**Functions** | [ValueTypeDataTypeStructElementDict](docs/v2/Functions/models/ValueTypeDataTypeStructElementDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeStructElementDict` | **Functions** | [ValueTypeDataTypeStructFieldIdentifier](docs/v2/Functions/models/ValueTypeDataTypeStructFieldIdentifier.md) | `from foundry.v2.functions.models import ValueTypeDataTypeStructFieldIdentifier` | **Functions** | [ValueTypeDataTypeStructType](docs/v2/Functions/models/ValueTypeDataTypeStructType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeStructType` | -**Functions** | [ValueTypeDataTypeStructTypeDict](docs/v2/Functions/models/ValueTypeDataTypeStructTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeStructTypeDict` | **Functions** | [ValueTypeDataTypeTimestampType](docs/v2/Functions/models/ValueTypeDataTypeTimestampType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeTimestampType` | -**Functions** | [ValueTypeDataTypeTimestampTypeDict](docs/v2/Functions/models/ValueTypeDataTypeTimestampTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeTimestampTypeDict` | **Functions** | [ValueTypeDataTypeUnionType](docs/v2/Functions/models/ValueTypeDataTypeUnionType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeUnionType` | -**Functions** | [ValueTypeDataTypeUnionTypeDict](docs/v2/Functions/models/ValueTypeDataTypeUnionTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeUnionTypeDict` | **Functions** | [ValueTypeDataTypeValueTypeReference](docs/v2/Functions/models/ValueTypeDataTypeValueTypeReference.md) | `from foundry.v2.functions.models import ValueTypeDataTypeValueTypeReference` | -**Functions** | [ValueTypeDataTypeValueTypeReferenceDict](docs/v2/Functions/models/ValueTypeDataTypeValueTypeReferenceDict.md) | `from foundry.v2.functions.models import ValueTypeDataTypeValueTypeReferenceDict` | **Functions** | [ValueTypeDescription](docs/v2/Functions/models/ValueTypeDescription.md) | `from foundry.v2.functions.models import ValueTypeDescription` | -**Functions** | [ValueTypeDict](docs/v2/Functions/models/ValueTypeDict.md) | `from foundry.v2.functions.models import ValueTypeDict` | **Functions** | [ValueTypeReference](docs/v2/Functions/models/ValueTypeReference.md) | `from foundry.v2.functions.models import ValueTypeReference` | -**Functions** | [ValueTypeReferenceDict](docs/v2/Functions/models/ValueTypeReferenceDict.md) | `from foundry.v2.functions.models import ValueTypeReferenceDict` | **Functions** | [ValueTypeRid](docs/v2/Functions/models/ValueTypeRid.md) | `from foundry.v2.functions.models import ValueTypeRid` | **Functions** | [ValueTypeVersion](docs/v2/Functions/models/ValueTypeVersion.md) | `from foundry.v2.functions.models import ValueTypeVersion` | **Functions** | [ValueTypeVersionId](docs/v2/Functions/models/ValueTypeVersionId.md) | `from foundry.v2.functions.models import ValueTypeVersionId` | **Functions** | [VersionId](docs/v2/Functions/models/VersionId.md) | `from foundry.v2.functions.models import VersionId` | -**Functions** | [VersionIdDict](docs/v2/Functions/models/VersionIdDict.md) | `from foundry.v2.functions.models import VersionIdDict` | **Geo** | [BBox](docs/v2/Geo/models/BBox.md) | `from foundry.v2.geo.models import BBox` | **Geo** | [Coordinate](docs/v2/Geo/models/Coordinate.md) | `from foundry.v2.geo.models import Coordinate` | **Geo** | [Feature](docs/v2/Geo/models/Feature.md) | `from foundry.v2.geo.models import Feature` | **Geo** | [FeatureCollection](docs/v2/Geo/models/FeatureCollection.md) | `from foundry.v2.geo.models import FeatureCollection` | -**Geo** | [FeatureCollectionDict](docs/v2/Geo/models/FeatureCollectionDict.md) | `from foundry.v2.geo.models import FeatureCollectionDict` | **Geo** | [FeatureCollectionTypes](docs/v2/Geo/models/FeatureCollectionTypes.md) | `from foundry.v2.geo.models import FeatureCollectionTypes` | -**Geo** | [FeatureCollectionTypesDict](docs/v2/Geo/models/FeatureCollectionTypesDict.md) | `from foundry.v2.geo.models import FeatureCollectionTypesDict` | -**Geo** | [FeatureDict](docs/v2/Geo/models/FeatureDict.md) | `from foundry.v2.geo.models import FeatureDict` | **Geo** | [FeaturePropertyKey](docs/v2/Geo/models/FeaturePropertyKey.md) | `from foundry.v2.geo.models import FeaturePropertyKey` | **Geo** | [Geometry](docs/v2/Geo/models/Geometry.md) | `from foundry.v2.geo.models import Geometry` | **Geo** | [GeometryCollection](docs/v2/Geo/models/GeometryCollection.md) | `from foundry.v2.geo.models import GeometryCollection` | -**Geo** | [GeometryCollectionDict](docs/v2/Geo/models/GeometryCollectionDict.md) | `from foundry.v2.geo.models import GeometryCollectionDict` | -**Geo** | [GeometryDict](docs/v2/Geo/models/GeometryDict.md) | `from foundry.v2.geo.models import GeometryDict` | **Geo** | [GeoPoint](docs/v2/Geo/models/GeoPoint.md) | `from foundry.v2.geo.models import GeoPoint` | -**Geo** | [GeoPointDict](docs/v2/Geo/models/GeoPointDict.md) | `from foundry.v2.geo.models import GeoPointDict` | **Geo** | [LinearRing](docs/v2/Geo/models/LinearRing.md) | `from foundry.v2.geo.models import LinearRing` | **Geo** | [LineString](docs/v2/Geo/models/LineString.md) | `from foundry.v2.geo.models import LineString` | **Geo** | [LineStringCoordinates](docs/v2/Geo/models/LineStringCoordinates.md) | `from foundry.v2.geo.models import LineStringCoordinates` | -**Geo** | [LineStringDict](docs/v2/Geo/models/LineStringDict.md) | `from foundry.v2.geo.models import LineStringDict` | **Geo** | [MultiLineString](docs/v2/Geo/models/MultiLineString.md) | `from foundry.v2.geo.models import MultiLineString` | -**Geo** | [MultiLineStringDict](docs/v2/Geo/models/MultiLineStringDict.md) | `from foundry.v2.geo.models import MultiLineStringDict` | **Geo** | [MultiPoint](docs/v2/Geo/models/MultiPoint.md) | `from foundry.v2.geo.models import MultiPoint` | -**Geo** | [MultiPointDict](docs/v2/Geo/models/MultiPointDict.md) | `from foundry.v2.geo.models import MultiPointDict` | **Geo** | [MultiPolygon](docs/v2/Geo/models/MultiPolygon.md) | `from foundry.v2.geo.models import MultiPolygon` | -**Geo** | [MultiPolygonDict](docs/v2/Geo/models/MultiPolygonDict.md) | `from foundry.v2.geo.models import MultiPolygonDict` | **Geo** | [Polygon](docs/v2/Geo/models/Polygon.md) | `from foundry.v2.geo.models import Polygon` | -**Geo** | [PolygonDict](docs/v2/Geo/models/PolygonDict.md) | `from foundry.v2.geo.models import PolygonDict` | **Geo** | [Position](docs/v2/Geo/models/Position.md) | `from foundry.v2.geo.models import Position` | **MediaSets** | [BranchName](docs/v2/MediaSets/models/BranchName.md) | `from foundry.v2.media_sets.models import BranchName` | **MediaSets** | [BranchRid](docs/v2/MediaSets/models/BranchRid.md) | `from foundry.v2.media_sets.models import BranchRid` | **MediaSets** | [GetMediaItemInfoResponse](docs/v2/MediaSets/models/GetMediaItemInfoResponse.md) | `from foundry.v2.media_sets.models import GetMediaItemInfoResponse` | -**MediaSets** | [GetMediaItemInfoResponseDict](docs/v2/MediaSets/models/GetMediaItemInfoResponseDict.md) | `from foundry.v2.media_sets.models import GetMediaItemInfoResponseDict` | **MediaSets** | [LogicalTimestamp](docs/v2/MediaSets/models/LogicalTimestamp.md) | `from foundry.v2.media_sets.models import LogicalTimestamp` | **MediaSets** | [MediaAttribution](docs/v2/MediaSets/models/MediaAttribution.md) | `from foundry.v2.media_sets.models import MediaAttribution` | -**MediaSets** | [MediaAttributionDict](docs/v2/MediaSets/models/MediaAttributionDict.md) | `from foundry.v2.media_sets.models import MediaAttributionDict` | **MediaSets** | [PutMediaItemResponse](docs/v2/MediaSets/models/PutMediaItemResponse.md) | `from foundry.v2.media_sets.models import PutMediaItemResponse` | -**MediaSets** | [PutMediaItemResponseDict](docs/v2/MediaSets/models/PutMediaItemResponseDict.md) | `from foundry.v2.media_sets.models import PutMediaItemResponseDict` | **MediaSets** | [TransactionId](docs/v2/MediaSets/models/TransactionId.md) | `from foundry.v2.media_sets.models import TransactionId` | **Ontologies** | [AbsoluteTimeRange](docs/v2/Ontologies/models/AbsoluteTimeRange.md) | `from foundry.v2.ontologies.models import AbsoluteTimeRange` | -**Ontologies** | [AbsoluteTimeRangeDict](docs/v2/Ontologies/models/AbsoluteTimeRangeDict.md) | `from foundry.v2.ontologies.models import AbsoluteTimeRangeDict` | **Ontologies** | [AbsoluteValuePropertyExpression](docs/v2/Ontologies/models/AbsoluteValuePropertyExpression.md) | `from foundry.v2.ontologies.models import AbsoluteValuePropertyExpression` | -**Ontologies** | [AbsoluteValuePropertyExpressionDict](docs/v2/Ontologies/models/AbsoluteValuePropertyExpressionDict.md) | `from foundry.v2.ontologies.models import AbsoluteValuePropertyExpressionDict` | **Ontologies** | [ActionParameterArrayType](docs/v2/Ontologies/models/ActionParameterArrayType.md) | `from foundry.v2.ontologies.models import ActionParameterArrayType` | -**Ontologies** | [ActionParameterArrayTypeDict](docs/v2/Ontologies/models/ActionParameterArrayTypeDict.md) | `from foundry.v2.ontologies.models import ActionParameterArrayTypeDict` | **Ontologies** | [ActionParameterType](docs/v2/Ontologies/models/ActionParameterType.md) | `from foundry.v2.ontologies.models import ActionParameterType` | -**Ontologies** | [ActionParameterTypeDict](docs/v2/Ontologies/models/ActionParameterTypeDict.md) | `from foundry.v2.ontologies.models import ActionParameterTypeDict` | **Ontologies** | [ActionParameterV2](docs/v2/Ontologies/models/ActionParameterV2.md) | `from foundry.v2.ontologies.models import ActionParameterV2` | -**Ontologies** | [ActionParameterV2Dict](docs/v2/Ontologies/models/ActionParameterV2Dict.md) | `from foundry.v2.ontologies.models import ActionParameterV2Dict` | **Ontologies** | [ActionResults](docs/v2/Ontologies/models/ActionResults.md) | `from foundry.v2.ontologies.models import ActionResults` | -**Ontologies** | [ActionResultsDict](docs/v2/Ontologies/models/ActionResultsDict.md) | `from foundry.v2.ontologies.models import ActionResultsDict` | **Ontologies** | [ActionRid](docs/v2/Ontologies/models/ActionRid.md) | `from foundry.v2.ontologies.models import ActionRid` | **Ontologies** | [ActionTypeApiName](docs/v2/Ontologies/models/ActionTypeApiName.md) | `from foundry.v2.ontologies.models import ActionTypeApiName` | **Ontologies** | [ActionTypeRid](docs/v2/Ontologies/models/ActionTypeRid.md) | `from foundry.v2.ontologies.models import ActionTypeRid` | **Ontologies** | [ActionTypeV2](docs/v2/Ontologies/models/ActionTypeV2.md) | `from foundry.v2.ontologies.models import ActionTypeV2` | -**Ontologies** | [ActionTypeV2Dict](docs/v2/Ontologies/models/ActionTypeV2Dict.md) | `from foundry.v2.ontologies.models import ActionTypeV2Dict` | **Ontologies** | [ActivePropertyTypeStatus](docs/v2/Ontologies/models/ActivePropertyTypeStatus.md) | `from foundry.v2.ontologies.models import ActivePropertyTypeStatus` | -**Ontologies** | [ActivePropertyTypeStatusDict](docs/v2/Ontologies/models/ActivePropertyTypeStatusDict.md) | `from foundry.v2.ontologies.models import ActivePropertyTypeStatusDict` | **Ontologies** | [AddLink](docs/v2/Ontologies/models/AddLink.md) | `from foundry.v2.ontologies.models import AddLink` | -**Ontologies** | [AddLinkDict](docs/v2/Ontologies/models/AddLinkDict.md) | `from foundry.v2.ontologies.models import AddLinkDict` | **Ontologies** | [AddObject](docs/v2/Ontologies/models/AddObject.md) | `from foundry.v2.ontologies.models import AddObject` | -**Ontologies** | [AddObjectDict](docs/v2/Ontologies/models/AddObjectDict.md) | `from foundry.v2.ontologies.models import AddObjectDict` | **Ontologies** | [AddPropertyExpression](docs/v2/Ontologies/models/AddPropertyExpression.md) | `from foundry.v2.ontologies.models import AddPropertyExpression` | -**Ontologies** | [AddPropertyExpressionDict](docs/v2/Ontologies/models/AddPropertyExpressionDict.md) | `from foundry.v2.ontologies.models import AddPropertyExpressionDict` | **Ontologies** | [AggregateObjectsResponseItemV2](docs/v2/Ontologies/models/AggregateObjectsResponseItemV2.md) | `from foundry.v2.ontologies.models import AggregateObjectsResponseItemV2` | -**Ontologies** | [AggregateObjectsResponseItemV2Dict](docs/v2/Ontologies/models/AggregateObjectsResponseItemV2Dict.md) | `from foundry.v2.ontologies.models import AggregateObjectsResponseItemV2Dict` | **Ontologies** | [AggregateObjectsResponseV2](docs/v2/Ontologies/models/AggregateObjectsResponseV2.md) | `from foundry.v2.ontologies.models import AggregateObjectsResponseV2` | -**Ontologies** | [AggregateObjectsResponseV2Dict](docs/v2/Ontologies/models/AggregateObjectsResponseV2Dict.md) | `from foundry.v2.ontologies.models import AggregateObjectsResponseV2Dict` | **Ontologies** | [AggregateTimeSeries](docs/v2/Ontologies/models/AggregateTimeSeries.md) | `from foundry.v2.ontologies.models import AggregateTimeSeries` | -**Ontologies** | [AggregateTimeSeriesDict](docs/v2/Ontologies/models/AggregateTimeSeriesDict.md) | `from foundry.v2.ontologies.models import AggregateTimeSeriesDict` | **Ontologies** | [AggregationAccuracy](docs/v2/Ontologies/models/AggregationAccuracy.md) | `from foundry.v2.ontologies.models import AggregationAccuracy` | **Ontologies** | [AggregationAccuracyRequest](docs/v2/Ontologies/models/AggregationAccuracyRequest.md) | `from foundry.v2.ontologies.models import AggregationAccuracyRequest` | **Ontologies** | [AggregationDurationGroupingV2](docs/v2/Ontologies/models/AggregationDurationGroupingV2.md) | `from foundry.v2.ontologies.models import AggregationDurationGroupingV2` | -**Ontologies** | [AggregationDurationGroupingV2Dict](docs/v2/Ontologies/models/AggregationDurationGroupingV2Dict.md) | `from foundry.v2.ontologies.models import AggregationDurationGroupingV2Dict` | **Ontologies** | [AggregationExactGroupingV2](docs/v2/Ontologies/models/AggregationExactGroupingV2.md) | `from foundry.v2.ontologies.models import AggregationExactGroupingV2` | -**Ontologies** | [AggregationExactGroupingV2Dict](docs/v2/Ontologies/models/AggregationExactGroupingV2Dict.md) | `from foundry.v2.ontologies.models import AggregationExactGroupingV2Dict` | **Ontologies** | [AggregationFixedWidthGroupingV2](docs/v2/Ontologies/models/AggregationFixedWidthGroupingV2.md) | `from foundry.v2.ontologies.models import AggregationFixedWidthGroupingV2` | -**Ontologies** | [AggregationFixedWidthGroupingV2Dict](docs/v2/Ontologies/models/AggregationFixedWidthGroupingV2Dict.md) | `from foundry.v2.ontologies.models import AggregationFixedWidthGroupingV2Dict` | **Ontologies** | [AggregationGroupByV2](docs/v2/Ontologies/models/AggregationGroupByV2.md) | `from foundry.v2.ontologies.models import AggregationGroupByV2` | -**Ontologies** | [AggregationGroupByV2Dict](docs/v2/Ontologies/models/AggregationGroupByV2Dict.md) | `from foundry.v2.ontologies.models import AggregationGroupByV2Dict` | **Ontologies** | [AggregationGroupKeyV2](docs/v2/Ontologies/models/AggregationGroupKeyV2.md) | `from foundry.v2.ontologies.models import AggregationGroupKeyV2` | **Ontologies** | [AggregationGroupValueV2](docs/v2/Ontologies/models/AggregationGroupValueV2.md) | `from foundry.v2.ontologies.models import AggregationGroupValueV2` | **Ontologies** | [AggregationMetricName](docs/v2/Ontologies/models/AggregationMetricName.md) | `from foundry.v2.ontologies.models import AggregationMetricName` | **Ontologies** | [AggregationMetricResultV2](docs/v2/Ontologies/models/AggregationMetricResultV2.md) | `from foundry.v2.ontologies.models import AggregationMetricResultV2` | -**Ontologies** | [AggregationMetricResultV2Dict](docs/v2/Ontologies/models/AggregationMetricResultV2Dict.md) | `from foundry.v2.ontologies.models import AggregationMetricResultV2Dict` | **Ontologies** | [AggregationRangesGroupingV2](docs/v2/Ontologies/models/AggregationRangesGroupingV2.md) | `from foundry.v2.ontologies.models import AggregationRangesGroupingV2` | -**Ontologies** | [AggregationRangesGroupingV2Dict](docs/v2/Ontologies/models/AggregationRangesGroupingV2Dict.md) | `from foundry.v2.ontologies.models import AggregationRangesGroupingV2Dict` | **Ontologies** | [AggregationRangeV2](docs/v2/Ontologies/models/AggregationRangeV2.md) | `from foundry.v2.ontologies.models import AggregationRangeV2` | -**Ontologies** | [AggregationRangeV2Dict](docs/v2/Ontologies/models/AggregationRangeV2Dict.md) | `from foundry.v2.ontologies.models import AggregationRangeV2Dict` | **Ontologies** | [AggregationV2](docs/v2/Ontologies/models/AggregationV2.md) | `from foundry.v2.ontologies.models import AggregationV2` | -**Ontologies** | [AggregationV2Dict](docs/v2/Ontologies/models/AggregationV2Dict.md) | `from foundry.v2.ontologies.models import AggregationV2Dict` | **Ontologies** | [AndQueryV2](docs/v2/Ontologies/models/AndQueryV2.md) | `from foundry.v2.ontologies.models import AndQueryV2` | -**Ontologies** | [AndQueryV2Dict](docs/v2/Ontologies/models/AndQueryV2Dict.md) | `from foundry.v2.ontologies.models import AndQueryV2Dict` | **Ontologies** | [ApplyActionMode](docs/v2/Ontologies/models/ApplyActionMode.md) | `from foundry.v2.ontologies.models import ApplyActionMode` | **Ontologies** | [ApplyActionRequestOptions](docs/v2/Ontologies/models/ApplyActionRequestOptions.md) | `from foundry.v2.ontologies.models import ApplyActionRequestOptions` | -**Ontologies** | [ApplyActionRequestOptionsDict](docs/v2/Ontologies/models/ApplyActionRequestOptionsDict.md) | `from foundry.v2.ontologies.models import ApplyActionRequestOptionsDict` | **Ontologies** | [ApproximateDistinctAggregationV2](docs/v2/Ontologies/models/ApproximateDistinctAggregationV2.md) | `from foundry.v2.ontologies.models import ApproximateDistinctAggregationV2` | -**Ontologies** | [ApproximateDistinctAggregationV2Dict](docs/v2/Ontologies/models/ApproximateDistinctAggregationV2Dict.md) | `from foundry.v2.ontologies.models import ApproximateDistinctAggregationV2Dict` | **Ontologies** | [ApproximatePercentileAggregationV2](docs/v2/Ontologies/models/ApproximatePercentileAggregationV2.md) | `from foundry.v2.ontologies.models import ApproximatePercentileAggregationV2` | -**Ontologies** | [ApproximatePercentileAggregationV2Dict](docs/v2/Ontologies/models/ApproximatePercentileAggregationV2Dict.md) | `from foundry.v2.ontologies.models import ApproximatePercentileAggregationV2Dict` | **Ontologies** | [ArraySizeConstraint](docs/v2/Ontologies/models/ArraySizeConstraint.md) | `from foundry.v2.ontologies.models import ArraySizeConstraint` | -**Ontologies** | [ArraySizeConstraintDict](docs/v2/Ontologies/models/ArraySizeConstraintDict.md) | `from foundry.v2.ontologies.models import ArraySizeConstraintDict` | **Ontologies** | [ArtifactRepositoryRid](docs/v2/Ontologies/models/ArtifactRepositoryRid.md) | `from foundry.v2.ontologies.models import ArtifactRepositoryRid` | **Ontologies** | [AttachmentMetadataResponse](docs/v2/Ontologies/models/AttachmentMetadataResponse.md) | `from foundry.v2.ontologies.models import AttachmentMetadataResponse` | -**Ontologies** | [AttachmentMetadataResponseDict](docs/v2/Ontologies/models/AttachmentMetadataResponseDict.md) | `from foundry.v2.ontologies.models import AttachmentMetadataResponseDict` | **Ontologies** | [AttachmentRid](docs/v2/Ontologies/models/AttachmentRid.md) | `from foundry.v2.ontologies.models import AttachmentRid` | **Ontologies** | [AttachmentV2](docs/v2/Ontologies/models/AttachmentV2.md) | `from foundry.v2.ontologies.models import AttachmentV2` | -**Ontologies** | [AttachmentV2Dict](docs/v2/Ontologies/models/AttachmentV2Dict.md) | `from foundry.v2.ontologies.models import AttachmentV2Dict` | **Ontologies** | [AvgAggregationV2](docs/v2/Ontologies/models/AvgAggregationV2.md) | `from foundry.v2.ontologies.models import AvgAggregationV2` | -**Ontologies** | [AvgAggregationV2Dict](docs/v2/Ontologies/models/AvgAggregationV2Dict.md) | `from foundry.v2.ontologies.models import AvgAggregationV2Dict` | **Ontologies** | [BatchActionObjectEdit](docs/v2/Ontologies/models/BatchActionObjectEdit.md) | `from foundry.v2.ontologies.models import BatchActionObjectEdit` | -**Ontologies** | [BatchActionObjectEditDict](docs/v2/Ontologies/models/BatchActionObjectEditDict.md) | `from foundry.v2.ontologies.models import BatchActionObjectEditDict` | **Ontologies** | [BatchActionObjectEdits](docs/v2/Ontologies/models/BatchActionObjectEdits.md) | `from foundry.v2.ontologies.models import BatchActionObjectEdits` | -**Ontologies** | [BatchActionObjectEditsDict](docs/v2/Ontologies/models/BatchActionObjectEditsDict.md) | `from foundry.v2.ontologies.models import BatchActionObjectEditsDict` | **Ontologies** | [BatchActionResults](docs/v2/Ontologies/models/BatchActionResults.md) | `from foundry.v2.ontologies.models import BatchActionResults` | -**Ontologies** | [BatchActionResultsDict](docs/v2/Ontologies/models/BatchActionResultsDict.md) | `from foundry.v2.ontologies.models import BatchActionResultsDict` | **Ontologies** | [BatchApplyActionRequestItem](docs/v2/Ontologies/models/BatchApplyActionRequestItem.md) | `from foundry.v2.ontologies.models import BatchApplyActionRequestItem` | -**Ontologies** | [BatchApplyActionRequestItemDict](docs/v2/Ontologies/models/BatchApplyActionRequestItemDict.md) | `from foundry.v2.ontologies.models import BatchApplyActionRequestItemDict` | **Ontologies** | [BatchApplyActionRequestOptions](docs/v2/Ontologies/models/BatchApplyActionRequestOptions.md) | `from foundry.v2.ontologies.models import BatchApplyActionRequestOptions` | -**Ontologies** | [BatchApplyActionRequestOptionsDict](docs/v2/Ontologies/models/BatchApplyActionRequestOptionsDict.md) | `from foundry.v2.ontologies.models import BatchApplyActionRequestOptionsDict` | **Ontologies** | [BatchApplyActionResponseV2](docs/v2/Ontologies/models/BatchApplyActionResponseV2.md) | `from foundry.v2.ontologies.models import BatchApplyActionResponseV2` | -**Ontologies** | [BatchApplyActionResponseV2Dict](docs/v2/Ontologies/models/BatchApplyActionResponseV2Dict.md) | `from foundry.v2.ontologies.models import BatchApplyActionResponseV2Dict` | **Ontologies** | [BatchReturnEditsMode](docs/v2/Ontologies/models/BatchReturnEditsMode.md) | `from foundry.v2.ontologies.models import BatchReturnEditsMode` | **Ontologies** | [BlueprintIcon](docs/v2/Ontologies/models/BlueprintIcon.md) | `from foundry.v2.ontologies.models import BlueprintIcon` | -**Ontologies** | [BlueprintIconDict](docs/v2/Ontologies/models/BlueprintIconDict.md) | `from foundry.v2.ontologies.models import BlueprintIconDict` | **Ontologies** | [BoundingBoxValue](docs/v2/Ontologies/models/BoundingBoxValue.md) | `from foundry.v2.ontologies.models import BoundingBoxValue` | -**Ontologies** | [BoundingBoxValueDict](docs/v2/Ontologies/models/BoundingBoxValueDict.md) | `from foundry.v2.ontologies.models import BoundingBoxValueDict` | **Ontologies** | [CenterPoint](docs/v2/Ontologies/models/CenterPoint.md) | `from foundry.v2.ontologies.models import CenterPoint` | -**Ontologies** | [CenterPointDict](docs/v2/Ontologies/models/CenterPointDict.md) | `from foundry.v2.ontologies.models import CenterPointDict` | **Ontologies** | [CenterPointTypes](docs/v2/Ontologies/models/CenterPointTypes.md) | `from foundry.v2.ontologies.models import CenterPointTypes` | -**Ontologies** | [CenterPointTypesDict](docs/v2/Ontologies/models/CenterPointTypesDict.md) | `from foundry.v2.ontologies.models import CenterPointTypesDict` | **Ontologies** | [ContainsAllTermsInOrderPrefixLastTerm](docs/v2/Ontologies/models/ContainsAllTermsInOrderPrefixLastTerm.md) | `from foundry.v2.ontologies.models import ContainsAllTermsInOrderPrefixLastTerm` | -**Ontologies** | [ContainsAllTermsInOrderPrefixLastTermDict](docs/v2/Ontologies/models/ContainsAllTermsInOrderPrefixLastTermDict.md) | `from foundry.v2.ontologies.models import ContainsAllTermsInOrderPrefixLastTermDict` | **Ontologies** | [ContainsAllTermsInOrderQuery](docs/v2/Ontologies/models/ContainsAllTermsInOrderQuery.md) | `from foundry.v2.ontologies.models import ContainsAllTermsInOrderQuery` | -**Ontologies** | [ContainsAllTermsInOrderQueryDict](docs/v2/Ontologies/models/ContainsAllTermsInOrderQueryDict.md) | `from foundry.v2.ontologies.models import ContainsAllTermsInOrderQueryDict` | **Ontologies** | [ContainsAllTermsQuery](docs/v2/Ontologies/models/ContainsAllTermsQuery.md) | `from foundry.v2.ontologies.models import ContainsAllTermsQuery` | -**Ontologies** | [ContainsAllTermsQueryDict](docs/v2/Ontologies/models/ContainsAllTermsQueryDict.md) | `from foundry.v2.ontologies.models import ContainsAllTermsQueryDict` | **Ontologies** | [ContainsAnyTermQuery](docs/v2/Ontologies/models/ContainsAnyTermQuery.md) | `from foundry.v2.ontologies.models import ContainsAnyTermQuery` | -**Ontologies** | [ContainsAnyTermQueryDict](docs/v2/Ontologies/models/ContainsAnyTermQueryDict.md) | `from foundry.v2.ontologies.models import ContainsAnyTermQueryDict` | **Ontologies** | [ContainsQueryV2](docs/v2/Ontologies/models/ContainsQueryV2.md) | `from foundry.v2.ontologies.models import ContainsQueryV2` | -**Ontologies** | [ContainsQueryV2Dict](docs/v2/Ontologies/models/ContainsQueryV2Dict.md) | `from foundry.v2.ontologies.models import ContainsQueryV2Dict` | **Ontologies** | [CountAggregationV2](docs/v2/Ontologies/models/CountAggregationV2.md) | `from foundry.v2.ontologies.models import CountAggregationV2` | -**Ontologies** | [CountAggregationV2Dict](docs/v2/Ontologies/models/CountAggregationV2Dict.md) | `from foundry.v2.ontologies.models import CountAggregationV2Dict` | **Ontologies** | [CountObjectsResponseV2](docs/v2/Ontologies/models/CountObjectsResponseV2.md) | `from foundry.v2.ontologies.models import CountObjectsResponseV2` | -**Ontologies** | [CountObjectsResponseV2Dict](docs/v2/Ontologies/models/CountObjectsResponseV2Dict.md) | `from foundry.v2.ontologies.models import CountObjectsResponseV2Dict` | **Ontologies** | [CreateInterfaceObjectRule](docs/v2/Ontologies/models/CreateInterfaceObjectRule.md) | `from foundry.v2.ontologies.models import CreateInterfaceObjectRule` | -**Ontologies** | [CreateInterfaceObjectRuleDict](docs/v2/Ontologies/models/CreateInterfaceObjectRuleDict.md) | `from foundry.v2.ontologies.models import CreateInterfaceObjectRuleDict` | **Ontologies** | [CreateLinkRule](docs/v2/Ontologies/models/CreateLinkRule.md) | `from foundry.v2.ontologies.models import CreateLinkRule` | -**Ontologies** | [CreateLinkRuleDict](docs/v2/Ontologies/models/CreateLinkRuleDict.md) | `from foundry.v2.ontologies.models import CreateLinkRuleDict` | **Ontologies** | [CreateObjectRule](docs/v2/Ontologies/models/CreateObjectRule.md) | `from foundry.v2.ontologies.models import CreateObjectRule` | -**Ontologies** | [CreateObjectRuleDict](docs/v2/Ontologies/models/CreateObjectRuleDict.md) | `from foundry.v2.ontologies.models import CreateObjectRuleDict` | **Ontologies** | [CreateTemporaryObjectSetResponseV2](docs/v2/Ontologies/models/CreateTemporaryObjectSetResponseV2.md) | `from foundry.v2.ontologies.models import CreateTemporaryObjectSetResponseV2` | -**Ontologies** | [CreateTemporaryObjectSetResponseV2Dict](docs/v2/Ontologies/models/CreateTemporaryObjectSetResponseV2Dict.md) | `from foundry.v2.ontologies.models import CreateTemporaryObjectSetResponseV2Dict` | **Ontologies** | [DataValue](docs/v2/Ontologies/models/DataValue.md) | `from foundry.v2.ontologies.models import DataValue` | **Ontologies** | [DeleteInterfaceObjectRule](docs/v2/Ontologies/models/DeleteInterfaceObjectRule.md) | `from foundry.v2.ontologies.models import DeleteInterfaceObjectRule` | -**Ontologies** | [DeleteInterfaceObjectRuleDict](docs/v2/Ontologies/models/DeleteInterfaceObjectRuleDict.md) | `from foundry.v2.ontologies.models import DeleteInterfaceObjectRuleDict` | **Ontologies** | [DeleteLink](docs/v2/Ontologies/models/DeleteLink.md) | `from foundry.v2.ontologies.models import DeleteLink` | -**Ontologies** | [DeleteLinkDict](docs/v2/Ontologies/models/DeleteLinkDict.md) | `from foundry.v2.ontologies.models import DeleteLinkDict` | **Ontologies** | [DeleteLinkRule](docs/v2/Ontologies/models/DeleteLinkRule.md) | `from foundry.v2.ontologies.models import DeleteLinkRule` | -**Ontologies** | [DeleteLinkRuleDict](docs/v2/Ontologies/models/DeleteLinkRuleDict.md) | `from foundry.v2.ontologies.models import DeleteLinkRuleDict` | **Ontologies** | [DeleteObject](docs/v2/Ontologies/models/DeleteObject.md) | `from foundry.v2.ontologies.models import DeleteObject` | -**Ontologies** | [DeleteObjectDict](docs/v2/Ontologies/models/DeleteObjectDict.md) | `from foundry.v2.ontologies.models import DeleteObjectDict` | **Ontologies** | [DeleteObjectRule](docs/v2/Ontologies/models/DeleteObjectRule.md) | `from foundry.v2.ontologies.models import DeleteObjectRule` | -**Ontologies** | [DeleteObjectRuleDict](docs/v2/Ontologies/models/DeleteObjectRuleDict.md) | `from foundry.v2.ontologies.models import DeleteObjectRuleDict` | **Ontologies** | [DeprecatedPropertyTypeStatus](docs/v2/Ontologies/models/DeprecatedPropertyTypeStatus.md) | `from foundry.v2.ontologies.models import DeprecatedPropertyTypeStatus` | -**Ontologies** | [DeprecatedPropertyTypeStatusDict](docs/v2/Ontologies/models/DeprecatedPropertyTypeStatusDict.md) | `from foundry.v2.ontologies.models import DeprecatedPropertyTypeStatusDict` | **Ontologies** | [DerivedPropertyApiName](docs/v2/Ontologies/models/DerivedPropertyApiName.md) | `from foundry.v2.ontologies.models import DerivedPropertyApiName` | **Ontologies** | [DerivedPropertyDefinition](docs/v2/Ontologies/models/DerivedPropertyDefinition.md) | `from foundry.v2.ontologies.models import DerivedPropertyDefinition` | -**Ontologies** | [DerivedPropertyDefinitionDict](docs/v2/Ontologies/models/DerivedPropertyDefinitionDict.md) | `from foundry.v2.ontologies.models import DerivedPropertyDefinitionDict` | **Ontologies** | [DividePropertyExpression](docs/v2/Ontologies/models/DividePropertyExpression.md) | `from foundry.v2.ontologies.models import DividePropertyExpression` | -**Ontologies** | [DividePropertyExpressionDict](docs/v2/Ontologies/models/DividePropertyExpressionDict.md) | `from foundry.v2.ontologies.models import DividePropertyExpressionDict` | **Ontologies** | [DoesNotIntersectBoundingBoxQuery](docs/v2/Ontologies/models/DoesNotIntersectBoundingBoxQuery.md) | `from foundry.v2.ontologies.models import DoesNotIntersectBoundingBoxQuery` | -**Ontologies** | [DoesNotIntersectBoundingBoxQueryDict](docs/v2/Ontologies/models/DoesNotIntersectBoundingBoxQueryDict.md) | `from foundry.v2.ontologies.models import DoesNotIntersectBoundingBoxQueryDict` | **Ontologies** | [DoesNotIntersectPolygonQuery](docs/v2/Ontologies/models/DoesNotIntersectPolygonQuery.md) | `from foundry.v2.ontologies.models import DoesNotIntersectPolygonQuery` | -**Ontologies** | [DoesNotIntersectPolygonQueryDict](docs/v2/Ontologies/models/DoesNotIntersectPolygonQueryDict.md) | `from foundry.v2.ontologies.models import DoesNotIntersectPolygonQueryDict` | **Ontologies** | [DoubleVector](docs/v2/Ontologies/models/DoubleVector.md) | `from foundry.v2.ontologies.models import DoubleVector` | -**Ontologies** | [DoubleVectorDict](docs/v2/Ontologies/models/DoubleVectorDict.md) | `from foundry.v2.ontologies.models import DoubleVectorDict` | **Ontologies** | [EntrySetType](docs/v2/Ontologies/models/EntrySetType.md) | `from foundry.v2.ontologies.models import EntrySetType` | -**Ontologies** | [EntrySetTypeDict](docs/v2/Ontologies/models/EntrySetTypeDict.md) | `from foundry.v2.ontologies.models import EntrySetTypeDict` | **Ontologies** | [EqualsQueryV2](docs/v2/Ontologies/models/EqualsQueryV2.md) | `from foundry.v2.ontologies.models import EqualsQueryV2` | -**Ontologies** | [EqualsQueryV2Dict](docs/v2/Ontologies/models/EqualsQueryV2Dict.md) | `from foundry.v2.ontologies.models import EqualsQueryV2Dict` | **Ontologies** | [ExactDistinctAggregationV2](docs/v2/Ontologies/models/ExactDistinctAggregationV2.md) | `from foundry.v2.ontologies.models import ExactDistinctAggregationV2` | -**Ontologies** | [ExactDistinctAggregationV2Dict](docs/v2/Ontologies/models/ExactDistinctAggregationV2Dict.md) | `from foundry.v2.ontologies.models import ExactDistinctAggregationV2Dict` | **Ontologies** | [ExamplePropertyTypeStatus](docs/v2/Ontologies/models/ExamplePropertyTypeStatus.md) | `from foundry.v2.ontologies.models import ExamplePropertyTypeStatus` | -**Ontologies** | [ExamplePropertyTypeStatusDict](docs/v2/Ontologies/models/ExamplePropertyTypeStatusDict.md) | `from foundry.v2.ontologies.models import ExamplePropertyTypeStatusDict` | **Ontologies** | [ExecuteQueryResponse](docs/v2/Ontologies/models/ExecuteQueryResponse.md) | `from foundry.v2.ontologies.models import ExecuteQueryResponse` | -**Ontologies** | [ExecuteQueryResponseDict](docs/v2/Ontologies/models/ExecuteQueryResponseDict.md) | `from foundry.v2.ontologies.models import ExecuteQueryResponseDict` | **Ontologies** | [ExperimentalPropertyTypeStatus](docs/v2/Ontologies/models/ExperimentalPropertyTypeStatus.md) | `from foundry.v2.ontologies.models import ExperimentalPropertyTypeStatus` | -**Ontologies** | [ExperimentalPropertyTypeStatusDict](docs/v2/Ontologies/models/ExperimentalPropertyTypeStatusDict.md) | `from foundry.v2.ontologies.models import ExperimentalPropertyTypeStatusDict` | **Ontologies** | [ExtractDatePart](docs/v2/Ontologies/models/ExtractDatePart.md) | `from foundry.v2.ontologies.models import ExtractDatePart` | **Ontologies** | [ExtractPropertyExpression](docs/v2/Ontologies/models/ExtractPropertyExpression.md) | `from foundry.v2.ontologies.models import ExtractPropertyExpression` | -**Ontologies** | [ExtractPropertyExpressionDict](docs/v2/Ontologies/models/ExtractPropertyExpressionDict.md) | `from foundry.v2.ontologies.models import ExtractPropertyExpressionDict` | **Ontologies** | [FilterValue](docs/v2/Ontologies/models/FilterValue.md) | `from foundry.v2.ontologies.models import FilterValue` | **Ontologies** | [FunctionRid](docs/v2/Ontologies/models/FunctionRid.md) | `from foundry.v2.ontologies.models import FunctionRid` | **Ontologies** | [FunctionVersion](docs/v2/Ontologies/models/FunctionVersion.md) | `from foundry.v2.ontologies.models import FunctionVersion` | **Ontologies** | [FuzzyV2](docs/v2/Ontologies/models/FuzzyV2.md) | `from foundry.v2.ontologies.models import FuzzyV2` | **Ontologies** | [GetSelectedPropertyOperation](docs/v2/Ontologies/models/GetSelectedPropertyOperation.md) | `from foundry.v2.ontologies.models import GetSelectedPropertyOperation` | -**Ontologies** | [GetSelectedPropertyOperationDict](docs/v2/Ontologies/models/GetSelectedPropertyOperationDict.md) | `from foundry.v2.ontologies.models import GetSelectedPropertyOperationDict` | **Ontologies** | [GreatestPropertyExpression](docs/v2/Ontologies/models/GreatestPropertyExpression.md) | `from foundry.v2.ontologies.models import GreatestPropertyExpression` | -**Ontologies** | [GreatestPropertyExpressionDict](docs/v2/Ontologies/models/GreatestPropertyExpressionDict.md) | `from foundry.v2.ontologies.models import GreatestPropertyExpressionDict` | **Ontologies** | [GroupMemberConstraint](docs/v2/Ontologies/models/GroupMemberConstraint.md) | `from foundry.v2.ontologies.models import GroupMemberConstraint` | -**Ontologies** | [GroupMemberConstraintDict](docs/v2/Ontologies/models/GroupMemberConstraintDict.md) | `from foundry.v2.ontologies.models import GroupMemberConstraintDict` | **Ontologies** | [GteQueryV2](docs/v2/Ontologies/models/GteQueryV2.md) | `from foundry.v2.ontologies.models import GteQueryV2` | -**Ontologies** | [GteQueryV2Dict](docs/v2/Ontologies/models/GteQueryV2Dict.md) | `from foundry.v2.ontologies.models import GteQueryV2Dict` | **Ontologies** | [GtQueryV2](docs/v2/Ontologies/models/GtQueryV2.md) | `from foundry.v2.ontologies.models import GtQueryV2` | -**Ontologies** | [GtQueryV2Dict](docs/v2/Ontologies/models/GtQueryV2Dict.md) | `from foundry.v2.ontologies.models import GtQueryV2Dict` | **Ontologies** | [Icon](docs/v2/Ontologies/models/Icon.md) | `from foundry.v2.ontologies.models import Icon` | -**Ontologies** | [IconDict](docs/v2/Ontologies/models/IconDict.md) | `from foundry.v2.ontologies.models import IconDict` | **Ontologies** | [InQuery](docs/v2/Ontologies/models/InQuery.md) | `from foundry.v2.ontologies.models import InQuery` | -**Ontologies** | [InQueryDict](docs/v2/Ontologies/models/InQueryDict.md) | `from foundry.v2.ontologies.models import InQueryDict` | **Ontologies** | [InterfaceLinkType](docs/v2/Ontologies/models/InterfaceLinkType.md) | `from foundry.v2.ontologies.models import InterfaceLinkType` | **Ontologies** | [InterfaceLinkTypeApiName](docs/v2/Ontologies/models/InterfaceLinkTypeApiName.md) | `from foundry.v2.ontologies.models import InterfaceLinkTypeApiName` | **Ontologies** | [InterfaceLinkTypeCardinality](docs/v2/Ontologies/models/InterfaceLinkTypeCardinality.md) | `from foundry.v2.ontologies.models import InterfaceLinkTypeCardinality` | -**Ontologies** | [InterfaceLinkTypeDict](docs/v2/Ontologies/models/InterfaceLinkTypeDict.md) | `from foundry.v2.ontologies.models import InterfaceLinkTypeDict` | **Ontologies** | [InterfaceLinkTypeLinkedEntityApiName](docs/v2/Ontologies/models/InterfaceLinkTypeLinkedEntityApiName.md) | `from foundry.v2.ontologies.models import InterfaceLinkTypeLinkedEntityApiName` | -**Ontologies** | [InterfaceLinkTypeLinkedEntityApiNameDict](docs/v2/Ontologies/models/InterfaceLinkTypeLinkedEntityApiNameDict.md) | `from foundry.v2.ontologies.models import InterfaceLinkTypeLinkedEntityApiNameDict` | **Ontologies** | [InterfaceLinkTypeRid](docs/v2/Ontologies/models/InterfaceLinkTypeRid.md) | `from foundry.v2.ontologies.models import InterfaceLinkTypeRid` | **Ontologies** | [InterfaceSharedPropertyType](docs/v2/Ontologies/models/InterfaceSharedPropertyType.md) | `from foundry.v2.ontologies.models import InterfaceSharedPropertyType` | -**Ontologies** | [InterfaceSharedPropertyTypeDict](docs/v2/Ontologies/models/InterfaceSharedPropertyTypeDict.md) | `from foundry.v2.ontologies.models import InterfaceSharedPropertyTypeDict` | **Ontologies** | [InterfaceToObjectTypeMapping](docs/v2/Ontologies/models/InterfaceToObjectTypeMapping.md) | `from foundry.v2.ontologies.models import InterfaceToObjectTypeMapping` | **Ontologies** | [InterfaceToObjectTypeMappings](docs/v2/Ontologies/models/InterfaceToObjectTypeMappings.md) | `from foundry.v2.ontologies.models import InterfaceToObjectTypeMappings` | **Ontologies** | [InterfaceType](docs/v2/Ontologies/models/InterfaceType.md) | `from foundry.v2.ontologies.models import InterfaceType` | **Ontologies** | [InterfaceTypeApiName](docs/v2/Ontologies/models/InterfaceTypeApiName.md) | `from foundry.v2.ontologies.models import InterfaceTypeApiName` | -**Ontologies** | [InterfaceTypeDict](docs/v2/Ontologies/models/InterfaceTypeDict.md) | `from foundry.v2.ontologies.models import InterfaceTypeDict` | **Ontologies** | [InterfaceTypeRid](docs/v2/Ontologies/models/InterfaceTypeRid.md) | `from foundry.v2.ontologies.models import InterfaceTypeRid` | **Ontologies** | [IntersectsBoundingBoxQuery](docs/v2/Ontologies/models/IntersectsBoundingBoxQuery.md) | `from foundry.v2.ontologies.models import IntersectsBoundingBoxQuery` | -**Ontologies** | [IntersectsBoundingBoxQueryDict](docs/v2/Ontologies/models/IntersectsBoundingBoxQueryDict.md) | `from foundry.v2.ontologies.models import IntersectsBoundingBoxQueryDict` | **Ontologies** | [IntersectsPolygonQuery](docs/v2/Ontologies/models/IntersectsPolygonQuery.md) | `from foundry.v2.ontologies.models import IntersectsPolygonQuery` | -**Ontologies** | [IntersectsPolygonQueryDict](docs/v2/Ontologies/models/IntersectsPolygonQueryDict.md) | `from foundry.v2.ontologies.models import IntersectsPolygonQueryDict` | **Ontologies** | [IsNullQueryV2](docs/v2/Ontologies/models/IsNullQueryV2.md) | `from foundry.v2.ontologies.models import IsNullQueryV2` | -**Ontologies** | [IsNullQueryV2Dict](docs/v2/Ontologies/models/IsNullQueryV2Dict.md) | `from foundry.v2.ontologies.models import IsNullQueryV2Dict` | **Ontologies** | [LeastPropertyExpression](docs/v2/Ontologies/models/LeastPropertyExpression.md) | `from foundry.v2.ontologies.models import LeastPropertyExpression` | -**Ontologies** | [LeastPropertyExpressionDict](docs/v2/Ontologies/models/LeastPropertyExpressionDict.md) | `from foundry.v2.ontologies.models import LeastPropertyExpressionDict` | **Ontologies** | [LinkedInterfaceTypeApiName](docs/v2/Ontologies/models/LinkedInterfaceTypeApiName.md) | `from foundry.v2.ontologies.models import LinkedInterfaceTypeApiName` | -**Ontologies** | [LinkedInterfaceTypeApiNameDict](docs/v2/Ontologies/models/LinkedInterfaceTypeApiNameDict.md) | `from foundry.v2.ontologies.models import LinkedInterfaceTypeApiNameDict` | **Ontologies** | [LinkedObjectTypeApiName](docs/v2/Ontologies/models/LinkedObjectTypeApiName.md) | `from foundry.v2.ontologies.models import LinkedObjectTypeApiName` | -**Ontologies** | [LinkedObjectTypeApiNameDict](docs/v2/Ontologies/models/LinkedObjectTypeApiNameDict.md) | `from foundry.v2.ontologies.models import LinkedObjectTypeApiNameDict` | **Ontologies** | [LinkSideObject](docs/v2/Ontologies/models/LinkSideObject.md) | `from foundry.v2.ontologies.models import LinkSideObject` | -**Ontologies** | [LinkSideObjectDict](docs/v2/Ontologies/models/LinkSideObjectDict.md) | `from foundry.v2.ontologies.models import LinkSideObjectDict` | **Ontologies** | [LinkTypeApiName](docs/v2/Ontologies/models/LinkTypeApiName.md) | `from foundry.v2.ontologies.models import LinkTypeApiName` | **Ontologies** | [LinkTypeRid](docs/v2/Ontologies/models/LinkTypeRid.md) | `from foundry.v2.ontologies.models import LinkTypeRid` | **Ontologies** | [LinkTypeSideCardinality](docs/v2/Ontologies/models/LinkTypeSideCardinality.md) | `from foundry.v2.ontologies.models import LinkTypeSideCardinality` | **Ontologies** | [LinkTypeSideV2](docs/v2/Ontologies/models/LinkTypeSideV2.md) | `from foundry.v2.ontologies.models import LinkTypeSideV2` | -**Ontologies** | [LinkTypeSideV2Dict](docs/v2/Ontologies/models/LinkTypeSideV2Dict.md) | `from foundry.v2.ontologies.models import LinkTypeSideV2Dict` | **Ontologies** | [ListActionTypesResponseV2](docs/v2/Ontologies/models/ListActionTypesResponseV2.md) | `from foundry.v2.ontologies.models import ListActionTypesResponseV2` | -**Ontologies** | [ListActionTypesResponseV2Dict](docs/v2/Ontologies/models/ListActionTypesResponseV2Dict.md) | `from foundry.v2.ontologies.models import ListActionTypesResponseV2Dict` | **Ontologies** | [ListAttachmentsResponseV2](docs/v2/Ontologies/models/ListAttachmentsResponseV2.md) | `from foundry.v2.ontologies.models import ListAttachmentsResponseV2` | -**Ontologies** | [ListAttachmentsResponseV2Dict](docs/v2/Ontologies/models/ListAttachmentsResponseV2Dict.md) | `from foundry.v2.ontologies.models import ListAttachmentsResponseV2Dict` | **Ontologies** | [ListInterfaceTypesResponse](docs/v2/Ontologies/models/ListInterfaceTypesResponse.md) | `from foundry.v2.ontologies.models import ListInterfaceTypesResponse` | -**Ontologies** | [ListInterfaceTypesResponseDict](docs/v2/Ontologies/models/ListInterfaceTypesResponseDict.md) | `from foundry.v2.ontologies.models import ListInterfaceTypesResponseDict` | **Ontologies** | [ListLinkedObjectsResponseV2](docs/v2/Ontologies/models/ListLinkedObjectsResponseV2.md) | `from foundry.v2.ontologies.models import ListLinkedObjectsResponseV2` | -**Ontologies** | [ListLinkedObjectsResponseV2Dict](docs/v2/Ontologies/models/ListLinkedObjectsResponseV2Dict.md) | `from foundry.v2.ontologies.models import ListLinkedObjectsResponseV2Dict` | **Ontologies** | [ListObjectsResponseV2](docs/v2/Ontologies/models/ListObjectsResponseV2.md) | `from foundry.v2.ontologies.models import ListObjectsResponseV2` | -**Ontologies** | [ListObjectsResponseV2Dict](docs/v2/Ontologies/models/ListObjectsResponseV2Dict.md) | `from foundry.v2.ontologies.models import ListObjectsResponseV2Dict` | **Ontologies** | [ListObjectTypesV2Response](docs/v2/Ontologies/models/ListObjectTypesV2Response.md) | `from foundry.v2.ontologies.models import ListObjectTypesV2Response` | -**Ontologies** | [ListObjectTypesV2ResponseDict](docs/v2/Ontologies/models/ListObjectTypesV2ResponseDict.md) | `from foundry.v2.ontologies.models import ListObjectTypesV2ResponseDict` | **Ontologies** | [ListOntologiesV2Response](docs/v2/Ontologies/models/ListOntologiesV2Response.md) | `from foundry.v2.ontologies.models import ListOntologiesV2Response` | -**Ontologies** | [ListOntologiesV2ResponseDict](docs/v2/Ontologies/models/ListOntologiesV2ResponseDict.md) | `from foundry.v2.ontologies.models import ListOntologiesV2ResponseDict` | **Ontologies** | [ListOutgoingLinkTypesResponseV2](docs/v2/Ontologies/models/ListOutgoingLinkTypesResponseV2.md) | `from foundry.v2.ontologies.models import ListOutgoingLinkTypesResponseV2` | -**Ontologies** | [ListOutgoingLinkTypesResponseV2Dict](docs/v2/Ontologies/models/ListOutgoingLinkTypesResponseV2Dict.md) | `from foundry.v2.ontologies.models import ListOutgoingLinkTypesResponseV2Dict` | **Ontologies** | [ListQueryTypesResponseV2](docs/v2/Ontologies/models/ListQueryTypesResponseV2.md) | `from foundry.v2.ontologies.models import ListQueryTypesResponseV2` | -**Ontologies** | [ListQueryTypesResponseV2Dict](docs/v2/Ontologies/models/ListQueryTypesResponseV2Dict.md) | `from foundry.v2.ontologies.models import ListQueryTypesResponseV2Dict` | **Ontologies** | [LoadObjectSetResponseV2](docs/v2/Ontologies/models/LoadObjectSetResponseV2.md) | `from foundry.v2.ontologies.models import LoadObjectSetResponseV2` | -**Ontologies** | [LoadObjectSetResponseV2Dict](docs/v2/Ontologies/models/LoadObjectSetResponseV2Dict.md) | `from foundry.v2.ontologies.models import LoadObjectSetResponseV2Dict` | **Ontologies** | [LoadObjectSetV2MultipleObjectTypesResponse](docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponse.md) | `from foundry.v2.ontologies.models import LoadObjectSetV2MultipleObjectTypesResponse` | -**Ontologies** | [LoadObjectSetV2MultipleObjectTypesResponseDict](docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponseDict.md) | `from foundry.v2.ontologies.models import LoadObjectSetV2MultipleObjectTypesResponseDict` | **Ontologies** | [LoadObjectSetV2ObjectsOrInterfacesResponse](docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesResponse.md) | `from foundry.v2.ontologies.models import LoadObjectSetV2ObjectsOrInterfacesResponse` | -**Ontologies** | [LoadObjectSetV2ObjectsOrInterfacesResponseDict](docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesResponseDict.md) | `from foundry.v2.ontologies.models import LoadObjectSetV2ObjectsOrInterfacesResponseDict` | **Ontologies** | [LogicRule](docs/v2/Ontologies/models/LogicRule.md) | `from foundry.v2.ontologies.models import LogicRule` | -**Ontologies** | [LogicRuleDict](docs/v2/Ontologies/models/LogicRuleDict.md) | `from foundry.v2.ontologies.models import LogicRuleDict` | **Ontologies** | [LteQueryV2](docs/v2/Ontologies/models/LteQueryV2.md) | `from foundry.v2.ontologies.models import LteQueryV2` | -**Ontologies** | [LteQueryV2Dict](docs/v2/Ontologies/models/LteQueryV2Dict.md) | `from foundry.v2.ontologies.models import LteQueryV2Dict` | **Ontologies** | [LtQueryV2](docs/v2/Ontologies/models/LtQueryV2.md) | `from foundry.v2.ontologies.models import LtQueryV2` | -**Ontologies** | [LtQueryV2Dict](docs/v2/Ontologies/models/LtQueryV2Dict.md) | `from foundry.v2.ontologies.models import LtQueryV2Dict` | **Ontologies** | [MaxAggregationV2](docs/v2/Ontologies/models/MaxAggregationV2.md) | `from foundry.v2.ontologies.models import MaxAggregationV2` | -**Ontologies** | [MaxAggregationV2Dict](docs/v2/Ontologies/models/MaxAggregationV2Dict.md) | `from foundry.v2.ontologies.models import MaxAggregationV2Dict` | **Ontologies** | [MediaMetadata](docs/v2/Ontologies/models/MediaMetadata.md) | `from foundry.v2.ontologies.models import MediaMetadata` | -**Ontologies** | [MediaMetadataDict](docs/v2/Ontologies/models/MediaMetadataDict.md) | `from foundry.v2.ontologies.models import MediaMetadataDict` | **Ontologies** | [MethodObjectSet](docs/v2/Ontologies/models/MethodObjectSet.md) | `from foundry.v2.ontologies.models import MethodObjectSet` | -**Ontologies** | [MethodObjectSetDict](docs/v2/Ontologies/models/MethodObjectSetDict.md) | `from foundry.v2.ontologies.models import MethodObjectSetDict` | **Ontologies** | [MinAggregationV2](docs/v2/Ontologies/models/MinAggregationV2.md) | `from foundry.v2.ontologies.models import MinAggregationV2` | -**Ontologies** | [MinAggregationV2Dict](docs/v2/Ontologies/models/MinAggregationV2Dict.md) | `from foundry.v2.ontologies.models import MinAggregationV2Dict` | **Ontologies** | [ModifyInterfaceObjectRule](docs/v2/Ontologies/models/ModifyInterfaceObjectRule.md) | `from foundry.v2.ontologies.models import ModifyInterfaceObjectRule` | -**Ontologies** | [ModifyInterfaceObjectRuleDict](docs/v2/Ontologies/models/ModifyInterfaceObjectRuleDict.md) | `from foundry.v2.ontologies.models import ModifyInterfaceObjectRuleDict` | **Ontologies** | [ModifyObject](docs/v2/Ontologies/models/ModifyObject.md) | `from foundry.v2.ontologies.models import ModifyObject` | -**Ontologies** | [ModifyObjectDict](docs/v2/Ontologies/models/ModifyObjectDict.md) | `from foundry.v2.ontologies.models import ModifyObjectDict` | **Ontologies** | [ModifyObjectRule](docs/v2/Ontologies/models/ModifyObjectRule.md) | `from foundry.v2.ontologies.models import ModifyObjectRule` | -**Ontologies** | [ModifyObjectRuleDict](docs/v2/Ontologies/models/ModifyObjectRuleDict.md) | `from foundry.v2.ontologies.models import ModifyObjectRuleDict` | **Ontologies** | [MultiplyPropertyExpression](docs/v2/Ontologies/models/MultiplyPropertyExpression.md) | `from foundry.v2.ontologies.models import MultiplyPropertyExpression` | -**Ontologies** | [MultiplyPropertyExpressionDict](docs/v2/Ontologies/models/MultiplyPropertyExpressionDict.md) | `from foundry.v2.ontologies.models import MultiplyPropertyExpressionDict` | **Ontologies** | [NearestNeighborsQuery](docs/v2/Ontologies/models/NearestNeighborsQuery.md) | `from foundry.v2.ontologies.models import NearestNeighborsQuery` | -**Ontologies** | [NearestNeighborsQueryDict](docs/v2/Ontologies/models/NearestNeighborsQueryDict.md) | `from foundry.v2.ontologies.models import NearestNeighborsQueryDict` | **Ontologies** | [NearestNeighborsQueryText](docs/v2/Ontologies/models/NearestNeighborsQueryText.md) | `from foundry.v2.ontologies.models import NearestNeighborsQueryText` | -**Ontologies** | [NearestNeighborsQueryTextDict](docs/v2/Ontologies/models/NearestNeighborsQueryTextDict.md) | `from foundry.v2.ontologies.models import NearestNeighborsQueryTextDict` | **Ontologies** | [NegatePropertyExpression](docs/v2/Ontologies/models/NegatePropertyExpression.md) | `from foundry.v2.ontologies.models import NegatePropertyExpression` | -**Ontologies** | [NegatePropertyExpressionDict](docs/v2/Ontologies/models/NegatePropertyExpressionDict.md) | `from foundry.v2.ontologies.models import NegatePropertyExpressionDict` | **Ontologies** | [NotQueryV2](docs/v2/Ontologies/models/NotQueryV2.md) | `from foundry.v2.ontologies.models import NotQueryV2` | -**Ontologies** | [NotQueryV2Dict](docs/v2/Ontologies/models/NotQueryV2Dict.md) | `from foundry.v2.ontologies.models import NotQueryV2Dict` | **Ontologies** | [ObjectEdit](docs/v2/Ontologies/models/ObjectEdit.md) | `from foundry.v2.ontologies.models import ObjectEdit` | -**Ontologies** | [ObjectEditDict](docs/v2/Ontologies/models/ObjectEditDict.md) | `from foundry.v2.ontologies.models import ObjectEditDict` | **Ontologies** | [ObjectEdits](docs/v2/Ontologies/models/ObjectEdits.md) | `from foundry.v2.ontologies.models import ObjectEdits` | -**Ontologies** | [ObjectEditsDict](docs/v2/Ontologies/models/ObjectEditsDict.md) | `from foundry.v2.ontologies.models import ObjectEditsDict` | **Ontologies** | [ObjectPropertyType](docs/v2/Ontologies/models/ObjectPropertyType.md) | `from foundry.v2.ontologies.models import ObjectPropertyType` | -**Ontologies** | [ObjectPropertyTypeDict](docs/v2/Ontologies/models/ObjectPropertyTypeDict.md) | `from foundry.v2.ontologies.models import ObjectPropertyTypeDict` | **Ontologies** | [ObjectPropertyValueConstraint](docs/v2/Ontologies/models/ObjectPropertyValueConstraint.md) | `from foundry.v2.ontologies.models import ObjectPropertyValueConstraint` | -**Ontologies** | [ObjectPropertyValueConstraintDict](docs/v2/Ontologies/models/ObjectPropertyValueConstraintDict.md) | `from foundry.v2.ontologies.models import ObjectPropertyValueConstraintDict` | **Ontologies** | [ObjectQueryResultConstraint](docs/v2/Ontologies/models/ObjectQueryResultConstraint.md) | `from foundry.v2.ontologies.models import ObjectQueryResultConstraint` | -**Ontologies** | [ObjectQueryResultConstraintDict](docs/v2/Ontologies/models/ObjectQueryResultConstraintDict.md) | `from foundry.v2.ontologies.models import ObjectQueryResultConstraintDict` | **Ontologies** | [ObjectRid](docs/v2/Ontologies/models/ObjectRid.md) | `from foundry.v2.ontologies.models import ObjectRid` | **Ontologies** | [ObjectSet](docs/v2/Ontologies/models/ObjectSet.md) | `from foundry.v2.ontologies.models import ObjectSet` | **Ontologies** | [ObjectSetAsBaseObjectTypesType](docs/v2/Ontologies/models/ObjectSetAsBaseObjectTypesType.md) | `from foundry.v2.ontologies.models import ObjectSetAsBaseObjectTypesType` | -**Ontologies** | [ObjectSetAsBaseObjectTypesTypeDict](docs/v2/Ontologies/models/ObjectSetAsBaseObjectTypesTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetAsBaseObjectTypesTypeDict` | **Ontologies** | [ObjectSetAsTypeType](docs/v2/Ontologies/models/ObjectSetAsTypeType.md) | `from foundry.v2.ontologies.models import ObjectSetAsTypeType` | -**Ontologies** | [ObjectSetAsTypeTypeDict](docs/v2/Ontologies/models/ObjectSetAsTypeTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetAsTypeTypeDict` | **Ontologies** | [ObjectSetBaseType](docs/v2/Ontologies/models/ObjectSetBaseType.md) | `from foundry.v2.ontologies.models import ObjectSetBaseType` | -**Ontologies** | [ObjectSetBaseTypeDict](docs/v2/Ontologies/models/ObjectSetBaseTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetBaseTypeDict` | -**Ontologies** | [ObjectSetDict](docs/v2/Ontologies/models/ObjectSetDict.md) | `from foundry.v2.ontologies.models import ObjectSetDict` | **Ontologies** | [ObjectSetFilterType](docs/v2/Ontologies/models/ObjectSetFilterType.md) | `from foundry.v2.ontologies.models import ObjectSetFilterType` | -**Ontologies** | [ObjectSetFilterTypeDict](docs/v2/Ontologies/models/ObjectSetFilterTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetFilterTypeDict` | **Ontologies** | [ObjectSetInterfaceBaseType](docs/v2/Ontologies/models/ObjectSetInterfaceBaseType.md) | `from foundry.v2.ontologies.models import ObjectSetInterfaceBaseType` | -**Ontologies** | [ObjectSetInterfaceBaseTypeDict](docs/v2/Ontologies/models/ObjectSetInterfaceBaseTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetInterfaceBaseTypeDict` | **Ontologies** | [ObjectSetIntersectionType](docs/v2/Ontologies/models/ObjectSetIntersectionType.md) | `from foundry.v2.ontologies.models import ObjectSetIntersectionType` | -**Ontologies** | [ObjectSetIntersectionTypeDict](docs/v2/Ontologies/models/ObjectSetIntersectionTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetIntersectionTypeDict` | **Ontologies** | [ObjectSetMethodInputType](docs/v2/Ontologies/models/ObjectSetMethodInputType.md) | `from foundry.v2.ontologies.models import ObjectSetMethodInputType` | -**Ontologies** | [ObjectSetMethodInputTypeDict](docs/v2/Ontologies/models/ObjectSetMethodInputTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetMethodInputTypeDict` | **Ontologies** | [ObjectSetNearestNeighborsType](docs/v2/Ontologies/models/ObjectSetNearestNeighborsType.md) | `from foundry.v2.ontologies.models import ObjectSetNearestNeighborsType` | -**Ontologies** | [ObjectSetNearestNeighborsTypeDict](docs/v2/Ontologies/models/ObjectSetNearestNeighborsTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetNearestNeighborsTypeDict` | **Ontologies** | [ObjectSetReferenceType](docs/v2/Ontologies/models/ObjectSetReferenceType.md) | `from foundry.v2.ontologies.models import ObjectSetReferenceType` | -**Ontologies** | [ObjectSetReferenceTypeDict](docs/v2/Ontologies/models/ObjectSetReferenceTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetReferenceTypeDict` | **Ontologies** | [ObjectSetRid](docs/v2/Ontologies/models/ObjectSetRid.md) | `from foundry.v2.ontologies.models import ObjectSetRid` | **Ontologies** | [ObjectSetSearchAroundType](docs/v2/Ontologies/models/ObjectSetSearchAroundType.md) | `from foundry.v2.ontologies.models import ObjectSetSearchAroundType` | -**Ontologies** | [ObjectSetSearchAroundTypeDict](docs/v2/Ontologies/models/ObjectSetSearchAroundTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetSearchAroundTypeDict` | **Ontologies** | [ObjectSetStaticType](docs/v2/Ontologies/models/ObjectSetStaticType.md) | `from foundry.v2.ontologies.models import ObjectSetStaticType` | -**Ontologies** | [ObjectSetStaticTypeDict](docs/v2/Ontologies/models/ObjectSetStaticTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetStaticTypeDict` | **Ontologies** | [ObjectSetSubtractType](docs/v2/Ontologies/models/ObjectSetSubtractType.md) | `from foundry.v2.ontologies.models import ObjectSetSubtractType` | -**Ontologies** | [ObjectSetSubtractTypeDict](docs/v2/Ontologies/models/ObjectSetSubtractTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetSubtractTypeDict` | **Ontologies** | [ObjectSetUnionType](docs/v2/Ontologies/models/ObjectSetUnionType.md) | `from foundry.v2.ontologies.models import ObjectSetUnionType` | -**Ontologies** | [ObjectSetUnionTypeDict](docs/v2/Ontologies/models/ObjectSetUnionTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetUnionTypeDict` | **Ontologies** | [ObjectSetWithPropertiesType](docs/v2/Ontologies/models/ObjectSetWithPropertiesType.md) | `from foundry.v2.ontologies.models import ObjectSetWithPropertiesType` | -**Ontologies** | [ObjectSetWithPropertiesTypeDict](docs/v2/Ontologies/models/ObjectSetWithPropertiesTypeDict.md) | `from foundry.v2.ontologies.models import ObjectSetWithPropertiesTypeDict` | **Ontologies** | [ObjectTypeApiName](docs/v2/Ontologies/models/ObjectTypeApiName.md) | `from foundry.v2.ontologies.models import ObjectTypeApiName` | **Ontologies** | [ObjectTypeEdits](docs/v2/Ontologies/models/ObjectTypeEdits.md) | `from foundry.v2.ontologies.models import ObjectTypeEdits` | -**Ontologies** | [ObjectTypeEditsDict](docs/v2/Ontologies/models/ObjectTypeEditsDict.md) | `from foundry.v2.ontologies.models import ObjectTypeEditsDict` | **Ontologies** | [ObjectTypeFullMetadata](docs/v2/Ontologies/models/ObjectTypeFullMetadata.md) | `from foundry.v2.ontologies.models import ObjectTypeFullMetadata` | -**Ontologies** | [ObjectTypeFullMetadataDict](docs/v2/Ontologies/models/ObjectTypeFullMetadataDict.md) | `from foundry.v2.ontologies.models import ObjectTypeFullMetadataDict` | **Ontologies** | [ObjectTypeId](docs/v2/Ontologies/models/ObjectTypeId.md) | `from foundry.v2.ontologies.models import ObjectTypeId` | **Ontologies** | [ObjectTypeInterfaceImplementation](docs/v2/Ontologies/models/ObjectTypeInterfaceImplementation.md) | `from foundry.v2.ontologies.models import ObjectTypeInterfaceImplementation` | -**Ontologies** | [ObjectTypeInterfaceImplementationDict](docs/v2/Ontologies/models/ObjectTypeInterfaceImplementationDict.md) | `from foundry.v2.ontologies.models import ObjectTypeInterfaceImplementationDict` | **Ontologies** | [ObjectTypeRid](docs/v2/Ontologies/models/ObjectTypeRid.md) | `from foundry.v2.ontologies.models import ObjectTypeRid` | **Ontologies** | [ObjectTypeV2](docs/v2/Ontologies/models/ObjectTypeV2.md) | `from foundry.v2.ontologies.models import ObjectTypeV2` | -**Ontologies** | [ObjectTypeV2Dict](docs/v2/Ontologies/models/ObjectTypeV2Dict.md) | `from foundry.v2.ontologies.models import ObjectTypeV2Dict` | **Ontologies** | [ObjectTypeVisibility](docs/v2/Ontologies/models/ObjectTypeVisibility.md) | `from foundry.v2.ontologies.models import ObjectTypeVisibility` | **Ontologies** | [OneOfConstraint](docs/v2/Ontologies/models/OneOfConstraint.md) | `from foundry.v2.ontologies.models import OneOfConstraint` | -**Ontologies** | [OneOfConstraintDict](docs/v2/Ontologies/models/OneOfConstraintDict.md) | `from foundry.v2.ontologies.models import OneOfConstraintDict` | **Ontologies** | [OntologyApiName](docs/v2/Ontologies/models/OntologyApiName.md) | `from foundry.v2.ontologies.models import OntologyApiName` | **Ontologies** | [OntologyArrayType](docs/v2/Ontologies/models/OntologyArrayType.md) | `from foundry.v2.ontologies.models import OntologyArrayType` | -**Ontologies** | [OntologyArrayTypeDict](docs/v2/Ontologies/models/OntologyArrayTypeDict.md) | `from foundry.v2.ontologies.models import OntologyArrayTypeDict` | **Ontologies** | [OntologyDataType](docs/v2/Ontologies/models/OntologyDataType.md) | `from foundry.v2.ontologies.models import OntologyDataType` | -**Ontologies** | [OntologyDataTypeDict](docs/v2/Ontologies/models/OntologyDataTypeDict.md) | `from foundry.v2.ontologies.models import OntologyDataTypeDict` | **Ontologies** | [OntologyFullMetadata](docs/v2/Ontologies/models/OntologyFullMetadata.md) | `from foundry.v2.ontologies.models import OntologyFullMetadata` | -**Ontologies** | [OntologyFullMetadataDict](docs/v2/Ontologies/models/OntologyFullMetadataDict.md) | `from foundry.v2.ontologies.models import OntologyFullMetadataDict` | **Ontologies** | [OntologyIdentifier](docs/v2/Ontologies/models/OntologyIdentifier.md) | `from foundry.v2.ontologies.models import OntologyIdentifier` | **Ontologies** | [OntologyInterfaceObjectType](docs/v2/Ontologies/models/OntologyInterfaceObjectType.md) | `from foundry.v2.ontologies.models import OntologyInterfaceObjectType` | -**Ontologies** | [OntologyInterfaceObjectTypeDict](docs/v2/Ontologies/models/OntologyInterfaceObjectTypeDict.md) | `from foundry.v2.ontologies.models import OntologyInterfaceObjectTypeDict` | **Ontologies** | [OntologyMapType](docs/v2/Ontologies/models/OntologyMapType.md) | `from foundry.v2.ontologies.models import OntologyMapType` | -**Ontologies** | [OntologyMapTypeDict](docs/v2/Ontologies/models/OntologyMapTypeDict.md) | `from foundry.v2.ontologies.models import OntologyMapTypeDict` | **Ontologies** | [OntologyObjectArrayType](docs/v2/Ontologies/models/OntologyObjectArrayType.md) | `from foundry.v2.ontologies.models import OntologyObjectArrayType` | -**Ontologies** | [OntologyObjectArrayTypeDict](docs/v2/Ontologies/models/OntologyObjectArrayTypeDict.md) | `from foundry.v2.ontologies.models import OntologyObjectArrayTypeDict` | **Ontologies** | [OntologyObjectSetType](docs/v2/Ontologies/models/OntologyObjectSetType.md) | `from foundry.v2.ontologies.models import OntologyObjectSetType` | -**Ontologies** | [OntologyObjectSetTypeDict](docs/v2/Ontologies/models/OntologyObjectSetTypeDict.md) | `from foundry.v2.ontologies.models import OntologyObjectSetTypeDict` | **Ontologies** | [OntologyObjectType](docs/v2/Ontologies/models/OntologyObjectType.md) | `from foundry.v2.ontologies.models import OntologyObjectType` | -**Ontologies** | [OntologyObjectTypeDict](docs/v2/Ontologies/models/OntologyObjectTypeDict.md) | `from foundry.v2.ontologies.models import OntologyObjectTypeDict` | **Ontologies** | [OntologyObjectTypeReferenceType](docs/v2/Ontologies/models/OntologyObjectTypeReferenceType.md) | `from foundry.v2.ontologies.models import OntologyObjectTypeReferenceType` | -**Ontologies** | [OntologyObjectTypeReferenceTypeDict](docs/v2/Ontologies/models/OntologyObjectTypeReferenceTypeDict.md) | `from foundry.v2.ontologies.models import OntologyObjectTypeReferenceTypeDict` | **Ontologies** | [OntologyObjectV2](docs/v2/Ontologies/models/OntologyObjectV2.md) | `from foundry.v2.ontologies.models import OntologyObjectV2` | **Ontologies** | [OntologyRid](docs/v2/Ontologies/models/OntologyRid.md) | `from foundry.v2.ontologies.models import OntologyRid` | **Ontologies** | [OntologySetType](docs/v2/Ontologies/models/OntologySetType.md) | `from foundry.v2.ontologies.models import OntologySetType` | -**Ontologies** | [OntologySetTypeDict](docs/v2/Ontologies/models/OntologySetTypeDict.md) | `from foundry.v2.ontologies.models import OntologySetTypeDict` | **Ontologies** | [OntologyStructField](docs/v2/Ontologies/models/OntologyStructField.md) | `from foundry.v2.ontologies.models import OntologyStructField` | -**Ontologies** | [OntologyStructFieldDict](docs/v2/Ontologies/models/OntologyStructFieldDict.md) | `from foundry.v2.ontologies.models import OntologyStructFieldDict` | **Ontologies** | [OntologyStructType](docs/v2/Ontologies/models/OntologyStructType.md) | `from foundry.v2.ontologies.models import OntologyStructType` | -**Ontologies** | [OntologyStructTypeDict](docs/v2/Ontologies/models/OntologyStructTypeDict.md) | `from foundry.v2.ontologies.models import OntologyStructTypeDict` | **Ontologies** | [OntologyV2](docs/v2/Ontologies/models/OntologyV2.md) | `from foundry.v2.ontologies.models import OntologyV2` | -**Ontologies** | [OntologyV2Dict](docs/v2/Ontologies/models/OntologyV2Dict.md) | `from foundry.v2.ontologies.models import OntologyV2Dict` | **Ontologies** | [OrderBy](docs/v2/Ontologies/models/OrderBy.md) | `from foundry.v2.ontologies.models import OrderBy` | **Ontologies** | [OrderByDirection](docs/v2/Ontologies/models/OrderByDirection.md) | `from foundry.v2.ontologies.models import OrderByDirection` | **Ontologies** | [OrQueryV2](docs/v2/Ontologies/models/OrQueryV2.md) | `from foundry.v2.ontologies.models import OrQueryV2` | -**Ontologies** | [OrQueryV2Dict](docs/v2/Ontologies/models/OrQueryV2Dict.md) | `from foundry.v2.ontologies.models import OrQueryV2Dict` | **Ontologies** | [ParameterEvaluatedConstraint](docs/v2/Ontologies/models/ParameterEvaluatedConstraint.md) | `from foundry.v2.ontologies.models import ParameterEvaluatedConstraint` | -**Ontologies** | [ParameterEvaluatedConstraintDict](docs/v2/Ontologies/models/ParameterEvaluatedConstraintDict.md) | `from foundry.v2.ontologies.models import ParameterEvaluatedConstraintDict` | **Ontologies** | [ParameterEvaluationResult](docs/v2/Ontologies/models/ParameterEvaluationResult.md) | `from foundry.v2.ontologies.models import ParameterEvaluationResult` | -**Ontologies** | [ParameterEvaluationResultDict](docs/v2/Ontologies/models/ParameterEvaluationResultDict.md) | `from foundry.v2.ontologies.models import ParameterEvaluationResultDict` | **Ontologies** | [ParameterId](docs/v2/Ontologies/models/ParameterId.md) | `from foundry.v2.ontologies.models import ParameterId` | **Ontologies** | [ParameterOption](docs/v2/Ontologies/models/ParameterOption.md) | `from foundry.v2.ontologies.models import ParameterOption` | -**Ontologies** | [ParameterOptionDict](docs/v2/Ontologies/models/ParameterOptionDict.md) | `from foundry.v2.ontologies.models import ParameterOptionDict` | **Ontologies** | [PolygonValue](docs/v2/Ontologies/models/PolygonValue.md) | `from foundry.v2.ontologies.models import PolygonValue` | -**Ontologies** | [PolygonValueDict](docs/v2/Ontologies/models/PolygonValueDict.md) | `from foundry.v2.ontologies.models import PolygonValueDict` | **Ontologies** | [PreciseDuration](docs/v2/Ontologies/models/PreciseDuration.md) | `from foundry.v2.ontologies.models import PreciseDuration` | -**Ontologies** | [PreciseDurationDict](docs/v2/Ontologies/models/PreciseDurationDict.md) | `from foundry.v2.ontologies.models import PreciseDurationDict` | **Ontologies** | [PreciseTimeUnit](docs/v2/Ontologies/models/PreciseTimeUnit.md) | `from foundry.v2.ontologies.models import PreciseTimeUnit` | **Ontologies** | [PrimaryKeyValue](docs/v2/Ontologies/models/PrimaryKeyValue.md) | `from foundry.v2.ontologies.models import PrimaryKeyValue` | **Ontologies** | [PropertyApiName](docs/v2/Ontologies/models/PropertyApiName.md) | `from foundry.v2.ontologies.models import PropertyApiName` | **Ontologies** | [PropertyApiNameSelector](docs/v2/Ontologies/models/PropertyApiNameSelector.md) | `from foundry.v2.ontologies.models import PropertyApiNameSelector` | -**Ontologies** | [PropertyApiNameSelectorDict](docs/v2/Ontologies/models/PropertyApiNameSelectorDict.md) | `from foundry.v2.ontologies.models import PropertyApiNameSelectorDict` | **Ontologies** | [PropertyFilter](docs/v2/Ontologies/models/PropertyFilter.md) | `from foundry.v2.ontologies.models import PropertyFilter` | **Ontologies** | [PropertyId](docs/v2/Ontologies/models/PropertyId.md) | `from foundry.v2.ontologies.models import PropertyId` | **Ontologies** | [PropertyIdentifier](docs/v2/Ontologies/models/PropertyIdentifier.md) | `from foundry.v2.ontologies.models import PropertyIdentifier` | -**Ontologies** | [PropertyIdentifierDict](docs/v2/Ontologies/models/PropertyIdentifierDict.md) | `from foundry.v2.ontologies.models import PropertyIdentifierDict` | **Ontologies** | [PropertyTypeRid](docs/v2/Ontologies/models/PropertyTypeRid.md) | `from foundry.v2.ontologies.models import PropertyTypeRid` | **Ontologies** | [PropertyTypeStatus](docs/v2/Ontologies/models/PropertyTypeStatus.md) | `from foundry.v2.ontologies.models import PropertyTypeStatus` | -**Ontologies** | [PropertyTypeStatusDict](docs/v2/Ontologies/models/PropertyTypeStatusDict.md) | `from foundry.v2.ontologies.models import PropertyTypeStatusDict` | **Ontologies** | [PropertyTypeVisibility](docs/v2/Ontologies/models/PropertyTypeVisibility.md) | `from foundry.v2.ontologies.models import PropertyTypeVisibility` | **Ontologies** | [PropertyV2](docs/v2/Ontologies/models/PropertyV2.md) | `from foundry.v2.ontologies.models import PropertyV2` | -**Ontologies** | [PropertyV2Dict](docs/v2/Ontologies/models/PropertyV2Dict.md) | `from foundry.v2.ontologies.models import PropertyV2Dict` | **Ontologies** | [PropertyValue](docs/v2/Ontologies/models/PropertyValue.md) | `from foundry.v2.ontologies.models import PropertyValue` | **Ontologies** | [PropertyValueEscapedString](docs/v2/Ontologies/models/PropertyValueEscapedString.md) | `from foundry.v2.ontologies.models import PropertyValueEscapedString` | **Ontologies** | [QueryAggregationKeyType](docs/v2/Ontologies/models/QueryAggregationKeyType.md) | `from foundry.v2.ontologies.models import QueryAggregationKeyType` | -**Ontologies** | [QueryAggregationKeyTypeDict](docs/v2/Ontologies/models/QueryAggregationKeyTypeDict.md) | `from foundry.v2.ontologies.models import QueryAggregationKeyTypeDict` | **Ontologies** | [QueryAggregationRangeSubType](docs/v2/Ontologies/models/QueryAggregationRangeSubType.md) | `from foundry.v2.ontologies.models import QueryAggregationRangeSubType` | -**Ontologies** | [QueryAggregationRangeSubTypeDict](docs/v2/Ontologies/models/QueryAggregationRangeSubTypeDict.md) | `from foundry.v2.ontologies.models import QueryAggregationRangeSubTypeDict` | **Ontologies** | [QueryAggregationRangeType](docs/v2/Ontologies/models/QueryAggregationRangeType.md) | `from foundry.v2.ontologies.models import QueryAggregationRangeType` | -**Ontologies** | [QueryAggregationRangeTypeDict](docs/v2/Ontologies/models/QueryAggregationRangeTypeDict.md) | `from foundry.v2.ontologies.models import QueryAggregationRangeTypeDict` | **Ontologies** | [QueryAggregationValueType](docs/v2/Ontologies/models/QueryAggregationValueType.md) | `from foundry.v2.ontologies.models import QueryAggregationValueType` | -**Ontologies** | [QueryAggregationValueTypeDict](docs/v2/Ontologies/models/QueryAggregationValueTypeDict.md) | `from foundry.v2.ontologies.models import QueryAggregationValueTypeDict` | **Ontologies** | [QueryApiName](docs/v2/Ontologies/models/QueryApiName.md) | `from foundry.v2.ontologies.models import QueryApiName` | **Ontologies** | [QueryArrayType](docs/v2/Ontologies/models/QueryArrayType.md) | `from foundry.v2.ontologies.models import QueryArrayType` | -**Ontologies** | [QueryArrayTypeDict](docs/v2/Ontologies/models/QueryArrayTypeDict.md) | `from foundry.v2.ontologies.models import QueryArrayTypeDict` | **Ontologies** | [QueryDataType](docs/v2/Ontologies/models/QueryDataType.md) | `from foundry.v2.ontologies.models import QueryDataType` | -**Ontologies** | [QueryDataTypeDict](docs/v2/Ontologies/models/QueryDataTypeDict.md) | `from foundry.v2.ontologies.models import QueryDataTypeDict` | **Ontologies** | [QueryParameterV2](docs/v2/Ontologies/models/QueryParameterV2.md) | `from foundry.v2.ontologies.models import QueryParameterV2` | -**Ontologies** | [QueryParameterV2Dict](docs/v2/Ontologies/models/QueryParameterV2Dict.md) | `from foundry.v2.ontologies.models import QueryParameterV2Dict` | **Ontologies** | [QueryRuntimeErrorParameter](docs/v2/Ontologies/models/QueryRuntimeErrorParameter.md) | `from foundry.v2.ontologies.models import QueryRuntimeErrorParameter` | **Ontologies** | [QuerySetType](docs/v2/Ontologies/models/QuerySetType.md) | `from foundry.v2.ontologies.models import QuerySetType` | -**Ontologies** | [QuerySetTypeDict](docs/v2/Ontologies/models/QuerySetTypeDict.md) | `from foundry.v2.ontologies.models import QuerySetTypeDict` | **Ontologies** | [QueryStructField](docs/v2/Ontologies/models/QueryStructField.md) | `from foundry.v2.ontologies.models import QueryStructField` | -**Ontologies** | [QueryStructFieldDict](docs/v2/Ontologies/models/QueryStructFieldDict.md) | `from foundry.v2.ontologies.models import QueryStructFieldDict` | **Ontologies** | [QueryStructType](docs/v2/Ontologies/models/QueryStructType.md) | `from foundry.v2.ontologies.models import QueryStructType` | -**Ontologies** | [QueryStructTypeDict](docs/v2/Ontologies/models/QueryStructTypeDict.md) | `from foundry.v2.ontologies.models import QueryStructTypeDict` | **Ontologies** | [QueryTypeV2](docs/v2/Ontologies/models/QueryTypeV2.md) | `from foundry.v2.ontologies.models import QueryTypeV2` | -**Ontologies** | [QueryTypeV2Dict](docs/v2/Ontologies/models/QueryTypeV2Dict.md) | `from foundry.v2.ontologies.models import QueryTypeV2Dict` | **Ontologies** | [QueryUnionType](docs/v2/Ontologies/models/QueryUnionType.md) | `from foundry.v2.ontologies.models import QueryUnionType` | -**Ontologies** | [QueryUnionTypeDict](docs/v2/Ontologies/models/QueryUnionTypeDict.md) | `from foundry.v2.ontologies.models import QueryUnionTypeDict` | **Ontologies** | [RangeConstraint](docs/v2/Ontologies/models/RangeConstraint.md) | `from foundry.v2.ontologies.models import RangeConstraint` | -**Ontologies** | [RangeConstraintDict](docs/v2/Ontologies/models/RangeConstraintDict.md) | `from foundry.v2.ontologies.models import RangeConstraintDict` | **Ontologies** | [RelativeTime](docs/v2/Ontologies/models/RelativeTime.md) | `from foundry.v2.ontologies.models import RelativeTime` | -**Ontologies** | [RelativeTimeDict](docs/v2/Ontologies/models/RelativeTimeDict.md) | `from foundry.v2.ontologies.models import RelativeTimeDict` | **Ontologies** | [RelativeTimeRange](docs/v2/Ontologies/models/RelativeTimeRange.md) | `from foundry.v2.ontologies.models import RelativeTimeRange` | -**Ontologies** | [RelativeTimeRangeDict](docs/v2/Ontologies/models/RelativeTimeRangeDict.md) | `from foundry.v2.ontologies.models import RelativeTimeRangeDict` | **Ontologies** | [RelativeTimeRelation](docs/v2/Ontologies/models/RelativeTimeRelation.md) | `from foundry.v2.ontologies.models import RelativeTimeRelation` | **Ontologies** | [RelativeTimeSeriesTimeUnit](docs/v2/Ontologies/models/RelativeTimeSeriesTimeUnit.md) | `from foundry.v2.ontologies.models import RelativeTimeSeriesTimeUnit` | **Ontologies** | [ReturnEditsMode](docs/v2/Ontologies/models/ReturnEditsMode.md) | `from foundry.v2.ontologies.models import ReturnEditsMode` | **Ontologies** | [RollingAggregateWindowPoints](docs/v2/Ontologies/models/RollingAggregateWindowPoints.md) | `from foundry.v2.ontologies.models import RollingAggregateWindowPoints` | -**Ontologies** | [RollingAggregateWindowPointsDict](docs/v2/Ontologies/models/RollingAggregateWindowPointsDict.md) | `from foundry.v2.ontologies.models import RollingAggregateWindowPointsDict` | **Ontologies** | [SdkPackageName](docs/v2/Ontologies/models/SdkPackageName.md) | `from foundry.v2.ontologies.models import SdkPackageName` | **Ontologies** | [SearchJsonQueryV2](docs/v2/Ontologies/models/SearchJsonQueryV2.md) | `from foundry.v2.ontologies.models import SearchJsonQueryV2` | -**Ontologies** | [SearchJsonQueryV2Dict](docs/v2/Ontologies/models/SearchJsonQueryV2Dict.md) | `from foundry.v2.ontologies.models import SearchJsonQueryV2Dict` | **Ontologies** | [SearchObjectsResponseV2](docs/v2/Ontologies/models/SearchObjectsResponseV2.md) | `from foundry.v2.ontologies.models import SearchObjectsResponseV2` | -**Ontologies** | [SearchObjectsResponseV2Dict](docs/v2/Ontologies/models/SearchObjectsResponseV2Dict.md) | `from foundry.v2.ontologies.models import SearchObjectsResponseV2Dict` | **Ontologies** | [SearchOrderByType](docs/v2/Ontologies/models/SearchOrderByType.md) | `from foundry.v2.ontologies.models import SearchOrderByType` | **Ontologies** | [SearchOrderByV2](docs/v2/Ontologies/models/SearchOrderByV2.md) | `from foundry.v2.ontologies.models import SearchOrderByV2` | -**Ontologies** | [SearchOrderByV2Dict](docs/v2/Ontologies/models/SearchOrderByV2Dict.md) | `from foundry.v2.ontologies.models import SearchOrderByV2Dict` | **Ontologies** | [SearchOrderingV2](docs/v2/Ontologies/models/SearchOrderingV2.md) | `from foundry.v2.ontologies.models import SearchOrderingV2` | -**Ontologies** | [SearchOrderingV2Dict](docs/v2/Ontologies/models/SearchOrderingV2Dict.md) | `from foundry.v2.ontologies.models import SearchOrderingV2Dict` | **Ontologies** | [SelectedPropertyApiName](docs/v2/Ontologies/models/SelectedPropertyApiName.md) | `from foundry.v2.ontologies.models import SelectedPropertyApiName` | **Ontologies** | [SelectedPropertyApproximateDistinctAggregation](docs/v2/Ontologies/models/SelectedPropertyApproximateDistinctAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyApproximateDistinctAggregation` | -**Ontologies** | [SelectedPropertyApproximateDistinctAggregationDict](docs/v2/Ontologies/models/SelectedPropertyApproximateDistinctAggregationDict.md) | `from foundry.v2.ontologies.models import SelectedPropertyApproximateDistinctAggregationDict` | **Ontologies** | [SelectedPropertyApproximatePercentileAggregation](docs/v2/Ontologies/models/SelectedPropertyApproximatePercentileAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyApproximatePercentileAggregation` | -**Ontologies** | [SelectedPropertyApproximatePercentileAggregationDict](docs/v2/Ontologies/models/SelectedPropertyApproximatePercentileAggregationDict.md) | `from foundry.v2.ontologies.models import SelectedPropertyApproximatePercentileAggregationDict` | **Ontologies** | [SelectedPropertyAvgAggregation](docs/v2/Ontologies/models/SelectedPropertyAvgAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyAvgAggregation` | -**Ontologies** | [SelectedPropertyAvgAggregationDict](docs/v2/Ontologies/models/SelectedPropertyAvgAggregationDict.md) | `from foundry.v2.ontologies.models import SelectedPropertyAvgAggregationDict` | **Ontologies** | [SelectedPropertyCollectListAggregation](docs/v2/Ontologies/models/SelectedPropertyCollectListAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyCollectListAggregation` | -**Ontologies** | [SelectedPropertyCollectListAggregationDict](docs/v2/Ontologies/models/SelectedPropertyCollectListAggregationDict.md) | `from foundry.v2.ontologies.models import SelectedPropertyCollectListAggregationDict` | **Ontologies** | [SelectedPropertyCollectSetAggregation](docs/v2/Ontologies/models/SelectedPropertyCollectSetAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyCollectSetAggregation` | -**Ontologies** | [SelectedPropertyCollectSetAggregationDict](docs/v2/Ontologies/models/SelectedPropertyCollectSetAggregationDict.md) | `from foundry.v2.ontologies.models import SelectedPropertyCollectSetAggregationDict` | **Ontologies** | [SelectedPropertyCountAggregation](docs/v2/Ontologies/models/SelectedPropertyCountAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyCountAggregation` | -**Ontologies** | [SelectedPropertyCountAggregationDict](docs/v2/Ontologies/models/SelectedPropertyCountAggregationDict.md) | `from foundry.v2.ontologies.models import SelectedPropertyCountAggregationDict` | **Ontologies** | [SelectedPropertyExactDistinctAggregation](docs/v2/Ontologies/models/SelectedPropertyExactDistinctAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyExactDistinctAggregation` | -**Ontologies** | [SelectedPropertyExactDistinctAggregationDict](docs/v2/Ontologies/models/SelectedPropertyExactDistinctAggregationDict.md) | `from foundry.v2.ontologies.models import SelectedPropertyExactDistinctAggregationDict` | **Ontologies** | [SelectedPropertyExpression](docs/v2/Ontologies/models/SelectedPropertyExpression.md) | `from foundry.v2.ontologies.models import SelectedPropertyExpression` | -**Ontologies** | [SelectedPropertyExpressionDict](docs/v2/Ontologies/models/SelectedPropertyExpressionDict.md) | `from foundry.v2.ontologies.models import SelectedPropertyExpressionDict` | **Ontologies** | [SelectedPropertyMaxAggregation](docs/v2/Ontologies/models/SelectedPropertyMaxAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyMaxAggregation` | -**Ontologies** | [SelectedPropertyMaxAggregationDict](docs/v2/Ontologies/models/SelectedPropertyMaxAggregationDict.md) | `from foundry.v2.ontologies.models import SelectedPropertyMaxAggregationDict` | **Ontologies** | [SelectedPropertyMinAggregation](docs/v2/Ontologies/models/SelectedPropertyMinAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyMinAggregation` | -**Ontologies** | [SelectedPropertyMinAggregationDict](docs/v2/Ontologies/models/SelectedPropertyMinAggregationDict.md) | `from foundry.v2.ontologies.models import SelectedPropertyMinAggregationDict` | **Ontologies** | [SelectedPropertyOperation](docs/v2/Ontologies/models/SelectedPropertyOperation.md) | `from foundry.v2.ontologies.models import SelectedPropertyOperation` | -**Ontologies** | [SelectedPropertyOperationDict](docs/v2/Ontologies/models/SelectedPropertyOperationDict.md) | `from foundry.v2.ontologies.models import SelectedPropertyOperationDict` | **Ontologies** | [SelectedPropertySumAggregation](docs/v2/Ontologies/models/SelectedPropertySumAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertySumAggregation` | -**Ontologies** | [SelectedPropertySumAggregationDict](docs/v2/Ontologies/models/SelectedPropertySumAggregationDict.md) | `from foundry.v2.ontologies.models import SelectedPropertySumAggregationDict` | **Ontologies** | [SharedPropertyType](docs/v2/Ontologies/models/SharedPropertyType.md) | `from foundry.v2.ontologies.models import SharedPropertyType` | **Ontologies** | [SharedPropertyTypeApiName](docs/v2/Ontologies/models/SharedPropertyTypeApiName.md) | `from foundry.v2.ontologies.models import SharedPropertyTypeApiName` | -**Ontologies** | [SharedPropertyTypeDict](docs/v2/Ontologies/models/SharedPropertyTypeDict.md) | `from foundry.v2.ontologies.models import SharedPropertyTypeDict` | **Ontologies** | [SharedPropertyTypeRid](docs/v2/Ontologies/models/SharedPropertyTypeRid.md) | `from foundry.v2.ontologies.models import SharedPropertyTypeRid` | **Ontologies** | [StartsWithQuery](docs/v2/Ontologies/models/StartsWithQuery.md) | `from foundry.v2.ontologies.models import StartsWithQuery` | -**Ontologies** | [StartsWithQueryDict](docs/v2/Ontologies/models/StartsWithQueryDict.md) | `from foundry.v2.ontologies.models import StartsWithQueryDict` | **Ontologies** | [StreamingOutputFormat](docs/v2/Ontologies/models/StreamingOutputFormat.md) | `from foundry.v2.ontologies.models import StreamingOutputFormat` | **Ontologies** | [StringLengthConstraint](docs/v2/Ontologies/models/StringLengthConstraint.md) | `from foundry.v2.ontologies.models import StringLengthConstraint` | -**Ontologies** | [StringLengthConstraintDict](docs/v2/Ontologies/models/StringLengthConstraintDict.md) | `from foundry.v2.ontologies.models import StringLengthConstraintDict` | **Ontologies** | [StringRegexMatchConstraint](docs/v2/Ontologies/models/StringRegexMatchConstraint.md) | `from foundry.v2.ontologies.models import StringRegexMatchConstraint` | -**Ontologies** | [StringRegexMatchConstraintDict](docs/v2/Ontologies/models/StringRegexMatchConstraintDict.md) | `from foundry.v2.ontologies.models import StringRegexMatchConstraintDict` | **Ontologies** | [StructFieldApiName](docs/v2/Ontologies/models/StructFieldApiName.md) | `from foundry.v2.ontologies.models import StructFieldApiName` | **Ontologies** | [StructFieldSelector](docs/v2/Ontologies/models/StructFieldSelector.md) | `from foundry.v2.ontologies.models import StructFieldSelector` | -**Ontologies** | [StructFieldSelectorDict](docs/v2/Ontologies/models/StructFieldSelectorDict.md) | `from foundry.v2.ontologies.models import StructFieldSelectorDict` | **Ontologies** | [StructFieldType](docs/v2/Ontologies/models/StructFieldType.md) | `from foundry.v2.ontologies.models import StructFieldType` | -**Ontologies** | [StructFieldTypeDict](docs/v2/Ontologies/models/StructFieldTypeDict.md) | `from foundry.v2.ontologies.models import StructFieldTypeDict` | **Ontologies** | [StructType](docs/v2/Ontologies/models/StructType.md) | `from foundry.v2.ontologies.models import StructType` | -**Ontologies** | [StructTypeDict](docs/v2/Ontologies/models/StructTypeDict.md) | `from foundry.v2.ontologies.models import StructTypeDict` | **Ontologies** | [SubmissionCriteriaEvaluation](docs/v2/Ontologies/models/SubmissionCriteriaEvaluation.md) | `from foundry.v2.ontologies.models import SubmissionCriteriaEvaluation` | -**Ontologies** | [SubmissionCriteriaEvaluationDict](docs/v2/Ontologies/models/SubmissionCriteriaEvaluationDict.md) | `from foundry.v2.ontologies.models import SubmissionCriteriaEvaluationDict` | **Ontologies** | [SubtractPropertyExpression](docs/v2/Ontologies/models/SubtractPropertyExpression.md) | `from foundry.v2.ontologies.models import SubtractPropertyExpression` | -**Ontologies** | [SubtractPropertyExpressionDict](docs/v2/Ontologies/models/SubtractPropertyExpressionDict.md) | `from foundry.v2.ontologies.models import SubtractPropertyExpressionDict` | **Ontologies** | [SumAggregationV2](docs/v2/Ontologies/models/SumAggregationV2.md) | `from foundry.v2.ontologies.models import SumAggregationV2` | -**Ontologies** | [SumAggregationV2Dict](docs/v2/Ontologies/models/SumAggregationV2Dict.md) | `from foundry.v2.ontologies.models import SumAggregationV2Dict` | **Ontologies** | [SyncApplyActionResponseV2](docs/v2/Ontologies/models/SyncApplyActionResponseV2.md) | `from foundry.v2.ontologies.models import SyncApplyActionResponseV2` | -**Ontologies** | [SyncApplyActionResponseV2Dict](docs/v2/Ontologies/models/SyncApplyActionResponseV2Dict.md) | `from foundry.v2.ontologies.models import SyncApplyActionResponseV2Dict` | **Ontologies** | [ThreeDimensionalAggregation](docs/v2/Ontologies/models/ThreeDimensionalAggregation.md) | `from foundry.v2.ontologies.models import ThreeDimensionalAggregation` | -**Ontologies** | [ThreeDimensionalAggregationDict](docs/v2/Ontologies/models/ThreeDimensionalAggregationDict.md) | `from foundry.v2.ontologies.models import ThreeDimensionalAggregationDict` | **Ontologies** | [TimeRange](docs/v2/Ontologies/models/TimeRange.md) | `from foundry.v2.ontologies.models import TimeRange` | -**Ontologies** | [TimeRangeDict](docs/v2/Ontologies/models/TimeRangeDict.md) | `from foundry.v2.ontologies.models import TimeRangeDict` | **Ontologies** | [TimeSeriesAggregationMethod](docs/v2/Ontologies/models/TimeSeriesAggregationMethod.md) | `from foundry.v2.ontologies.models import TimeSeriesAggregationMethod` | **Ontologies** | [TimeSeriesAggregationStrategy](docs/v2/Ontologies/models/TimeSeriesAggregationStrategy.md) | `from foundry.v2.ontologies.models import TimeSeriesAggregationStrategy` | -**Ontologies** | [TimeSeriesAggregationStrategyDict](docs/v2/Ontologies/models/TimeSeriesAggregationStrategyDict.md) | `from foundry.v2.ontologies.models import TimeSeriesAggregationStrategyDict` | **Ontologies** | [TimeSeriesCumulativeAggregate](docs/v2/Ontologies/models/TimeSeriesCumulativeAggregate.md) | `from foundry.v2.ontologies.models import TimeSeriesCumulativeAggregate` | -**Ontologies** | [TimeSeriesCumulativeAggregateDict](docs/v2/Ontologies/models/TimeSeriesCumulativeAggregateDict.md) | `from foundry.v2.ontologies.models import TimeSeriesCumulativeAggregateDict` | **Ontologies** | [TimeseriesEntry](docs/v2/Ontologies/models/TimeseriesEntry.md) | `from foundry.v2.ontologies.models import TimeseriesEntry` | -**Ontologies** | [TimeseriesEntryDict](docs/v2/Ontologies/models/TimeseriesEntryDict.md) | `from foundry.v2.ontologies.models import TimeseriesEntryDict` | **Ontologies** | [TimeSeriesPeriodicAggregate](docs/v2/Ontologies/models/TimeSeriesPeriodicAggregate.md) | `from foundry.v2.ontologies.models import TimeSeriesPeriodicAggregate` | -**Ontologies** | [TimeSeriesPeriodicAggregateDict](docs/v2/Ontologies/models/TimeSeriesPeriodicAggregateDict.md) | `from foundry.v2.ontologies.models import TimeSeriesPeriodicAggregateDict` | **Ontologies** | [TimeSeriesPoint](docs/v2/Ontologies/models/TimeSeriesPoint.md) | `from foundry.v2.ontologies.models import TimeSeriesPoint` | -**Ontologies** | [TimeSeriesPointDict](docs/v2/Ontologies/models/TimeSeriesPointDict.md) | `from foundry.v2.ontologies.models import TimeSeriesPointDict` | **Ontologies** | [TimeSeriesRollingAggregate](docs/v2/Ontologies/models/TimeSeriesRollingAggregate.md) | `from foundry.v2.ontologies.models import TimeSeriesRollingAggregate` | -**Ontologies** | [TimeSeriesRollingAggregateDict](docs/v2/Ontologies/models/TimeSeriesRollingAggregateDict.md) | `from foundry.v2.ontologies.models import TimeSeriesRollingAggregateDict` | **Ontologies** | [TimeSeriesRollingAggregateWindow](docs/v2/Ontologies/models/TimeSeriesRollingAggregateWindow.md) | `from foundry.v2.ontologies.models import TimeSeriesRollingAggregateWindow` | -**Ontologies** | [TimeSeriesRollingAggregateWindowDict](docs/v2/Ontologies/models/TimeSeriesRollingAggregateWindowDict.md) | `from foundry.v2.ontologies.models import TimeSeriesRollingAggregateWindowDict` | **Ontologies** | [TimeSeriesWindowType](docs/v2/Ontologies/models/TimeSeriesWindowType.md) | `from foundry.v2.ontologies.models import TimeSeriesWindowType` | **Ontologies** | [TimeUnit](docs/v2/Ontologies/models/TimeUnit.md) | `from foundry.v2.ontologies.models import TimeUnit` | **Ontologies** | [TwoDimensionalAggregation](docs/v2/Ontologies/models/TwoDimensionalAggregation.md) | `from foundry.v2.ontologies.models import TwoDimensionalAggregation` | -**Ontologies** | [TwoDimensionalAggregationDict](docs/v2/Ontologies/models/TwoDimensionalAggregationDict.md) | `from foundry.v2.ontologies.models import TwoDimensionalAggregationDict` | **Ontologies** | [UnevaluableConstraint](docs/v2/Ontologies/models/UnevaluableConstraint.md) | `from foundry.v2.ontologies.models import UnevaluableConstraint` | -**Ontologies** | [UnevaluableConstraintDict](docs/v2/Ontologies/models/UnevaluableConstraintDict.md) | `from foundry.v2.ontologies.models import UnevaluableConstraintDict` | **Ontologies** | [ValidateActionResponseV2](docs/v2/Ontologies/models/ValidateActionResponseV2.md) | `from foundry.v2.ontologies.models import ValidateActionResponseV2` | -**Ontologies** | [ValidateActionResponseV2Dict](docs/v2/Ontologies/models/ValidateActionResponseV2Dict.md) | `from foundry.v2.ontologies.models import ValidateActionResponseV2Dict` | **Ontologies** | [ValidationResult](docs/v2/Ontologies/models/ValidationResult.md) | `from foundry.v2.ontologies.models import ValidationResult` | **Ontologies** | [ValueType](docs/v2/Ontologies/models/ValueType.md) | `from foundry.v2.ontologies.models import ValueType` | **Ontologies** | [WithinBoundingBoxPoint](docs/v2/Ontologies/models/WithinBoundingBoxPoint.md) | `from foundry.v2.ontologies.models import WithinBoundingBoxPoint` | -**Ontologies** | [WithinBoundingBoxPointDict](docs/v2/Ontologies/models/WithinBoundingBoxPointDict.md) | `from foundry.v2.ontologies.models import WithinBoundingBoxPointDict` | **Ontologies** | [WithinBoundingBoxQuery](docs/v2/Ontologies/models/WithinBoundingBoxQuery.md) | `from foundry.v2.ontologies.models import WithinBoundingBoxQuery` | -**Ontologies** | [WithinBoundingBoxQueryDict](docs/v2/Ontologies/models/WithinBoundingBoxQueryDict.md) | `from foundry.v2.ontologies.models import WithinBoundingBoxQueryDict` | **Ontologies** | [WithinDistanceOfQuery](docs/v2/Ontologies/models/WithinDistanceOfQuery.md) | `from foundry.v2.ontologies.models import WithinDistanceOfQuery` | -**Ontologies** | [WithinDistanceOfQueryDict](docs/v2/Ontologies/models/WithinDistanceOfQueryDict.md) | `from foundry.v2.ontologies.models import WithinDistanceOfQueryDict` | **Ontologies** | [WithinPolygonQuery](docs/v2/Ontologies/models/WithinPolygonQuery.md) | `from foundry.v2.ontologies.models import WithinPolygonQuery` | -**Ontologies** | [WithinPolygonQueryDict](docs/v2/Ontologies/models/WithinPolygonQueryDict.md) | `from foundry.v2.ontologies.models import WithinPolygonQueryDict` | **Orchestration** | [AbortOnFailure](docs/v2/Orchestration/models/AbortOnFailure.md) | `from foundry.v2.orchestration.models import AbortOnFailure` | **Orchestration** | [Action](docs/v2/Orchestration/models/Action.md) | `from foundry.v2.orchestration.models import Action` | -**Orchestration** | [ActionDict](docs/v2/Orchestration/models/ActionDict.md) | `from foundry.v2.orchestration.models import ActionDict` | **Orchestration** | [AndTrigger](docs/v2/Orchestration/models/AndTrigger.md) | `from foundry.v2.orchestration.models import AndTrigger` | -**Orchestration** | [AndTriggerDict](docs/v2/Orchestration/models/AndTriggerDict.md) | `from foundry.v2.orchestration.models import AndTriggerDict` | **Orchestration** | [Build](docs/v2/Orchestration/models/Build.md) | `from foundry.v2.orchestration.models import Build` | **Orchestration** | [BuildableRid](docs/v2/Orchestration/models/BuildableRid.md) | `from foundry.v2.orchestration.models import BuildableRid` | -**Orchestration** | [BuildDict](docs/v2/Orchestration/models/BuildDict.md) | `from foundry.v2.orchestration.models import BuildDict` | **Orchestration** | [BuildStatus](docs/v2/Orchestration/models/BuildStatus.md) | `from foundry.v2.orchestration.models import BuildStatus` | **Orchestration** | [BuildTarget](docs/v2/Orchestration/models/BuildTarget.md) | `from foundry.v2.orchestration.models import BuildTarget` | -**Orchestration** | [BuildTargetDict](docs/v2/Orchestration/models/BuildTargetDict.md) | `from foundry.v2.orchestration.models import BuildTargetDict` | **Orchestration** | [ConnectingTarget](docs/v2/Orchestration/models/ConnectingTarget.md) | `from foundry.v2.orchestration.models import ConnectingTarget` | -**Orchestration** | [ConnectingTargetDict](docs/v2/Orchestration/models/ConnectingTargetDict.md) | `from foundry.v2.orchestration.models import ConnectingTargetDict` | **Orchestration** | [CreateScheduleRequestAction](docs/v2/Orchestration/models/CreateScheduleRequestAction.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestAction` | -**Orchestration** | [CreateScheduleRequestActionDict](docs/v2/Orchestration/models/CreateScheduleRequestActionDict.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestActionDict` | **Orchestration** | [CreateScheduleRequestBuildTarget](docs/v2/Orchestration/models/CreateScheduleRequestBuildTarget.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestBuildTarget` | -**Orchestration** | [CreateScheduleRequestBuildTargetDict](docs/v2/Orchestration/models/CreateScheduleRequestBuildTargetDict.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestBuildTargetDict` | **Orchestration** | [CreateScheduleRequestConnectingTarget](docs/v2/Orchestration/models/CreateScheduleRequestConnectingTarget.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestConnectingTarget` | -**Orchestration** | [CreateScheduleRequestConnectingTargetDict](docs/v2/Orchestration/models/CreateScheduleRequestConnectingTargetDict.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestConnectingTargetDict` | **Orchestration** | [CreateScheduleRequestManualTarget](docs/v2/Orchestration/models/CreateScheduleRequestManualTarget.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestManualTarget` | -**Orchestration** | [CreateScheduleRequestManualTargetDict](docs/v2/Orchestration/models/CreateScheduleRequestManualTargetDict.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestManualTargetDict` | **Orchestration** | [CreateScheduleRequestProjectScope](docs/v2/Orchestration/models/CreateScheduleRequestProjectScope.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestProjectScope` | -**Orchestration** | [CreateScheduleRequestProjectScopeDict](docs/v2/Orchestration/models/CreateScheduleRequestProjectScopeDict.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestProjectScopeDict` | **Orchestration** | [CreateScheduleRequestScopeMode](docs/v2/Orchestration/models/CreateScheduleRequestScopeMode.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestScopeMode` | -**Orchestration** | [CreateScheduleRequestScopeModeDict](docs/v2/Orchestration/models/CreateScheduleRequestScopeModeDict.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestScopeModeDict` | **Orchestration** | [CreateScheduleRequestUpstreamTarget](docs/v2/Orchestration/models/CreateScheduleRequestUpstreamTarget.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestUpstreamTarget` | -**Orchestration** | [CreateScheduleRequestUpstreamTargetDict](docs/v2/Orchestration/models/CreateScheduleRequestUpstreamTargetDict.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestUpstreamTargetDict` | **Orchestration** | [CreateScheduleRequestUserScope](docs/v2/Orchestration/models/CreateScheduleRequestUserScope.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestUserScope` | -**Orchestration** | [CreateScheduleRequestUserScopeDict](docs/v2/Orchestration/models/CreateScheduleRequestUserScopeDict.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestUserScopeDict` | **Orchestration** | [CronExpression](docs/v2/Orchestration/models/CronExpression.md) | `from foundry.v2.orchestration.models import CronExpression` | **Orchestration** | [DatasetJobOutput](docs/v2/Orchestration/models/DatasetJobOutput.md) | `from foundry.v2.orchestration.models import DatasetJobOutput` | -**Orchestration** | [DatasetJobOutputDict](docs/v2/Orchestration/models/DatasetJobOutputDict.md) | `from foundry.v2.orchestration.models import DatasetJobOutputDict` | **Orchestration** | [DatasetUpdatedTrigger](docs/v2/Orchestration/models/DatasetUpdatedTrigger.md) | `from foundry.v2.orchestration.models import DatasetUpdatedTrigger` | -**Orchestration** | [DatasetUpdatedTriggerDict](docs/v2/Orchestration/models/DatasetUpdatedTriggerDict.md) | `from foundry.v2.orchestration.models import DatasetUpdatedTriggerDict` | **Orchestration** | [FallbackBranches](docs/v2/Orchestration/models/FallbackBranches.md) | `from foundry.v2.orchestration.models import FallbackBranches` | **Orchestration** | [ForceBuild](docs/v2/Orchestration/models/ForceBuild.md) | `from foundry.v2.orchestration.models import ForceBuild` | **Orchestration** | [GetBuildsBatchRequestElement](docs/v2/Orchestration/models/GetBuildsBatchRequestElement.md) | `from foundry.v2.orchestration.models import GetBuildsBatchRequestElement` | -**Orchestration** | [GetBuildsBatchRequestElementDict](docs/v2/Orchestration/models/GetBuildsBatchRequestElementDict.md) | `from foundry.v2.orchestration.models import GetBuildsBatchRequestElementDict` | **Orchestration** | [GetBuildsBatchResponse](docs/v2/Orchestration/models/GetBuildsBatchResponse.md) | `from foundry.v2.orchestration.models import GetBuildsBatchResponse` | -**Orchestration** | [GetBuildsBatchResponseDict](docs/v2/Orchestration/models/GetBuildsBatchResponseDict.md) | `from foundry.v2.orchestration.models import GetBuildsBatchResponseDict` | **Orchestration** | [GetJobsBatchRequestElement](docs/v2/Orchestration/models/GetJobsBatchRequestElement.md) | `from foundry.v2.orchestration.models import GetJobsBatchRequestElement` | -**Orchestration** | [GetJobsBatchRequestElementDict](docs/v2/Orchestration/models/GetJobsBatchRequestElementDict.md) | `from foundry.v2.orchestration.models import GetJobsBatchRequestElementDict` | **Orchestration** | [GetJobsBatchResponse](docs/v2/Orchestration/models/GetJobsBatchResponse.md) | `from foundry.v2.orchestration.models import GetJobsBatchResponse` | -**Orchestration** | [GetJobsBatchResponseDict](docs/v2/Orchestration/models/GetJobsBatchResponseDict.md) | `from foundry.v2.orchestration.models import GetJobsBatchResponseDict` | **Orchestration** | [Job](docs/v2/Orchestration/models/Job.md) | `from foundry.v2.orchestration.models import Job` | -**Orchestration** | [JobDict](docs/v2/Orchestration/models/JobDict.md) | `from foundry.v2.orchestration.models import JobDict` | **Orchestration** | [JobOutput](docs/v2/Orchestration/models/JobOutput.md) | `from foundry.v2.orchestration.models import JobOutput` | -**Orchestration** | [JobOutputDict](docs/v2/Orchestration/models/JobOutputDict.md) | `from foundry.v2.orchestration.models import JobOutputDict` | **Orchestration** | [JobStartedTime](docs/v2/Orchestration/models/JobStartedTime.md) | `from foundry.v2.orchestration.models import JobStartedTime` | **Orchestration** | [JobStatus](docs/v2/Orchestration/models/JobStatus.md) | `from foundry.v2.orchestration.models import JobStatus` | **Orchestration** | [JobSucceededTrigger](docs/v2/Orchestration/models/JobSucceededTrigger.md) | `from foundry.v2.orchestration.models import JobSucceededTrigger` | -**Orchestration** | [JobSucceededTriggerDict](docs/v2/Orchestration/models/JobSucceededTriggerDict.md) | `from foundry.v2.orchestration.models import JobSucceededTriggerDict` | **Orchestration** | [ListJobsOfBuildResponse](docs/v2/Orchestration/models/ListJobsOfBuildResponse.md) | `from foundry.v2.orchestration.models import ListJobsOfBuildResponse` | -**Orchestration** | [ListJobsOfBuildResponseDict](docs/v2/Orchestration/models/ListJobsOfBuildResponseDict.md) | `from foundry.v2.orchestration.models import ListJobsOfBuildResponseDict` | **Orchestration** | [ListRunsOfScheduleResponse](docs/v2/Orchestration/models/ListRunsOfScheduleResponse.md) | `from foundry.v2.orchestration.models import ListRunsOfScheduleResponse` | -**Orchestration** | [ListRunsOfScheduleResponseDict](docs/v2/Orchestration/models/ListRunsOfScheduleResponseDict.md) | `from foundry.v2.orchestration.models import ListRunsOfScheduleResponseDict` | **Orchestration** | [ManualTarget](docs/v2/Orchestration/models/ManualTarget.md) | `from foundry.v2.orchestration.models import ManualTarget` | -**Orchestration** | [ManualTargetDict](docs/v2/Orchestration/models/ManualTargetDict.md) | `from foundry.v2.orchestration.models import ManualTargetDict` | **Orchestration** | [MediaSetUpdatedTrigger](docs/v2/Orchestration/models/MediaSetUpdatedTrigger.md) | `from foundry.v2.orchestration.models import MediaSetUpdatedTrigger` | -**Orchestration** | [MediaSetUpdatedTriggerDict](docs/v2/Orchestration/models/MediaSetUpdatedTriggerDict.md) | `from foundry.v2.orchestration.models import MediaSetUpdatedTriggerDict` | **Orchestration** | [NewLogicTrigger](docs/v2/Orchestration/models/NewLogicTrigger.md) | `from foundry.v2.orchestration.models import NewLogicTrigger` | -**Orchestration** | [NewLogicTriggerDict](docs/v2/Orchestration/models/NewLogicTriggerDict.md) | `from foundry.v2.orchestration.models import NewLogicTriggerDict` | **Orchestration** | [NotificationsEnabled](docs/v2/Orchestration/models/NotificationsEnabled.md) | `from foundry.v2.orchestration.models import NotificationsEnabled` | **Orchestration** | [OrTrigger](docs/v2/Orchestration/models/OrTrigger.md) | `from foundry.v2.orchestration.models import OrTrigger` | -**Orchestration** | [OrTriggerDict](docs/v2/Orchestration/models/OrTriggerDict.md) | `from foundry.v2.orchestration.models import OrTriggerDict` | **Orchestration** | [ProjectScope](docs/v2/Orchestration/models/ProjectScope.md) | `from foundry.v2.orchestration.models import ProjectScope` | -**Orchestration** | [ProjectScopeDict](docs/v2/Orchestration/models/ProjectScopeDict.md) | `from foundry.v2.orchestration.models import ProjectScopeDict` | **Orchestration** | [ReplaceScheduleRequestAction](docs/v2/Orchestration/models/ReplaceScheduleRequestAction.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestAction` | -**Orchestration** | [ReplaceScheduleRequestActionDict](docs/v2/Orchestration/models/ReplaceScheduleRequestActionDict.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestActionDict` | **Orchestration** | [ReplaceScheduleRequestBuildTarget](docs/v2/Orchestration/models/ReplaceScheduleRequestBuildTarget.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestBuildTarget` | -**Orchestration** | [ReplaceScheduleRequestBuildTargetDict](docs/v2/Orchestration/models/ReplaceScheduleRequestBuildTargetDict.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestBuildTargetDict` | **Orchestration** | [ReplaceScheduleRequestConnectingTarget](docs/v2/Orchestration/models/ReplaceScheduleRequestConnectingTarget.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestConnectingTarget` | -**Orchestration** | [ReplaceScheduleRequestConnectingTargetDict](docs/v2/Orchestration/models/ReplaceScheduleRequestConnectingTargetDict.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestConnectingTargetDict` | **Orchestration** | [ReplaceScheduleRequestManualTarget](docs/v2/Orchestration/models/ReplaceScheduleRequestManualTarget.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestManualTarget` | -**Orchestration** | [ReplaceScheduleRequestManualTargetDict](docs/v2/Orchestration/models/ReplaceScheduleRequestManualTargetDict.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestManualTargetDict` | **Orchestration** | [ReplaceScheduleRequestProjectScope](docs/v2/Orchestration/models/ReplaceScheduleRequestProjectScope.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestProjectScope` | -**Orchestration** | [ReplaceScheduleRequestProjectScopeDict](docs/v2/Orchestration/models/ReplaceScheduleRequestProjectScopeDict.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestProjectScopeDict` | **Orchestration** | [ReplaceScheduleRequestScopeMode](docs/v2/Orchestration/models/ReplaceScheduleRequestScopeMode.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestScopeMode` | -**Orchestration** | [ReplaceScheduleRequestScopeModeDict](docs/v2/Orchestration/models/ReplaceScheduleRequestScopeModeDict.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestScopeModeDict` | **Orchestration** | [ReplaceScheduleRequestUpstreamTarget](docs/v2/Orchestration/models/ReplaceScheduleRequestUpstreamTarget.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestUpstreamTarget` | -**Orchestration** | [ReplaceScheduleRequestUpstreamTargetDict](docs/v2/Orchestration/models/ReplaceScheduleRequestUpstreamTargetDict.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestUpstreamTargetDict` | **Orchestration** | [ReplaceScheduleRequestUserScope](docs/v2/Orchestration/models/ReplaceScheduleRequestUserScope.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestUserScope` | -**Orchestration** | [ReplaceScheduleRequestUserScopeDict](docs/v2/Orchestration/models/ReplaceScheduleRequestUserScopeDict.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestUserScopeDict` | **Orchestration** | [RetryBackoffDuration](docs/v2/Orchestration/models/RetryBackoffDuration.md) | `from foundry.v2.orchestration.models import RetryBackoffDuration` | -**Orchestration** | [RetryBackoffDurationDict](docs/v2/Orchestration/models/RetryBackoffDurationDict.md) | `from foundry.v2.orchestration.models import RetryBackoffDurationDict` | **Orchestration** | [RetryCount](docs/v2/Orchestration/models/RetryCount.md) | `from foundry.v2.orchestration.models import RetryCount` | **Orchestration** | [Schedule](docs/v2/Orchestration/models/Schedule.md) | `from foundry.v2.orchestration.models import Schedule` | -**Orchestration** | [ScheduleDict](docs/v2/Orchestration/models/ScheduleDict.md) | `from foundry.v2.orchestration.models import ScheduleDict` | **Orchestration** | [SchedulePaused](docs/v2/Orchestration/models/SchedulePaused.md) | `from foundry.v2.orchestration.models import SchedulePaused` | **Orchestration** | [ScheduleRid](docs/v2/Orchestration/models/ScheduleRid.md) | `from foundry.v2.orchestration.models import ScheduleRid` | **Orchestration** | [ScheduleRun](docs/v2/Orchestration/models/ScheduleRun.md) | `from foundry.v2.orchestration.models import ScheduleRun` | -**Orchestration** | [ScheduleRunDict](docs/v2/Orchestration/models/ScheduleRunDict.md) | `from foundry.v2.orchestration.models import ScheduleRunDict` | **Orchestration** | [ScheduleRunError](docs/v2/Orchestration/models/ScheduleRunError.md) | `from foundry.v2.orchestration.models import ScheduleRunError` | -**Orchestration** | [ScheduleRunErrorDict](docs/v2/Orchestration/models/ScheduleRunErrorDict.md) | `from foundry.v2.orchestration.models import ScheduleRunErrorDict` | **Orchestration** | [ScheduleRunErrorName](docs/v2/Orchestration/models/ScheduleRunErrorName.md) | `from foundry.v2.orchestration.models import ScheduleRunErrorName` | **Orchestration** | [ScheduleRunIgnored](docs/v2/Orchestration/models/ScheduleRunIgnored.md) | `from foundry.v2.orchestration.models import ScheduleRunIgnored` | -**Orchestration** | [ScheduleRunIgnoredDict](docs/v2/Orchestration/models/ScheduleRunIgnoredDict.md) | `from foundry.v2.orchestration.models import ScheduleRunIgnoredDict` | **Orchestration** | [ScheduleRunResult](docs/v2/Orchestration/models/ScheduleRunResult.md) | `from foundry.v2.orchestration.models import ScheduleRunResult` | -**Orchestration** | [ScheduleRunResultDict](docs/v2/Orchestration/models/ScheduleRunResultDict.md) | `from foundry.v2.orchestration.models import ScheduleRunResultDict` | **Orchestration** | [ScheduleRunRid](docs/v2/Orchestration/models/ScheduleRunRid.md) | `from foundry.v2.orchestration.models import ScheduleRunRid` | **Orchestration** | [ScheduleRunSubmitted](docs/v2/Orchestration/models/ScheduleRunSubmitted.md) | `from foundry.v2.orchestration.models import ScheduleRunSubmitted` | -**Orchestration** | [ScheduleRunSubmittedDict](docs/v2/Orchestration/models/ScheduleRunSubmittedDict.md) | `from foundry.v2.orchestration.models import ScheduleRunSubmittedDict` | **Orchestration** | [ScheduleSucceededTrigger](docs/v2/Orchestration/models/ScheduleSucceededTrigger.md) | `from foundry.v2.orchestration.models import ScheduleSucceededTrigger` | -**Orchestration** | [ScheduleSucceededTriggerDict](docs/v2/Orchestration/models/ScheduleSucceededTriggerDict.md) | `from foundry.v2.orchestration.models import ScheduleSucceededTriggerDict` | **Orchestration** | [ScheduleVersion](docs/v2/Orchestration/models/ScheduleVersion.md) | `from foundry.v2.orchestration.models import ScheduleVersion` | -**Orchestration** | [ScheduleVersionDict](docs/v2/Orchestration/models/ScheduleVersionDict.md) | `from foundry.v2.orchestration.models import ScheduleVersionDict` | **Orchestration** | [ScheduleVersionRid](docs/v2/Orchestration/models/ScheduleVersionRid.md) | `from foundry.v2.orchestration.models import ScheduleVersionRid` | **Orchestration** | [ScopeMode](docs/v2/Orchestration/models/ScopeMode.md) | `from foundry.v2.orchestration.models import ScopeMode` | -**Orchestration** | [ScopeModeDict](docs/v2/Orchestration/models/ScopeModeDict.md) | `from foundry.v2.orchestration.models import ScopeModeDict` | **Orchestration** | [SearchBuildsAndFilter](docs/v2/Orchestration/models/SearchBuildsAndFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsAndFilter` | -**Orchestration** | [SearchBuildsAndFilterDict](docs/v2/Orchestration/models/SearchBuildsAndFilterDict.md) | `from foundry.v2.orchestration.models import SearchBuildsAndFilterDict` | **Orchestration** | [SearchBuildsEqualsFilter](docs/v2/Orchestration/models/SearchBuildsEqualsFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsEqualsFilter` | -**Orchestration** | [SearchBuildsEqualsFilterDict](docs/v2/Orchestration/models/SearchBuildsEqualsFilterDict.md) | `from foundry.v2.orchestration.models import SearchBuildsEqualsFilterDict` | **Orchestration** | [SearchBuildsEqualsFilterField](docs/v2/Orchestration/models/SearchBuildsEqualsFilterField.md) | `from foundry.v2.orchestration.models import SearchBuildsEqualsFilterField` | **Orchestration** | [SearchBuildsFilter](docs/v2/Orchestration/models/SearchBuildsFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsFilter` | -**Orchestration** | [SearchBuildsFilterDict](docs/v2/Orchestration/models/SearchBuildsFilterDict.md) | `from foundry.v2.orchestration.models import SearchBuildsFilterDict` | **Orchestration** | [SearchBuildsGteFilter](docs/v2/Orchestration/models/SearchBuildsGteFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsGteFilter` | -**Orchestration** | [SearchBuildsGteFilterDict](docs/v2/Orchestration/models/SearchBuildsGteFilterDict.md) | `from foundry.v2.orchestration.models import SearchBuildsGteFilterDict` | **Orchestration** | [SearchBuildsGteFilterField](docs/v2/Orchestration/models/SearchBuildsGteFilterField.md) | `from foundry.v2.orchestration.models import SearchBuildsGteFilterField` | **Orchestration** | [SearchBuildsLtFilter](docs/v2/Orchestration/models/SearchBuildsLtFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsLtFilter` | -**Orchestration** | [SearchBuildsLtFilterDict](docs/v2/Orchestration/models/SearchBuildsLtFilterDict.md) | `from foundry.v2.orchestration.models import SearchBuildsLtFilterDict` | **Orchestration** | [SearchBuildsLtFilterField](docs/v2/Orchestration/models/SearchBuildsLtFilterField.md) | `from foundry.v2.orchestration.models import SearchBuildsLtFilterField` | **Orchestration** | [SearchBuildsNotFilter](docs/v2/Orchestration/models/SearchBuildsNotFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsNotFilter` | -**Orchestration** | [SearchBuildsNotFilterDict](docs/v2/Orchestration/models/SearchBuildsNotFilterDict.md) | `from foundry.v2.orchestration.models import SearchBuildsNotFilterDict` | **Orchestration** | [SearchBuildsOrderBy](docs/v2/Orchestration/models/SearchBuildsOrderBy.md) | `from foundry.v2.orchestration.models import SearchBuildsOrderBy` | -**Orchestration** | [SearchBuildsOrderByDict](docs/v2/Orchestration/models/SearchBuildsOrderByDict.md) | `from foundry.v2.orchestration.models import SearchBuildsOrderByDict` | **Orchestration** | [SearchBuildsOrderByField](docs/v2/Orchestration/models/SearchBuildsOrderByField.md) | `from foundry.v2.orchestration.models import SearchBuildsOrderByField` | **Orchestration** | [SearchBuildsOrderByItem](docs/v2/Orchestration/models/SearchBuildsOrderByItem.md) | `from foundry.v2.orchestration.models import SearchBuildsOrderByItem` | -**Orchestration** | [SearchBuildsOrderByItemDict](docs/v2/Orchestration/models/SearchBuildsOrderByItemDict.md) | `from foundry.v2.orchestration.models import SearchBuildsOrderByItemDict` | **Orchestration** | [SearchBuildsOrFilter](docs/v2/Orchestration/models/SearchBuildsOrFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsOrFilter` | -**Orchestration** | [SearchBuildsOrFilterDict](docs/v2/Orchestration/models/SearchBuildsOrFilterDict.md) | `from foundry.v2.orchestration.models import SearchBuildsOrFilterDict` | **Orchestration** | [SearchBuildsResponse](docs/v2/Orchestration/models/SearchBuildsResponse.md) | `from foundry.v2.orchestration.models import SearchBuildsResponse` | -**Orchestration** | [SearchBuildsResponseDict](docs/v2/Orchestration/models/SearchBuildsResponseDict.md) | `from foundry.v2.orchestration.models import SearchBuildsResponseDict` | **Orchestration** | [TimeTrigger](docs/v2/Orchestration/models/TimeTrigger.md) | `from foundry.v2.orchestration.models import TimeTrigger` | -**Orchestration** | [TimeTriggerDict](docs/v2/Orchestration/models/TimeTriggerDict.md) | `from foundry.v2.orchestration.models import TimeTriggerDict` | **Orchestration** | [TransactionalMediaSetJobOutput](docs/v2/Orchestration/models/TransactionalMediaSetJobOutput.md) | `from foundry.v2.orchestration.models import TransactionalMediaSetJobOutput` | -**Orchestration** | [TransactionalMediaSetJobOutputDict](docs/v2/Orchestration/models/TransactionalMediaSetJobOutputDict.md) | `from foundry.v2.orchestration.models import TransactionalMediaSetJobOutputDict` | **Orchestration** | [Trigger](docs/v2/Orchestration/models/Trigger.md) | `from foundry.v2.orchestration.models import Trigger` | -**Orchestration** | [TriggerDict](docs/v2/Orchestration/models/TriggerDict.md) | `from foundry.v2.orchestration.models import TriggerDict` | **Orchestration** | [UpstreamTarget](docs/v2/Orchestration/models/UpstreamTarget.md) | `from foundry.v2.orchestration.models import UpstreamTarget` | -**Orchestration** | [UpstreamTargetDict](docs/v2/Orchestration/models/UpstreamTargetDict.md) | `from foundry.v2.orchestration.models import UpstreamTargetDict` | **Orchestration** | [UserScope](docs/v2/Orchestration/models/UserScope.md) | `from foundry.v2.orchestration.models import UserScope` | -**Orchestration** | [UserScopeDict](docs/v2/Orchestration/models/UserScopeDict.md) | `from foundry.v2.orchestration.models import UserScopeDict` | **SqlQueries** | [CanceledQueryStatus](docs/v2/SqlQueries/models/CanceledQueryStatus.md) | `from foundry.v2.sql_queries.models import CanceledQueryStatus` | -**SqlQueries** | [CanceledQueryStatusDict](docs/v2/SqlQueries/models/CanceledQueryStatusDict.md) | `from foundry.v2.sql_queries.models import CanceledQueryStatusDict` | **SqlQueries** | [FailedQueryStatus](docs/v2/SqlQueries/models/FailedQueryStatus.md) | `from foundry.v2.sql_queries.models import FailedQueryStatus` | -**SqlQueries** | [FailedQueryStatusDict](docs/v2/SqlQueries/models/FailedQueryStatusDict.md) | `from foundry.v2.sql_queries.models import FailedQueryStatusDict` | **SqlQueries** | [QueryId](docs/v2/SqlQueries/models/QueryId.md) | `from foundry.v2.sql_queries.models import QueryId` | **SqlQueries** | [QueryStatus](docs/v2/SqlQueries/models/QueryStatus.md) | `from foundry.v2.sql_queries.models import QueryStatus` | -**SqlQueries** | [QueryStatusDict](docs/v2/SqlQueries/models/QueryStatusDict.md) | `from foundry.v2.sql_queries.models import QueryStatusDict` | **SqlQueries** | [RunningQueryStatus](docs/v2/SqlQueries/models/RunningQueryStatus.md) | `from foundry.v2.sql_queries.models import RunningQueryStatus` | -**SqlQueries** | [RunningQueryStatusDict](docs/v2/SqlQueries/models/RunningQueryStatusDict.md) | `from foundry.v2.sql_queries.models import RunningQueryStatusDict` | **SqlQueries** | [SucceededQueryStatus](docs/v2/SqlQueries/models/SucceededQueryStatus.md) | `from foundry.v2.sql_queries.models import SucceededQueryStatus` | -**SqlQueries** | [SucceededQueryStatusDict](docs/v2/SqlQueries/models/SucceededQueryStatusDict.md) | `from foundry.v2.sql_queries.models import SucceededQueryStatusDict` | **Streams** | [Compressed](docs/v2/Streams/models/Compressed.md) | `from foundry.v2.streams.models import Compressed` | **Streams** | [CreateStreamRequestStreamSchema](docs/v2/Streams/models/CreateStreamRequestStreamSchema.md) | `from foundry.v2.streams.models import CreateStreamRequestStreamSchema` | -**Streams** | [CreateStreamRequestStreamSchemaDict](docs/v2/Streams/models/CreateStreamRequestStreamSchemaDict.md) | `from foundry.v2.streams.models import CreateStreamRequestStreamSchemaDict` | **Streams** | [Dataset](docs/v2/Streams/models/Dataset.md) | `from foundry.v2.streams.models import Dataset` | -**Streams** | [DatasetDict](docs/v2/Streams/models/DatasetDict.md) | `from foundry.v2.streams.models import DatasetDict` | **Streams** | [PartitionsCount](docs/v2/Streams/models/PartitionsCount.md) | `from foundry.v2.streams.models import PartitionsCount` | **Streams** | [Record](docs/v2/Streams/models/Record.md) | `from foundry.v2.streams.models import Record` | **Streams** | [Stream](docs/v2/Streams/models/Stream.md) | `from foundry.v2.streams.models import Stream` | -**Streams** | [StreamDict](docs/v2/Streams/models/StreamDict.md) | `from foundry.v2.streams.models import StreamDict` | **Streams** | [StreamType](docs/v2/Streams/models/StreamType.md) | `from foundry.v2.streams.models import StreamType` | **Streams** | [ViewRid](docs/v2/Streams/models/ViewRid.md) | `from foundry.v2.streams.models import ViewRid` | **ThirdPartyApplications** | [ListVersionsResponse](docs/v2/ThirdPartyApplications/models/ListVersionsResponse.md) | `from foundry.v2.third_party_applications.models import ListVersionsResponse` | -**ThirdPartyApplications** | [ListVersionsResponseDict](docs/v2/ThirdPartyApplications/models/ListVersionsResponseDict.md) | `from foundry.v2.third_party_applications.models import ListVersionsResponseDict` | **ThirdPartyApplications** | [Subdomain](docs/v2/ThirdPartyApplications/models/Subdomain.md) | `from foundry.v2.third_party_applications.models import Subdomain` | **ThirdPartyApplications** | [ThirdPartyApplication](docs/v2/ThirdPartyApplications/models/ThirdPartyApplication.md) | `from foundry.v2.third_party_applications.models import ThirdPartyApplication` | -**ThirdPartyApplications** | [ThirdPartyApplicationDict](docs/v2/ThirdPartyApplications/models/ThirdPartyApplicationDict.md) | `from foundry.v2.third_party_applications.models import ThirdPartyApplicationDict` | **ThirdPartyApplications** | [ThirdPartyApplicationRid](docs/v2/ThirdPartyApplications/models/ThirdPartyApplicationRid.md) | `from foundry.v2.third_party_applications.models import ThirdPartyApplicationRid` | **ThirdPartyApplications** | [Version](docs/v2/ThirdPartyApplications/models/Version.md) | `from foundry.v2.third_party_applications.models import Version` | -**ThirdPartyApplications** | [VersionDict](docs/v2/ThirdPartyApplications/models/VersionDict.md) | `from foundry.v2.third_party_applications.models import VersionDict` | **ThirdPartyApplications** | [VersionVersion](docs/v2/ThirdPartyApplications/models/VersionVersion.md) | `from foundry.v2.third_party_applications.models import VersionVersion` | **ThirdPartyApplications** | [Website](docs/v2/ThirdPartyApplications/models/Website.md) | `from foundry.v2.third_party_applications.models import Website` | -**ThirdPartyApplications** | [WebsiteDict](docs/v2/ThirdPartyApplications/models/WebsiteDict.md) | `from foundry.v2.third_party_applications.models import WebsiteDict` | ## Documentation for V1 models @@ -2077,303 +1489,195 @@ Namespace | Name | Import | Namespace | Name | Import | --------- | ---- | ------ | **Core** | [AnyType](docs/v1/Core/models/AnyType.md) | `from foundry.v1.core.models import AnyType` | -**Core** | [AnyTypeDict](docs/v1/Core/models/AnyTypeDict.md) | `from foundry.v1.core.models import AnyTypeDict` | -**Core** | [AttachmentTypeDict](docs/v1/Core/models/AttachmentTypeDict.md) | `from foundry.v1.core.models import AttachmentTypeDict` | +**Core** | [AttachmentType](docs/v1/Core/models/AttachmentType.md) | `from foundry.v1.core.models import AttachmentType` | **Core** | [BinaryType](docs/v1/Core/models/BinaryType.md) | `from foundry.v1.core.models import BinaryType` | -**Core** | [BinaryTypeDict](docs/v1/Core/models/BinaryTypeDict.md) | `from foundry.v1.core.models import BinaryTypeDict` | **Core** | [BooleanType](docs/v1/Core/models/BooleanType.md) | `from foundry.v1.core.models import BooleanType` | -**Core** | [BooleanTypeDict](docs/v1/Core/models/BooleanTypeDict.md) | `from foundry.v1.core.models import BooleanTypeDict` | **Core** | [ByteType](docs/v1/Core/models/ByteType.md) | `from foundry.v1.core.models import ByteType` | -**Core** | [ByteTypeDict](docs/v1/Core/models/ByteTypeDict.md) | `from foundry.v1.core.models import ByteTypeDict` | **Core** | [CipherTextType](docs/v1/Core/models/CipherTextType.md) | `from foundry.v1.core.models import CipherTextType` | -**Core** | [CipherTextTypeDict](docs/v1/Core/models/CipherTextTypeDict.md) | `from foundry.v1.core.models import CipherTextTypeDict` | **Core** | [ContentLength](docs/v1/Core/models/ContentLength.md) | `from foundry.v1.core.models import ContentLength` | **Core** | [ContentType](docs/v1/Core/models/ContentType.md) | `from foundry.v1.core.models import ContentType` | **Core** | [DateType](docs/v1/Core/models/DateType.md) | `from foundry.v1.core.models import DateType` | -**Core** | [DateTypeDict](docs/v1/Core/models/DateTypeDict.md) | `from foundry.v1.core.models import DateTypeDict` | **Core** | [DecimalType](docs/v1/Core/models/DecimalType.md) | `from foundry.v1.core.models import DecimalType` | -**Core** | [DecimalTypeDict](docs/v1/Core/models/DecimalTypeDict.md) | `from foundry.v1.core.models import DecimalTypeDict` | **Core** | [DisplayName](docs/v1/Core/models/DisplayName.md) | `from foundry.v1.core.models import DisplayName` | **Core** | [DistanceUnit](docs/v1/Core/models/DistanceUnit.md) | `from foundry.v1.core.models import DistanceUnit` | **Core** | [DoubleType](docs/v1/Core/models/DoubleType.md) | `from foundry.v1.core.models import DoubleType` | -**Core** | [DoubleTypeDict](docs/v1/Core/models/DoubleTypeDict.md) | `from foundry.v1.core.models import DoubleTypeDict` | **Core** | [Filename](docs/v1/Core/models/Filename.md) | `from foundry.v1.core.models import Filename` | **Core** | [FilePath](docs/v1/Core/models/FilePath.md) | `from foundry.v1.core.models import FilePath` | **Core** | [FloatType](docs/v1/Core/models/FloatType.md) | `from foundry.v1.core.models import FloatType` | -**Core** | [FloatTypeDict](docs/v1/Core/models/FloatTypeDict.md) | `from foundry.v1.core.models import FloatTypeDict` | **Core** | [FolderRid](docs/v1/Core/models/FolderRid.md) | `from foundry.v1.core.models import FolderRid` | **Core** | [IntegerType](docs/v1/Core/models/IntegerType.md) | `from foundry.v1.core.models import IntegerType` | -**Core** | [IntegerTypeDict](docs/v1/Core/models/IntegerTypeDict.md) | `from foundry.v1.core.models import IntegerTypeDict` | **Core** | [LongType](docs/v1/Core/models/LongType.md) | `from foundry.v1.core.models import LongType` | -**Core** | [LongTypeDict](docs/v1/Core/models/LongTypeDict.md) | `from foundry.v1.core.models import LongTypeDict` | **Core** | [MarkingType](docs/v1/Core/models/MarkingType.md) | `from foundry.v1.core.models import MarkingType` | -**Core** | [MarkingTypeDict](docs/v1/Core/models/MarkingTypeDict.md) | `from foundry.v1.core.models import MarkingTypeDict` | **Core** | [MediaType](docs/v1/Core/models/MediaType.md) | `from foundry.v1.core.models import MediaType` | -**Core** | [NullTypeDict](docs/v1/Core/models/NullTypeDict.md) | `from foundry.v1.core.models import NullTypeDict` | +**Core** | [NullType](docs/v1/Core/models/NullType.md) | `from foundry.v1.core.models import NullType` | **Core** | [OperationScope](docs/v1/Core/models/OperationScope.md) | `from foundry.v1.core.models import OperationScope` | **Core** | [PageSize](docs/v1/Core/models/PageSize.md) | `from foundry.v1.core.models import PageSize` | **Core** | [PageToken](docs/v1/Core/models/PageToken.md) | `from foundry.v1.core.models import PageToken` | **Core** | [PreviewMode](docs/v1/Core/models/PreviewMode.md) | `from foundry.v1.core.models import PreviewMode` | **Core** | [ReleaseStatus](docs/v1/Core/models/ReleaseStatus.md) | `from foundry.v1.core.models import ReleaseStatus` | **Core** | [ShortType](docs/v1/Core/models/ShortType.md) | `from foundry.v1.core.models import ShortType` | -**Core** | [ShortTypeDict](docs/v1/Core/models/ShortTypeDict.md) | `from foundry.v1.core.models import ShortTypeDict` | **Core** | [SizeBytes](docs/v1/Core/models/SizeBytes.md) | `from foundry.v1.core.models import SizeBytes` | **Core** | [StringType](docs/v1/Core/models/StringType.md) | `from foundry.v1.core.models import StringType` | -**Core** | [StringTypeDict](docs/v1/Core/models/StringTypeDict.md) | `from foundry.v1.core.models import StringTypeDict` | **Core** | [StructFieldName](docs/v1/Core/models/StructFieldName.md) | `from foundry.v1.core.models import StructFieldName` | **Core** | [TimestampType](docs/v1/Core/models/TimestampType.md) | `from foundry.v1.core.models import TimestampType` | -**Core** | [TimestampTypeDict](docs/v1/Core/models/TimestampTypeDict.md) | `from foundry.v1.core.models import TimestampTypeDict` | **Core** | [TotalCount](docs/v1/Core/models/TotalCount.md) | `from foundry.v1.core.models import TotalCount` | **Core** | [UnsupportedType](docs/v1/Core/models/UnsupportedType.md) | `from foundry.v1.core.models import UnsupportedType` | -**Core** | [UnsupportedTypeDict](docs/v1/Core/models/UnsupportedTypeDict.md) | `from foundry.v1.core.models import UnsupportedTypeDict` | **Datasets** | [Branch](docs/v1/Datasets/models/Branch.md) | `from foundry.v1.datasets.models import Branch` | -**Datasets** | [BranchDict](docs/v1/Datasets/models/BranchDict.md) | `from foundry.v1.datasets.models import BranchDict` | **Datasets** | [BranchId](docs/v1/Datasets/models/BranchId.md) | `from foundry.v1.datasets.models import BranchId` | **Datasets** | [Dataset](docs/v1/Datasets/models/Dataset.md) | `from foundry.v1.datasets.models import Dataset` | -**Datasets** | [DatasetDict](docs/v1/Datasets/models/DatasetDict.md) | `from foundry.v1.datasets.models import DatasetDict` | **Datasets** | [DatasetName](docs/v1/Datasets/models/DatasetName.md) | `from foundry.v1.datasets.models import DatasetName` | **Datasets** | [DatasetRid](docs/v1/Datasets/models/DatasetRid.md) | `from foundry.v1.datasets.models import DatasetRid` | **Datasets** | [File](docs/v1/Datasets/models/File.md) | `from foundry.v1.datasets.models import File` | -**Datasets** | [FileDict](docs/v1/Datasets/models/FileDict.md) | `from foundry.v1.datasets.models import FileDict` | **Datasets** | [ListBranchesResponse](docs/v1/Datasets/models/ListBranchesResponse.md) | `from foundry.v1.datasets.models import ListBranchesResponse` | -**Datasets** | [ListBranchesResponseDict](docs/v1/Datasets/models/ListBranchesResponseDict.md) | `from foundry.v1.datasets.models import ListBranchesResponseDict` | **Datasets** | [ListFilesResponse](docs/v1/Datasets/models/ListFilesResponse.md) | `from foundry.v1.datasets.models import ListFilesResponse` | -**Datasets** | [ListFilesResponseDict](docs/v1/Datasets/models/ListFilesResponseDict.md) | `from foundry.v1.datasets.models import ListFilesResponseDict` | **Datasets** | [TableExportFormat](docs/v1/Datasets/models/TableExportFormat.md) | `from foundry.v1.datasets.models import TableExportFormat` | **Datasets** | [Transaction](docs/v1/Datasets/models/Transaction.md) | `from foundry.v1.datasets.models import Transaction` | -**Datasets** | [TransactionDict](docs/v1/Datasets/models/TransactionDict.md) | `from foundry.v1.datasets.models import TransactionDict` | **Datasets** | [TransactionRid](docs/v1/Datasets/models/TransactionRid.md) | `from foundry.v1.datasets.models import TransactionRid` | **Datasets** | [TransactionStatus](docs/v1/Datasets/models/TransactionStatus.md) | `from foundry.v1.datasets.models import TransactionStatus` | **Datasets** | [TransactionType](docs/v1/Datasets/models/TransactionType.md) | `from foundry.v1.datasets.models import TransactionType` | **Ontologies** | [ActionRid](docs/v1/Ontologies/models/ActionRid.md) | `from foundry.v1.ontologies.models import ActionRid` | **Ontologies** | [ActionType](docs/v1/Ontologies/models/ActionType.md) | `from foundry.v1.ontologies.models import ActionType` | **Ontologies** | [ActionTypeApiName](docs/v1/Ontologies/models/ActionTypeApiName.md) | `from foundry.v1.ontologies.models import ActionTypeApiName` | -**Ontologies** | [ActionTypeDict](docs/v1/Ontologies/models/ActionTypeDict.md) | `from foundry.v1.ontologies.models import ActionTypeDict` | **Ontologies** | [ActionTypeRid](docs/v1/Ontologies/models/ActionTypeRid.md) | `from foundry.v1.ontologies.models import ActionTypeRid` | **Ontologies** | [AggregateObjectsResponse](docs/v1/Ontologies/models/AggregateObjectsResponse.md) | `from foundry.v1.ontologies.models import AggregateObjectsResponse` | -**Ontologies** | [AggregateObjectsResponseDict](docs/v1/Ontologies/models/AggregateObjectsResponseDict.md) | `from foundry.v1.ontologies.models import AggregateObjectsResponseDict` | **Ontologies** | [AggregateObjectsResponseItem](docs/v1/Ontologies/models/AggregateObjectsResponseItem.md) | `from foundry.v1.ontologies.models import AggregateObjectsResponseItem` | -**Ontologies** | [AggregateObjectsResponseItemDict](docs/v1/Ontologies/models/AggregateObjectsResponseItemDict.md) | `from foundry.v1.ontologies.models import AggregateObjectsResponseItemDict` | **Ontologies** | [Aggregation](docs/v1/Ontologies/models/Aggregation.md) | `from foundry.v1.ontologies.models import Aggregation` | -**Ontologies** | [AggregationDict](docs/v1/Ontologies/models/AggregationDict.md) | `from foundry.v1.ontologies.models import AggregationDict` | **Ontologies** | [AggregationDurationGrouping](docs/v1/Ontologies/models/AggregationDurationGrouping.md) | `from foundry.v1.ontologies.models import AggregationDurationGrouping` | -**Ontologies** | [AggregationDurationGroupingDict](docs/v1/Ontologies/models/AggregationDurationGroupingDict.md) | `from foundry.v1.ontologies.models import AggregationDurationGroupingDict` | **Ontologies** | [AggregationExactGrouping](docs/v1/Ontologies/models/AggregationExactGrouping.md) | `from foundry.v1.ontologies.models import AggregationExactGrouping` | -**Ontologies** | [AggregationExactGroupingDict](docs/v1/Ontologies/models/AggregationExactGroupingDict.md) | `from foundry.v1.ontologies.models import AggregationExactGroupingDict` | **Ontologies** | [AggregationFixedWidthGrouping](docs/v1/Ontologies/models/AggregationFixedWidthGrouping.md) | `from foundry.v1.ontologies.models import AggregationFixedWidthGrouping` | -**Ontologies** | [AggregationFixedWidthGroupingDict](docs/v1/Ontologies/models/AggregationFixedWidthGroupingDict.md) | `from foundry.v1.ontologies.models import AggregationFixedWidthGroupingDict` | **Ontologies** | [AggregationGroupBy](docs/v1/Ontologies/models/AggregationGroupBy.md) | `from foundry.v1.ontologies.models import AggregationGroupBy` | -**Ontologies** | [AggregationGroupByDict](docs/v1/Ontologies/models/AggregationGroupByDict.md) | `from foundry.v1.ontologies.models import AggregationGroupByDict` | **Ontologies** | [AggregationGroupKey](docs/v1/Ontologies/models/AggregationGroupKey.md) | `from foundry.v1.ontologies.models import AggregationGroupKey` | **Ontologies** | [AggregationGroupValue](docs/v1/Ontologies/models/AggregationGroupValue.md) | `from foundry.v1.ontologies.models import AggregationGroupValue` | **Ontologies** | [AggregationMetricName](docs/v1/Ontologies/models/AggregationMetricName.md) | `from foundry.v1.ontologies.models import AggregationMetricName` | **Ontologies** | [AggregationMetricResult](docs/v1/Ontologies/models/AggregationMetricResult.md) | `from foundry.v1.ontologies.models import AggregationMetricResult` | -**Ontologies** | [AggregationMetricResultDict](docs/v1/Ontologies/models/AggregationMetricResultDict.md) | `from foundry.v1.ontologies.models import AggregationMetricResultDict` | **Ontologies** | [AggregationRange](docs/v1/Ontologies/models/AggregationRange.md) | `from foundry.v1.ontologies.models import AggregationRange` | -**Ontologies** | [AggregationRangeDict](docs/v1/Ontologies/models/AggregationRangeDict.md) | `from foundry.v1.ontologies.models import AggregationRangeDict` | **Ontologies** | [AggregationRangesGrouping](docs/v1/Ontologies/models/AggregationRangesGrouping.md) | `from foundry.v1.ontologies.models import AggregationRangesGrouping` | -**Ontologies** | [AggregationRangesGroupingDict](docs/v1/Ontologies/models/AggregationRangesGroupingDict.md) | `from foundry.v1.ontologies.models import AggregationRangesGroupingDict` | **Ontologies** | [AllTermsQuery](docs/v1/Ontologies/models/AllTermsQuery.md) | `from foundry.v1.ontologies.models import AllTermsQuery` | -**Ontologies** | [AllTermsQueryDict](docs/v1/Ontologies/models/AllTermsQueryDict.md) | `from foundry.v1.ontologies.models import AllTermsQueryDict` | **Ontologies** | [AndQuery](docs/v1/Ontologies/models/AndQuery.md) | `from foundry.v1.ontologies.models import AndQuery` | -**Ontologies** | [AndQueryDict](docs/v1/Ontologies/models/AndQueryDict.md) | `from foundry.v1.ontologies.models import AndQueryDict` | **Ontologies** | [AnyTermQuery](docs/v1/Ontologies/models/AnyTermQuery.md) | `from foundry.v1.ontologies.models import AnyTermQuery` | -**Ontologies** | [AnyTermQueryDict](docs/v1/Ontologies/models/AnyTermQueryDict.md) | `from foundry.v1.ontologies.models import AnyTermQueryDict` | **Ontologies** | [ApplyActionMode](docs/v1/Ontologies/models/ApplyActionMode.md) | `from foundry.v1.ontologies.models import ApplyActionMode` | **Ontologies** | [ApplyActionRequest](docs/v1/Ontologies/models/ApplyActionRequest.md) | `from foundry.v1.ontologies.models import ApplyActionRequest` | -**Ontologies** | [ApplyActionRequestDict](docs/v1/Ontologies/models/ApplyActionRequestDict.md) | `from foundry.v1.ontologies.models import ApplyActionRequestDict` | **Ontologies** | [ApplyActionRequestOptions](docs/v1/Ontologies/models/ApplyActionRequestOptions.md) | `from foundry.v1.ontologies.models import ApplyActionRequestOptions` | -**Ontologies** | [ApplyActionRequestOptionsDict](docs/v1/Ontologies/models/ApplyActionRequestOptionsDict.md) | `from foundry.v1.ontologies.models import ApplyActionRequestOptionsDict` | **Ontologies** | [ApplyActionResponse](docs/v1/Ontologies/models/ApplyActionResponse.md) | `from foundry.v1.ontologies.models import ApplyActionResponse` | -**Ontologies** | [ApplyActionResponseDict](docs/v1/Ontologies/models/ApplyActionResponseDict.md) | `from foundry.v1.ontologies.models import ApplyActionResponseDict` | **Ontologies** | [ApproximateDistinctAggregation](docs/v1/Ontologies/models/ApproximateDistinctAggregation.md) | `from foundry.v1.ontologies.models import ApproximateDistinctAggregation` | -**Ontologies** | [ApproximateDistinctAggregationDict](docs/v1/Ontologies/models/ApproximateDistinctAggregationDict.md) | `from foundry.v1.ontologies.models import ApproximateDistinctAggregationDict` | **Ontologies** | [ArraySizeConstraint](docs/v1/Ontologies/models/ArraySizeConstraint.md) | `from foundry.v1.ontologies.models import ArraySizeConstraint` | -**Ontologies** | [ArraySizeConstraintDict](docs/v1/Ontologies/models/ArraySizeConstraintDict.md) | `from foundry.v1.ontologies.models import ArraySizeConstraintDict` | **Ontologies** | [ArtifactRepositoryRid](docs/v1/Ontologies/models/ArtifactRepositoryRid.md) | `from foundry.v1.ontologies.models import ArtifactRepositoryRid` | **Ontologies** | [Attachment](docs/v1/Ontologies/models/Attachment.md) | `from foundry.v1.ontologies.models import Attachment` | -**Ontologies** | [AttachmentDict](docs/v1/Ontologies/models/AttachmentDict.md) | `from foundry.v1.ontologies.models import AttachmentDict` | **Ontologies** | [AttachmentRid](docs/v1/Ontologies/models/AttachmentRid.md) | `from foundry.v1.ontologies.models import AttachmentRid` | **Ontologies** | [AvgAggregation](docs/v1/Ontologies/models/AvgAggregation.md) | `from foundry.v1.ontologies.models import AvgAggregation` | -**Ontologies** | [AvgAggregationDict](docs/v1/Ontologies/models/AvgAggregationDict.md) | `from foundry.v1.ontologies.models import AvgAggregationDict` | **Ontologies** | [BatchApplyActionResponse](docs/v1/Ontologies/models/BatchApplyActionResponse.md) | `from foundry.v1.ontologies.models import BatchApplyActionResponse` | -**Ontologies** | [BatchApplyActionResponseDict](docs/v1/Ontologies/models/BatchApplyActionResponseDict.md) | `from foundry.v1.ontologies.models import BatchApplyActionResponseDict` | **Ontologies** | [ContainsQuery](docs/v1/Ontologies/models/ContainsQuery.md) | `from foundry.v1.ontologies.models import ContainsQuery` | -**Ontologies** | [ContainsQueryDict](docs/v1/Ontologies/models/ContainsQueryDict.md) | `from foundry.v1.ontologies.models import ContainsQueryDict` | **Ontologies** | [CountAggregation](docs/v1/Ontologies/models/CountAggregation.md) | `from foundry.v1.ontologies.models import CountAggregation` | -**Ontologies** | [CountAggregationDict](docs/v1/Ontologies/models/CountAggregationDict.md) | `from foundry.v1.ontologies.models import CountAggregationDict` | **Ontologies** | [CreateInterfaceObjectRule](docs/v1/Ontologies/models/CreateInterfaceObjectRule.md) | `from foundry.v1.ontologies.models import CreateInterfaceObjectRule` | -**Ontologies** | [CreateInterfaceObjectRuleDict](docs/v1/Ontologies/models/CreateInterfaceObjectRuleDict.md) | `from foundry.v1.ontologies.models import CreateInterfaceObjectRuleDict` | **Ontologies** | [CreateLinkRule](docs/v1/Ontologies/models/CreateLinkRule.md) | `from foundry.v1.ontologies.models import CreateLinkRule` | -**Ontologies** | [CreateLinkRuleDict](docs/v1/Ontologies/models/CreateLinkRuleDict.md) | `from foundry.v1.ontologies.models import CreateLinkRuleDict` | **Ontologies** | [CreateObjectRule](docs/v1/Ontologies/models/CreateObjectRule.md) | `from foundry.v1.ontologies.models import CreateObjectRule` | -**Ontologies** | [CreateObjectRuleDict](docs/v1/Ontologies/models/CreateObjectRuleDict.md) | `from foundry.v1.ontologies.models import CreateObjectRuleDict` | **Ontologies** | [DataValue](docs/v1/Ontologies/models/DataValue.md) | `from foundry.v1.ontologies.models import DataValue` | **Ontologies** | [DeleteInterfaceObjectRule](docs/v1/Ontologies/models/DeleteInterfaceObjectRule.md) | `from foundry.v1.ontologies.models import DeleteInterfaceObjectRule` | -**Ontologies** | [DeleteInterfaceObjectRuleDict](docs/v1/Ontologies/models/DeleteInterfaceObjectRuleDict.md) | `from foundry.v1.ontologies.models import DeleteInterfaceObjectRuleDict` | **Ontologies** | [DeleteLinkRule](docs/v1/Ontologies/models/DeleteLinkRule.md) | `from foundry.v1.ontologies.models import DeleteLinkRule` | -**Ontologies** | [DeleteLinkRuleDict](docs/v1/Ontologies/models/DeleteLinkRuleDict.md) | `from foundry.v1.ontologies.models import DeleteLinkRuleDict` | **Ontologies** | [DeleteObjectRule](docs/v1/Ontologies/models/DeleteObjectRule.md) | `from foundry.v1.ontologies.models import DeleteObjectRule` | -**Ontologies** | [DeleteObjectRuleDict](docs/v1/Ontologies/models/DeleteObjectRuleDict.md) | `from foundry.v1.ontologies.models import DeleteObjectRuleDict` | **Ontologies** | [DerivedPropertyApiName](docs/v1/Ontologies/models/DerivedPropertyApiName.md) | `from foundry.v1.ontologies.models import DerivedPropertyApiName` | **Ontologies** | [Duration](docs/v1/Ontologies/models/Duration.md) | `from foundry.v1.ontologies.models import Duration` | -**Ontologies** | [EntrySetTypeDict](docs/v1/Ontologies/models/EntrySetTypeDict.md) | `from foundry.v1.ontologies.models import EntrySetTypeDict` | +**Ontologies** | [EntrySetType](docs/v1/Ontologies/models/EntrySetType.md) | `from foundry.v1.ontologies.models import EntrySetType` | **Ontologies** | [EqualsQuery](docs/v1/Ontologies/models/EqualsQuery.md) | `from foundry.v1.ontologies.models import EqualsQuery` | -**Ontologies** | [EqualsQueryDict](docs/v1/Ontologies/models/EqualsQueryDict.md) | `from foundry.v1.ontologies.models import EqualsQueryDict` | **Ontologies** | [ExecuteQueryResponse](docs/v1/Ontologies/models/ExecuteQueryResponse.md) | `from foundry.v1.ontologies.models import ExecuteQueryResponse` | -**Ontologies** | [ExecuteQueryResponseDict](docs/v1/Ontologies/models/ExecuteQueryResponseDict.md) | `from foundry.v1.ontologies.models import ExecuteQueryResponseDict` | **Ontologies** | [FieldNameV1](docs/v1/Ontologies/models/FieldNameV1.md) | `from foundry.v1.ontologies.models import FieldNameV1` | **Ontologies** | [FilterValue](docs/v1/Ontologies/models/FilterValue.md) | `from foundry.v1.ontologies.models import FilterValue` | **Ontologies** | [FunctionRid](docs/v1/Ontologies/models/FunctionRid.md) | `from foundry.v1.ontologies.models import FunctionRid` | **Ontologies** | [FunctionVersion](docs/v1/Ontologies/models/FunctionVersion.md) | `from foundry.v1.ontologies.models import FunctionVersion` | **Ontologies** | [Fuzzy](docs/v1/Ontologies/models/Fuzzy.md) | `from foundry.v1.ontologies.models import Fuzzy` | **Ontologies** | [GroupMemberConstraint](docs/v1/Ontologies/models/GroupMemberConstraint.md) | `from foundry.v1.ontologies.models import GroupMemberConstraint` | -**Ontologies** | [GroupMemberConstraintDict](docs/v1/Ontologies/models/GroupMemberConstraintDict.md) | `from foundry.v1.ontologies.models import GroupMemberConstraintDict` | **Ontologies** | [GteQuery](docs/v1/Ontologies/models/GteQuery.md) | `from foundry.v1.ontologies.models import GteQuery` | -**Ontologies** | [GteQueryDict](docs/v1/Ontologies/models/GteQueryDict.md) | `from foundry.v1.ontologies.models import GteQueryDict` | **Ontologies** | [GtQuery](docs/v1/Ontologies/models/GtQuery.md) | `from foundry.v1.ontologies.models import GtQuery` | -**Ontologies** | [GtQueryDict](docs/v1/Ontologies/models/GtQueryDict.md) | `from foundry.v1.ontologies.models import GtQueryDict` | **Ontologies** | [InterfaceTypeApiName](docs/v1/Ontologies/models/InterfaceTypeApiName.md) | `from foundry.v1.ontologies.models import InterfaceTypeApiName` | **Ontologies** | [InterfaceTypeRid](docs/v1/Ontologies/models/InterfaceTypeRid.md) | `from foundry.v1.ontologies.models import InterfaceTypeRid` | **Ontologies** | [IsNullQuery](docs/v1/Ontologies/models/IsNullQuery.md) | `from foundry.v1.ontologies.models import IsNullQuery` | -**Ontologies** | [IsNullQueryDict](docs/v1/Ontologies/models/IsNullQueryDict.md) | `from foundry.v1.ontologies.models import IsNullQueryDict` | **Ontologies** | [LinkTypeApiName](docs/v1/Ontologies/models/LinkTypeApiName.md) | `from foundry.v1.ontologies.models import LinkTypeApiName` | **Ontologies** | [LinkTypeSide](docs/v1/Ontologies/models/LinkTypeSide.md) | `from foundry.v1.ontologies.models import LinkTypeSide` | **Ontologies** | [LinkTypeSideCardinality](docs/v1/Ontologies/models/LinkTypeSideCardinality.md) | `from foundry.v1.ontologies.models import LinkTypeSideCardinality` | -**Ontologies** | [LinkTypeSideDict](docs/v1/Ontologies/models/LinkTypeSideDict.md) | `from foundry.v1.ontologies.models import LinkTypeSideDict` | **Ontologies** | [ListActionTypesResponse](docs/v1/Ontologies/models/ListActionTypesResponse.md) | `from foundry.v1.ontologies.models import ListActionTypesResponse` | -**Ontologies** | [ListActionTypesResponseDict](docs/v1/Ontologies/models/ListActionTypesResponseDict.md) | `from foundry.v1.ontologies.models import ListActionTypesResponseDict` | **Ontologies** | [ListLinkedObjectsResponse](docs/v1/Ontologies/models/ListLinkedObjectsResponse.md) | `from foundry.v1.ontologies.models import ListLinkedObjectsResponse` | -**Ontologies** | [ListLinkedObjectsResponseDict](docs/v1/Ontologies/models/ListLinkedObjectsResponseDict.md) | `from foundry.v1.ontologies.models import ListLinkedObjectsResponseDict` | **Ontologies** | [ListObjectsResponse](docs/v1/Ontologies/models/ListObjectsResponse.md) | `from foundry.v1.ontologies.models import ListObjectsResponse` | -**Ontologies** | [ListObjectsResponseDict](docs/v1/Ontologies/models/ListObjectsResponseDict.md) | `from foundry.v1.ontologies.models import ListObjectsResponseDict` | **Ontologies** | [ListObjectTypesResponse](docs/v1/Ontologies/models/ListObjectTypesResponse.md) | `from foundry.v1.ontologies.models import ListObjectTypesResponse` | -**Ontologies** | [ListObjectTypesResponseDict](docs/v1/Ontologies/models/ListObjectTypesResponseDict.md) | `from foundry.v1.ontologies.models import ListObjectTypesResponseDict` | **Ontologies** | [ListOntologiesResponse](docs/v1/Ontologies/models/ListOntologiesResponse.md) | `from foundry.v1.ontologies.models import ListOntologiesResponse` | -**Ontologies** | [ListOntologiesResponseDict](docs/v1/Ontologies/models/ListOntologiesResponseDict.md) | `from foundry.v1.ontologies.models import ListOntologiesResponseDict` | **Ontologies** | [ListOutgoingLinkTypesResponse](docs/v1/Ontologies/models/ListOutgoingLinkTypesResponse.md) | `from foundry.v1.ontologies.models import ListOutgoingLinkTypesResponse` | -**Ontologies** | [ListOutgoingLinkTypesResponseDict](docs/v1/Ontologies/models/ListOutgoingLinkTypesResponseDict.md) | `from foundry.v1.ontologies.models import ListOutgoingLinkTypesResponseDict` | **Ontologies** | [ListQueryTypesResponse](docs/v1/Ontologies/models/ListQueryTypesResponse.md) | `from foundry.v1.ontologies.models import ListQueryTypesResponse` | -**Ontologies** | [ListQueryTypesResponseDict](docs/v1/Ontologies/models/ListQueryTypesResponseDict.md) | `from foundry.v1.ontologies.models import ListQueryTypesResponseDict` | **Ontologies** | [LogicRule](docs/v1/Ontologies/models/LogicRule.md) | `from foundry.v1.ontologies.models import LogicRule` | -**Ontologies** | [LogicRuleDict](docs/v1/Ontologies/models/LogicRuleDict.md) | `from foundry.v1.ontologies.models import LogicRuleDict` | **Ontologies** | [LteQuery](docs/v1/Ontologies/models/LteQuery.md) | `from foundry.v1.ontologies.models import LteQuery` | -**Ontologies** | [LteQueryDict](docs/v1/Ontologies/models/LteQueryDict.md) | `from foundry.v1.ontologies.models import LteQueryDict` | **Ontologies** | [LtQuery](docs/v1/Ontologies/models/LtQuery.md) | `from foundry.v1.ontologies.models import LtQuery` | -**Ontologies** | [LtQueryDict](docs/v1/Ontologies/models/LtQueryDict.md) | `from foundry.v1.ontologies.models import LtQueryDict` | **Ontologies** | [MaxAggregation](docs/v1/Ontologies/models/MaxAggregation.md) | `from foundry.v1.ontologies.models import MaxAggregation` | -**Ontologies** | [MaxAggregationDict](docs/v1/Ontologies/models/MaxAggregationDict.md) | `from foundry.v1.ontologies.models import MaxAggregationDict` | **Ontologies** | [MinAggregation](docs/v1/Ontologies/models/MinAggregation.md) | `from foundry.v1.ontologies.models import MinAggregation` | -**Ontologies** | [MinAggregationDict](docs/v1/Ontologies/models/MinAggregationDict.md) | `from foundry.v1.ontologies.models import MinAggregationDict` | **Ontologies** | [ModifyInterfaceObjectRule](docs/v1/Ontologies/models/ModifyInterfaceObjectRule.md) | `from foundry.v1.ontologies.models import ModifyInterfaceObjectRule` | -**Ontologies** | [ModifyInterfaceObjectRuleDict](docs/v1/Ontologies/models/ModifyInterfaceObjectRuleDict.md) | `from foundry.v1.ontologies.models import ModifyInterfaceObjectRuleDict` | **Ontologies** | [ModifyObjectRule](docs/v1/Ontologies/models/ModifyObjectRule.md) | `from foundry.v1.ontologies.models import ModifyObjectRule` | -**Ontologies** | [ModifyObjectRuleDict](docs/v1/Ontologies/models/ModifyObjectRuleDict.md) | `from foundry.v1.ontologies.models import ModifyObjectRuleDict` | **Ontologies** | [NotQuery](docs/v1/Ontologies/models/NotQuery.md) | `from foundry.v1.ontologies.models import NotQuery` | -**Ontologies** | [NotQueryDict](docs/v1/Ontologies/models/NotQueryDict.md) | `from foundry.v1.ontologies.models import NotQueryDict` | **Ontologies** | [ObjectPropertyValueConstraint](docs/v1/Ontologies/models/ObjectPropertyValueConstraint.md) | `from foundry.v1.ontologies.models import ObjectPropertyValueConstraint` | -**Ontologies** | [ObjectPropertyValueConstraintDict](docs/v1/Ontologies/models/ObjectPropertyValueConstraintDict.md) | `from foundry.v1.ontologies.models import ObjectPropertyValueConstraintDict` | **Ontologies** | [ObjectQueryResultConstraint](docs/v1/Ontologies/models/ObjectQueryResultConstraint.md) | `from foundry.v1.ontologies.models import ObjectQueryResultConstraint` | -**Ontologies** | [ObjectQueryResultConstraintDict](docs/v1/Ontologies/models/ObjectQueryResultConstraintDict.md) | `from foundry.v1.ontologies.models import ObjectQueryResultConstraintDict` | **Ontologies** | [ObjectRid](docs/v1/Ontologies/models/ObjectRid.md) | `from foundry.v1.ontologies.models import ObjectRid` | **Ontologies** | [ObjectSetRid](docs/v1/Ontologies/models/ObjectSetRid.md) | `from foundry.v1.ontologies.models import ObjectSetRid` | **Ontologies** | [ObjectType](docs/v1/Ontologies/models/ObjectType.md) | `from foundry.v1.ontologies.models import ObjectType` | **Ontologies** | [ObjectTypeApiName](docs/v1/Ontologies/models/ObjectTypeApiName.md) | `from foundry.v1.ontologies.models import ObjectTypeApiName` | -**Ontologies** | [ObjectTypeDict](docs/v1/Ontologies/models/ObjectTypeDict.md) | `from foundry.v1.ontologies.models import ObjectTypeDict` | **Ontologies** | [ObjectTypeRid](docs/v1/Ontologies/models/ObjectTypeRid.md) | `from foundry.v1.ontologies.models import ObjectTypeRid` | **Ontologies** | [ObjectTypeVisibility](docs/v1/Ontologies/models/ObjectTypeVisibility.md) | `from foundry.v1.ontologies.models import ObjectTypeVisibility` | **Ontologies** | [OneOfConstraint](docs/v1/Ontologies/models/OneOfConstraint.md) | `from foundry.v1.ontologies.models import OneOfConstraint` | -**Ontologies** | [OneOfConstraintDict](docs/v1/Ontologies/models/OneOfConstraintDict.md) | `from foundry.v1.ontologies.models import OneOfConstraintDict` | **Ontologies** | [Ontology](docs/v1/Ontologies/models/Ontology.md) | `from foundry.v1.ontologies.models import Ontology` | **Ontologies** | [OntologyApiName](docs/v1/Ontologies/models/OntologyApiName.md) | `from foundry.v1.ontologies.models import OntologyApiName` | **Ontologies** | [OntologyArrayType](docs/v1/Ontologies/models/OntologyArrayType.md) | `from foundry.v1.ontologies.models import OntologyArrayType` | -**Ontologies** | [OntologyArrayTypeDict](docs/v1/Ontologies/models/OntologyArrayTypeDict.md) | `from foundry.v1.ontologies.models import OntologyArrayTypeDict` | **Ontologies** | [OntologyDataType](docs/v1/Ontologies/models/OntologyDataType.md) | `from foundry.v1.ontologies.models import OntologyDataType` | -**Ontologies** | [OntologyDataTypeDict](docs/v1/Ontologies/models/OntologyDataTypeDict.md) | `from foundry.v1.ontologies.models import OntologyDataTypeDict` | -**Ontologies** | [OntologyDict](docs/v1/Ontologies/models/OntologyDict.md) | `from foundry.v1.ontologies.models import OntologyDict` | **Ontologies** | [OntologyMapType](docs/v1/Ontologies/models/OntologyMapType.md) | `from foundry.v1.ontologies.models import OntologyMapType` | -**Ontologies** | [OntologyMapTypeDict](docs/v1/Ontologies/models/OntologyMapTypeDict.md) | `from foundry.v1.ontologies.models import OntologyMapTypeDict` | **Ontologies** | [OntologyObject](docs/v1/Ontologies/models/OntologyObject.md) | `from foundry.v1.ontologies.models import OntologyObject` | -**Ontologies** | [OntologyObjectDict](docs/v1/Ontologies/models/OntologyObjectDict.md) | `from foundry.v1.ontologies.models import OntologyObjectDict` | **Ontologies** | [OntologyObjectSetType](docs/v1/Ontologies/models/OntologyObjectSetType.md) | `from foundry.v1.ontologies.models import OntologyObjectSetType` | -**Ontologies** | [OntologyObjectSetTypeDict](docs/v1/Ontologies/models/OntologyObjectSetTypeDict.md) | `from foundry.v1.ontologies.models import OntologyObjectSetTypeDict` | **Ontologies** | [OntologyObjectType](docs/v1/Ontologies/models/OntologyObjectType.md) | `from foundry.v1.ontologies.models import OntologyObjectType` | -**Ontologies** | [OntologyObjectTypeDict](docs/v1/Ontologies/models/OntologyObjectTypeDict.md) | `from foundry.v1.ontologies.models import OntologyObjectTypeDict` | **Ontologies** | [OntologyRid](docs/v1/Ontologies/models/OntologyRid.md) | `from foundry.v1.ontologies.models import OntologyRid` | **Ontologies** | [OntologySetType](docs/v1/Ontologies/models/OntologySetType.md) | `from foundry.v1.ontologies.models import OntologySetType` | -**Ontologies** | [OntologySetTypeDict](docs/v1/Ontologies/models/OntologySetTypeDict.md) | `from foundry.v1.ontologies.models import OntologySetTypeDict` | **Ontologies** | [OntologyStructField](docs/v1/Ontologies/models/OntologyStructField.md) | `from foundry.v1.ontologies.models import OntologyStructField` | -**Ontologies** | [OntologyStructFieldDict](docs/v1/Ontologies/models/OntologyStructFieldDict.md) | `from foundry.v1.ontologies.models import OntologyStructFieldDict` | **Ontologies** | [OntologyStructType](docs/v1/Ontologies/models/OntologyStructType.md) | `from foundry.v1.ontologies.models import OntologyStructType` | -**Ontologies** | [OntologyStructTypeDict](docs/v1/Ontologies/models/OntologyStructTypeDict.md) | `from foundry.v1.ontologies.models import OntologyStructTypeDict` | **Ontologies** | [OrderBy](docs/v1/Ontologies/models/OrderBy.md) | `from foundry.v1.ontologies.models import OrderBy` | **Ontologies** | [OrQuery](docs/v1/Ontologies/models/OrQuery.md) | `from foundry.v1.ontologies.models import OrQuery` | -**Ontologies** | [OrQueryDict](docs/v1/Ontologies/models/OrQueryDict.md) | `from foundry.v1.ontologies.models import OrQueryDict` | **Ontologies** | [Parameter](docs/v1/Ontologies/models/Parameter.md) | `from foundry.v1.ontologies.models import Parameter` | -**Ontologies** | [ParameterDict](docs/v1/Ontologies/models/ParameterDict.md) | `from foundry.v1.ontologies.models import ParameterDict` | **Ontologies** | [ParameterEvaluatedConstraint](docs/v1/Ontologies/models/ParameterEvaluatedConstraint.md) | `from foundry.v1.ontologies.models import ParameterEvaluatedConstraint` | -**Ontologies** | [ParameterEvaluatedConstraintDict](docs/v1/Ontologies/models/ParameterEvaluatedConstraintDict.md) | `from foundry.v1.ontologies.models import ParameterEvaluatedConstraintDict` | **Ontologies** | [ParameterEvaluationResult](docs/v1/Ontologies/models/ParameterEvaluationResult.md) | `from foundry.v1.ontologies.models import ParameterEvaluationResult` | -**Ontologies** | [ParameterEvaluationResultDict](docs/v1/Ontologies/models/ParameterEvaluationResultDict.md) | `from foundry.v1.ontologies.models import ParameterEvaluationResultDict` | **Ontologies** | [ParameterId](docs/v1/Ontologies/models/ParameterId.md) | `from foundry.v1.ontologies.models import ParameterId` | **Ontologies** | [ParameterOption](docs/v1/Ontologies/models/ParameterOption.md) | `from foundry.v1.ontologies.models import ParameterOption` | -**Ontologies** | [ParameterOptionDict](docs/v1/Ontologies/models/ParameterOptionDict.md) | `from foundry.v1.ontologies.models import ParameterOptionDict` | **Ontologies** | [PhraseQuery](docs/v1/Ontologies/models/PhraseQuery.md) | `from foundry.v1.ontologies.models import PhraseQuery` | -**Ontologies** | [PhraseQueryDict](docs/v1/Ontologies/models/PhraseQueryDict.md) | `from foundry.v1.ontologies.models import PhraseQueryDict` | **Ontologies** | [PrefixQuery](docs/v1/Ontologies/models/PrefixQuery.md) | `from foundry.v1.ontologies.models import PrefixQuery` | -**Ontologies** | [PrefixQueryDict](docs/v1/Ontologies/models/PrefixQueryDict.md) | `from foundry.v1.ontologies.models import PrefixQueryDict` | **Ontologies** | [PrimaryKeyValue](docs/v1/Ontologies/models/PrimaryKeyValue.md) | `from foundry.v1.ontologies.models import PrimaryKeyValue` | **Ontologies** | [Property](docs/v1/Ontologies/models/Property.md) | `from foundry.v1.ontologies.models import Property` | **Ontologies** | [PropertyApiName](docs/v1/Ontologies/models/PropertyApiName.md) | `from foundry.v1.ontologies.models import PropertyApiName` | -**Ontologies** | [PropertyDict](docs/v1/Ontologies/models/PropertyDict.md) | `from foundry.v1.ontologies.models import PropertyDict` | **Ontologies** | [PropertyFilter](docs/v1/Ontologies/models/PropertyFilter.md) | `from foundry.v1.ontologies.models import PropertyFilter` | **Ontologies** | [PropertyId](docs/v1/Ontologies/models/PropertyId.md) | `from foundry.v1.ontologies.models import PropertyId` | **Ontologies** | [PropertyValue](docs/v1/Ontologies/models/PropertyValue.md) | `from foundry.v1.ontologies.models import PropertyValue` | **Ontologies** | [PropertyValueEscapedString](docs/v1/Ontologies/models/PropertyValueEscapedString.md) | `from foundry.v1.ontologies.models import PropertyValueEscapedString` | -**Ontologies** | [QueryAggregationKeyTypeDict](docs/v1/Ontologies/models/QueryAggregationKeyTypeDict.md) | `from foundry.v1.ontologies.models import QueryAggregationKeyTypeDict` | -**Ontologies** | [QueryAggregationRangeSubTypeDict](docs/v1/Ontologies/models/QueryAggregationRangeSubTypeDict.md) | `from foundry.v1.ontologies.models import QueryAggregationRangeSubTypeDict` | -**Ontologies** | [QueryAggregationRangeTypeDict](docs/v1/Ontologies/models/QueryAggregationRangeTypeDict.md) | `from foundry.v1.ontologies.models import QueryAggregationRangeTypeDict` | -**Ontologies** | [QueryAggregationValueTypeDict](docs/v1/Ontologies/models/QueryAggregationValueTypeDict.md) | `from foundry.v1.ontologies.models import QueryAggregationValueTypeDict` | +**Ontologies** | [QueryAggregationKeyType](docs/v1/Ontologies/models/QueryAggregationKeyType.md) | `from foundry.v1.ontologies.models import QueryAggregationKeyType` | +**Ontologies** | [QueryAggregationRangeSubType](docs/v1/Ontologies/models/QueryAggregationRangeSubType.md) | `from foundry.v1.ontologies.models import QueryAggregationRangeSubType` | +**Ontologies** | [QueryAggregationRangeType](docs/v1/Ontologies/models/QueryAggregationRangeType.md) | `from foundry.v1.ontologies.models import QueryAggregationRangeType` | +**Ontologies** | [QueryAggregationValueType](docs/v1/Ontologies/models/QueryAggregationValueType.md) | `from foundry.v1.ontologies.models import QueryAggregationValueType` | **Ontologies** | [QueryApiName](docs/v1/Ontologies/models/QueryApiName.md) | `from foundry.v1.ontologies.models import QueryApiName` | -**Ontologies** | [QueryArrayTypeDict](docs/v1/Ontologies/models/QueryArrayTypeDict.md) | `from foundry.v1.ontologies.models import QueryArrayTypeDict` | -**Ontologies** | [QueryDataTypeDict](docs/v1/Ontologies/models/QueryDataTypeDict.md) | `from foundry.v1.ontologies.models import QueryDataTypeDict` | +**Ontologies** | [QueryArrayType](docs/v1/Ontologies/models/QueryArrayType.md) | `from foundry.v1.ontologies.models import QueryArrayType` | +**Ontologies** | [QueryDataType](docs/v1/Ontologies/models/QueryDataType.md) | `from foundry.v1.ontologies.models import QueryDataType` | **Ontologies** | [QueryRuntimeErrorParameter](docs/v1/Ontologies/models/QueryRuntimeErrorParameter.md) | `from foundry.v1.ontologies.models import QueryRuntimeErrorParameter` | -**Ontologies** | [QuerySetTypeDict](docs/v1/Ontologies/models/QuerySetTypeDict.md) | `from foundry.v1.ontologies.models import QuerySetTypeDict` | -**Ontologies** | [QueryStructFieldDict](docs/v1/Ontologies/models/QueryStructFieldDict.md) | `from foundry.v1.ontologies.models import QueryStructFieldDict` | -**Ontologies** | [QueryStructTypeDict](docs/v1/Ontologies/models/QueryStructTypeDict.md) | `from foundry.v1.ontologies.models import QueryStructTypeDict` | +**Ontologies** | [QuerySetType](docs/v1/Ontologies/models/QuerySetType.md) | `from foundry.v1.ontologies.models import QuerySetType` | +**Ontologies** | [QueryStructField](docs/v1/Ontologies/models/QueryStructField.md) | `from foundry.v1.ontologies.models import QueryStructField` | +**Ontologies** | [QueryStructType](docs/v1/Ontologies/models/QueryStructType.md) | `from foundry.v1.ontologies.models import QueryStructType` | **Ontologies** | [QueryType](docs/v1/Ontologies/models/QueryType.md) | `from foundry.v1.ontologies.models import QueryType` | -**Ontologies** | [QueryTypeDict](docs/v1/Ontologies/models/QueryTypeDict.md) | `from foundry.v1.ontologies.models import QueryTypeDict` | -**Ontologies** | [QueryUnionTypeDict](docs/v1/Ontologies/models/QueryUnionTypeDict.md) | `from foundry.v1.ontologies.models import QueryUnionTypeDict` | +**Ontologies** | [QueryUnionType](docs/v1/Ontologies/models/QueryUnionType.md) | `from foundry.v1.ontologies.models import QueryUnionType` | **Ontologies** | [RangeConstraint](docs/v1/Ontologies/models/RangeConstraint.md) | `from foundry.v1.ontologies.models import RangeConstraint` | -**Ontologies** | [RangeConstraintDict](docs/v1/Ontologies/models/RangeConstraintDict.md) | `from foundry.v1.ontologies.models import RangeConstraintDict` | **Ontologies** | [ReturnEditsMode](docs/v1/Ontologies/models/ReturnEditsMode.md) | `from foundry.v1.ontologies.models import ReturnEditsMode` | **Ontologies** | [SdkPackageName](docs/v1/Ontologies/models/SdkPackageName.md) | `from foundry.v1.ontologies.models import SdkPackageName` | **Ontologies** | [SearchJsonQuery](docs/v1/Ontologies/models/SearchJsonQuery.md) | `from foundry.v1.ontologies.models import SearchJsonQuery` | -**Ontologies** | [SearchJsonQueryDict](docs/v1/Ontologies/models/SearchJsonQueryDict.md) | `from foundry.v1.ontologies.models import SearchJsonQueryDict` | **Ontologies** | [SearchObjectsResponse](docs/v1/Ontologies/models/SearchObjectsResponse.md) | `from foundry.v1.ontologies.models import SearchObjectsResponse` | -**Ontologies** | [SearchObjectsResponseDict](docs/v1/Ontologies/models/SearchObjectsResponseDict.md) | `from foundry.v1.ontologies.models import SearchObjectsResponseDict` | **Ontologies** | [SearchOrderBy](docs/v1/Ontologies/models/SearchOrderBy.md) | `from foundry.v1.ontologies.models import SearchOrderBy` | -**Ontologies** | [SearchOrderByDict](docs/v1/Ontologies/models/SearchOrderByDict.md) | `from foundry.v1.ontologies.models import SearchOrderByDict` | **Ontologies** | [SearchOrderByType](docs/v1/Ontologies/models/SearchOrderByType.md) | `from foundry.v1.ontologies.models import SearchOrderByType` | **Ontologies** | [SearchOrdering](docs/v1/Ontologies/models/SearchOrdering.md) | `from foundry.v1.ontologies.models import SearchOrdering` | -**Ontologies** | [SearchOrderingDict](docs/v1/Ontologies/models/SearchOrderingDict.md) | `from foundry.v1.ontologies.models import SearchOrderingDict` | **Ontologies** | [SelectedPropertyApiName](docs/v1/Ontologies/models/SelectedPropertyApiName.md) | `from foundry.v1.ontologies.models import SelectedPropertyApiName` | **Ontologies** | [SharedPropertyTypeApiName](docs/v1/Ontologies/models/SharedPropertyTypeApiName.md) | `from foundry.v1.ontologies.models import SharedPropertyTypeApiName` | **Ontologies** | [SharedPropertyTypeRid](docs/v1/Ontologies/models/SharedPropertyTypeRid.md) | `from foundry.v1.ontologies.models import SharedPropertyTypeRid` | **Ontologies** | [StringLengthConstraint](docs/v1/Ontologies/models/StringLengthConstraint.md) | `from foundry.v1.ontologies.models import StringLengthConstraint` | -**Ontologies** | [StringLengthConstraintDict](docs/v1/Ontologies/models/StringLengthConstraintDict.md) | `from foundry.v1.ontologies.models import StringLengthConstraintDict` | **Ontologies** | [StringRegexMatchConstraint](docs/v1/Ontologies/models/StringRegexMatchConstraint.md) | `from foundry.v1.ontologies.models import StringRegexMatchConstraint` | -**Ontologies** | [StringRegexMatchConstraintDict](docs/v1/Ontologies/models/StringRegexMatchConstraintDict.md) | `from foundry.v1.ontologies.models import StringRegexMatchConstraintDict` | **Ontologies** | [SubmissionCriteriaEvaluation](docs/v1/Ontologies/models/SubmissionCriteriaEvaluation.md) | `from foundry.v1.ontologies.models import SubmissionCriteriaEvaluation` | -**Ontologies** | [SubmissionCriteriaEvaluationDict](docs/v1/Ontologies/models/SubmissionCriteriaEvaluationDict.md) | `from foundry.v1.ontologies.models import SubmissionCriteriaEvaluationDict` | **Ontologies** | [SumAggregation](docs/v1/Ontologies/models/SumAggregation.md) | `from foundry.v1.ontologies.models import SumAggregation` | -**Ontologies** | [SumAggregationDict](docs/v1/Ontologies/models/SumAggregationDict.md) | `from foundry.v1.ontologies.models import SumAggregationDict` | -**Ontologies** | [ThreeDimensionalAggregationDict](docs/v1/Ontologies/models/ThreeDimensionalAggregationDict.md) | `from foundry.v1.ontologies.models import ThreeDimensionalAggregationDict` | -**Ontologies** | [TwoDimensionalAggregationDict](docs/v1/Ontologies/models/TwoDimensionalAggregationDict.md) | `from foundry.v1.ontologies.models import TwoDimensionalAggregationDict` | +**Ontologies** | [ThreeDimensionalAggregation](docs/v1/Ontologies/models/ThreeDimensionalAggregation.md) | `from foundry.v1.ontologies.models import ThreeDimensionalAggregation` | +**Ontologies** | [TwoDimensionalAggregation](docs/v1/Ontologies/models/TwoDimensionalAggregation.md) | `from foundry.v1.ontologies.models import TwoDimensionalAggregation` | **Ontologies** | [UnevaluableConstraint](docs/v1/Ontologies/models/UnevaluableConstraint.md) | `from foundry.v1.ontologies.models import UnevaluableConstraint` | -**Ontologies** | [UnevaluableConstraintDict](docs/v1/Ontologies/models/UnevaluableConstraintDict.md) | `from foundry.v1.ontologies.models import UnevaluableConstraintDict` | **Ontologies** | [ValidateActionResponse](docs/v1/Ontologies/models/ValidateActionResponse.md) | `from foundry.v1.ontologies.models import ValidateActionResponse` | -**Ontologies** | [ValidateActionResponseDict](docs/v1/Ontologies/models/ValidateActionResponseDict.md) | `from foundry.v1.ontologies.models import ValidateActionResponseDict` | **Ontologies** | [ValidationResult](docs/v1/Ontologies/models/ValidationResult.md) | `from foundry.v1.ontologies.models import ValidationResult` | **Ontologies** | [ValueType](docs/v1/Ontologies/models/ValueType.md) | `from foundry.v1.ontologies.models import ValueType` | diff --git a/docs/v1/Core/models/AnyTypeDict.md b/docs/v1/Core/models/AnyTypeDict.md deleted file mode 100644 index 70cd22a28..000000000 --- a/docs/v1/Core/models/AnyTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AnyTypeDict - -AnyType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["any"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/AttachmentTypeDict.md b/docs/v1/Core/models/AttachmentType.md similarity index 94% rename from docs/v1/Core/models/AttachmentTypeDict.md rename to docs/v1/Core/models/AttachmentType.md index 199cd46a8..e477e43da 100644 --- a/docs/v1/Core/models/AttachmentTypeDict.md +++ b/docs/v1/Core/models/AttachmentType.md @@ -1,4 +1,4 @@ -# AttachmentTypeDict +# AttachmentType AttachmentType diff --git a/docs/v1/Core/models/BinaryTypeDict.md b/docs/v1/Core/models/BinaryTypeDict.md deleted file mode 100644 index f4c017460..000000000 --- a/docs/v1/Core/models/BinaryTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BinaryTypeDict - -BinaryType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["binary"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/BooleanTypeDict.md b/docs/v1/Core/models/BooleanTypeDict.md deleted file mode 100644 index 14a46067d..000000000 --- a/docs/v1/Core/models/BooleanTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BooleanTypeDict - -BooleanType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["boolean"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/ByteTypeDict.md b/docs/v1/Core/models/ByteTypeDict.md deleted file mode 100644 index 022617c5b..000000000 --- a/docs/v1/Core/models/ByteTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ByteTypeDict - -ByteType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["byte"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/CipherTextTypeDict.md b/docs/v1/Core/models/CipherTextTypeDict.md deleted file mode 100644 index 8db797d3d..000000000 --- a/docs/v1/Core/models/CipherTextTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CipherTextTypeDict - -CipherTextType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**defaultCipherChannel** | NotRequired[str] | No | An optional Cipher Channel RID which can be used for encryption updates to empty values. | -**type** | Literal["cipherText"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/DateTypeDict.md b/docs/v1/Core/models/DateTypeDict.md deleted file mode 100644 index 6d29ccb32..000000000 --- a/docs/v1/Core/models/DateTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# DateTypeDict - -DateType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["date"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/DecimalTypeDict.md b/docs/v1/Core/models/DecimalTypeDict.md deleted file mode 100644 index 30d4adb9f..000000000 --- a/docs/v1/Core/models/DecimalTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# DecimalTypeDict - -DecimalType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**precision** | NotRequired[int] | No | The total number of digits of the Decimal type. The maximum value is 38. | -**scale** | NotRequired[int] | No | The number of digits to the right of the decimal point. The maximum value is 38. | -**type** | Literal["decimal"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/DoubleTypeDict.md b/docs/v1/Core/models/DoubleTypeDict.md deleted file mode 100644 index 7b7575f6a..000000000 --- a/docs/v1/Core/models/DoubleTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# DoubleTypeDict - -DoubleType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["double"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/FloatTypeDict.md b/docs/v1/Core/models/FloatTypeDict.md deleted file mode 100644 index 7ee76ce51..000000000 --- a/docs/v1/Core/models/FloatTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# FloatTypeDict - -FloatType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["float"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/IntegerTypeDict.md b/docs/v1/Core/models/IntegerTypeDict.md deleted file mode 100644 index ddedd4d8e..000000000 --- a/docs/v1/Core/models/IntegerTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# IntegerTypeDict - -IntegerType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["integer"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/LongTypeDict.md b/docs/v1/Core/models/LongTypeDict.md deleted file mode 100644 index 297e1bd2a..000000000 --- a/docs/v1/Core/models/LongTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# LongTypeDict - -LongType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["long"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/MarkingTypeDict.md b/docs/v1/Core/models/MarkingTypeDict.md deleted file mode 100644 index 61a73bb27..000000000 --- a/docs/v1/Core/models/MarkingTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# MarkingTypeDict - -MarkingType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["marking"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/NullTypeDict.md b/docs/v1/Core/models/NullType.md similarity index 95% rename from docs/v1/Core/models/NullTypeDict.md rename to docs/v1/Core/models/NullType.md index dc6c7924b..fc2eba1f5 100644 --- a/docs/v1/Core/models/NullTypeDict.md +++ b/docs/v1/Core/models/NullType.md @@ -1,4 +1,4 @@ -# NullTypeDict +# NullType NullType diff --git a/docs/v1/Core/models/ShortTypeDict.md b/docs/v1/Core/models/ShortTypeDict.md deleted file mode 100644 index 7d96cc91d..000000000 --- a/docs/v1/Core/models/ShortTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ShortTypeDict - -ShortType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["short"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/StringTypeDict.md b/docs/v1/Core/models/StringTypeDict.md deleted file mode 100644 index 7b98f852c..000000000 --- a/docs/v1/Core/models/StringTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# StringTypeDict - -StringType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["string"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/TimestampTypeDict.md b/docs/v1/Core/models/TimestampTypeDict.md deleted file mode 100644 index 617eace43..000000000 --- a/docs/v1/Core/models/TimestampTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# TimestampTypeDict - -TimestampType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["timestamp"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Core/models/UnsupportedTypeDict.md b/docs/v1/Core/models/UnsupportedTypeDict.md deleted file mode 100644 index b7380365d..000000000 --- a/docs/v1/Core/models/UnsupportedTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnsupportedTypeDict - -UnsupportedType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**unsupportedType** | str | Yes | | -**type** | Literal["unsupported"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Datasets/Branch.md b/docs/v1/Datasets/Branch.md index e783b12a5..e4440c376 100644 --- a/docs/v1/Datasets/Branch.md +++ b/docs/v1/Datasets/Branch.md @@ -6,7 +6,6 @@ Method | HTTP request | Release Stage | [**delete**](#delete) | **DELETE** /v1/datasets/{datasetRid}/branches/{branchId} | Stable | [**get**](#get) | **GET** /v1/datasets/{datasetRid}/branches/{branchId} | Stable | [**list**](#list) | **GET** /v1/datasets/{datasetRid}/branches | Stable | -[**page**](#page) | **GET** /v1/datasets/{datasetRid}/branches | Stable | # **create** Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. @@ -218,64 +217,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListBranchesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) - -# **page** -Lists the Branches of a Dataset. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | The Resource Identifier (RID) of the Dataset on which to list Branches. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | - -### Return type -**ListBranchesResponse** - -### Example - -```python -from foundry.v1 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# DatasetRid | The Resource Identifier (RID) of the Dataset on which to list Branches. -dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -page_size = None -# Optional[PageToken] -page_token = None - - -try: - api_response = foundry_client.datasets.Dataset.Branch.page( - dataset_rid, page_size=page_size, page_token=page_token - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Branch.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v1/Datasets/File.md b/docs/v1/Datasets/File.md index c3a2e396f..c1a19a08e 100644 --- a/docs/v1/Datasets/File.md +++ b/docs/v1/Datasets/File.md @@ -5,7 +5,6 @@ Method | HTTP request | Release Stage | [**delete**](#delete) | **DELETE** /v1/datasets/{datasetRid}/files/{filePath} | Stable | [**get**](#get) | **GET** /v1/datasets/{datasetRid}/files/{filePath} | Stable | [**list**](#list) | **GET** /v1/datasets/{datasetRid}/files | Stable | -[**page**](#page) | **GET** /v1/datasets/{datasetRid}/files | Stable | [**read**](#read) | **GET** /v1/datasets/{datasetRid}/files/{filePath}/content | Stable | [**upload**](#upload) | **POST** /v1/datasets/{datasetRid}/files:upload | Stable | @@ -275,101 +274,6 @@ b'Hello!' ``` -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListFilesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) - -# **page** -Lists Files contained in a Dataset. By default files are listed on the latest view of the default -branch - `master` for most enrollments. - -#### Advanced Usage - -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - -To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most -recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the -branch if there are no snapshot transactions. - -To **list files on the resolved view of a transaction** specify the Transaction's resource identifier -as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot -transaction, or the earliest ancestor transaction if there are no snapshot transactions. - -To **list files on the resolved view of a range of transactions** specify the the start transaction's resource -identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This -will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. -Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when -the start and end transactions do not belong to the same root-to-leaf path. - -To **list files on a specific transaction** specify the Transaction's resource identifier as both the -`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that -Transaction. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | The Resource Identifier (RID) of the Dataset on which to list Files. | | -**branch_id** | Optional[BranchId] | The identifier (name) of the Branch on which to list Files. Defaults to `master` for most enrollments. | [optional] | -**end_transaction_rid** | Optional[TransactionRid] | The Resource Identifier (RID) of the end Transaction. | [optional] | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**start_transaction_rid** | Optional[TransactionRid] | The Resource Identifier (RID) of the start Transaction. | [optional] | - -### Return type -**ListFilesResponse** - -### Example - -```python -from foundry.v1 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# DatasetRid | The Resource Identifier (RID) of the Dataset on which to list Files. -dataset_rid = None -# Optional[BranchId] | The identifier (name) of the Branch on which to list Files. Defaults to `master` for most enrollments. -branch_id = None -# Optional[TransactionRid] | The Resource Identifier (RID) of the end Transaction. -end_transaction_rid = None -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -page_size = None -# Optional[PageToken] -page_token = None -# Optional[TransactionRid] | The Resource Identifier (RID) of the start Transaction. -start_transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.File.page( - dataset_rid, - branch_id=branch_id, - end_transaction_rid=end_transaction_rid, - page_size=page_size, - page_token=page_token, - start_transaction_rid=start_transaction_rid, - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling File.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v1/Datasets/models/BranchDict.md b/docs/v1/Datasets/models/BranchDict.md deleted file mode 100644 index 0a7b49ef9..000000000 --- a/docs/v1/Datasets/models/BranchDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# BranchDict - -A Branch of a Dataset. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**branchId** | BranchId | Yes | | -**transactionRid** | NotRequired[TransactionRid] | No | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Datasets/models/DatasetDict.md b/docs/v1/Datasets/models/DatasetDict.md deleted file mode 100644 index c53421c2b..000000000 --- a/docs/v1/Datasets/models/DatasetDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# DatasetDict - -Dataset - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | DatasetRid | Yes | | -**name** | DatasetName | Yes | | -**parentFolderRid** | FolderRid | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Datasets/models/FileDict.md b/docs/v1/Datasets/models/FileDict.md deleted file mode 100644 index 23adb2be4..000000000 --- a/docs/v1/Datasets/models/FileDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# FileDict - -File - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**path** | FilePath | Yes | | -**transactionRid** | TransactionRid | Yes | | -**sizeBytes** | NotRequired[Long] | No | | -**updatedTime** | datetime | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Datasets/models/ListBranchesResponseDict.md b/docs/v1/Datasets/models/ListBranchesResponseDict.md deleted file mode 100644 index 9e36d3d32..000000000 --- a/docs/v1/Datasets/models/ListBranchesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListBranchesResponseDict - -ListBranchesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[BranchDict] | Yes | The list of branches in the current page. | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Datasets/models/ListFilesResponseDict.md b/docs/v1/Datasets/models/ListFilesResponseDict.md deleted file mode 100644 index 45801410b..000000000 --- a/docs/v1/Datasets/models/ListFilesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListFilesResponseDict - -A page of Files and an optional page token that can be used to retrieve the next page. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[FileDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Datasets/models/TransactionDict.md b/docs/v1/Datasets/models/TransactionDict.md deleted file mode 100644 index 5279105ca..000000000 --- a/docs/v1/Datasets/models/TransactionDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# TransactionDict - -An operation that modifies the files within a dataset. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | TransactionRid | Yes | | -**transactionType** | TransactionType | Yes | | -**status** | TransactionStatus | Yes | | -**createdTime** | datetime | Yes | The timestamp when the transaction was created, in ISO 8601 timestamp format. | -**closedTime** | NotRequired[datetime] | No | The timestamp when the transaction was closed, in ISO 8601 timestamp format. | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/Action.md b/docs/v1/Ontologies/Action.md index 1ec3a8df4..bfa4aa63d 100644 --- a/docs/v1/Ontologies/Action.md +++ b/docs/v1/Ontologies/Action.md @@ -89,7 +89,7 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology_rid** | OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. | | **action_type** | ActionTypeApiName | The API name of the action to apply. To find the API name for your action, use the **List action types** endpoint or check the **Ontology Manager**. | | -**requests** | List[Union[ApplyActionRequest, ApplyActionRequestDict]] | | | +**requests** | List[ApplyActionRequest] | | | ### Return type **BatchApplyActionResponse** @@ -107,7 +107,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" # ActionTypeApiName | The API name of the action to apply. To find the API name for your action, use the **List action types** endpoint or check the **Ontology Manager**. action_type = "rename-employee" -# List[Union[ApplyActionRequest, ApplyActionRequestDict]] +# List[ApplyActionRequest] requests = [ {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}}, {"parameters": {"id": 80061, "newName": "Joe Bloggs"}}, diff --git a/docs/v1/Ontologies/ActionType.md b/docs/v1/Ontologies/ActionType.md index a52d71e16..f69bcb4a3 100644 --- a/docs/v1/Ontologies/ActionType.md +++ b/docs/v1/Ontologies/ActionType.md @@ -4,7 +4,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**get**](#get) | **GET** /v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName} | Stable | [**list**](#list) | **GET** /v1/ontologies/{ontologyRid}/actionTypes | Stable | -[**page**](#page) | **GET** /v1/ontologies/{ontologyRid}/actionTypes | Stable | # **get** Gets a specific action type with the given API name. @@ -110,67 +109,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListActionTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) - -# **page** -Lists the action types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | - -### Return type -**ListActionTypesResponse** - -### Example - -```python -from foundry.v1 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -page_size = None -# Optional[PageToken] -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.ActionType.page( - ontology_rid, page_size=page_size, page_token=page_token - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling ActionType.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v1/Ontologies/ObjectType.md b/docs/v1/Ontologies/ObjectType.md index 84fd9c065..8bc857312 100644 --- a/docs/v1/Ontologies/ObjectType.md +++ b/docs/v1/Ontologies/ObjectType.md @@ -6,8 +6,6 @@ Method | HTTP request | Release Stage | [**get_outgoing_link_type**](#get_outgoing_link_type) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | Stable | [**list**](#list) | **GET** /v1/ontologies/{ontologyRid}/objectTypes | Stable | [**list_outgoing_link_types**](#list_outgoing_link_types) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes | Stable | -[**page**](#page) | **GET** /v1/ontologies/{ontologyRid}/objectTypes | Stable | -[**page_outgoing_link_types**](#page_outgoing_link_types) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes | Stable | # **get** Gets a specific object type with the given API name. @@ -232,130 +230,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListOutgoingLinkTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) - -# **page** -Lists the object types for the given Ontology. - -Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are -more results available, at least one result will be present in the -response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | - -### Return type -**ListObjectTypesResponse** - -### Example - -```python -from foundry.v1 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -page_size = None -# Optional[PageToken] -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.ObjectType.page( - ontology_rid, page_size=page_size, page_token=page_token - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling ObjectType.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListObjectTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) - -# **page_outgoing_link_types** -List the outgoing links for an object type. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager** application. | | -**object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager** application. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | - -### Return type -**ListOutgoingLinkTypesResponse** - -### Example - -```python -from foundry.v1 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager** application. -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" -# ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager** application. -object_type = "Flight" -# Optional[PageSize] | The desired size of the page to be returned. -page_size = None -# Optional[PageToken] -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.ObjectType.page_outgoing_link_types( - ontology_rid, object_type, page_size=page_size, page_token=page_token - ) - print("The page_outgoing_link_types response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling ObjectType.page_outgoing_link_types: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v1/Ontologies/OntologyObject.md b/docs/v1/Ontologies/OntologyObject.md index fa34f8c0f..1a990aad1 100644 --- a/docs/v1/Ontologies/OntologyObject.md +++ b/docs/v1/Ontologies/OntologyObject.md @@ -7,8 +7,6 @@ Method | HTTP request | Release Stage | [**get_linked_object**](#get_linked_object) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} | Stable | [**list**](#list) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType} | Stable | [**list_linked_objects**](#list_linked_objects) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType} | Stable | -[**page**](#page) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType} | Stable | -[**page_linked_objects**](#page_linked_objects) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType} | Stable | [**search**](#search) | **POST** /v1/ontologies/{ontologyRid}/objects/{objectType}/search | Stable | # **aggregate** @@ -23,9 +21,9 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology_rid** | OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the objects. | | **object_type** | ObjectTypeApiName | The type of the object to aggregate on. | | -**aggregation** | List[Union[Aggregation, AggregationDict]] | | | -**group_by** | List[Union[AggregationGroupBy, AggregationGroupByDict]] | | | -**query** | Optional[Union[SearchJsonQuery, SearchJsonQueryDict]] | | [optional] | +**aggregation** | List[Aggregation] | | | +**group_by** | List[AggregationGroupBy] | | | +**query** | Optional[SearchJsonQuery] | | [optional] | ### Return type **AggregateObjectsResponse** @@ -43,12 +41,12 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" # ObjectTypeApiName | The type of the object to aggregate on. object_type = "employee" -# List[Union[Aggregation, AggregationDict]] +# List[Aggregation] aggregation = [ {"type": "min", "field": "properties.tenure", "name": "min_tenure"}, {"type": "avg", "field": "properties.tenure", "name": "avg_tenure"}, ] -# List[Union[AggregationGroupBy, AggregationGroupByDict]] +# List[AggregationGroupBy] group_by = [ { "field": "properties.startDate", @@ -57,7 +55,7 @@ group_by = [ }, {"field": "properties.city", "type": "exact"}, ] -# Optional[Union[SearchJsonQuery, SearchJsonQueryDict]] +# Optional[SearchJsonQuery] query = {"not": {"field": "properties.name", "eq": "john"}} @@ -388,188 +386,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListLinkedObjectsResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) - -# **page** -Lists the objects for the given Ontology and object type. - -This endpoint supports filtering objects. -See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. - -Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or -repeated objects in the response pages. - -For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects -are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - -Each page may be smaller or larger than the requested page size. However, it -is guaranteed that if there are more results available, at least one result will be present -in the response. - -Note that null value properties will not be returned. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | | -**order_by** | Optional[OrderBy] | | [optional] | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**properties** | Optional[List[SelectedPropertyApiName]] | The properties of the object type that should be included in the response. Omit this parameter to get all the properties. | [optional] | - -### Return type -**ListObjectsResponse** - -### Example - -```python -from foundry.v1 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" -# ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. -object_type = "employee" -# Optional[OrderBy] -order_by = None -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -page_size = None -# Optional[PageToken] -page_token = None -# Optional[List[SelectedPropertyApiName]] | The properties of the object type that should be included in the response. Omit this parameter to get all the properties. -properties = None - - -try: - api_response = foundry_client.ontologies.OntologyObject.page( - ontology_rid, - object_type, - order_by=order_by, - page_size=page_size, - page_token=page_token, - properties=properties, - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling OntologyObject.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListObjectsResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) - -# **page_linked_objects** -Lists the linked objects for a specific object and the given link type. - -This endpoint supports filtering objects. -See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. - -Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or -repeated objects in the response pages. - -For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects -are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - -Each page may be smaller or larger than the requested page size. However, it -is guaranteed that if there are more results available, at least one result will be present -in the response. - -Note that null value properties will not be returned. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**object_type** | ObjectTypeApiName | The API name of the object from which the links originate. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | | -**primary_key** | PropertyValueEscapedString | The primary key of the object from which the links originate. To look up the expected primary key for your object type, use the `Get object type` endpoint or the **Ontology Manager**. | | -**link_type** | LinkTypeApiName | The API name of the link that exists between the object and the requested objects. To find the API name for your link type, check the **Ontology Manager**. | | -**order_by** | Optional[OrderBy] | | [optional] | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**properties** | Optional[List[SelectedPropertyApiName]] | The properties of the object type that should be included in the response. Omit this parameter to get all the properties. | [optional] | - -### Return type -**ListLinkedObjectsResponse** - -### Example - -```python -from foundry.v1 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" -# ObjectTypeApiName | The API name of the object from which the links originate. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. -object_type = "employee" -# PropertyValueEscapedString | The primary key of the object from which the links originate. To look up the expected primary key for your object type, use the `Get object type` endpoint or the **Ontology Manager**. -primary_key = 50030 -# LinkTypeApiName | The API name of the link that exists between the object and the requested objects. To find the API name for your link type, check the **Ontology Manager**. -link_type = "directReport" -# Optional[OrderBy] -order_by = None -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -page_size = None -# Optional[PageToken] -page_token = None -# Optional[List[SelectedPropertyApiName]] | The properties of the object type that should be included in the response. Omit this parameter to get all the properties. -properties = None - - -try: - api_response = foundry_client.ontologies.OntologyObject.page_linked_objects( - ontology_rid, - object_type, - primary_key, - link_type, - order_by=order_by, - page_size=page_size, - page_token=page_token, - properties=properties, - ) - print("The page_linked_objects response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling OntologyObject.page_linked_objects: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) @@ -615,8 +431,8 @@ Name | Type | Description | Notes | **ontology_rid** | OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the objects. | | **object_type** | ObjectTypeApiName | The type of the requested objects. | | **fields** | List[PropertyApiName] | The API names of the object type properties to include in the response. | | -**query** | Union[SearchJsonQuery, SearchJsonQueryDict] | | | -**order_by** | Optional[Union[SearchOrderBy, SearchOrderByDict]] | | [optional] | +**query** | SearchJsonQuery | | | +**order_by** | Optional[SearchOrderBy] | | [optional] | **page_size** | Optional[PageSize] | | [optional] | **page_token** | Optional[PageToken] | | [optional] | @@ -638,9 +454,9 @@ ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" object_type = "employee" # List[PropertyApiName] | The API names of the object type properties to include in the response. fields = None -# Union[SearchJsonQuery, SearchJsonQueryDict] +# SearchJsonQuery query = {"not": {"field": "properties.age", "eq": 21}} -# Optional[Union[SearchOrderBy, SearchOrderByDict]] +# Optional[SearchOrderBy] order_by = None # Optional[PageSize] page_size = None diff --git a/docs/v1/Ontologies/QueryType.md b/docs/v1/Ontologies/QueryType.md index 30286790e..0168608ce 100644 --- a/docs/v1/Ontologies/QueryType.md +++ b/docs/v1/Ontologies/QueryType.md @@ -4,7 +4,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**get**](#get) | **GET** /v1/ontologies/{ontologyRid}/queryTypes/{queryApiName} | Stable | [**list**](#list) | **GET** /v1/ontologies/{ontologyRid}/queryTypes | Stable | -[**page**](#page) | **GET** /v1/ontologies/{ontologyRid}/queryTypes | Stable | # **get** Gets a specific query type with the given API name. @@ -108,67 +107,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListQueryTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) - -# **page** -Lists the query types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | - -### Return type -**ListQueryTypesResponse** - -### Example - -```python -from foundry.v1 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -page_size = None -# Optional[PageToken] -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.QueryType.page( - ontology_rid, page_size=page_size, page_token=page_token - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling QueryType.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v1/Ontologies/models/ActionTypeDict.md b/docs/v1/Ontologies/models/ActionTypeDict.md deleted file mode 100644 index 0eac927c3..000000000 --- a/docs/v1/Ontologies/models/ActionTypeDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ActionTypeDict - -Represents an action type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ActionTypeApiName | Yes | | -**description** | NotRequired[str] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**parameters** | Dict[ParameterId, ParameterDict] | Yes | | -**rid** | ActionTypeRid | Yes | | -**operations** | List[LogicRuleDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AggregateObjectsResponseDict.md b/docs/v1/Ontologies/models/AggregateObjectsResponseDict.md deleted file mode 100644 index 4b6d7b2a9..000000000 --- a/docs/v1/Ontologies/models/AggregateObjectsResponseDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsResponseDict - -AggregateObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**excludedItems** | NotRequired[int] | No | | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[AggregateObjectsResponseItemDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AggregateObjectsResponseItemDict.md b/docs/v1/Ontologies/models/AggregateObjectsResponseItemDict.md deleted file mode 100644 index f9e0f401d..000000000 --- a/docs/v1/Ontologies/models/AggregateObjectsResponseItemDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregateObjectsResponseItemDict - -AggregateObjectsResponseItem - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**group** | Dict[AggregationGroupKey, AggregationGroupValue] | Yes | | -**metrics** | List[AggregationMetricResultDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AggregationDict.md b/docs/v1/Ontologies/models/AggregationDict.md deleted file mode 100644 index f4d384308..000000000 --- a/docs/v1/Ontologies/models/AggregationDict.md +++ /dev/null @@ -1,20 +0,0 @@ -# AggregationDict - -Specifies an aggregation function. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -ApproximateDistinctAggregationDict | approximateDistinct -MinAggregationDict | min -AvgAggregationDict | avg -MaxAggregationDict | max -CountAggregationDict | count -SumAggregationDict | sum - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AggregationDurationGroupingDict.md b/docs/v1/Ontologies/models/AggregationDurationGroupingDict.md deleted file mode 100644 index 41cc5fddb..000000000 --- a/docs/v1/Ontologies/models/AggregationDurationGroupingDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# AggregationDurationGroupingDict - -Divides objects into groups according to an interval. Note that this grouping applies only on date types. -The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**duration** | Duration | Yes | | -**type** | Literal["duration"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AggregationExactGroupingDict.md b/docs/v1/Ontologies/models/AggregationExactGroupingDict.md deleted file mode 100644 index 20981c124..000000000 --- a/docs/v1/Ontologies/models/AggregationExactGroupingDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationExactGroupingDict - -Divides objects into groups according to an exact value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**maxGroupCount** | NotRequired[int] | No | | -**type** | Literal["exact"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AggregationFixedWidthGroupingDict.md b/docs/v1/Ontologies/models/AggregationFixedWidthGroupingDict.md deleted file mode 100644 index ad4dadb38..000000000 --- a/docs/v1/Ontologies/models/AggregationFixedWidthGroupingDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationFixedWidthGroupingDict - -Divides objects into groups with the specified width. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**fixedWidth** | int | Yes | | -**type** | Literal["fixedWidth"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AggregationGroupByDict.md b/docs/v1/Ontologies/models/AggregationGroupByDict.md deleted file mode 100644 index 936d2b76f..000000000 --- a/docs/v1/Ontologies/models/AggregationGroupByDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# AggregationGroupByDict - -Specifies a grouping for aggregation results. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -AggregationDurationGroupingDict | duration -AggregationFixedWidthGroupingDict | fixedWidth -AggregationRangesGroupingDict | ranges -AggregationExactGroupingDict | exact - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AggregationMetricResultDict.md b/docs/v1/Ontologies/models/AggregationMetricResultDict.md deleted file mode 100644 index 1d5d02364..000000000 --- a/docs/v1/Ontologies/models/AggregationMetricResultDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationMetricResultDict - -AggregationMetricResult - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | str | Yes | | -**value** | NotRequired[float] | No | TBD | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AggregationRangeDict.md b/docs/v1/Ontologies/models/AggregationRangeDict.md deleted file mode 100644 index a4ef264d0..000000000 --- a/docs/v1/Ontologies/models/AggregationRangeDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregationRangeDict - -Specifies a date range from an inclusive start date to an exclusive end date. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Exclusive end date. | -**lte** | NotRequired[Any] | No | Inclusive end date. | -**gt** | NotRequired[Any] | No | Exclusive start date. | -**gte** | NotRequired[Any] | No | Inclusive start date. | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AggregationRangesGroupingDict.md b/docs/v1/Ontologies/models/AggregationRangesGroupingDict.md deleted file mode 100644 index 4b9d9a6d8..000000000 --- a/docs/v1/Ontologies/models/AggregationRangesGroupingDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationRangesGroupingDict - -Divides objects into groups according to specified ranges. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**ranges** | List[AggregationRangeDict] | Yes | | -**type** | Literal["ranges"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AllTermsQueryDict.md b/docs/v1/Ontologies/models/AllTermsQueryDict.md deleted file mode 100644 index 6d12d69bb..000000000 --- a/docs/v1/Ontologies/models/AllTermsQueryDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# AllTermsQueryDict - -Returns objects where the specified field contains all of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | str | Yes | | -**fuzzy** | NotRequired[Fuzzy] | No | | -**type** | Literal["allTerms"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AndQueryDict.md b/docs/v1/Ontologies/models/AndQueryDict.md deleted file mode 100644 index c4498ac6b..000000000 --- a/docs/v1/Ontologies/models/AndQueryDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AndQueryDict - -Returns objects where every query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryDict] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AnyTermQueryDict.md b/docs/v1/Ontologies/models/AnyTermQueryDict.md deleted file mode 100644 index 1c50e14d6..000000000 --- a/docs/v1/Ontologies/models/AnyTermQueryDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# AnyTermQueryDict - -Returns objects where the specified field contains any of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | str | Yes | | -**fuzzy** | NotRequired[Fuzzy] | No | | -**type** | Literal["anyTerm"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ApplyActionRequestDict.md b/docs/v1/Ontologies/models/ApplyActionRequestDict.md deleted file mode 100644 index e69533f32..000000000 --- a/docs/v1/Ontologies/models/ApplyActionRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ApplyActionRequestDict - -ApplyActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ApplyActionRequestOptionsDict.md b/docs/v1/Ontologies/models/ApplyActionRequestOptionsDict.md deleted file mode 100644 index 6247ee30b..000000000 --- a/docs/v1/Ontologies/models/ApplyActionRequestOptionsDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ApplyActionRequestOptionsDict - -ApplyActionRequestOptions - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**mode** | NotRequired[ApplyActionMode] | No | | -**returnEdits** | NotRequired[ReturnEditsMode] | No | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ApplyActionResponseDict.md b/docs/v1/Ontologies/models/ApplyActionResponseDict.md deleted file mode 100644 index 1df22c0d5..000000000 --- a/docs/v1/Ontologies/models/ApplyActionResponseDict.md +++ /dev/null @@ -1,10 +0,0 @@ -# ApplyActionResponseDict - -ApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ApproximateDistinctAggregationDict.md b/docs/v1/Ontologies/models/ApproximateDistinctAggregationDict.md deleted file mode 100644 index ea8a5504a..000000000 --- a/docs/v1/Ontologies/models/ApproximateDistinctAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ApproximateDistinctAggregationDict - -Computes an approximate number of distinct values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["approximateDistinct"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ArraySizeConstraintDict.md b/docs/v1/Ontologies/models/ArraySizeConstraintDict.md deleted file mode 100644 index 5df42cef3..000000000 --- a/docs/v1/Ontologies/models/ArraySizeConstraintDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ArraySizeConstraintDict - -The parameter expects an array of values and the size of the array must fall within the defined range. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Less than | -**lte** | NotRequired[Any] | No | Less than or equal | -**gt** | NotRequired[Any] | No | Greater than | -**gte** | NotRequired[Any] | No | Greater than or equal | -**type** | Literal["arraySize"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AttachmentDict.md b/docs/v1/Ontologies/models/AttachmentDict.md deleted file mode 100644 index 158665cf6..000000000 --- a/docs/v1/Ontologies/models/AttachmentDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AttachmentDict - -The representation of an attachment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | -**filename** | Filename | Yes | | -**sizeBytes** | SizeBytes | Yes | | -**mediaType** | MediaType | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/AvgAggregationDict.md b/docs/v1/Ontologies/models/AvgAggregationDict.md deleted file mode 100644 index 114a1e0a4..000000000 --- a/docs/v1/Ontologies/models/AvgAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AvgAggregationDict - -Computes the average value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["avg"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/BatchApplyActionResponseDict.md b/docs/v1/Ontologies/models/BatchApplyActionResponseDict.md deleted file mode 100644 index 49a411da2..000000000 --- a/docs/v1/Ontologies/models/BatchApplyActionResponseDict.md +++ /dev/null @@ -1,10 +0,0 @@ -# BatchApplyActionResponseDict - -BatchApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ContainsQueryDict.md b/docs/v1/Ontologies/models/ContainsQueryDict.md deleted file mode 100644 index c2ef90552..000000000 --- a/docs/v1/Ontologies/models/ContainsQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ContainsQueryDict - -Returns objects where the specified array contains a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["contains"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/CountAggregationDict.md b/docs/v1/Ontologies/models/CountAggregationDict.md deleted file mode 100644 index 6cdc50dc5..000000000 --- a/docs/v1/Ontologies/models/CountAggregationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CountAggregationDict - -Computes the total count of objects. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["count"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/CreateInterfaceObjectRuleDict.md b/docs/v1/Ontologies/models/CreateInterfaceObjectRuleDict.md deleted file mode 100644 index 729422864..000000000 --- a/docs/v1/Ontologies/models/CreateInterfaceObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateInterfaceObjectRuleDict - -CreateInterfaceObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | -**type** | Literal["createInterfaceObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/CreateLinkRuleDict.md b/docs/v1/Ontologies/models/CreateLinkRuleDict.md deleted file mode 100644 index 88d90090a..000000000 --- a/docs/v1/Ontologies/models/CreateLinkRuleDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# CreateLinkRuleDict - -CreateLinkRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | -**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | -**aSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**bSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["createLink"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/CreateObjectRuleDict.md b/docs/v1/Ontologies/models/CreateObjectRuleDict.md deleted file mode 100644 index 22b842475..000000000 --- a/docs/v1/Ontologies/models/CreateObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateObjectRuleDict - -CreateObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["createObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/DeleteInterfaceObjectRuleDict.md b/docs/v1/Ontologies/models/DeleteInterfaceObjectRuleDict.md deleted file mode 100644 index 3a17c8d0c..000000000 --- a/docs/v1/Ontologies/models/DeleteInterfaceObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# DeleteInterfaceObjectRuleDict - -DeleteInterfaceObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | -**type** | Literal["deleteInterfaceObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/DeleteLinkRuleDict.md b/docs/v1/Ontologies/models/DeleteLinkRuleDict.md deleted file mode 100644 index 4f5d0c7c0..000000000 --- a/docs/v1/Ontologies/models/DeleteLinkRuleDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# DeleteLinkRuleDict - -DeleteLinkRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | -**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | -**aSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**bSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["deleteLink"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/DeleteObjectRuleDict.md b/docs/v1/Ontologies/models/DeleteObjectRuleDict.md deleted file mode 100644 index 3ea3e784d..000000000 --- a/docs/v1/Ontologies/models/DeleteObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# DeleteObjectRuleDict - -DeleteObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["deleteObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/EntrySetTypeDict.md b/docs/v1/Ontologies/models/EntrySetType.md similarity index 76% rename from docs/v1/Ontologies/models/EntrySetTypeDict.md rename to docs/v1/Ontologies/models/EntrySetType.md index 6c4d98d5d..5a8563bd5 100644 --- a/docs/v1/Ontologies/models/EntrySetTypeDict.md +++ b/docs/v1/Ontologies/models/EntrySetType.md @@ -1,12 +1,12 @@ -# EntrySetTypeDict +# EntrySetType EntrySetType ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**keyType** | QueryDataTypeDict | Yes | | -**valueType** | QueryDataTypeDict | Yes | | +**key_type** | QueryDataType | Yes | | +**value_type** | QueryDataType | Yes | | **type** | Literal["entrySet"] | Yes | None | diff --git a/docs/v1/Ontologies/models/EqualsQueryDict.md b/docs/v1/Ontologies/models/EqualsQueryDict.md deleted file mode 100644 index 375c6ed5b..000000000 --- a/docs/v1/Ontologies/models/EqualsQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# EqualsQueryDict - -Returns objects where the specified field is equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["eq"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ExecuteQueryResponseDict.md b/docs/v1/Ontologies/models/ExecuteQueryResponseDict.md deleted file mode 100644 index 318b26d87..000000000 --- a/docs/v1/Ontologies/models/ExecuteQueryResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExecuteQueryResponseDict - -ExecuteQueryResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | DataValue | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/GroupMemberConstraintDict.md b/docs/v1/Ontologies/models/GroupMemberConstraintDict.md deleted file mode 100644 index 6d4cdad95..000000000 --- a/docs/v1/Ontologies/models/GroupMemberConstraintDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# GroupMemberConstraintDict - -The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["groupMember"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/GtQueryDict.md b/docs/v1/Ontologies/models/GtQueryDict.md deleted file mode 100644 index 4f028028e..000000000 --- a/docs/v1/Ontologies/models/GtQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GtQueryDict - -Returns objects where the specified field is greater than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gt"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/GteQueryDict.md b/docs/v1/Ontologies/models/GteQueryDict.md deleted file mode 100644 index 61a326e2a..000000000 --- a/docs/v1/Ontologies/models/GteQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GteQueryDict - -Returns objects where the specified field is greater than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gte"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/IsNullQueryDict.md b/docs/v1/Ontologies/models/IsNullQueryDict.md deleted file mode 100644 index 86f49769f..000000000 --- a/docs/v1/Ontologies/models/IsNullQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# IsNullQueryDict - -Returns objects based on the existence of the specified field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | bool | Yes | | -**type** | Literal["isNull"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/LinkTypeSideDict.md b/docs/v1/Ontologies/models/LinkTypeSideDict.md deleted file mode 100644 index 2c119031c..000000000 --- a/docs/v1/Ontologies/models/LinkTypeSideDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# LinkTypeSideDict - -LinkTypeSide - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | LinkTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**cardinality** | LinkTypeSideCardinality | Yes | | -**foreignKeyPropertyApiName** | NotRequired[PropertyApiName] | No | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ListActionTypesResponseDict.md b/docs/v1/Ontologies/models/ListActionTypesResponseDict.md deleted file mode 100644 index 68e6b8b3b..000000000 --- a/docs/v1/Ontologies/models/ListActionTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListActionTypesResponseDict - -ListActionTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[ActionTypeDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ListLinkedObjectsResponseDict.md b/docs/v1/Ontologies/models/ListLinkedObjectsResponseDict.md deleted file mode 100644 index c8f24600a..000000000 --- a/docs/v1/Ontologies/models/ListLinkedObjectsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListLinkedObjectsResponseDict - -ListLinkedObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[OntologyObjectDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ListObjectTypesResponseDict.md b/docs/v1/Ontologies/models/ListObjectTypesResponseDict.md deleted file mode 100644 index abd5db7d3..000000000 --- a/docs/v1/Ontologies/models/ListObjectTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListObjectTypesResponseDict - -ListObjectTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[ObjectTypeDict] | Yes | The list of object types in the current page. | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ListObjectsResponseDict.md b/docs/v1/Ontologies/models/ListObjectsResponseDict.md deleted file mode 100644 index 7292e6306..000000000 --- a/docs/v1/Ontologies/models/ListObjectsResponseDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListObjectsResponseDict - -ListObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[OntologyObjectDict] | Yes | The list of objects in the current page. | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ListOntologiesResponseDict.md b/docs/v1/Ontologies/models/ListOntologiesResponseDict.md deleted file mode 100644 index 92c331bc1..000000000 --- a/docs/v1/Ontologies/models/ListOntologiesResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListOntologiesResponseDict - -ListOntologiesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyDict] | Yes | The list of Ontologies the user has access to. | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ListOutgoingLinkTypesResponseDict.md b/docs/v1/Ontologies/models/ListOutgoingLinkTypesResponseDict.md deleted file mode 100644 index 6d0bfc846..000000000 --- a/docs/v1/Ontologies/models/ListOutgoingLinkTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListOutgoingLinkTypesResponseDict - -ListOutgoingLinkTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[LinkTypeSideDict] | Yes | The list of link type sides in the current page. | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ListQueryTypesResponseDict.md b/docs/v1/Ontologies/models/ListQueryTypesResponseDict.md deleted file mode 100644 index 152884fb0..000000000 --- a/docs/v1/Ontologies/models/ListQueryTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListQueryTypesResponseDict - -ListQueryTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[QueryTypeDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/LogicRuleDict.md b/docs/v1/Ontologies/models/LogicRuleDict.md deleted file mode 100644 index 74b56b1c3..000000000 --- a/docs/v1/Ontologies/models/LogicRuleDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# LogicRuleDict - -LogicRule - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DeleteInterfaceObjectRuleDict | deleteInterfaceObject -ModifyInterfaceObjectRuleDict | modifyInterfaceObject -ModifyObjectRuleDict | modifyObject -DeleteObjectRuleDict | deleteObject -CreateInterfaceObjectRuleDict | createInterfaceObject -DeleteLinkRuleDict | deleteLink -CreateObjectRuleDict | createObject -CreateLinkRuleDict | createLink - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/LtQueryDict.md b/docs/v1/Ontologies/models/LtQueryDict.md deleted file mode 100644 index ddcc10bce..000000000 --- a/docs/v1/Ontologies/models/LtQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LtQueryDict - -Returns objects where the specified field is less than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lt"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/LteQueryDict.md b/docs/v1/Ontologies/models/LteQueryDict.md deleted file mode 100644 index cc77757a6..000000000 --- a/docs/v1/Ontologies/models/LteQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LteQueryDict - -Returns objects where the specified field is less than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lte"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/MaxAggregationDict.md b/docs/v1/Ontologies/models/MaxAggregationDict.md deleted file mode 100644 index acd7404e1..000000000 --- a/docs/v1/Ontologies/models/MaxAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MaxAggregationDict - -Computes the maximum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["max"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/MinAggregationDict.md b/docs/v1/Ontologies/models/MinAggregationDict.md deleted file mode 100644 index aef1d4a19..000000000 --- a/docs/v1/Ontologies/models/MinAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MinAggregationDict - -Computes the minimum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["min"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ModifyInterfaceObjectRuleDict.md b/docs/v1/Ontologies/models/ModifyInterfaceObjectRuleDict.md deleted file mode 100644 index 07879db68..000000000 --- a/docs/v1/Ontologies/models/ModifyInterfaceObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModifyInterfaceObjectRuleDict - -ModifyInterfaceObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | -**type** | Literal["modifyInterfaceObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ModifyObjectRuleDict.md b/docs/v1/Ontologies/models/ModifyObjectRuleDict.md deleted file mode 100644 index f15d647c3..000000000 --- a/docs/v1/Ontologies/models/ModifyObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModifyObjectRuleDict - -ModifyObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["modifyObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/NotQueryDict.md b/docs/v1/Ontologies/models/NotQueryDict.md deleted file mode 100644 index 1db793a0e..000000000 --- a/docs/v1/Ontologies/models/NotQueryDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# NotQueryDict - -Returns objects where the query is not satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | SearchJsonQueryDict | Yes | | -**type** | Literal["not"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ObjectPropertyValueConstraintDict.md b/docs/v1/Ontologies/models/ObjectPropertyValueConstraintDict.md deleted file mode 100644 index 7efe0e4b6..000000000 --- a/docs/v1/Ontologies/models/ObjectPropertyValueConstraintDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectPropertyValueConstraintDict - -The parameter value must be a property value of an object found within an object set. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["objectPropertyValue"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ObjectQueryResultConstraintDict.md b/docs/v1/Ontologies/models/ObjectQueryResultConstraintDict.md deleted file mode 100644 index 32ae57685..000000000 --- a/docs/v1/Ontologies/models/ObjectQueryResultConstraintDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectQueryResultConstraintDict - -The parameter value must be the primary key of an object found within an object set. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["objectQueryResult"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ObjectTypeDict.md b/docs/v1/Ontologies/models/ObjectTypeDict.md deleted file mode 100644 index ed25aa5fa..000000000 --- a/docs/v1/Ontologies/models/ObjectTypeDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# ObjectTypeDict - -Represents an object type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ObjectTypeApiName | Yes | | -**displayName** | NotRequired[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**description** | NotRequired[str] | No | The description of the object type. | -**visibility** | NotRequired[ObjectTypeVisibility] | No | | -**primaryKey** | List[PropertyApiName] | Yes | The primary key of the object. This is a list of properties that can be used to uniquely identify the object. | -**properties** | Dict[PropertyApiName, PropertyDict] | Yes | A map of the properties of the object type. | -**rid** | ObjectTypeRid | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/OneOfConstraintDict.md b/docs/v1/Ontologies/models/OneOfConstraintDict.md deleted file mode 100644 index c3061e74c..000000000 --- a/docs/v1/Ontologies/models/OneOfConstraintDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# OneOfConstraintDict - -The parameter has a manually predefined set of options. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | List[ParameterOptionDict] | Yes | | -**otherValuesAllowed** | bool | Yes | A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**. | -**type** | Literal["oneOf"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/OntologyArrayTypeDict.md b/docs/v1/Ontologies/models/OntologyArrayTypeDict.md deleted file mode 100644 index 23bb25370..000000000 --- a/docs/v1/Ontologies/models/OntologyArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyArrayTypeDict - -OntologyArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**itemType** | OntologyDataTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/OntologyDataTypeDict.md b/docs/v1/Ontologies/models/OntologyDataTypeDict.md deleted file mode 100644 index 224da8941..000000000 --- a/docs/v1/Ontologies/models/OntologyDataTypeDict.md +++ /dev/null @@ -1,37 +0,0 @@ -# OntologyDataTypeDict - -A union of all the primitive types used by Palantir's Ontology-based products. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateTypeDict | date -OntologyStructTypeDict | struct -OntologySetTypeDict | set -StringTypeDict | string -ByteTypeDict | byte -DoubleTypeDict | double -IntegerTypeDict | integer -FloatTypeDict | float -AnyTypeDict | any -LongTypeDict | long -BooleanTypeDict | boolean -CipherTextTypeDict | cipherText -MarkingTypeDict | marking -UnsupportedTypeDict | unsupported -OntologyArrayTypeDict | array -OntologyObjectSetTypeDict | objectSet -BinaryTypeDict | binary -ShortTypeDict | short -DecimalTypeDict | decimal -OntologyMapTypeDict | map -TimestampTypeDict | timestamp -OntologyObjectTypeDict | object - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/OntologyDict.md b/docs/v1/Ontologies/models/OntologyDict.md deleted file mode 100644 index d2df9b574..000000000 --- a/docs/v1/Ontologies/models/OntologyDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# OntologyDict - -Metadata about an Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | OntologyApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | str | Yes | | -**rid** | OntologyRid | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/OntologyMapTypeDict.md b/docs/v1/Ontologies/models/OntologyMapTypeDict.md deleted file mode 100644 index b6b8dd52c..000000000 --- a/docs/v1/Ontologies/models/OntologyMapTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyMapTypeDict - -OntologyMapType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | OntologyDataTypeDict | Yes | | -**valueType** | OntologyDataTypeDict | Yes | | -**type** | Literal["map"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/OntologyObjectDict.md b/docs/v1/Ontologies/models/OntologyObjectDict.md deleted file mode 100644 index 5be1bc454..000000000 --- a/docs/v1/Ontologies/models/OntologyObjectDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyObjectDict - -Represents an object in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | Dict[PropertyApiName, Optional[PropertyValue]] | Yes | A map of the property values of the object. | -**rid** | ObjectRid | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/OntologyObjectSetTypeDict.md b/docs/v1/Ontologies/models/OntologyObjectSetTypeDict.md deleted file mode 100644 index c1dacb25e..000000000 --- a/docs/v1/Ontologies/models/OntologyObjectSetTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyObjectSetTypeDict - -OntologyObjectSetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectApiName** | NotRequired[ObjectTypeApiName] | No | | -**objectTypeApiName** | NotRequired[ObjectTypeApiName] | No | | -**type** | Literal["objectSet"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/OntologyObjectTypeDict.md b/docs/v1/Ontologies/models/OntologyObjectTypeDict.md deleted file mode 100644 index 8aa3349e6..000000000 --- a/docs/v1/Ontologies/models/OntologyObjectTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyObjectTypeDict - -OntologyObjectType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectApiName** | ObjectTypeApiName | Yes | | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["object"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/OntologySetTypeDict.md b/docs/v1/Ontologies/models/OntologySetTypeDict.md deleted file mode 100644 index 02446408b..000000000 --- a/docs/v1/Ontologies/models/OntologySetTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologySetTypeDict - -OntologySetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**itemType** | OntologyDataTypeDict | Yes | | -**type** | Literal["set"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/OntologyStructFieldDict.md b/docs/v1/Ontologies/models/OntologyStructFieldDict.md deleted file mode 100644 index 8030d6e49..000000000 --- a/docs/v1/Ontologies/models/OntologyStructFieldDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyStructFieldDict - -OntologyStructField - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StructFieldName | Yes | | -**fieldType** | OntologyDataTypeDict | Yes | | -**required** | bool | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/OntologyStructTypeDict.md b/docs/v1/Ontologies/models/OntologyStructTypeDict.md deleted file mode 100644 index c50cb9bb0..000000000 --- a/docs/v1/Ontologies/models/OntologyStructTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyStructTypeDict - -OntologyStructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[OntologyStructFieldDict] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/OrQueryDict.md b/docs/v1/Ontologies/models/OrQueryDict.md deleted file mode 100644 index b309ee767..000000000 --- a/docs/v1/Ontologies/models/OrQueryDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrQueryDict - -Returns objects where at least 1 query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryDict] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ParameterDict.md b/docs/v1/Ontologies/models/ParameterDict.md deleted file mode 100644 index d3fccd282..000000000 --- a/docs/v1/Ontologies/models/ParameterDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ParameterDict - -Details about a parameter of an action or query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[str] | No | | -**baseType** | ValueType | Yes | | -**dataType** | NotRequired[OntologyDataTypeDict] | No | | -**required** | bool | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ParameterEvaluatedConstraintDict.md b/docs/v1/Ontologies/models/ParameterEvaluatedConstraintDict.md deleted file mode 100644 index f4aa7d6c0..000000000 --- a/docs/v1/Ontologies/models/ParameterEvaluatedConstraintDict.md +++ /dev/null @@ -1,40 +0,0 @@ -# ParameterEvaluatedConstraintDict - -A constraint that an action parameter value must satisfy in order to be considered valid. -Constraints can be configured on action parameters in the **Ontology Manager**. -Applicable constraints are determined dynamically based on parameter inputs. -Parameter values are evaluated against the final set of constraints. - -The type of the constraint. -| Type | Description | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | -| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | -| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | -| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | -| `oneOf` | The parameter has a manually predefined set of options. | -| `range` | The parameter value must be within the defined range. | -| `stringLength` | The parameter value must have a length within the defined range. | -| `stringRegexMatch` | The parameter value must match a predefined regular expression. | -| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -OneOfConstraintDict | oneOf -GroupMemberConstraintDict | groupMember -ObjectPropertyValueConstraintDict | objectPropertyValue -RangeConstraintDict | range -ArraySizeConstraintDict | arraySize -ObjectQueryResultConstraintDict | objectQueryResult -StringLengthConstraintDict | stringLength -StringRegexMatchConstraintDict | stringRegexMatch -UnevaluableConstraintDict | unevaluable - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ParameterEvaluationResultDict.md b/docs/v1/Ontologies/models/ParameterEvaluationResultDict.md deleted file mode 100644 index d01b0a681..000000000 --- a/docs/v1/Ontologies/models/ParameterEvaluationResultDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterEvaluationResultDict - -Represents the validity of a parameter against the configured constraints. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**evaluatedConstraints** | List[ParameterEvaluatedConstraintDict] | Yes | | -**required** | bool | Yes | Represents whether the parameter is a required input to the action. | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ParameterOptionDict.md b/docs/v1/Ontologies/models/ParameterOptionDict.md deleted file mode 100644 index a5d12f43b..000000000 --- a/docs/v1/Ontologies/models/ParameterOptionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterOptionDict - -A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**displayName** | NotRequired[DisplayName] | No | | -**value** | NotRequired[Any] | No | An allowed configured value for a parameter within an action. | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/PhraseQueryDict.md b/docs/v1/Ontologies/models/PhraseQueryDict.md deleted file mode 100644 index 3af401649..000000000 --- a/docs/v1/Ontologies/models/PhraseQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PhraseQueryDict - -Returns objects where the specified field contains the provided value as a substring. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | str | Yes | | -**type** | Literal["phrase"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/PrefixQueryDict.md b/docs/v1/Ontologies/models/PrefixQueryDict.md deleted file mode 100644 index 61e6a17af..000000000 --- a/docs/v1/Ontologies/models/PrefixQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PrefixQueryDict - -Returns objects where the specified field starts with the provided value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | str | Yes | | -**type** | Literal["prefix"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/PropertyDict.md b/docs/v1/Ontologies/models/PropertyDict.md deleted file mode 100644 index 332a9798b..000000000 --- a/docs/v1/Ontologies/models/PropertyDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PropertyDict - -Details about some property of an object. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[str] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**baseType** | ValueType | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/QueryAggregationKeyTypeDict.md b/docs/v1/Ontologies/models/QueryAggregationKeyType.md similarity index 68% rename from docs/v1/Ontologies/models/QueryAggregationKeyTypeDict.md rename to docs/v1/Ontologies/models/QueryAggregationKeyType.md index d9bcb851e..d2d0b1649 100644 --- a/docs/v1/Ontologies/models/QueryAggregationKeyTypeDict.md +++ b/docs/v1/Ontologies/models/QueryAggregationKeyType.md @@ -1,4 +1,4 @@ -# QueryAggregationKeyTypeDict +# QueryAggregationKeyType A union of all the types supported by query aggregation keys. @@ -10,13 +10,13 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- -DateTypeDict | date -BooleanTypeDict | boolean -StringTypeDict | string -DoubleTypeDict | double -QueryAggregationRangeTypeDict | range -IntegerTypeDict | integer -TimestampTypeDict | timestamp +DateType | date +BooleanType | boolean +StringType | string +DoubleType | double +QueryAggregationRangeType | range +IntegerType | integer +TimestampType | timestamp [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/QueryAggregationRangeSubTypeDict.md b/docs/v1/Ontologies/models/QueryAggregationRangeSubType.md similarity index 77% rename from docs/v1/Ontologies/models/QueryAggregationRangeSubTypeDict.md rename to docs/v1/Ontologies/models/QueryAggregationRangeSubType.md index c4b3e677d..11aac0482 100644 --- a/docs/v1/Ontologies/models/QueryAggregationRangeSubTypeDict.md +++ b/docs/v1/Ontologies/models/QueryAggregationRangeSubType.md @@ -1,4 +1,4 @@ -# QueryAggregationRangeSubTypeDict +# QueryAggregationRangeSubType A union of all the types supported by query aggregation ranges. @@ -10,10 +10,10 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- -DateTypeDict | date -DoubleTypeDict | double -IntegerTypeDict | integer -TimestampTypeDict | timestamp +DateType | date +DoubleType | double +IntegerType | integer +TimestampType | timestamp [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/QueryAggregationRangeTypeDict.md b/docs/v1/Ontologies/models/QueryAggregationRangeType.md similarity index 79% rename from docs/v1/Ontologies/models/QueryAggregationRangeTypeDict.md rename to docs/v1/Ontologies/models/QueryAggregationRangeType.md index eeb21c24e..0fc4058bb 100644 --- a/docs/v1/Ontologies/models/QueryAggregationRangeTypeDict.md +++ b/docs/v1/Ontologies/models/QueryAggregationRangeType.md @@ -1,11 +1,11 @@ -# QueryAggregationRangeTypeDict +# QueryAggregationRangeType QueryAggregationRangeType ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**subType** | QueryAggregationRangeSubTypeDict | Yes | | +**sub_type** | QueryAggregationRangeSubType | Yes | | **type** | Literal["range"] | Yes | None | diff --git a/docs/v1/Ontologies/models/QueryAggregationValueTypeDict.md b/docs/v1/Ontologies/models/QueryAggregationValueType.md similarity index 81% rename from docs/v1/Ontologies/models/QueryAggregationValueTypeDict.md rename to docs/v1/Ontologies/models/QueryAggregationValueType.md index b4b006322..b98c83a60 100644 --- a/docs/v1/Ontologies/models/QueryAggregationValueTypeDict.md +++ b/docs/v1/Ontologies/models/QueryAggregationValueType.md @@ -1,4 +1,4 @@ -# QueryAggregationValueTypeDict +# QueryAggregationValueType A union of all the types supported by query aggregation keys. @@ -10,9 +10,9 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- -DateTypeDict | date -DoubleTypeDict | double -TimestampTypeDict | timestamp +DateType | date +DoubleType | double +TimestampType | timestamp [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/QueryArrayTypeDict.md b/docs/v1/Ontologies/models/QueryArrayType.md similarity index 84% rename from docs/v1/Ontologies/models/QueryArrayTypeDict.md rename to docs/v1/Ontologies/models/QueryArrayType.md index 5ffa0bcce..7c018e8a0 100644 --- a/docs/v1/Ontologies/models/QueryArrayTypeDict.md +++ b/docs/v1/Ontologies/models/QueryArrayType.md @@ -1,11 +1,11 @@ -# QueryArrayTypeDict +# QueryArrayType QueryArrayType ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**subType** | QueryDataTypeDict | Yes | | +**sub_type** | QueryDataType | Yes | | **type** | Literal["array"] | Yes | None | diff --git a/docs/v1/Ontologies/models/QueryDataType.md b/docs/v1/Ontologies/models/QueryDataType.md new file mode 100644 index 000000000..79de6acd2 --- /dev/null +++ b/docs/v1/Ontologies/models/QueryDataType.md @@ -0,0 +1,35 @@ +# QueryDataType + +A union of all the types supported by Ontology Query parameters or outputs. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateType | date +QueryStructType | struct +QuerySetType | set +StringType | string +EntrySetType | entrySet +DoubleType | double +IntegerType | integer +ThreeDimensionalAggregation | threeDimensionalAggregation +QueryUnionType | union +FloatType | float +LongType | long +BooleanType | boolean +UnsupportedType | unsupported +AttachmentType | attachment +NullType | null +QueryArrayType | array +OntologyObjectSetType | objectSet +TwoDimensionalAggregation | twoDimensionalAggregation +OntologyObjectType | object +TimestampType | timestamp + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/QueryDataTypeDict.md b/docs/v1/Ontologies/models/QueryDataTypeDict.md deleted file mode 100644 index 6c29cd0d6..000000000 --- a/docs/v1/Ontologies/models/QueryDataTypeDict.md +++ /dev/null @@ -1,35 +0,0 @@ -# QueryDataTypeDict - -A union of all the types supported by Ontology Query parameters or outputs. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateTypeDict | date -QueryStructTypeDict | struct -QuerySetTypeDict | set -StringTypeDict | string -EntrySetTypeDict | entrySet -DoubleTypeDict | double -IntegerTypeDict | integer -ThreeDimensionalAggregationDict | threeDimensionalAggregation -QueryUnionTypeDict | union -FloatTypeDict | float -LongTypeDict | long -BooleanTypeDict | boolean -UnsupportedTypeDict | unsupported -AttachmentTypeDict | attachment -NullTypeDict | null -QueryArrayTypeDict | array -OntologyObjectSetTypeDict | objectSet -TwoDimensionalAggregationDict | twoDimensionalAggregation -OntologyObjectTypeDict | object -TimestampTypeDict | timestamp - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/QuerySetTypeDict.md b/docs/v1/Ontologies/models/QuerySetType.md similarity index 84% rename from docs/v1/Ontologies/models/QuerySetTypeDict.md rename to docs/v1/Ontologies/models/QuerySetType.md index adf76c22e..378700e5c 100644 --- a/docs/v1/Ontologies/models/QuerySetTypeDict.md +++ b/docs/v1/Ontologies/models/QuerySetType.md @@ -1,11 +1,11 @@ -# QuerySetTypeDict +# QuerySetType QuerySetType ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**subType** | QueryDataTypeDict | Yes | | +**sub_type** | QueryDataType | Yes | | **type** | Literal["set"] | Yes | None | diff --git a/docs/v1/Ontologies/models/QueryStructFieldDict.md b/docs/v1/Ontologies/models/QueryStructField.md similarity index 83% rename from docs/v1/Ontologies/models/QueryStructFieldDict.md rename to docs/v1/Ontologies/models/QueryStructField.md index 3c3d05837..765701f28 100644 --- a/docs/v1/Ontologies/models/QueryStructFieldDict.md +++ b/docs/v1/Ontologies/models/QueryStructField.md @@ -1,4 +1,4 @@ -# QueryStructFieldDict +# QueryStructField QueryStructField @@ -6,7 +6,7 @@ QueryStructField | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **name** | StructFieldName | Yes | | -**fieldType** | QueryDataTypeDict | Yes | | +**field_type** | QueryDataType | Yes | | [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/QueryStructTypeDict.md b/docs/v1/Ontologies/models/QueryStructType.md similarity index 82% rename from docs/v1/Ontologies/models/QueryStructTypeDict.md rename to docs/v1/Ontologies/models/QueryStructType.md index 746d13067..aea2be272 100644 --- a/docs/v1/Ontologies/models/QueryStructTypeDict.md +++ b/docs/v1/Ontologies/models/QueryStructType.md @@ -1,11 +1,11 @@ -# QueryStructTypeDict +# QueryStructType QueryStructType ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**fields** | List[QueryStructFieldDict] | Yes | | +**fields** | List[QueryStructField] | Yes | | **type** | Literal["struct"] | Yes | None | diff --git a/docs/v1/Ontologies/models/QueryTypeDict.md b/docs/v1/Ontologies/models/QueryTypeDict.md deleted file mode 100644 index 3fb0e8cd7..000000000 --- a/docs/v1/Ontologies/models/QueryTypeDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# QueryTypeDict - -Represents a query type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | QueryApiName | Yes | | -**description** | NotRequired[str] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**parameters** | Dict[ParameterId, ParameterDict] | Yes | | -**output** | NotRequired[OntologyDataTypeDict] | No | | -**rid** | FunctionRid | Yes | | -**version** | FunctionVersion | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/QueryUnionTypeDict.md b/docs/v1/Ontologies/models/QueryUnionType.md similarity index 82% rename from docs/v1/Ontologies/models/QueryUnionTypeDict.md rename to docs/v1/Ontologies/models/QueryUnionType.md index 8f69712f9..d0dc84a41 100644 --- a/docs/v1/Ontologies/models/QueryUnionTypeDict.md +++ b/docs/v1/Ontologies/models/QueryUnionType.md @@ -1,11 +1,11 @@ -# QueryUnionTypeDict +# QueryUnionType QueryUnionType ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**unionTypes** | List[QueryDataTypeDict] | Yes | | +**union_types** | List[QueryDataType] | Yes | | **type** | Literal["union"] | Yes | None | diff --git a/docs/v1/Ontologies/models/RangeConstraintDict.md b/docs/v1/Ontologies/models/RangeConstraintDict.md deleted file mode 100644 index e38be5013..000000000 --- a/docs/v1/Ontologies/models/RangeConstraintDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# RangeConstraintDict - -The parameter value must be within the defined range. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Less than | -**lte** | NotRequired[Any] | No | Less than or equal | -**gt** | NotRequired[Any] | No | Greater than | -**gte** | NotRequired[Any] | No | Greater than or equal | -**type** | Literal["range"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/SearchJsonQueryDict.md b/docs/v1/Ontologies/models/SearchJsonQueryDict.md deleted file mode 100644 index 8c66ce6af..000000000 --- a/docs/v1/Ontologies/models/SearchJsonQueryDict.md +++ /dev/null @@ -1,28 +0,0 @@ -# SearchJsonQueryDict - -SearchJsonQuery - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -OrQueryDict | or -PrefixQueryDict | prefix -LtQueryDict | lt -AllTermsQueryDict | allTerms -EqualsQueryDict | eq -GtQueryDict | gt -ContainsQueryDict | contains -NotQueryDict | not -PhraseQueryDict | phrase -AndQueryDict | and -IsNullQueryDict | isNull -GteQueryDict | gte -AnyTermQueryDict | anyTerm -LteQueryDict | lte - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/SearchObjectsResponseDict.md b/docs/v1/Ontologies/models/SearchObjectsResponseDict.md deleted file mode 100644 index 200c4bdcb..000000000 --- a/docs/v1/Ontologies/models/SearchObjectsResponseDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchObjectsResponseDict - -SearchObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/SearchOrderByDict.md b/docs/v1/Ontologies/models/SearchOrderByDict.md deleted file mode 100644 index 2c52b8b11..000000000 --- a/docs/v1/Ontologies/models/SearchOrderByDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# SearchOrderByDict - -Specifies the ordering of search results by a field and an ordering direction. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[SearchOrderingDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/SearchOrderingDict.md b/docs/v1/Ontologies/models/SearchOrderingDict.md deleted file mode 100644 index 8fc1979fc..000000000 --- a/docs/v1/Ontologies/models/SearchOrderingDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchOrderingDict - -SearchOrdering - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**direction** | NotRequired[str] | No | Specifies the ordering direction (can be either `asc` or `desc`) | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/StringLengthConstraintDict.md b/docs/v1/Ontologies/models/StringLengthConstraintDict.md deleted file mode 100644 index d6c761192..000000000 --- a/docs/v1/Ontologies/models/StringLengthConstraintDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# StringLengthConstraintDict - -The parameter value must have a length within the defined range. -*This range is always inclusive.* - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Less than | -**lte** | NotRequired[Any] | No | Less than or equal | -**gt** | NotRequired[Any] | No | Greater than | -**gte** | NotRequired[Any] | No | Greater than or equal | -**type** | Literal["stringLength"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/StringRegexMatchConstraintDict.md b/docs/v1/Ontologies/models/StringRegexMatchConstraintDict.md deleted file mode 100644 index d402fd776..000000000 --- a/docs/v1/Ontologies/models/StringRegexMatchConstraintDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# StringRegexMatchConstraintDict - -The parameter value must match a predefined regular expression. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**regex** | str | Yes | The regular expression configured in the **Ontology Manager**. | -**configuredFailureMessage** | NotRequired[str] | No | The message indicating that the regular expression was not matched. This is configured per parameter in the **Ontology Manager**. | -**type** | Literal["stringRegexMatch"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/SubmissionCriteriaEvaluationDict.md b/docs/v1/Ontologies/models/SubmissionCriteriaEvaluationDict.md deleted file mode 100644 index fd0ea36e3..000000000 --- a/docs/v1/Ontologies/models/SubmissionCriteriaEvaluationDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# SubmissionCriteriaEvaluationDict - -Contains the status of the **submission criteria**. -**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. -These are configured in the **Ontology Manager**. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**configuredFailureMessage** | NotRequired[str] | No | The message indicating one of the **submission criteria** was not satisfied. This is configured per **submission criteria** in the **Ontology Manager**. | -**result** | ValidationResult | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/SumAggregationDict.md b/docs/v1/Ontologies/models/SumAggregationDict.md deleted file mode 100644 index 004cb613d..000000000 --- a/docs/v1/Ontologies/models/SumAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SumAggregationDict - -Computes the sum of values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["sum"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ThreeDimensionalAggregationDict.md b/docs/v1/Ontologies/models/ThreeDimensionalAggregation.md similarity index 72% rename from docs/v1/Ontologies/models/ThreeDimensionalAggregationDict.md rename to docs/v1/Ontologies/models/ThreeDimensionalAggregation.md index e5dcd4350..e82f23994 100644 --- a/docs/v1/Ontologies/models/ThreeDimensionalAggregationDict.md +++ b/docs/v1/Ontologies/models/ThreeDimensionalAggregation.md @@ -1,12 +1,12 @@ -# ThreeDimensionalAggregationDict +# ThreeDimensionalAggregation ThreeDimensionalAggregation ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**keyType** | QueryAggregationKeyTypeDict | Yes | | -**valueType** | TwoDimensionalAggregationDict | Yes | | +**key_type** | QueryAggregationKeyType | Yes | | +**value_type** | TwoDimensionalAggregation | Yes | | **type** | Literal["threeDimensionalAggregation"] | Yes | None | diff --git a/docs/v1/Ontologies/models/TwoDimensionalAggregationDict.md b/docs/v1/Ontologies/models/TwoDimensionalAggregation.md similarity index 72% rename from docs/v1/Ontologies/models/TwoDimensionalAggregationDict.md rename to docs/v1/Ontologies/models/TwoDimensionalAggregation.md index 1e5ad94b9..f5cb32b2e 100644 --- a/docs/v1/Ontologies/models/TwoDimensionalAggregationDict.md +++ b/docs/v1/Ontologies/models/TwoDimensionalAggregation.md @@ -1,12 +1,12 @@ -# TwoDimensionalAggregationDict +# TwoDimensionalAggregation TwoDimensionalAggregation ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**keyType** | QueryAggregationKeyTypeDict | Yes | | -**valueType** | QueryAggregationValueTypeDict | Yes | | +**key_type** | QueryAggregationKeyType | Yes | | +**value_type** | QueryAggregationValueType | Yes | | **type** | Literal["twoDimensionalAggregation"] | Yes | None | diff --git a/docs/v1/Ontologies/models/UnevaluableConstraintDict.md b/docs/v1/Ontologies/models/UnevaluableConstraintDict.md deleted file mode 100644 index 8676ae729..000000000 --- a/docs/v1/Ontologies/models/UnevaluableConstraintDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# UnevaluableConstraintDict - -The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. -This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["unevaluable"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/Ontologies/models/ValidateActionResponseDict.md b/docs/v1/Ontologies/models/ValidateActionResponseDict.md deleted file mode 100644 index 5b69791c5..000000000 --- a/docs/v1/Ontologies/models/ValidateActionResponseDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ValidateActionResponseDict - -ValidateActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**submissionCriteria** | List[SubmissionCriteriaEvaluationDict] | Yes | | -**parameters** | Dict[ParameterId, ParameterEvaluationResultDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/Group.md b/docs/v2/Admin/Group.md index 7bd9449ac..102e2ffac 100644 --- a/docs/v2/Admin/Group.md +++ b/docs/v2/Admin/Group.md @@ -7,7 +7,6 @@ Method | HTTP request | Release Stage | [**get**](#get) | **GET** /v2/admin/groups/{groupId} | Stable | [**get_batch**](#get_batch) | **POST** /v2/admin/groups/getBatch | Stable | [**list**](#list) | **GET** /v2/admin/groups | Stable | -[**page**](#page) | **GET** /v2/admin/groups | Stable | [**search**](#search) | **POST** /v2/admin/groups/search | Stable | # **create** @@ -181,7 +180,7 @@ The maximum batch size for this endpoint is 500. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**body** | List[Union[GetGroupsBatchRequestElement, GetGroupsBatchRequestElementDict]] | Body of the request | | +**body** | List[GetGroupsBatchRequestElement] | Body of the request | | ### Return type **GetGroupsBatchResponse** @@ -195,7 +194,7 @@ from pprint import pprint client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# List[Union[GetGroupsBatchRequestElement, GetGroupsBatchRequestElementDict]] | Body of the request +# List[GetGroupsBatchRequestElement] | Body of the request body = [{"groupId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"}] @@ -261,58 +260,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListGroupsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists all Groups. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | - -### Return type -**ListGroupsResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None - - -try: - api_response = foundry_client.admin.Group.page(page_size=page_size, page_token=page_token) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Group.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) @@ -332,7 +279,7 @@ Perform a case-insensitive prefix search for groups based on group name. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**where** | Union[GroupSearchFilter, GroupSearchFilterDict] | | | +**where** | GroupSearchFilter | | | **page_size** | Optional[PageSize] | | [optional] | **page_token** | Optional[PageToken] | | [optional] | @@ -348,7 +295,7 @@ from pprint import pprint client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# Union[GroupSearchFilter, GroupSearchFilterDict] +# GroupSearchFilter where = {"type": "queryString"} # Optional[PageSize] page_size = 100 diff --git a/docs/v2/Admin/GroupMember.md b/docs/v2/Admin/GroupMember.md index 1825b7248..2fd62ba94 100644 --- a/docs/v2/Admin/GroupMember.md +++ b/docs/v2/Admin/GroupMember.md @@ -4,7 +4,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**add**](#add) | **POST** /v2/admin/groups/{groupId}/groupMembers/add | Stable | [**list**](#list) | **GET** /v2/admin/groups/{groupId}/groupMembers | Stable | -[**page**](#page) | **GET** /v2/admin/groups/{groupId}/groupMembers | Stable | [**remove**](#remove) | **POST** /v2/admin/groups/{groupId}/groupMembers/remove | Stable | # **add** @@ -115,71 +114,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListGroupMembersResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists all members (which can be a User or a Group) of a given Group. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, -it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. -To get the next page, make the same request again, but set the value of the `pageToken` query parameter -to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field -in the response, you are on the last page. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**group_id** | PrincipalId | | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**transitive** | Optional[bool] | When true, includes the transitive members of groups contained within this group. For example, say the Group has member Group A, and Group A has member User B. If `transitive=false` only Group A will be returned, but if `transitive=true` then Group A and User B will be returned. This will recursively resolve Groups through all layers of nesting. Defaults to false. | [optional] | - -### Return type -**ListGroupMembersResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# PrincipalId -group_id = None -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[bool] | When true, includes the transitive members of groups contained within this group. For example, say the Group has member Group A, and Group A has member User B. If `transitive=false` only Group A will be returned, but if `transitive=true` then Group A and User B will be returned. This will recursively resolve Groups through all layers of nesting. Defaults to false. -transitive = None - - -try: - api_response = foundry_client.admin.Group.GroupMember.page( - group_id, page_size=page_size, page_token=page_token, transitive=transitive - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling GroupMember.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Admin/GroupMembership.md b/docs/v2/Admin/GroupMembership.md index 780dafedc..cf6684e68 100644 --- a/docs/v2/Admin/GroupMembership.md +++ b/docs/v2/Admin/GroupMembership.md @@ -3,7 +3,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**list**](#list) | **GET** /v2/admin/users/{userId}/groupMemberships | Stable | -[**page**](#page) | **GET** /v2/admin/users/{userId}/groupMemberships | Stable | # **list** Lists all Groups a given User is a member of. @@ -58,71 +57,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListGroupMembershipsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists all Groups a given User is a member of. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, -it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. -To get the next page, make the same request again, but set the value of the `pageToken` query parameter -to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field -in the response, you are on the last page. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**user_id** | PrincipalId | | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**transitive** | Optional[bool] | When true, includes the transitive memberships of the Groups the User is a member of. For example, say the User is a member of Group A, and Group A is a member of Group B. If `transitive=false` only Group A will be returned, but if `transitive=true` then Groups A and B will be returned. This will recursively resolve Groups through all layers of nesting. Defaults to false. | [optional] | - -### Return type -**ListGroupMembershipsResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# PrincipalId -user_id = None -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[bool] | When true, includes the transitive memberships of the Groups the User is a member of. For example, say the User is a member of Group A, and Group A is a member of Group B. If `transitive=false` only Group A will be returned, but if `transitive=true` then Groups A and B will be returned. This will recursively resolve Groups through all layers of nesting. Defaults to false. -transitive = None - - -try: - api_response = foundry_client.admin.User.GroupMembership.page( - user_id, page_size=page_size, page_token=page_token, transitive=transitive - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling GroupMembership.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Admin/Host.md b/docs/v2/Admin/Host.md index 82705216b..4eebb70a9 100644 --- a/docs/v2/Admin/Host.md +++ b/docs/v2/Admin/Host.md @@ -3,7 +3,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**list**](#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/hosts | Private Beta | -[**page**](#page) | **GET** /v2/admin/enrollments/{enrollmentRid}/hosts | Private Beta | # **list** Lists all Hosts. @@ -53,66 +52,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListHostsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists all Hosts. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**enrollment_rid** | EnrollmentRid | | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListHostsResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# EnrollmentRid -enrollment_rid = None -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.admin.Enrollment.Host.page( - enrollment_rid, page_size=page_size, page_token=page_token, preview=preview - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Host.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Admin/Marking.md b/docs/v2/Admin/Marking.md index 0e4ee2e25..1d3903387 100644 --- a/docs/v2/Admin/Marking.md +++ b/docs/v2/Admin/Marking.md @@ -6,7 +6,6 @@ Method | HTTP request | Release Stage | [**get**](#get) | **GET** /v2/admin/markings/{markingId} | Public Beta | [**get_batch**](#get_batch) | **POST** /v2/admin/markings/getBatch | Public Beta | [**list**](#list) | **GET** /v2/admin/markings | Public Beta | -[**page**](#page) | **GET** /v2/admin/markings | Public Beta | # **create** Creates a new Marking. @@ -17,7 +16,7 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **category_id** | MarkingCategoryId | | | **initial_members** | List[PrincipalId] | Users and Groups that will be able to view resources protected by this Marking. This can be changed later through the MarkingMember operations. | | -**initial_role_assignments** | List[Union[MarkingRoleUpdate, MarkingRoleUpdateDict]] | The initial roles that will be assigned when the Marking is created. At least one ADMIN role must be provided. This can be changed later through the MarkingRoleAssignment operations. WARNING: If you do not include your own principal ID or the ID of a Group that you are a member of, you will create a Marking that you cannot administer. | | +**initial_role_assignments** | List[MarkingRoleUpdate] | The initial roles that will be assigned when the Marking is created. At least one ADMIN role must be provided. This can be changed later through the MarkingRoleAssignment operations. WARNING: If you do not include your own principal ID or the ID of a Group that you are a member of, you will create a Marking that you cannot administer. | | **name** | MarkingName | | | **description** | Optional[str] | | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -38,7 +37,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant category_id = "0950264e-01c8-4e83-81a9-1a6b7f77621a" # List[PrincipalId] | Users and Groups that will be able to view resources protected by this Marking. This can be changed later through the MarkingMember operations. initial_members = ["f05f8da4-b84c-4fca-9c77-8af0b13d11de"] -# List[Union[MarkingRoleUpdate, MarkingRoleUpdateDict]] | The initial roles that will be assigned when the Marking is created. At least one ADMIN role must be provided. This can be changed later through the MarkingRoleAssignment operations. WARNING: If you do not include your own principal ID or the ID of a Group that you are a member of, you will create a Marking that you cannot administer. +# List[MarkingRoleUpdate] | The initial roles that will be assigned when the Marking is created. At least one ADMIN role must be provided. This can be changed later through the MarkingRoleAssignment operations. WARNING: If you do not include your own principal ID or the ID of a Group that you are a member of, you will create a Marking that you cannot administer. initial_role_assignments = [ {"role": "ADMINISTER", "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"} ] @@ -138,7 +137,7 @@ The maximum batch size for this endpoint is 500. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**body** | List[Union[GetMarkingsBatchRequestElement, GetMarkingsBatchRequestElementDict]] | Body of the request | | +**body** | List[GetMarkingsBatchRequestElement] | Body of the request | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -153,7 +152,7 @@ from pprint import pprint client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# List[Union[GetMarkingsBatchRequestElement, GetMarkingsBatchRequestElementDict]] | Body of the request +# List[GetMarkingsBatchRequestElement] | Body of the request body = [{"markingId": "18212f9a-0e63-4b79-96a0-aae04df23336"}] # Optional[PreviewMode] | Enables the use of preview functionality. preview = None @@ -224,61 +223,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListMarkingsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Maximum page size 100. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListMarkingsResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.admin.Marking.page( - page_size=page_size, page_token=page_token, preview=preview - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Marking.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Admin/MarkingCategory.md b/docs/v2/Admin/MarkingCategory.md index 5b0745cd9..737d89dc1 100644 --- a/docs/v2/Admin/MarkingCategory.md +++ b/docs/v2/Admin/MarkingCategory.md @@ -4,7 +4,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**get**](#get) | **GET** /v2/admin/markingCategories/{markingCategoryId} | Public Beta | [**list**](#list) | **GET** /v2/admin/markingCategories | Public Beta | -[**page**](#page) | **GET** /v2/admin/markingCategories | Public Beta | # **get** Get the MarkingCategory with the specified id. @@ -99,61 +98,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListMarkingCategoriesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Maximum page size 100. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListMarkingCategoriesResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.admin.MarkingCategory.page( - page_size=page_size, page_token=page_token, preview=preview - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling MarkingCategory.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Admin/MarkingMember.md b/docs/v2/Admin/MarkingMember.md index 9d5815dca..6044262d8 100644 --- a/docs/v2/Admin/MarkingMember.md +++ b/docs/v2/Admin/MarkingMember.md @@ -4,7 +4,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**add**](#add) | **POST** /v2/admin/markings/{markingId}/markingMembers/add | Public Beta | [**list**](#list) | **GET** /v2/admin/markings/{markingId}/markingMembers | Public Beta | -[**page**](#page) | **GET** /v2/admin/markings/{markingId}/markingMembers | Public Beta | [**remove**](#remove) | **POST** /v2/admin/markings/{markingId}/markingMembers/remove | Public Beta | # **add** @@ -117,73 +116,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListMarkingMembersResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists all principals who can view resources protected by the given Marking. Ignores the `pageSize` parameter. -Requires `api:admin-write` because only marking administrators can view marking members. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**marking_id** | MarkingId | | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | -**transitive** | Optional[bool] | When true, includes the transitive members of groups contained within groups that are members of this Marking. For example, say the Marking has member Group A, and Group A has member User B. If `transitive=false` only Group A will be returned, but if `transitive=true` then Group A and User B will be returned. This will recursively resolve Groups through all layers of nesting. Defaults to false. | [optional] | - -### Return type -**ListMarkingMembersResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# MarkingId -marking_id = None -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None -# Optional[bool] | When true, includes the transitive members of groups contained within groups that are members of this Marking. For example, say the Marking has member Group A, and Group A has member User B. If `transitive=false` only Group A will be returned, but if `transitive=true` then Group A and User B will be returned. This will recursively resolve Groups through all layers of nesting. Defaults to false. -transitive = None - - -try: - api_response = foundry_client.admin.Marking.MarkingMember.page( - marking_id, - page_size=page_size, - page_token=page_token, - preview=preview, - transitive=transitive, - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling MarkingMember.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Admin/MarkingRoleAssignment.md b/docs/v2/Admin/MarkingRoleAssignment.md index 1248f1df9..cb19ba4f5 100644 --- a/docs/v2/Admin/MarkingRoleAssignment.md +++ b/docs/v2/Admin/MarkingRoleAssignment.md @@ -4,7 +4,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**add**](#add) | **POST** /v2/admin/markings/{markingId}/roleAssignments/add | Public Beta | [**list**](#list) | **GET** /v2/admin/markings/{markingId}/roleAssignments | Public Beta | -[**page**](#page) | **GET** /v2/admin/markings/{markingId}/roleAssignments | Public Beta | [**remove**](#remove) | **POST** /v2/admin/markings/{markingId}/roleAssignments/remove | Public Beta | # **add** @@ -15,7 +14,7 @@ Method | HTTP request | Release Stage | Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **marking_id** | MarkingId | | | -**role_assignments** | List[Union[MarkingRoleUpdate, MarkingRoleUpdateDict]] | | | +**role_assignments** | List[MarkingRoleUpdate] | | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -32,7 +31,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant # MarkingId marking_id = None -# List[Union[MarkingRoleUpdate, MarkingRoleUpdateDict]] +# List[MarkingRoleUpdate] role_assignments = [{"role": "ADMINISTER", "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"}] # Optional[PreviewMode] | Enables the use of preview functionality. preview = None @@ -109,65 +108,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListMarkingRoleAssignmentsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -List all principals who are assigned a role for the given Marking. Ignores the `pageSize` parameter. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**marking_id** | MarkingId | | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListMarkingRoleAssignmentsResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# MarkingId -marking_id = None -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.admin.Marking.MarkingRoleAssignment.page( - marking_id, page_size=page_size, page_token=page_token, preview=preview - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling MarkingRoleAssignment.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) @@ -187,7 +127,7 @@ See [README](../../../README.md#authorization) Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **marking_id** | MarkingId | | | -**role_assignments** | List[Union[MarkingRoleUpdate, MarkingRoleUpdateDict]] | | | +**role_assignments** | List[MarkingRoleUpdate] | | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -204,7 +144,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant # MarkingId marking_id = None -# List[Union[MarkingRoleUpdate, MarkingRoleUpdateDict]] +# List[MarkingRoleUpdate] role_assignments = [{"role": "ADMINISTER", "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"}] # Optional[PreviewMode] | Enables the use of preview functionality. preview = None diff --git a/docs/v2/Admin/User.md b/docs/v2/Admin/User.md index 89e7f24a0..c8886ea05 100644 --- a/docs/v2/Admin/User.md +++ b/docs/v2/Admin/User.md @@ -8,7 +8,6 @@ Method | HTTP request | Release Stage | [**get_current**](#get_current) | **GET** /v2/admin/users/getCurrent | Stable | [**get_markings**](#get_markings) | **GET** /v2/admin/users/{userId}/getMarkings | Public Beta | [**list**](#list) | **GET** /v2/admin/users | Stable | -[**page**](#page) | **GET** /v2/admin/users | Stable | [**profile_picture**](#profile_picture) | **GET** /v2/admin/users/{userId}/profilePicture | Stable | [**search**](#search) | **POST** /v2/admin/users/search | Stable | @@ -115,7 +114,7 @@ The maximum batch size for this endpoint is 500. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**body** | List[Union[GetUsersBatchRequestElement, GetUsersBatchRequestElementDict]] | Body of the request | | +**body** | List[GetUsersBatchRequestElement] | Body of the request | | ### Return type **GetUsersBatchResponse** @@ -129,7 +128,7 @@ from pprint import pprint client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# List[Union[GetUsersBatchRequestElement, GetUsersBatchRequestElementDict]] | Body of the request +# List[GetUsersBatchRequestElement] | Body of the request body = [{"userId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"}] @@ -288,58 +287,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListUsersResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists all Users. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | - -### Return type -**ListUsersResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None - - -try: - api_response = foundry_client.admin.User.page(page_size=page_size, page_token=page_token) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling User.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) @@ -406,7 +353,7 @@ Perform a case-insensitive prefix search for users based on username, given name Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**where** | Union[UserSearchFilter, UserSearchFilterDict] | | | +**where** | UserSearchFilter | | | **page_size** | Optional[PageSize] | | [optional] | **page_token** | Optional[PageToken] | | [optional] | @@ -422,7 +369,7 @@ from pprint import pprint client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# Union[UserSearchFilter, UserSearchFilterDict] +# UserSearchFilter where = {"type": "queryString"} # Optional[PageSize] page_size = 100 diff --git a/docs/v2/Admin/models/AuthenticationProviderDict.md b/docs/v2/Admin/models/AuthenticationProviderDict.md deleted file mode 100644 index 573a7a83a..000000000 --- a/docs/v2/Admin/models/AuthenticationProviderDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# AuthenticationProviderDict - -AuthenticationProvider - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AuthenticationProviderRid | Yes | | -**name** | AuthenticationProviderName | Yes | | -**realm** | Realm | Yes | | -**enabled** | AuthenticationProviderEnabled | Yes | Whether users can log in using this provider. | -**supportedHosts** | List[HostName] | Yes | This provider can only be utilized from these hosts. | -**supportedUsernamePatterns** | List[str] | Yes | Users who enter usernames that match these patterns will be redirected to this authentication provider. | -**protocol** | AuthenticationProtocolDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/CertificateInfoDict.md b/docs/v2/Admin/models/CertificateInfoDict.md deleted file mode 100644 index e3f725b5a..000000000 --- a/docs/v2/Admin/models/CertificateInfoDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# CertificateInfoDict - -CertificateInfo - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**pemCertificate** | str | Yes | The certificate, in PEM format. | -**commonName** | NotRequired[str] | No | | -**expiryDate** | datetime | Yes | | -**usageType** | CertificateUsageType | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/EnrollmentDict.md b/docs/v2/Admin/models/EnrollmentDict.md deleted file mode 100644 index 50c1bce8f..000000000 --- a/docs/v2/Admin/models/EnrollmentDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# EnrollmentDict - -Enrollment - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | EnrollmentRid | Yes | | -**name** | EnrollmentName | Yes | | -**createdTime** | NotRequired[CreatedTime] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/GetGroupsBatchRequestElementDict.md b/docs/v2/Admin/models/GetGroupsBatchRequestElementDict.md deleted file mode 100644 index eb053bae2..000000000 --- a/docs/v2/Admin/models/GetGroupsBatchRequestElementDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetGroupsBatchRequestElementDict - -GetGroupsBatchRequestElement - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**groupId** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/GetGroupsBatchResponseDict.md b/docs/v2/Admin/models/GetGroupsBatchResponseDict.md deleted file mode 100644 index 2af104b18..000000000 --- a/docs/v2/Admin/models/GetGroupsBatchResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetGroupsBatchResponseDict - -GetGroupsBatchResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | Dict[PrincipalId, GroupDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/GetMarkingsBatchRequestElementDict.md b/docs/v2/Admin/models/GetMarkingsBatchRequestElementDict.md deleted file mode 100644 index 3591d4628..000000000 --- a/docs/v2/Admin/models/GetMarkingsBatchRequestElementDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetMarkingsBatchRequestElementDict - -GetMarkingsBatchRequestElement - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**markingId** | MarkingId | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/GetMarkingsBatchResponseDict.md b/docs/v2/Admin/models/GetMarkingsBatchResponseDict.md deleted file mode 100644 index 92bb8b7a0..000000000 --- a/docs/v2/Admin/models/GetMarkingsBatchResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetMarkingsBatchResponseDict - -GetMarkingsBatchResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | Dict[MarkingId, MarkingDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/GetUserMarkingsResponseDict.md b/docs/v2/Admin/models/GetUserMarkingsResponseDict.md deleted file mode 100644 index fb5863e62..000000000 --- a/docs/v2/Admin/models/GetUserMarkingsResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetUserMarkingsResponseDict - -GetUserMarkingsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**view** | List[MarkingId] | Yes | The markings that the user has access to. The user will be able to access resources protected with these markings. This includes organization markings for organizations in which the user is a guest member. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/GetUsersBatchRequestElementDict.md b/docs/v2/Admin/models/GetUsersBatchRequestElementDict.md deleted file mode 100644 index b8b3f6f5b..000000000 --- a/docs/v2/Admin/models/GetUsersBatchRequestElementDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetUsersBatchRequestElementDict - -GetUsersBatchRequestElement - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**userId** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/GetUsersBatchResponseDict.md b/docs/v2/Admin/models/GetUsersBatchResponseDict.md deleted file mode 100644 index a19e7c8e6..000000000 --- a/docs/v2/Admin/models/GetUsersBatchResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetUsersBatchResponseDict - -GetUsersBatchResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | Dict[PrincipalId, UserDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/GroupDict.md b/docs/v2/Admin/models/GroupDict.md deleted file mode 100644 index 568382b66..000000000 --- a/docs/v2/Admin/models/GroupDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# GroupDict - -Group - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | PrincipalId | Yes | | -**name** | GroupName | Yes | The name of the Group. | -**description** | NotRequired[str] | No | A description of the Group. | -**realm** | Realm | Yes | | -**organizations** | List[OrganizationRid] | Yes | The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed. | -**attributes** | Dict[AttributeName, AttributeValues] | Yes | A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/GroupMemberDict.md b/docs/v2/Admin/models/GroupMemberDict.md deleted file mode 100644 index 119aee7c1..000000000 --- a/docs/v2/Admin/models/GroupMemberDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# GroupMemberDict - -GroupMember - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**principalType** | PrincipalType | Yes | | -**principalId** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/GroupMembershipDict.md b/docs/v2/Admin/models/GroupMembershipDict.md deleted file mode 100644 index 2145f4604..000000000 --- a/docs/v2/Admin/models/GroupMembershipDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GroupMembershipDict - -GroupMembership - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**groupId** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/GroupProviderInfoDict.md b/docs/v2/Admin/models/GroupProviderInfoDict.md deleted file mode 100644 index b19f784cd..000000000 --- a/docs/v2/Admin/models/GroupProviderInfoDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GroupProviderInfoDict - -GroupProviderInfo - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**providerId** | ProviderId | Yes | 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. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/GroupSearchFilterDict.md b/docs/v2/Admin/models/GroupSearchFilterDict.md deleted file mode 100644 index eb5977df2..000000000 --- a/docs/v2/Admin/models/GroupSearchFilterDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# GroupSearchFilterDict - -GroupSearchFilter - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | PrincipalFilterType | Yes | | -**value** | str | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/HostDict.md b/docs/v2/Admin/models/HostDict.md deleted file mode 100644 index 172bc2248..000000000 --- a/docs/v2/Admin/models/HostDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# HostDict - -Host - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**hostName** | HostName | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/ListAuthenticationProvidersResponseDict.md b/docs/v2/Admin/models/ListAuthenticationProvidersResponseDict.md deleted file mode 100644 index 89eede0b2..000000000 --- a/docs/v2/Admin/models/ListAuthenticationProvidersResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListAuthenticationProvidersResponseDict - -ListAuthenticationProvidersResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[AuthenticationProviderDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/ListGroupMembersResponseDict.md b/docs/v2/Admin/models/ListGroupMembersResponseDict.md deleted file mode 100644 index 33da3ee00..000000000 --- a/docs/v2/Admin/models/ListGroupMembersResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListGroupMembersResponseDict - -ListGroupMembersResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[GroupMemberDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/ListGroupMembershipsResponseDict.md b/docs/v2/Admin/models/ListGroupMembershipsResponseDict.md deleted file mode 100644 index 49b9d9407..000000000 --- a/docs/v2/Admin/models/ListGroupMembershipsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListGroupMembershipsResponseDict - -ListGroupMembershipsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[GroupMembershipDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/ListGroupsResponseDict.md b/docs/v2/Admin/models/ListGroupsResponseDict.md deleted file mode 100644 index 197287e5f..000000000 --- a/docs/v2/Admin/models/ListGroupsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListGroupsResponseDict - -ListGroupsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[GroupDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/ListHostsResponseDict.md b/docs/v2/Admin/models/ListHostsResponseDict.md deleted file mode 100644 index 897744043..000000000 --- a/docs/v2/Admin/models/ListHostsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListHostsResponseDict - -ListHostsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[HostDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/ListMarkingCategoriesResponseDict.md b/docs/v2/Admin/models/ListMarkingCategoriesResponseDict.md deleted file mode 100644 index d0c7e3838..000000000 --- a/docs/v2/Admin/models/ListMarkingCategoriesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListMarkingCategoriesResponseDict - -ListMarkingCategoriesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[MarkingCategoryDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/ListMarkingMembersResponseDict.md b/docs/v2/Admin/models/ListMarkingMembersResponseDict.md deleted file mode 100644 index 41824ad11..000000000 --- a/docs/v2/Admin/models/ListMarkingMembersResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListMarkingMembersResponseDict - -ListMarkingMembersResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[MarkingMemberDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/ListMarkingRoleAssignmentsResponseDict.md b/docs/v2/Admin/models/ListMarkingRoleAssignmentsResponseDict.md deleted file mode 100644 index 55c8aaeab..000000000 --- a/docs/v2/Admin/models/ListMarkingRoleAssignmentsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListMarkingRoleAssignmentsResponseDict - -ListMarkingRoleAssignmentsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[MarkingRoleAssignmentDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/ListMarkingsResponseDict.md b/docs/v2/Admin/models/ListMarkingsResponseDict.md deleted file mode 100644 index 2052b320c..000000000 --- a/docs/v2/Admin/models/ListMarkingsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListMarkingsResponseDict - -ListMarkingsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[MarkingDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/ListUsersResponseDict.md b/docs/v2/Admin/models/ListUsersResponseDict.md deleted file mode 100644 index 44bdaf647..000000000 --- a/docs/v2/Admin/models/ListUsersResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListUsersResponseDict - -ListUsersResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[UserDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/MarkingCategoryDict.md b/docs/v2/Admin/models/MarkingCategoryDict.md deleted file mode 100644 index 1bd97d0d3..000000000 --- a/docs/v2/Admin/models/MarkingCategoryDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# MarkingCategoryDict - -MarkingCategory - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | MarkingCategoryId | Yes | | -**name** | MarkingCategoryName | Yes | | -**description** | NotRequired[str] | No | | -**categoryType** | MarkingCategoryType | Yes | | -**markingType** | MarkingType | Yes | | -**markings** | List[MarkingId] | Yes | | -**createdTime** | CreatedTime | Yes | | -**createdBy** | NotRequired[CreatedBy] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/MarkingDict.md b/docs/v2/Admin/models/MarkingDict.md deleted file mode 100644 index 0ed006512..000000000 --- a/docs/v2/Admin/models/MarkingDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# MarkingDict - -Marking - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | MarkingId | Yes | | -**categoryId** | MarkingCategoryId | Yes | | -**name** | MarkingName | Yes | | -**description** | NotRequired[str] | No | | -**organization** | NotRequired[OrganizationRid] | No | If this marking is associated with an Organization, its RID will be populated here. | -**createdTime** | CreatedTime | Yes | | -**createdBy** | NotRequired[CreatedBy] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/MarkingMemberDict.md b/docs/v2/Admin/models/MarkingMemberDict.md deleted file mode 100644 index ad8cc89dd..000000000 --- a/docs/v2/Admin/models/MarkingMemberDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# MarkingMemberDict - -MarkingMember - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**principalType** | PrincipalType | Yes | | -**principalId** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/MarkingRoleAssignmentDict.md b/docs/v2/Admin/models/MarkingRoleAssignmentDict.md deleted file mode 100644 index d4bf7a0a3..000000000 --- a/docs/v2/Admin/models/MarkingRoleAssignmentDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MarkingRoleAssignmentDict - -MarkingRoleAssignment - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**principalType** | PrincipalType | Yes | | -**principalId** | PrincipalId | Yes | | -**role** | MarkingRole | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/MarkingRoleUpdateDict.md b/docs/v2/Admin/models/MarkingRoleUpdateDict.md deleted file mode 100644 index 8163acd72..000000000 --- a/docs/v2/Admin/models/MarkingRoleUpdateDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# MarkingRoleUpdateDict - -MarkingRoleUpdate - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**role** | MarkingRole | Yes | | -**principalId** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/OidcAuthenticationProtocolDict.md b/docs/v2/Admin/models/OidcAuthenticationProtocolDict.md deleted file mode 100644 index 11632ba71..000000000 --- a/docs/v2/Admin/models/OidcAuthenticationProtocolDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# OidcAuthenticationProtocolDict - -OidcAuthenticationProtocol - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["oidc"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/OrganizationDict.md b/docs/v2/Admin/models/OrganizationDict.md deleted file mode 100644 index 5ae5540bb..000000000 --- a/docs/v2/Admin/models/OrganizationDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# OrganizationDict - -Organization - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | OrganizationRid | Yes | | -**name** | OrganizationName | Yes | | -**description** | NotRequired[str] | No | | -**markingId** | MarkingId | Yes | The ID of this Organization's underlying marking. Organization guest access can be managed by updating the membership of this Marking. | -**host** | NotRequired[HostName] | No | The primary host name of the Organization. This should be used when constructing URLs for users of this Organization. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/SamlAuthenticationProtocolDict.md b/docs/v2/Admin/models/SamlAuthenticationProtocolDict.md deleted file mode 100644 index 2ce2542cb..000000000 --- a/docs/v2/Admin/models/SamlAuthenticationProtocolDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SamlAuthenticationProtocolDict - -SamlAuthenticationProtocol - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**serviceProviderMetadata** | SamlServiceProviderMetadataDict | Yes | | -**type** | Literal["saml"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/SamlServiceProviderMetadataDict.md b/docs/v2/Admin/models/SamlServiceProviderMetadataDict.md deleted file mode 100644 index 70160e380..000000000 --- a/docs/v2/Admin/models/SamlServiceProviderMetadataDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# SamlServiceProviderMetadataDict - -Information that describes a Foundry Authentication Provider as a SAML service provider. All information listed here is generated by Foundry. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**entityId** | str | Yes | The static SAML entity ID that represents this service provider. | -**metadataUrl** | str | Yes | A public URL from which this service provider metadata can be downloaded as XML. | -**acsUrls** | List[str] | Yes | The Assertion Consumer Service (ACS) URLs for this service provider, to which the SAML identity provider redirects authentication responses. | -**logoutUrls** | List[str] | Yes | The URLs for this service provider to which the SAML identity provider sends logout requests. | -**certificates** | List[CertificateInfoDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/SearchGroupsResponseDict.md b/docs/v2/Admin/models/SearchGroupsResponseDict.md deleted file mode 100644 index 8164d3dd8..000000000 --- a/docs/v2/Admin/models/SearchGroupsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchGroupsResponseDict - -SearchGroupsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[GroupDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/SearchUsersResponseDict.md b/docs/v2/Admin/models/SearchUsersResponseDict.md deleted file mode 100644 index dc46fd287..000000000 --- a/docs/v2/Admin/models/SearchUsersResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchUsersResponseDict - -SearchUsersResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[UserDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/UserDict.md b/docs/v2/Admin/models/UserDict.md deleted file mode 100644 index a0e09bb79..000000000 --- a/docs/v2/Admin/models/UserDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# UserDict - -User - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | PrincipalId | Yes | | -**username** | UserUsername | Yes | The Foundry username of the User. This is unique within the realm. | -**givenName** | NotRequired[str] | No | The given name of the User. | -**familyName** | NotRequired[str] | No | The family name (last name) of the User. | -**email** | NotRequired[str] | No | The email at which to contact a User. Multiple users may have the same email address. | -**realm** | Realm | Yes | | -**organization** | NotRequired[OrganizationRid] | No | The RID of the user's primary Organization. This will be blank for third-party application service users. | -**attributes** | Dict[AttributeName, AttributeValues] | Yes | A map of the User's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. Additional attributes may be configured by Foundry administrators in Control Panel and populated by the User's SSO provider upon login. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/UserProviderInfoDict.md b/docs/v2/Admin/models/UserProviderInfoDict.md deleted file mode 100644 index 082b55d59..000000000 --- a/docs/v2/Admin/models/UserProviderInfoDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# UserProviderInfoDict - -UserProviderInfo - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**providerId** | ProviderId | Yes | The ID of the User in the external authentication provider. This value is determined by the authentication provider. At most one User can have a given provider ID in a given Realm. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/models/UserSearchFilterDict.md b/docs/v2/Admin/models/UserSearchFilterDict.md deleted file mode 100644 index d23e3d5a9..000000000 --- a/docs/v2/Admin/models/UserSearchFilterDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# UserSearchFilterDict - -UserSearchFilter - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | PrincipalFilterType | Yes | | -**value** | str | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/Agent.md b/docs/v2/AipAgents/Agent.md index 2e1caeb49..181fcc61f 100644 --- a/docs/v2/AipAgents/Agent.md +++ b/docs/v2/AipAgents/Agent.md @@ -3,7 +3,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**all_sessions**](#all_sessions) | **GET** /v2/aipAgents/agents/allSessions | Public Beta | -[**all_sessions_page**](#all_sessions_page) | **GET** /v2/aipAgents/agents/allSessions | Public Beta | [**get**](#get) | **GET** /v2/aipAgents/agents/{agentRid} | Public Beta | # **all_sessions** @@ -51,63 +50,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | AgentsSessionsPage | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **all_sessions_page** -List all conversation sessions between the calling user and all accessible Agents that were created by this client. -Sessions are returned in order of most recently updated first. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**page_size** | Optional[PageSize] | The maximum number of sessions to return in a single page. The maximum allowed value is 100. Defaults to 100 if not specified. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**AgentsSessionsPage** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# Optional[PageSize] | The maximum number of sessions to return in a single page. The maximum allowed value is 100. Defaults to 100 if not specified. -page_size = None -# Optional[PageToken] -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.aip_agents.Agent.all_sessions_page( - page_size=page_size, page_token=page_token, preview=preview - ) - print("The all_sessions_page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Agent.all_sessions_page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/AipAgents/AgentVersion.md b/docs/v2/AipAgents/AgentVersion.md index de8b2b865..abb711715 100644 --- a/docs/v2/AipAgents/AgentVersion.md +++ b/docs/v2/AipAgents/AgentVersion.md @@ -4,7 +4,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**get**](#get) | **GET** /v2/aipAgents/agents/{agentRid}/agentVersions/{agentVersionString} | Public Beta | [**list**](#list) | **GET** /v2/aipAgents/agents/{agentRid}/agentVersions | Public Beta | -[**page**](#page) | **GET** /v2/aipAgents/agents/{agentRid}/agentVersions | Public Beta | # **get** Get version details for an AIP Agent. @@ -109,66 +108,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListAgentVersionsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -List all versions for an AIP Agent. -Versions are returned in descending order, by most recent versions first. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListAgentVersionsResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). -agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.aip_agents.Agent.AgentVersion.page( - agent_rid, page_size=page_size, page_token=page_token, preview=preview - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling AgentVersion.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/AipAgents/Session.md b/docs/v2/AipAgents/Session.md index c363bc61b..253765226 100644 --- a/docs/v2/AipAgents/Session.md +++ b/docs/v2/AipAgents/Session.md @@ -7,7 +7,6 @@ Method | HTTP request | Release Stage | [**create**](#create) | **POST** /v2/aipAgents/agents/{agentRid}/sessions | Public Beta | [**get**](#get) | **GET** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid} | Public Beta | [**list**](#list) | **GET** /v2/aipAgents/agents/{agentRid}/sessions | Public Beta | -[**page**](#page) | **GET** /v2/aipAgents/agents/{agentRid}/sessions | Public Beta | [**rag_context**](#rag_context) | **PUT** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/ragContext | Public Beta | [**streaming_continue**](#streaming_continue) | **POST** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/streamingContinue | Public Beta | [**update_title**](#update_title) | **PUT** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/updateTitle | Public Beta | @@ -27,9 +26,9 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | **session_rid** | SessionRid | The Resource Identifier (RID) of the conversation session. | | -**parameter_inputs** | Dict[ParameterId, Union[ParameterValue, ParameterValueDict]] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. | | -**user_input** | Union[UserTextInput, UserTextInputDict] | The user message for the Agent to respond to. | | -**contexts_override** | Optional[List[Union[InputContext, InputContextDict]]] | If set, automatic [context retrieval](/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. | [optional] | +**parameter_inputs** | Dict[ParameterId, ParameterValue] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. | | +**user_input** | UserTextInput | The user message for the Agent to respond to. | | +**contexts_override** | Optional[List[InputContext]] | If set, automatic [context retrieval](/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -48,7 +47,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # SessionRid | The Resource Identifier (RID) of the conversation session. session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6" -# Dict[ParameterId, Union[ParameterValue, ParameterValueDict]] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. +# Dict[ParameterId, ParameterValue] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. parameter_inputs = { "currentCustomerOrders": { "type": "objectSet", @@ -60,9 +59,9 @@ parameter_inputs = { }, } } -# Union[UserTextInput, UserTextInputDict] | The user message for the Agent to respond to. +# UserTextInput | The user message for the Agent to respond to. user_input = {"text": "What is the status of my order?"} -# Optional[List[Union[InputContext, InputContextDict]]] | If set, automatic [context retrieval](/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. +# Optional[List[InputContext]] | If set, automatic [context retrieval](/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. contexts_override = None # Optional[PreviewMode] | Enables the use of preview functionality. preview = None @@ -323,68 +322,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListSessionsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -List all conversation sessions between the calling user and an Agent that was created by this client. -This does not list sessions for the user created by other clients. -For example, any sessions created by the user in AIP Agent Studio will not be listed here. -Sessions are returned in order of most recently updated first. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListSessionsResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). -agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.aip_agents.Agent.Session.page( - agent_rid, page_size=page_size, page_token=page_token, preview=preview - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Session.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) @@ -407,8 +344,8 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | **session_rid** | SessionRid | The Resource Identifier (RID) of the conversation session. | | -**parameter_inputs** | Dict[ParameterId, Union[ParameterValue, ParameterValueDict]] | Any values for [application variables](/docs/foundry/agent-studio/application-state/) to use for the context retrieval. | | -**user_input** | Union[UserTextInput, UserTextInputDict] | The user message to retrieve relevant context for from the configured Agent data sources. | | +**parameter_inputs** | Dict[ParameterId, ParameterValue] | Any values for [application variables](/docs/foundry/agent-studio/application-state/) to use for the context retrieval. | | +**user_input** | UserTextInput | The user message to retrieve relevant context for from the configured Agent data sources. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -427,9 +364,9 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # SessionRid | The Resource Identifier (RID) of the conversation session. session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6" -# Dict[ParameterId, Union[ParameterValue, ParameterValueDict]] | Any values for [application variables](/docs/foundry/agent-studio/application-state/) to use for the context retrieval. +# Dict[ParameterId, ParameterValue] | Any values for [application variables](/docs/foundry/agent-studio/application-state/) to use for the context retrieval. parameter_inputs = {"customerName": {"type": "string", "value": "Titan Technologies"}} -# Union[UserTextInput, UserTextInputDict] | The user message to retrieve relevant context for from the configured Agent data sources. +# UserTextInput | The user message to retrieve relevant context for from the configured Agent data sources. user_input = {"text": "What is the status of my order?"} # Optional[PreviewMode] | Enables the use of preview functionality. preview = None @@ -479,9 +416,9 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | **session_rid** | SessionRid | The Resource Identifier (RID) of the conversation session. | | -**parameter_inputs** | Dict[ParameterId, Union[ParameterValue, ParameterValueDict]] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. | | -**user_input** | Union[UserTextInput, UserTextInputDict] | The user message for the Agent to respond to. | | -**contexts_override** | Optional[List[Union[InputContext, InputContextDict]]] | If set, automatic [context](/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. | [optional] | +**parameter_inputs** | Dict[ParameterId, ParameterValue] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. | | +**user_input** | UserTextInput | The user message for the Agent to respond to. | | +**contexts_override** | Optional[List[InputContext]] | If set, automatic [context](/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. | [optional] | **message_id** | Optional[MessageId] | A client-generated Universally Unique Identifier (UUID) to identify the message, which the client can use to cancel the exchange before the streaming response is complete. | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -501,7 +438,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # SessionRid | The Resource Identifier (RID) of the conversation session. session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6" -# Dict[ParameterId, Union[ParameterValue, ParameterValueDict]] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. +# Dict[ParameterId, ParameterValue] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. parameter_inputs = { "currentCustomerOrders": { "type": "objectSet", @@ -513,9 +450,9 @@ parameter_inputs = { }, } } -# Union[UserTextInput, UserTextInputDict] | The user message for the Agent to respond to. +# UserTextInput | The user message for the Agent to respond to. user_input = {"text": "What is the status of my order?"} -# Optional[List[Union[InputContext, InputContextDict]]] | If set, automatic [context](/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. +# Optional[List[InputContext]] | If set, automatic [context](/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. contexts_override = None # Optional[MessageId] | A client-generated Universally Unique Identifier (UUID) to identify the message, which the client can use to cancel the exchange before the streaming response is complete. message_id = "00f8412a-c29d-4063-a417-8052825285a5" diff --git a/docs/v2/AipAgents/models/AgentDict.md b/docs/v2/AipAgents/models/AgentDict.md deleted file mode 100644 index ca0a7a6c7..000000000 --- a/docs/v2/AipAgents/models/AgentDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AgentDict - -Agent - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AgentRid | Yes | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | -**version** | AgentVersionString | Yes | The version of this instance of the Agent. | -**metadata** | AgentMetadataDict | Yes | | -**parameters** | Dict[ParameterId, ParameterDict] | Yes | The types and names of variables configured for the Agent in [AIP Agent Studio](/docs/foundry/agent-studio/overview/) in the [application state](/docs/foundry/agent-studio/application-state/). These variables can be used to send custom values in prompts sent to an Agent to customize and control the Agent's behavior. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/AgentMetadataDict.md b/docs/v2/AipAgents/models/AgentMetadataDict.md deleted file mode 100644 index f2eb3efa2..000000000 --- a/docs/v2/AipAgents/models/AgentMetadataDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AgentMetadataDict - -Metadata for an Agent. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**displayName** | str | Yes | The name of the Agent. | -**description** | NotRequired[str] | No | The description for the Agent. | -**inputPlaceholder** | NotRequired[str] | No | The default text to show as the placeholder input for chats with the Agent. | -**suggestedPrompts** | List[str] | Yes | Prompts to show to the user as example messages to start a conversation with the Agent. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/AgentSessionRagContextResponseDict.md b/docs/v2/AipAgents/models/AgentSessionRagContextResponseDict.md deleted file mode 100644 index 774205981..000000000 --- a/docs/v2/AipAgents/models/AgentSessionRagContextResponseDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AgentSessionRagContextResponseDict - -Context retrieved from an Agent's configured context data sources which was relevant to the supplied user message. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectContexts** | List[ObjectContextDict] | Yes | | -**functionRetrievedContexts** | List[FunctionRetrievedContextDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/AgentVersionDetailsDict.md b/docs/v2/AipAgents/models/AgentVersionDetailsDict.md deleted file mode 100644 index 2f93ad1cd..000000000 --- a/docs/v2/AipAgents/models/AgentVersionDetailsDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AgentVersionDetailsDict - -Semantic version details for an Agent. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**major** | int | Yes | The major version of the Agent. Incremented every time the Agent is published. | -**minor** | int | Yes | The minor version of the Agent. Incremented every time the Agent is saved. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/AgentVersionDict.md b/docs/v2/AipAgents/models/AgentVersionDict.md deleted file mode 100644 index 1e7cbca3f..000000000 --- a/docs/v2/AipAgents/models/AgentVersionDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AgentVersionDict - -AgentVersion - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**string** | AgentVersionString | Yes | The semantic version of the Agent, formatted as "majorVersion.minorVersion". | -**version** | AgentVersionDetailsDict | Yes | Semantic version details of the Agent. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/AgentsSessionsPageDict.md b/docs/v2/AipAgents/models/AgentsSessionsPageDict.md deleted file mode 100644 index cfb645d07..000000000 --- a/docs/v2/AipAgents/models/AgentsSessionsPageDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AgentsSessionsPageDict - -A page of results for sessions across all accessible Agents for the calling user. -Sessions are returned in order of most recently updated first. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | The page token that should be used when requesting the next page of results. Empty if there are no more results to retrieve. | -**data** | List[SessionDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/CancelSessionResponseDict.md b/docs/v2/AipAgents/models/CancelSessionResponseDict.md deleted file mode 100644 index 00e7ddd25..000000000 --- a/docs/v2/AipAgents/models/CancelSessionResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CancelSessionResponseDict - -CancelSessionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | NotRequired[SessionExchangeResultDict] | No | If the `response` field was specified, this returns the result that was added to the session for the canceled exchange, with the client-provided response. If no `response` was specified in the request, this returns an empty response, as no exchange was added to the session. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/ContentDict.md b/docs/v2/AipAgents/models/ContentDict.md deleted file mode 100644 index 15c4b6502..000000000 --- a/docs/v2/AipAgents/models/ContentDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ContentDict - -Content - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**exchanges** | List[SessionExchangeDict] | Yes | The conversation history for the session, represented as a list of exchanges. Each exchange represents an initiating message from the user and the Agent's response. Exchanges are returned in chronological order, starting with the first exchange. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/FunctionRetrievedContextDict.md b/docs/v2/AipAgents/models/FunctionRetrievedContextDict.md deleted file mode 100644 index 811302f18..000000000 --- a/docs/v2/AipAgents/models/FunctionRetrievedContextDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# FunctionRetrievedContextDict - -Context retrieved from running a function to include as additional context in the prompt to the Agent. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**functionRid** | FunctionRid | Yes | | -**functionVersion** | FunctionVersion | Yes | | -**retrievedPrompt** | str | Yes | String content returned from a context retrieval function. | -**type** | Literal["functionRetrievedContext"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/InputContextDict.md b/docs/v2/AipAgents/models/InputContextDict.md deleted file mode 100644 index 5b670cc13..000000000 --- a/docs/v2/AipAgents/models/InputContextDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# InputContextDict - -Custom retrieved [context](/docs/foundry/agent-studio/retrieval-context/) to provide to an Agent for continuing a session. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -FunctionRetrievedContextDict | functionRetrievedContext -ObjectContextDict | objectContext - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/ListAgentVersionsResponseDict.md b/docs/v2/AipAgents/models/ListAgentVersionsResponseDict.md deleted file mode 100644 index f0db110cb..000000000 --- a/docs/v2/AipAgents/models/ListAgentVersionsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListAgentVersionsResponseDict - -ListAgentVersionsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[AgentVersionDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/ListSessionsResponseDict.md b/docs/v2/AipAgents/models/ListSessionsResponseDict.md deleted file mode 100644 index fc23a1d47..000000000 --- a/docs/v2/AipAgents/models/ListSessionsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListSessionsResponseDict - -ListSessionsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[SessionDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/ObjectContextDict.md b/docs/v2/AipAgents/models/ObjectContextDict.md deleted file mode 100644 index 457e93dea..000000000 --- a/docs/v2/AipAgents/models/ObjectContextDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ObjectContextDict - -Details of relevant retrieved object instances for a user's message to include as additional context in the prompt to the Agent. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectRids** | List[ObjectRid] | Yes | The RIDs of the relevant object instances to include in the prompt. | -**propertyTypeRids** | List[PropertyTypeRid] | Yes | The RIDs of the property types for the given objects to include in the prompt. | -**type** | Literal["objectContext"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/ObjectSetParameterDict.md b/docs/v2/AipAgents/models/ObjectSetParameterDict.md deleted file mode 100644 index 9fc140a6d..000000000 --- a/docs/v2/AipAgents/models/ObjectSetParameterDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetParameterDict - -ObjectSetParameter - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**expectedObjectTypes** | List[ObjectTypeId] | Yes | The types of objects that are expected in ObjectSet values passed for this variable. | -**type** | Literal["objectSet"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/ObjectSetParameterValueDict.md b/docs/v2/AipAgents/models/ObjectSetParameterValueDict.md deleted file mode 100644 index a86044f93..000000000 --- a/docs/v2/AipAgents/models/ObjectSetParameterValueDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetParameterValueDict - -A value passed for `ObjectSetParameter` application variable types. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**ontology** | OntologyIdentifier | Yes | The API name of the Ontology for the provided `ObjectSet`. To find the API name, use the `List ontologies` endpoint or check the [Ontology Manager](/docs/foundry/ontology-manager/overview/). | -**type** | Literal["objectSet"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/ObjectSetParameterValueUpdateDict.md b/docs/v2/AipAgents/models/ObjectSetParameterValueUpdateDict.md deleted file mode 100644 index aa2bc372d..000000000 --- a/docs/v2/AipAgents/models/ObjectSetParameterValueUpdateDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetParameterValueUpdateDict - -ObjectSetParameterValueUpdate - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | ObjectSetRid | Yes | | -**type** | Literal["objectSet"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/ParameterDict.md b/docs/v2/AipAgents/models/ParameterDict.md deleted file mode 100644 index 50fa71567..000000000 --- a/docs/v2/AipAgents/models/ParameterDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ParameterDict - -A variable configured in the application state of an Agent in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameterType** | ParameterTypeDict | Yes | Details of the types of values accepted and defaults for this variable. | -**access** | ParameterAccessMode | Yes | The access mode controls how the Agent is able to interact with the variable. | -**description** | NotRequired[str] | No | A description to explain the use of this variable. This description is injected into the Agent's prompt to provide context for when to use the variable. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/ParameterTypeDict.md b/docs/v2/AipAgents/models/ParameterTypeDict.md deleted file mode 100644 index 56f95720c..000000000 --- a/docs/v2/AipAgents/models/ParameterTypeDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ParameterTypeDict - -ParameterType - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -StringParameterDict | string -ObjectSetParameterDict | objectSet - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/ParameterValueDict.md b/docs/v2/AipAgents/models/ParameterValueDict.md deleted file mode 100644 index d881a10ad..000000000 --- a/docs/v2/AipAgents/models/ParameterValueDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ParameterValueDict - -The value provided for a variable configured in the [application state](/docs/foundry/agent-studio/application-state/) of an Agent. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -StringParameterValueDict | string -ObjectSetParameterValueDict | objectSet - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/ParameterValueUpdateDict.md b/docs/v2/AipAgents/models/ParameterValueUpdateDict.md deleted file mode 100644 index 63ed159cc..000000000 --- a/docs/v2/AipAgents/models/ParameterValueUpdateDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# ParameterValueUpdateDict - -A value update for an [application variable](/docs/foundry/agent-studio/application-state/) generated by the Agent. -For `StringParameter` types, this will be the updated string value. -For `ObjectSetParameter` types, this will be a Resource Identifier (RID) for the updated object set. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -StringParameterValueDict | string -ObjectSetParameterValueUpdateDict | objectSet - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/SessionDict.md b/docs/v2/AipAgents/models/SessionDict.md deleted file mode 100644 index e39a6116b..000000000 --- a/docs/v2/AipAgents/models/SessionDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# SessionDict - -Session - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | SessionRid | Yes | The Resource Identifier (RID) of the conversation session. | -**metadata** | SessionMetadataDict | Yes | Metadata about the session. | -**agentRid** | AgentRid | Yes | The Resource Identifier (RID) of the Agent associated with the session. | -**agentVersion** | AgentVersionString | Yes | The version of the Agent associated with the session. This can be set by clients on session creation. If not specified, defaults to use the latest published version of the Agent at session creation time. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/SessionExchangeContextsDict.md b/docs/v2/AipAgents/models/SessionExchangeContextsDict.md deleted file mode 100644 index f17336600..000000000 --- a/docs/v2/AipAgents/models/SessionExchangeContextsDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SessionExchangeContextsDict - -Retrieved context which was passed to the Agent as input for the exchange. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectContexts** | List[ObjectContextDict] | Yes | Relevant object context for the user's message that was included in the prompt to the Agent. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/SessionExchangeDict.md b/docs/v2/AipAgents/models/SessionExchangeDict.md deleted file mode 100644 index 7a1ff9642..000000000 --- a/docs/v2/AipAgents/models/SessionExchangeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SessionExchangeDict - -Represents an individual exchange between a user and an Agent in a conversation session. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**userInput** | UserTextInputDict | Yes | The user message that initiated the exchange. | -**contexts** | NotRequired[SessionExchangeContextsDict] | No | Additional retrieved context that was included in the prompt to the Agent. This may include context that was passed by the client with the user input, or relevant context that was automatically retrieved and added based on available data sources configured on the Agent. Empty if no additional context was included in the prompt. | -**result** | SessionExchangeResultDict | Yes | The final result for the exchange. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/SessionExchangeResultDict.md b/docs/v2/AipAgents/models/SessionExchangeResultDict.md deleted file mode 100644 index 8326ad102..000000000 --- a/docs/v2/AipAgents/models/SessionExchangeResultDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# SessionExchangeResultDict - -The returned result from the Agent for a session exchange. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**agentMarkdownResponse** | AgentMarkdownResponse | Yes | The final text response generated by the Agent. Responses are formatted using markdown. | -**parameterUpdates** | Dict[ParameterId, ParameterValueUpdateDict] | Yes | Any updates to application variable values which were generated by the Agent for this exchange. Updates can only be generated for application variables configured with `READ_WRITE` access on the Agent in AIP Agent Studio. | -**totalTokensUsed** | NotRequired[int] | No | Total tokens used to compute the result. Omitted if token usage information is not supported by the model used for the session. | -**interruptedOutput** | bool | Yes | True if the exchange was canceled. In that case, the response (if any) was provided by the client as part of the cancellation request rather than by the Agent. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/SessionMetadataDict.md b/docs/v2/AipAgents/models/SessionMetadataDict.md deleted file mode 100644 index 3175818ad..000000000 --- a/docs/v2/AipAgents/models/SessionMetadataDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# SessionMetadataDict - -Metadata for a conversation session with an Agent. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**title** | str | Yes | The title of the session. | -**createdTime** | datetime | Yes | The time the session was created. | -**updatedTime** | datetime | Yes | The time the session was last updated. | -**messageCount** | int | Yes | The count of messages in the session. Includes both user messages and Agent replies, so each complete exchange counts as two messages. | -**estimatedExpiresTime** | datetime | Yes | The estimated time at which the session is due to expire. Once a session has expired, it can no longer be accessed and a new session must be created. The expiry time is automatically extended when new exchanges are added to the session. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/StringParameterDict.md b/docs/v2/AipAgents/models/StringParameterDict.md deleted file mode 100644 index 4e8e956d9..000000000 --- a/docs/v2/AipAgents/models/StringParameterDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# StringParameterDict - -StringParameter - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**defaultValue** | NotRequired[str] | No | The default value to use for this variable. | -**type** | Literal["string"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/StringParameterValueDict.md b/docs/v2/AipAgents/models/StringParameterValueDict.md deleted file mode 100644 index 391da0016..000000000 --- a/docs/v2/AipAgents/models/StringParameterValueDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# StringParameterValueDict - -A value passed for `StringParameter` application variable types. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | str | Yes | | -**type** | Literal["string"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/UserTextInputDict.md b/docs/v2/AipAgents/models/UserTextInputDict.md deleted file mode 100644 index c4f1f0ff1..000000000 --- a/docs/v2/AipAgents/models/UserTextInputDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# UserTextInputDict - -UserTextInput - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**text** | str | Yes | The user message text. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/Connection.md b/docs/v2/Connectivity/Connection.md index e09f3b683..a960b2919 100644 --- a/docs/v2/Connectivity/Connection.md +++ b/docs/v2/Connectivity/Connection.md @@ -23,7 +23,7 @@ use the Foundry UI instead. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**configuration** | Union[CreateConnectionRequestConnectionConfiguration, CreateConnectionRequestConnectionConfigurationDict] | | | +**configuration** | CreateConnectionRequestConnectionConfiguration | | | **display_name** | ConnectionDisplayName | The display name of the Connection. The display name must not be blank. | | **parent_folder_rid** | FolderRid | | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -40,7 +40,7 @@ from pprint import pprint client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# Union[CreateConnectionRequestConnectionConfiguration, CreateConnectionRequestConnectionConfigurationDict] +# CreateConnectionRequestConnectionConfiguration configuration = None # ConnectionDisplayName | The display name of the Connection. The display name must not be blank. display_name = "Connection to my external system" diff --git a/docs/v2/Connectivity/FileImport.md b/docs/v2/Connectivity/FileImport.md index 01b36f77b..19553b8bc 100644 --- a/docs/v2/Connectivity/FileImport.md +++ b/docs/v2/Connectivity/FileImport.md @@ -7,7 +7,6 @@ Method | HTTP request | Release Stage | [**execute**](#execute) | **POST** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}/execute | Public Beta | [**get**](#get) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid} | Public Beta | [**list**](#list) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports | Public Beta | -[**page**](#page) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports | Public Beta | [**replace**](#replace) | **PUT** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid} | Private Beta | # **create** @@ -20,7 +19,7 @@ Name | Type | Description | Notes | **connection_rid** | ConnectionRid | | | **dataset_rid** | DatasetRid | The RID of the output dataset. | | **display_name** | FileImportDisplayName | | | -**file_import_filters** | List[Union[FileImportFilter, FileImportFilterDict]] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) | | +**file_import_filters** | List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) | | **import_mode** | FileImportMode | | | **branch_name** | Optional[BranchName] | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -44,7 +43,7 @@ connection_rid = None dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" # FileImportDisplayName display_name = "My file import" -# List[Union[FileImportFilter, FileImportFilterDict]] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) +# List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) file_import_filters = None # FileImportMode import_mode = "SNAPSHOT" @@ -305,66 +304,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListFileImportsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists all file imports defined for this connection. -Only file imports that the user has permissions to view will be returned. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**connection_rid** | ConnectionRid | | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListFileImportsResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ConnectionRid -connection_rid = None -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.connectivity.Connection.FileImport.page( - connection_rid, page_size=page_size, page_token=page_token, preview=preview - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling FileImport.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) @@ -387,7 +326,7 @@ Name | Type | Description | Notes | **file_import_rid** | FileImportRid | | | **dataset_rid** | DatasetRid | The RID of the output dataset. | | **display_name** | FileImportDisplayName | | | -**file_import_filters** | List[Union[FileImportFilter, FileImportFilterDict]] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) | | +**file_import_filters** | List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) | | **import_mode** | FileImportMode | | | **branch_name** | Optional[BranchName] | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -413,7 +352,7 @@ file_import_rid = None dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" # FileImportDisplayName display_name = "My file import" -# List[Union[FileImportFilter, FileImportFilterDict]] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) +# List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) file_import_filters = None # FileImportMode import_mode = "SNAPSHOT" diff --git a/docs/v2/Connectivity/TableImport.md b/docs/v2/Connectivity/TableImport.md index c2e906177..bfab2a7a8 100644 --- a/docs/v2/Connectivity/TableImport.md +++ b/docs/v2/Connectivity/TableImport.md @@ -7,7 +7,6 @@ Method | HTTP request | Release Stage | [**execute**](#execute) | **POST** /v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}/execute | Public Beta | [**get**](#get) | **GET** /v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid} | Public Beta | [**list**](#list) | **GET** /v2/connectivity/connections/{connectionRid}/tableImports | Public Beta | -[**page**](#page) | **GET** /v2/connectivity/connections/{connectionRid}/tableImports | Public Beta | # **create** Creates a new TableImport. @@ -17,7 +16,7 @@ Creates a new TableImport. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **connection_rid** | ConnectionRid | | | -**config** | Union[CreateTableImportRequestTableImportConfig, CreateTableImportRequestTableImportConfigDict] | | | +**config** | CreateTableImportRequestTableImportConfig | | | **dataset_rid** | DatasetRid | The RID of the output dataset. | | **display_name** | TableImportDisplayName | | | **import_mode** | TableImportMode | | | @@ -39,7 +38,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant # ConnectionRid connection_rid = None -# Union[CreateTableImportRequestTableImportConfig, CreateTableImportRequestTableImportConfigDict] +# CreateTableImportRequestTableImportConfig config = None # DatasetRid | The RID of the output dataset. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -304,66 +303,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListTableImportsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists all table imports defined for this connection. -Only table imports that the user has permissions to view will be returned. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**connection_rid** | ConnectionRid | | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListTableImportsResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ConnectionRid -connection_rid = None -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.connectivity.Connection.TableImport.page( - connection_rid, page_size=page_size, page_token=page_token, preview=preview - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling TableImport.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Connectivity/models/ApiKeyAuthenticationDict.md b/docs/v2/Connectivity/models/ApiKeyAuthenticationDict.md deleted file mode 100644 index 6940b4850..000000000 --- a/docs/v2/Connectivity/models/ApiKeyAuthenticationDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# ApiKeyAuthenticationDict - -The API key used to authenticate to the external system. -This can be configured as a header or query parameter. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**location** | RestRequestApiKeyLocationDict | Yes | The location of the API key in the request. | -**apiKey** | EncryptedPropertyDict | Yes | The value of the API key. | -**type** | Literal["apiKey"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/AsPlaintextValueDict.md b/docs/v2/Connectivity/models/AsPlaintextValueDict.md deleted file mode 100644 index 1d9c2e755..000000000 --- a/docs/v2/Connectivity/models/AsPlaintextValueDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsPlaintextValueDict - -AsPlaintextValue - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | PlaintextValue | Yes | | -**type** | Literal["asPlaintextValue"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/AsSecretNameDict.md b/docs/v2/Connectivity/models/AsSecretNameDict.md deleted file mode 100644 index 7e6809d75..000000000 --- a/docs/v2/Connectivity/models/AsSecretNameDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AsSecretNameDict - -AsSecretName - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | SecretName | Yes | | -**type** | Literal["asSecretName"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/AwsAccessKeyDict.md b/docs/v2/Connectivity/models/AwsAccessKeyDict.md deleted file mode 100644 index b822eebe1..000000000 --- a/docs/v2/Connectivity/models/AwsAccessKeyDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# AwsAccessKeyDict - -[Access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) are long-term -credentials for an IAM user or the AWS account root user. -Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) and a secret access -key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). You must use both the access key ID and -secret access key together to authenticate your requests. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**accessKeyId** | str | Yes | | -**secretAccessKey** | EncryptedPropertyDict | Yes | | -**type** | Literal["awsAccessKey"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/AwsOidcAuthenticationDict.md b/docs/v2/Connectivity/models/AwsOidcAuthenticationDict.md deleted file mode 100644 index c98c0f2f6..000000000 --- a/docs/v2/Connectivity/models/AwsOidcAuthenticationDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# AwsOidcAuthenticationDict - -[OpenID Connect (OIDC)](/docs/foundry/data-connection/oidc/) is an open authentication protocol that allows -you to authenticate to external system resources without the use of static credentials. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**audience** | str | Yes | The configured audience that identifies the external system. | -**issuerUrl** | str | Yes | The URL that identifies Foundry as an OIDC identity provider. | -**subject** | ConnectionRid | Yes | The RID of the Connection that is connecting to the external system. | -**type** | Literal["oidc"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/BasicCredentialsDict.md b/docs/v2/Connectivity/models/BasicCredentialsDict.md deleted file mode 100644 index 8eff3ef12..000000000 --- a/docs/v2/Connectivity/models/BasicCredentialsDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# BasicCredentialsDict - -BasicCredentials - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**username** | str | Yes | | -**password** | EncryptedPropertyDict | Yes | | -**type** | Literal["basic"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/BearerTokenDict.md b/docs/v2/Connectivity/models/BearerTokenDict.md deleted file mode 100644 index e5a8c1eee..000000000 --- a/docs/v2/Connectivity/models/BearerTokenDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# BearerTokenDict - -The bearer token used to authenticate to the external system. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**bearerToken** | EncryptedPropertyDict | Yes | | -**type** | Literal["bearerToken"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CloudIdentityDict.md b/docs/v2/Connectivity/models/CloudIdentityDict.md deleted file mode 100644 index e72925377..000000000 --- a/docs/v2/Connectivity/models/CloudIdentityDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# CloudIdentityDict - -[Cloud identities](/docs/foundry/administration/configure-cloud-identities/) allow you to authenticate to -cloud provider resources without the use of static credentials. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**cloudIdentityRid** | CloudIdentityRid | Yes | | -**type** | Literal["cloudIdentity"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/ConnectionConfigurationDict.md b/docs/v2/Connectivity/models/ConnectionConfigurationDict.md deleted file mode 100644 index 4d2c2e1a2..000000000 --- a/docs/v2/Connectivity/models/ConnectionConfigurationDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ConnectionConfigurationDict - -ConnectionConfiguration - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -S3ConnectionConfigurationDict | s3 -RestConnectionConfigurationDict | rest -JdbcConnectionConfigurationDict | jdbc - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/ConnectionDict.md b/docs/v2/Connectivity/models/ConnectionDict.md deleted file mode 100644 index 1231df6b8..000000000 --- a/docs/v2/Connectivity/models/ConnectionDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ConnectionDict - -Connection - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ConnectionRid | Yes | | -**parentFolderRid** | FolderRid | Yes | | -**displayName** | ConnectionDisplayName | Yes | The display name of the Connection. The display name must not be blank. | -**configuration** | ConnectionConfigurationDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestConnectionConfigurationDict.md b/docs/v2/Connectivity/models/CreateConnectionRequestConnectionConfigurationDict.md deleted file mode 100644 index 20390f01b..000000000 --- a/docs/v2/Connectivity/models/CreateConnectionRequestConnectionConfigurationDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# CreateConnectionRequestConnectionConfigurationDict - -CreateConnectionRequestConnectionConfiguration - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -CreateConnectionRequestS3ConnectionConfigurationDict | s3 -CreateConnectionRequestRestConnectionConfigurationDict | rest -CreateConnectionRequestJdbcConnectionConfigurationDict | jdbc - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestJdbcConnectionConfigurationDict.md b/docs/v2/Connectivity/models/CreateConnectionRequestJdbcConnectionConfigurationDict.md deleted file mode 100644 index 750e0e71d..000000000 --- a/docs/v2/Connectivity/models/CreateConnectionRequestJdbcConnectionConfigurationDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# CreateConnectionRequestJdbcConnectionConfigurationDict - -CreateConnectionRequestJdbcConnectionConfiguration - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**credentials** | NotRequired[BasicCredentialsDict] | No | | -**driverClass** | str | Yes | The fully-qualified driver class name that is used to connect to the database. | -**jdbcProperties** | Dict[str, str] | Yes | The list of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed to the JDBC driver to configure behavior. Refer to the documentation of your specific connection for additional available JDBC properties to add to your connection configuration. | -**url** | str | Yes | The URL that the JDBC driver uses to connect to a database. | -**type** | Literal["jdbc"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestRestConnectionConfigurationDict.md b/docs/v2/Connectivity/models/CreateConnectionRequestRestConnectionConfigurationDict.md deleted file mode 100644 index 1bfa8925f..000000000 --- a/docs/v2/Connectivity/models/CreateConnectionRequestRestConnectionConfigurationDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# CreateConnectionRequestRestConnectionConfigurationDict - -CreateConnectionRequestRestConnectionConfiguration - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**additionalSecrets** | NotRequired[RestConnectionAdditionalSecretsDict] | No | Additional secrets that can be referenced in code and webhook configurations. If not provided, no additional secrets will be created. | -**oauth2ClientRid** | NotRequired[RID] | No | The RID of the [Outbound application](/docs/foundry/administration/configure-outbound-applications) that is used to authenticate to the external system via OAuth2. Currently, a connection may use only one outbound application for OAuth 2.0 authentication. Selecting a different outbound application will update the configuration for all domains with OAuth 2.0 as the selected authorization. | -**domains** | List[DomainDict] | Yes | The domains that the connection is allowed to access. At least one domain must be specified. | -**type** | Literal["rest"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestS3ConnectionConfigurationDict.md b/docs/v2/Connectivity/models/CreateConnectionRequestS3ConnectionConfigurationDict.md deleted file mode 100644 index 8af0796c9..000000000 --- a/docs/v2/Connectivity/models/CreateConnectionRequestS3ConnectionConfigurationDict.md +++ /dev/null @@ -1,25 +0,0 @@ -# CreateConnectionRequestS3ConnectionConfigurationDict - -CreateConnectionRequestS3ConnectionConfiguration - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**connectionTimeoutMillis** | NotRequired[Long] | No | The amount of time (in milliseconds) to wait when initially establishing a connection before giving up and timing out. If not specified, defaults to 10000 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_CONNECTION_TIMEOUT). | -**maxErrorRetry** | NotRequired[int] | No | The maximum number of retry attempts for failed requests to the S3 service. If not specified, defaults to 3 as defined by the [AWS SDK default](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/retry-strategy.html#retry-strategies). | -**bucketUrl** | str | Yes | The URL of the S3 bucket. The URL should contain a trailing slash. | -**clientKmsConfiguration** | NotRequired[S3KmsConfigurationDict] | No | The client-side KMS key to use for encryption and decryption of data in the S3 bucket. If not specified, the default KMS key for the bucket is used. | -**matchSubfolderExactly** | NotRequired[bool] | No | If true, only files in the subfolder specified in the bucket URL will be synced. If false, all files in the bucket will be synced. If not specified, defaults to false. | -**stsRoleConfiguration** | NotRequired[StsRoleConfigurationDict] | No | The configuration needed to assume a role to connect to the S3 external system. | -**s3Endpoint** | NotRequired[str] | No | The endpoint of the S3 service. This is used to connect to a custom S3 service that is not AWS S3. If not specified, defaults to the [AWS S3 endpoint](https://docs.aws.amazon.com/general/latest/gr/s3.html). Warning: Specifying a region and a custom endpoint containing a region can lead to unexpected behavior. | -**socketTimeoutMillis** | NotRequired[Long] | No | The amount of time (in milliseconds) to wait for data to be transferred over an established, open connection. If not specified, defaults to 50000 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_SOCKET_TIMEOUT). | -**enableRequesterPays** | NotRequired[bool] | No | Defaults to false, unless set and overwritten. If true, includes the [requester pays header](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html) in requests, allowing reads from requester pays buckets. | -**s3EndpointSigningRegion** | NotRequired[Region] | No | The region used when constructing the S3 client using a custom endpoint. This is often not required and would only be needed if you are using the S3 connector with an S3-compliant third-party API, and are also setting a custom endpoint that requires a non-default region. | -**region** | NotRequired[Region] | No | The region representing the location of the S3 bucket. Warning: Specifying a region and a custom endpoint containing a region can lead to unexpected behavior. | -**authenticationMode** | NotRequired[S3AuthenticationModeDict] | No | The authentication mode to use to connect to the S3 external system. No authentication mode is required to connect to publicly accessible AWS S3 buckets. | -**proxyConfiguration** | NotRequired[S3ProxyConfigurationDict] | No | The configuration needed to connect to the S3 external system through a proxy. | -**maxConnections** | NotRequired[int] | No | The maximum number of HTTP connections to the S3 service per sync. If not specified, defaults to 50 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_MAX_CONNECTIONS). | -**type** | Literal["s3"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestJdbcImportConfigDict.md b/docs/v2/Connectivity/models/CreateTableImportRequestJdbcImportConfigDict.md deleted file mode 100644 index 82f288446..000000000 --- a/docs/v2/Connectivity/models/CreateTableImportRequestJdbcImportConfigDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateTableImportRequestJdbcImportConfigDict - -CreateTableImportRequestJdbcImportConfig - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | -**type** | Literal["jdbcImportConfig"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfigDict.md b/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfigDict.md deleted file mode 100644 index 12c69a431..000000000 --- a/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfigDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateTableImportRequestMicrosoftAccessImportConfigDict - -CreateTableImportRequestMicrosoftAccessImportConfig - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | -**type** | Literal["microsoftAccessImportConfig"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfigDict.md b/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfigDict.md deleted file mode 100644 index 90b90cc86..000000000 --- a/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfigDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateTableImportRequestMicrosoftSqlServerImportConfigDict - -CreateTableImportRequestMicrosoftSqlServerImportConfig - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | -**type** | Literal["microsoftSqlServerImportConfig"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestOracleImportConfigDict.md b/docs/v2/Connectivity/models/CreateTableImportRequestOracleImportConfigDict.md deleted file mode 100644 index c29af3805..000000000 --- a/docs/v2/Connectivity/models/CreateTableImportRequestOracleImportConfigDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateTableImportRequestOracleImportConfigDict - -CreateTableImportRequestOracleImportConfig - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | -**type** | Literal["oracleImportConfig"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestPostgreSqlImportConfigDict.md b/docs/v2/Connectivity/models/CreateTableImportRequestPostgreSqlImportConfigDict.md deleted file mode 100644 index 982101f45..000000000 --- a/docs/v2/Connectivity/models/CreateTableImportRequestPostgreSqlImportConfigDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateTableImportRequestPostgreSqlImportConfigDict - -CreateTableImportRequestPostgreSqlImportConfig - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | -**type** | Literal["postgreSqlImportConfig"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfigDict.md b/docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfigDict.md deleted file mode 100644 index fcda0cc52..000000000 --- a/docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfigDict.md +++ /dev/null @@ -1,20 +0,0 @@ -# CreateTableImportRequestTableImportConfigDict - -The import configuration for a specific [connector type](/docs/foundry/data-integration/source-type-overview). - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -CreateTableImportRequestJdbcImportConfigDict | jdbcImportConfig -CreateTableImportRequestMicrosoftSqlServerImportConfigDict | microsoftSqlServerImportConfig -CreateTableImportRequestPostgreSqlImportConfigDict | postgreSqlImportConfig -CreateTableImportRequestMicrosoftAccessImportConfigDict | microsoftAccessImportConfig -CreateTableImportRequestOracleImportConfigDict | oracleImportConfig - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/DomainDict.md b/docs/v2/Connectivity/models/DomainDict.md deleted file mode 100644 index 46895bb09..000000000 --- a/docs/v2/Connectivity/models/DomainDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# DomainDict - -The domain that the connection is allowed to access. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**scheme** | NotRequired[UriScheme] | No | The scheme of the domain that the connection is allowed to access. If not specified, defaults to HTTPS. | -**host** | str | Yes | The domain name, IPv4, or IPv6 address. | -**port** | NotRequired[int] | No | The port number of the domain that the connection is allowed to access. | -**auth** | NotRequired[RestAuthenticationModeDict] | No | The URI scheme must be HTTPS if using any authentication. If not specified, no authentication is required. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/EncryptedPropertyDict.md b/docs/v2/Connectivity/models/EncryptedPropertyDict.md deleted file mode 100644 index dca367174..000000000 --- a/docs/v2/Connectivity/models/EncryptedPropertyDict.md +++ /dev/null @@ -1,21 +0,0 @@ -# EncryptedPropertyDict - -When reading an encrypted property, the secret name representing the encrypted value will be returned. -When writing to an encrypted property: -- If a plaintext value is passed as an input, the plaintext value will be encrypted and saved to the property. -- If a secret name is passed as an input, the secret name must match the existing secret name of the property - and the property will retain its previously encrypted value. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -AsSecretNameDict | asSecretName -AsPlaintextValueDict | asPlaintextValue - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/FileAnyPathMatchesFilterDict.md b/docs/v2/Connectivity/models/FileAnyPathMatchesFilterDict.md deleted file mode 100644 index b3666bf1c..000000000 --- a/docs/v2/Connectivity/models/FileAnyPathMatchesFilterDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# FileAnyPathMatchesFilterDict - -If any file has a relative path matching the regular expression, sync all files in the subfolder that are not otherwise filtered. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**regex** | str | Yes | The regular expression for the relative path to match against. | -**type** | Literal["anyPathMatchesFilter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/FileAtLeastCountFilterDict.md b/docs/v2/Connectivity/models/FileAtLeastCountFilterDict.md deleted file mode 100644 index 988d53865..000000000 --- a/docs/v2/Connectivity/models/FileAtLeastCountFilterDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# FileAtLeastCountFilterDict - -Import all filtered files only if there are at least the specified number of files remaining. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**minFilesCount** | int | Yes | The minimum number of files remaining expected. The value specified must be greater than 0. | -**type** | Literal["atLeastCountFilter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/FileChangedSinceLastUploadFilterDict.md b/docs/v2/Connectivity/models/FileChangedSinceLastUploadFilterDict.md deleted file mode 100644 index 17a09c658..000000000 --- a/docs/v2/Connectivity/models/FileChangedSinceLastUploadFilterDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# FileChangedSinceLastUploadFilterDict - -Only import files that have changed or been added since the last import run. Whether or not a file is considered to be changed is determined by the specified file properties. -This will exclude files uploaded in any previous imports, regardless of the file import mode used. A SNAPSHOT file import mode does not reset the filter. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fileProperties** | List[FileProperty] | Yes | The criteria on which to determine whether a file has been changed or not since the last import. If any of the specified criteria have changed, the file is consider changed. The criteria include: LAST_MODIFIED: The file's last modified timestamp has changed since the last import. SIZE: The file's size has changed since the last import. If no criteria are specified, only newly added files will be imported. | -**type** | Literal["changedSinceLastUploadFilter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/FileImportCustomFilterDict.md b/docs/v2/Connectivity/models/FileImportCustomFilterDict.md deleted file mode 100644 index 51a2f541b..000000000 --- a/docs/v2/Connectivity/models/FileImportCustomFilterDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# FileImportCustomFilterDict - -A custom file import filter. Custom file import filters can be fetched but cannot currently be used -when creating or updating file imports. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**config** | Any | Yes | | -**type** | Literal["customFilter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/FileImportDict.md b/docs/v2/Connectivity/models/FileImportDict.md deleted file mode 100644 index d35ce2da4..000000000 --- a/docs/v2/Connectivity/models/FileImportDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# FileImportDict - -FileImport - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | FileImportRid | Yes | | -**connectionRid** | ConnectionRid | Yes | The RID of the Connection (also known as a source) that the File Import uses to import data. | -**datasetRid** | DatasetRid | Yes | The RID of the output dataset. | -**branchName** | NotRequired[BranchName] | No | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. | -**displayName** | FileImportDisplayName | Yes | | -**fileImportFilters** | List[FileImportFilterDict] | Yes | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) | -**importMode** | FileImportMode | Yes | | -**subfolder** | NotRequired[str] | No | A subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/FileImportFilterDict.md b/docs/v2/Connectivity/models/FileImportFilterDict.md deleted file mode 100644 index 8a47296aa..000000000 --- a/docs/v2/Connectivity/models/FileImportFilterDict.md +++ /dev/null @@ -1,25 +0,0 @@ -# FileImportFilterDict - -[Filters](/docs/foundry/data-connection/file-based-syncs/#filters) allow you to filter source files -before they are imported into Foundry. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -FilePathNotMatchesFilterDict | pathNotMatchesFilter -FileAnyPathMatchesFilterDict | anyPathMatchesFilter -FilesCountLimitFilterDict | filesCountLimitFilter -FileChangedSinceLastUploadFilterDict | changedSinceLastUploadFilter -FileImportCustomFilterDict | customFilter -FileLastModifiedAfterFilterDict | lastModifiedAfterFilter -FilePathMatchesFilterDict | pathMatchesFilter -FileAtLeastCountFilterDict | atLeastCountFilter -FileSizeFilterDict | fileSizeFilter - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/FileLastModifiedAfterFilterDict.md b/docs/v2/Connectivity/models/FileLastModifiedAfterFilterDict.md deleted file mode 100644 index c912ba577..000000000 --- a/docs/v2/Connectivity/models/FileLastModifiedAfterFilterDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# FileLastModifiedAfterFilterDict - -Only import files that have been modified after a specified timestamp - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**afterTimestamp** | NotRequired[datetime] | No | Timestamp threshold, specified in ISO-8601 format. If not specified, defaults to the timestamp the filter is added to the file import. | -**type** | Literal["lastModifiedAfterFilter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/FilePathMatchesFilterDict.md b/docs/v2/Connectivity/models/FilePathMatchesFilterDict.md deleted file mode 100644 index 8a5d96900..000000000 --- a/docs/v2/Connectivity/models/FilePathMatchesFilterDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# FilePathMatchesFilterDict - -Only import files whose path (relative to the root of the source) matches the regular expression. - -**Example** -Suppose we are importing files from `relative/subfolder`. -`relative/subfolder` contains: -- `relative/subfolder/include-file.txt` -- `relative/subfolder/exclude-file.txt` -- `relative/subfolder/other-file.txt` - -With the `relative/subfolder/include-.*.txt` regex, only `relative/subfolder/include-file.txt` will be imported. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**regex** | str | Yes | Must be written to match the paths relative to the root of the source, even if a subfolder is specified. | -**type** | Literal["pathMatchesFilter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/FilePathNotMatchesFilterDict.md b/docs/v2/Connectivity/models/FilePathNotMatchesFilterDict.md deleted file mode 100644 index 2374286e8..000000000 --- a/docs/v2/Connectivity/models/FilePathNotMatchesFilterDict.md +++ /dev/null @@ -1,23 +0,0 @@ -# FilePathNotMatchesFilterDict - -Only import files whose path (relative to the root of the source) does not match the regular expression. - -**Example** -Suppose we are importing files from `relative/subfolder`. -`relative/subfolder` contains: -- `relative/subfolder/include-file.txt` -- `relative/subfolder/exclude-file.txt` -- `relative/subfolder/other-file.txt` - -With the `relative/subfolder/exclude-.*.txt` regex, both `relative/subfolder/include-file.txt` and `relative/subfolder/other-file.txt` will be imported, -and `relative/subfolder/exclude-file.txt` will be excluded from the import. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**regex** | str | Yes | Must be written to match the paths relative to the root of the source, even if a subfolder is specified. | -**type** | Literal["pathNotMatchesFilter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/FileSizeFilterDict.md b/docs/v2/Connectivity/models/FileSizeFilterDict.md deleted file mode 100644 index 19076122e..000000000 --- a/docs/v2/Connectivity/models/FileSizeFilterDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# FileSizeFilterDict - -Only import files whose size is between the specified minimum and maximum values. -At least one of `gt` or `lt` should be present. -If both are present, the value specified for `gt` must be strictly less than `lt - 1`. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**gt** | NotRequired[SizeBytes] | No | File size must be greater than this number for it to be imported. The value specified cannot be a negative number. | -**lt** | NotRequired[SizeBytes] | No | File size must be less than this number for it to be imported. The value specified must be at least 1 byte. | -**type** | Literal["fileSizeFilter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/FilesCountLimitFilterDict.md b/docs/v2/Connectivity/models/FilesCountLimitFilterDict.md deleted file mode 100644 index 7c007cb90..000000000 --- a/docs/v2/Connectivity/models/FilesCountLimitFilterDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# FilesCountLimitFilterDict - -Only retain `filesCount` number of files in each transaction. -The choice of files to retain is made without any guarantee of order. -This option can increase the reliability of incremental syncs. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**filesCount** | int | Yes | The number of files to import in the transaction. The value specified must be positive. | -**type** | Literal["filesCountLimitFilter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/HeaderApiKeyDict.md b/docs/v2/Connectivity/models/HeaderApiKeyDict.md deleted file mode 100644 index 633ad476e..000000000 --- a/docs/v2/Connectivity/models/HeaderApiKeyDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# HeaderApiKeyDict - -HeaderApiKey - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**headerName** | str | Yes | The name of the header that the API key is passed in. | -**type** | Literal["header"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/JdbcConnectionConfigurationDict.md b/docs/v2/Connectivity/models/JdbcConnectionConfigurationDict.md deleted file mode 100644 index 441974ec0..000000000 --- a/docs/v2/Connectivity/models/JdbcConnectionConfigurationDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# JdbcConnectionConfigurationDict - -The configuration needed to connect to an external system using the JDBC protocol. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**url** | str | Yes | The URL that the JDBC driver uses to connect to a database. | -**driverClass** | str | Yes | The fully-qualified driver class name that is used to connect to the database. | -**jdbcProperties** | Dict[str, str] | Yes | The list of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed to the JDBC driver to configure behavior. Refer to the documentation of your specific connection for additional available JDBC properties to add to your connection configuration. | -**credentials** | NotRequired[BasicCredentialsDict] | No | | -**type** | Literal["jdbc"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/JdbcImportConfigDict.md b/docs/v2/Connectivity/models/JdbcImportConfigDict.md deleted file mode 100644 index 55e36d18c..000000000 --- a/docs/v2/Connectivity/models/JdbcImportConfigDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# JdbcImportConfigDict - -The import configuration for a [custom JDBC connection](/docs/foundry/available-connectors/custom-jdbc-sources). - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | -**type** | Literal["jdbcImportConfig"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/ListFileImportsResponseDict.md b/docs/v2/Connectivity/models/ListFileImportsResponseDict.md deleted file mode 100644 index adf6525f6..000000000 --- a/docs/v2/Connectivity/models/ListFileImportsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListFileImportsResponseDict - -ListFileImportsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[FileImportDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/ListTableImportsResponseDict.md b/docs/v2/Connectivity/models/ListTableImportsResponseDict.md deleted file mode 100644 index 8ab9b4dce..000000000 --- a/docs/v2/Connectivity/models/ListTableImportsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListTableImportsResponseDict - -ListTableImportsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[TableImportDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/MicrosoftAccessImportConfigDict.md b/docs/v2/Connectivity/models/MicrosoftAccessImportConfigDict.md deleted file mode 100644 index 7c134a485..000000000 --- a/docs/v2/Connectivity/models/MicrosoftAccessImportConfigDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MicrosoftAccessImportConfigDict - -The import configuration for a [Microsoft Access connection](/docs/foundry/available-connectors/microsoft-access). - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | -**type** | Literal["microsoftAccessImportConfig"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/MicrosoftSqlServerImportConfigDict.md b/docs/v2/Connectivity/models/MicrosoftSqlServerImportConfigDict.md deleted file mode 100644 index a4f0a9005..000000000 --- a/docs/v2/Connectivity/models/MicrosoftSqlServerImportConfigDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MicrosoftSqlServerImportConfigDict - -The import configuration for a [Microsoft SQL Server connection](/docs/foundry/available-connectors/microsoft-sql-server). - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | -**type** | Literal["microsoftSqlServerImportConfig"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/OracleImportConfigDict.md b/docs/v2/Connectivity/models/OracleImportConfigDict.md deleted file mode 100644 index fc069fa8f..000000000 --- a/docs/v2/Connectivity/models/OracleImportConfigDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OracleImportConfigDict - -The import configuration for an Oracle Database 21 connection. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | -**type** | Literal["oracleImportConfig"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/PostgreSqlImportConfigDict.md b/docs/v2/Connectivity/models/PostgreSqlImportConfigDict.md deleted file mode 100644 index 66df7c37f..000000000 --- a/docs/v2/Connectivity/models/PostgreSqlImportConfigDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PostgreSqlImportConfigDict - -The import configuration for a [PostgreSQL connection](/docs/foundry/available-connectors/postgresql). - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | -**type** | Literal["postgreSqlImportConfig"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/QueryParameterApiKeyDict.md b/docs/v2/Connectivity/models/QueryParameterApiKeyDict.md deleted file mode 100644 index c718c6ec6..000000000 --- a/docs/v2/Connectivity/models/QueryParameterApiKeyDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryParameterApiKeyDict - -QueryParameterApiKey - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**queryParameterName** | str | Yes | The name of the query parameter that the API key is passed in. | -**type** | Literal["queryParameter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/RestAuthenticationModeDict.md b/docs/v2/Connectivity/models/RestAuthenticationModeDict.md deleted file mode 100644 index c7a5023d6..000000000 --- a/docs/v2/Connectivity/models/RestAuthenticationModeDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# RestAuthenticationModeDict - -The method of authentication for connecting to an external REST system. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -BearerTokenDict | bearerToken -ApiKeyAuthenticationDict | apiKey -BasicCredentialsDict | basic -RestConnectionOAuth2Dict | oauth2 - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/RestConnectionAdditionalSecretsDict.md b/docs/v2/Connectivity/models/RestConnectionAdditionalSecretsDict.md deleted file mode 100644 index 82591f26b..000000000 --- a/docs/v2/Connectivity/models/RestConnectionAdditionalSecretsDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# RestConnectionAdditionalSecretsDict - -When creating or updating additional secrets, use SecretsWithPlaintextValues. -When fetching the RestConnectionConfiguration, SecretsNames will be provided. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -SecretsWithPlaintextValuesDict | asSecretsWithPlaintextValues -SecretsNamesDict | asSecretsNames - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/RestConnectionConfigurationDict.md b/docs/v2/Connectivity/models/RestConnectionConfigurationDict.md deleted file mode 100644 index cff9f4861..000000000 --- a/docs/v2/Connectivity/models/RestConnectionConfigurationDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# RestConnectionConfigurationDict - -The configuration needed to connect to a [REST external system](/docs/foundry/available-connectors/rest-apis). - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**domains** | List[DomainDict] | Yes | The domains that the connection is allowed to access. At least one domain must be specified. | -**additionalSecrets** | NotRequired[RestConnectionAdditionalSecretsDict] | No | Additional secrets that can be referenced in code and webhook configurations. If not provided, no additional secrets will be created. | -**oauth2ClientRid** | NotRequired[RID] | No | The RID of the [Outbound application](/docs/foundry/administration/configure-outbound-applications) that is used to authenticate to the external system via OAuth2. Currently, a connection may use only one outbound application for OAuth 2.0 authentication. Selecting a different outbound application will update the configuration for all domains with OAuth 2.0 as the selected authorization. | -**type** | Literal["rest"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/RestConnectionOAuth2Dict.md b/docs/v2/Connectivity/models/RestConnectionOAuth2Dict.md deleted file mode 100644 index ec979be17..000000000 --- a/docs/v2/Connectivity/models/RestConnectionOAuth2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# RestConnectionOAuth2Dict - -In order to use OAuth2 you must have an Outbound application configured in the [Foundry Control Panel Organization settings](/docs/foundry/administration/configure-outbound-applications#create-an-outbound-application). -The RID of the Outbound application must be configured in the RestConnectionConfiguration in the `oauth2ClientRid` field. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["oauth2"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/RestRequestApiKeyLocationDict.md b/docs/v2/Connectivity/models/RestRequestApiKeyLocationDict.md deleted file mode 100644 index 34731c0da..000000000 --- a/docs/v2/Connectivity/models/RestRequestApiKeyLocationDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# RestRequestApiKeyLocationDict - -The location of the API key in the request. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -HeaderApiKeyDict | header -QueryParameterApiKeyDict | queryParameter - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/S3AuthenticationModeDict.md b/docs/v2/Connectivity/models/S3AuthenticationModeDict.md deleted file mode 100644 index fd71bbf4b..000000000 --- a/docs/v2/Connectivity/models/S3AuthenticationModeDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# S3AuthenticationModeDict - -S3AuthenticationMode - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -AwsAccessKeyDict | awsAccessKey -CloudIdentityDict | cloudIdentity -AwsOidcAuthenticationDict | oidc - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/S3ConnectionConfigurationDict.md b/docs/v2/Connectivity/models/S3ConnectionConfigurationDict.md deleted file mode 100644 index 059d85f34..000000000 --- a/docs/v2/Connectivity/models/S3ConnectionConfigurationDict.md +++ /dev/null @@ -1,27 +0,0 @@ -# S3ConnectionConfigurationDict - -The configuration needed to connect to an [AWS S3 external system (or any other S3-like external systems that -implement the s3a protocol)](/docs/foundry/available-connectors/amazon-s3/#amazon-s3). - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**bucketUrl** | str | Yes | The URL of the S3 bucket. The URL should contain a trailing slash. | -**s3Endpoint** | NotRequired[str] | No | The endpoint of the S3 service. This is used to connect to a custom S3 service that is not AWS S3. If not specified, defaults to the [AWS S3 endpoint](https://docs.aws.amazon.com/general/latest/gr/s3.html). Warning: Specifying a region and a custom endpoint containing a region can lead to unexpected behavior. | -**region** | NotRequired[Region] | No | The region representing the location of the S3 bucket. Warning: Specifying a region and a custom endpoint containing a region can lead to unexpected behavior. | -**authenticationMode** | NotRequired[S3AuthenticationModeDict] | No | The authentication mode to use to connect to the S3 external system. No authentication mode is required to connect to publicly accessible AWS S3 buckets. | -**s3EndpointSigningRegion** | NotRequired[Region] | No | The region used when constructing the S3 client using a custom endpoint. This is often not required and would only be needed if you are using the S3 connector with an S3-compliant third-party API, and are also setting a custom endpoint that requires a non-default region. | -**clientKmsConfiguration** | NotRequired[S3KmsConfigurationDict] | No | The client-side KMS key to use for encryption and decryption of data in the S3 bucket. If not specified, the default KMS key for the bucket is used. | -**stsRoleConfiguration** | NotRequired[StsRoleConfigurationDict] | No | The configuration needed to assume a role to connect to the S3 external system. | -**proxyConfiguration** | NotRequired[S3ProxyConfigurationDict] | No | The configuration needed to connect to the S3 external system through a proxy. | -**maxConnections** | NotRequired[int] | No | The maximum number of HTTP connections to the S3 service per sync. If not specified, defaults to 50 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_MAX_CONNECTIONS). | -**connectionTimeoutMillis** | NotRequired[Long] | No | The amount of time (in milliseconds) to wait when initially establishing a connection before giving up and timing out. If not specified, defaults to 10000 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_CONNECTION_TIMEOUT). | -**socketTimeoutMillis** | NotRequired[Long] | No | The amount of time (in milliseconds) to wait for data to be transferred over an established, open connection. If not specified, defaults to 50000 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_SOCKET_TIMEOUT). | -**maxErrorRetry** | NotRequired[int] | No | The maximum number of retry attempts for failed requests to the S3 service. If not specified, defaults to 3 as defined by the [AWS SDK default](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/retry-strategy.html#retry-strategies). | -**matchSubfolderExactly** | NotRequired[bool] | No | If true, only files in the subfolder specified in the bucket URL will be synced. If false, all files in the bucket will be synced. If not specified, defaults to false. | -**enableRequesterPays** | NotRequired[bool] | No | Defaults to false, unless set and overwritten. If true, includes the [requester pays header](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html) in requests, allowing reads from requester pays buckets. | -**type** | Literal["s3"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/S3KmsConfigurationDict.md b/docs/v2/Connectivity/models/S3KmsConfigurationDict.md deleted file mode 100644 index 3c1df28ca..000000000 --- a/docs/v2/Connectivity/models/S3KmsConfigurationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# S3KmsConfigurationDict - -S3KmsConfiguration - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**kmsKey** | str | Yes | The client-side KMS key to use for encryption and decryption of data in the S3 bucket. If not specified, the default KMS key for the bucket is used. | -**kmsRegion** | NotRequired[Region] | No | The region of the client-side KMS key to use for encryption and decryption of data in the S3 bucket. If not specified, the default KMS key region for the bucket is used. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/S3ProxyConfigurationDict.md b/docs/v2/Connectivity/models/S3ProxyConfigurationDict.md deleted file mode 100644 index 29cd665b4..000000000 --- a/docs/v2/Connectivity/models/S3ProxyConfigurationDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# S3ProxyConfigurationDict - -S3ProxyConfiguration - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**host** | str | Yes | Domain name, IPv4, or IPv6 address. `protocol` and `port` must be specified separately. | -**port** | int | Yes | | -**nonProxyHosts** | NotRequired[List[str]] | No | A list of hosts that can bypass the proxy, such as those used for STS Role. You can also use "*" wildcards. | -**protocol** | NotRequired[Protocol] | No | If defined, must be "HTTP" or "HTTPS". Defaults to "HTTPS". | -**credentials** | NotRequired[BasicCredentialsDict] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/SecretsNamesDict.md b/docs/v2/Connectivity/models/SecretsNamesDict.md deleted file mode 100644 index 73f8723be..000000000 --- a/docs/v2/Connectivity/models/SecretsNamesDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# SecretsNamesDict - -A list of secret names that can be referenced in code and webhook configurations. -This will be provided to the client when fetching the RestConnectionConfiguration. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**secretNames** | List[SecretName] | Yes | The names of the additional secrets that can be referenced in code and webhook configurations. | -**type** | Literal["asSecretsNames"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/SecretsWithPlaintextValuesDict.md b/docs/v2/Connectivity/models/SecretsWithPlaintextValuesDict.md deleted file mode 100644 index 1be109a21..000000000 --- a/docs/v2/Connectivity/models/SecretsWithPlaintextValuesDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# SecretsWithPlaintextValuesDict - -A map representing secret name to plaintext secret value pairs. -This should be used when creating or updating additional secrets for a REST connection. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**secrets** | Dict[SecretName, PlaintextValue] | Yes | The additional secrets that can be referenced in code and webhook configurations. | -**type** | Literal["asSecretsWithPlaintextValues"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/StsRoleConfigurationDict.md b/docs/v2/Connectivity/models/StsRoleConfigurationDict.md deleted file mode 100644 index 3cf12aa90..000000000 --- a/docs/v2/Connectivity/models/StsRoleConfigurationDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# StsRoleConfigurationDict - -StsRoleConfiguration - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**roleArn** | str | Yes | The Amazon Resource Name (ARN) of the role to assume. For more information, see the official [AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-arn-format). | -**roleSessionName** | str | Yes | An identifier for the assumed role session. The value can be any string that you assume will be unique within the AWS account. For more information, see the official [AWS documentation](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#API_AssumeRole_RequestParameters). | -**roleSessionDuration** | NotRequired[DurationDict] | No | The duration of the role session. The value specified can range from 900 seconds (15 minutes) up to the maximum session duration set for the role. The maximum session duration setting can have a value from 1 hour to 12 hours. For more details see the official [AWS documentation](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#API_AssumeRole_RequestParameters). | -**externalId** | NotRequired[str] | No | A unique identifier that is used by third parties when assuming roles in their customers' accounts. For more information, see the official [AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html). | -**stsEndpoint** | NotRequired[str] | No | By default, the AWS Security Token Service (AWS STS) is available as a global service, and all AWS STS requests go to a single endpoint at https://sts.amazonaws.com. AWS recommends using Regional AWS STS endpoints instead of the global endpoint to reduce latency, build in redundancy, and increase session token validity. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/TableImportConfigDict.md b/docs/v2/Connectivity/models/TableImportConfigDict.md deleted file mode 100644 index fb0eb329d..000000000 --- a/docs/v2/Connectivity/models/TableImportConfigDict.md +++ /dev/null @@ -1,20 +0,0 @@ -# TableImportConfigDict - -The import configuration for a specific [connector type](/docs/foundry/data-integration/source-type-overview). - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -JdbcImportConfigDict | jdbcImportConfig -MicrosoftSqlServerImportConfigDict | microsoftSqlServerImportConfig -PostgreSqlImportConfigDict | postgreSqlImportConfig -MicrosoftAccessImportConfigDict | microsoftAccessImportConfig -OracleImportConfigDict | oracleImportConfig - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/TableImportDict.md b/docs/v2/Connectivity/models/TableImportDict.md deleted file mode 100644 index d91c2e46e..000000000 --- a/docs/v2/Connectivity/models/TableImportDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# TableImportDict - -TableImport - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | TableImportRid | Yes | | -**connectionRid** | ConnectionRid | Yes | The RID of the Connection (also known as a source) that the Table Import uses to import data. | -**datasetRid** | DatasetRid | Yes | The RID of the output dataset. | -**branchName** | NotRequired[BranchName] | No | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. | -**displayName** | TableImportDisplayName | Yes | | -**importMode** | TableImportMode | Yes | | -**allowSchemaChanges** | TableImportAllowSchemaChanges | Yes | Allow the TableImport to succeed if the schema of imported rows does not match the existing dataset's schema. Defaults to false for new table imports. | -**config** | TableImportConfigDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/AnyTypeDict.md b/docs/v2/Core/models/AnyTypeDict.md deleted file mode 100644 index 1e20f4973..000000000 --- a/docs/v2/Core/models/AnyTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AnyTypeDict - -AnyType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["any"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/ArrayFieldTypeDict.md b/docs/v2/Core/models/ArrayFieldTypeDict.md deleted file mode 100644 index d247ab445..000000000 --- a/docs/v2/Core/models/ArrayFieldTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ArrayFieldTypeDict - -ArrayFieldType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**itemsSchema** | FieldSchemaDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/AttachmentTypeDict.md b/docs/v2/Core/models/AttachmentTypeDict.md deleted file mode 100644 index b5b320556..000000000 --- a/docs/v2/Core/models/AttachmentTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttachmentTypeDict - -AttachmentType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["attachment"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/BinaryTypeDict.md b/docs/v2/Core/models/BinaryTypeDict.md deleted file mode 100644 index 734471df4..000000000 --- a/docs/v2/Core/models/BinaryTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BinaryTypeDict - -BinaryType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["binary"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/BooleanTypeDict.md b/docs/v2/Core/models/BooleanTypeDict.md deleted file mode 100644 index 5393418c2..000000000 --- a/docs/v2/Core/models/BooleanTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BooleanTypeDict - -BooleanType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["boolean"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/ByteTypeDict.md b/docs/v2/Core/models/ByteTypeDict.md deleted file mode 100644 index 8e022d52e..000000000 --- a/docs/v2/Core/models/ByteTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ByteTypeDict - -ByteType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["byte"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/ChangeDataCaptureConfigurationDict.md b/docs/v2/Core/models/ChangeDataCaptureConfigurationDict.md deleted file mode 100644 index 69aa27055..000000000 --- a/docs/v2/Core/models/ChangeDataCaptureConfigurationDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ChangeDataCaptureConfigurationDict - -Configuration for utilizing the stream as a change data capture (CDC) dataset. To configure CDC on a stream, at -least one key needs to be provided. - -For more information on CDC in -Foundry, see the [Change Data Capture](/docs/foundry/data-integration/change-data-capture/) user documentation. - - -## Type -```python -FullRowChangeDataCaptureConfigurationDict -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/CipherTextTypeDict.md b/docs/v2/Core/models/CipherTextTypeDict.md deleted file mode 100644 index 64997cffe..000000000 --- a/docs/v2/Core/models/CipherTextTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CipherTextTypeDict - -CipherTextType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**defaultCipherChannel** | NotRequired[RID] | No | An optional Cipher Channel RID which can be used for encryption updates to empty values. | -**type** | Literal["cipherText"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/DateTypeDict.md b/docs/v2/Core/models/DateTypeDict.md deleted file mode 100644 index 78ff464f2..000000000 --- a/docs/v2/Core/models/DateTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# DateTypeDict - -DateType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["date"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/DecimalTypeDict.md b/docs/v2/Core/models/DecimalTypeDict.md deleted file mode 100644 index df00be0cb..000000000 --- a/docs/v2/Core/models/DecimalTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# DecimalTypeDict - -DecimalType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**precision** | NotRequired[int] | No | The total number of digits of the Decimal type. The maximum value is 38. | -**scale** | NotRequired[int] | No | The number of digits to the right of the decimal point. The maximum value is 38. | -**type** | Literal["decimal"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/DistanceDict.md b/docs/v2/Core/models/DistanceDict.md deleted file mode 100644 index 063d47b14..000000000 --- a/docs/v2/Core/models/DistanceDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# DistanceDict - -A measurement of distance. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | float | Yes | | -**unit** | DistanceUnit | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/DoubleTypeDict.md b/docs/v2/Core/models/DoubleTypeDict.md deleted file mode 100644 index 083ce0976..000000000 --- a/docs/v2/Core/models/DoubleTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# DoubleTypeDict - -DoubleType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["double"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/DurationDict.md b/docs/v2/Core/models/DurationDict.md deleted file mode 100644 index 128b5e887..000000000 --- a/docs/v2/Core/models/DurationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# DurationDict - -A measurement of duration. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | int | Yes | The duration value. | -**unit** | TimeUnit | Yes | The unit of duration. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/EmbeddingModelDict.md b/docs/v2/Core/models/EmbeddingModelDict.md deleted file mode 100644 index 7503c5c9b..000000000 --- a/docs/v2/Core/models/EmbeddingModelDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# EmbeddingModelDict - -EmbeddingModel - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -LmsEmbeddingModelDict | lms -FoundryLiveDeploymentDict | foundryLiveDeployment - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/FieldDataTypeDict.md b/docs/v2/Core/models/FieldDataTypeDict.md deleted file mode 100644 index b7e3889f3..000000000 --- a/docs/v2/Core/models/FieldDataTypeDict.md +++ /dev/null @@ -1,29 +0,0 @@ -# FieldDataTypeDict - -FieldDataType - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -StructFieldTypeDict | struct -DateTypeDict | date -StringTypeDict | string -ByteTypeDict | byte -DoubleTypeDict | double -IntegerTypeDict | integer -FloatTypeDict | float -LongTypeDict | long -BooleanTypeDict | boolean -ArrayFieldTypeDict | array -BinaryTypeDict | binary -ShortTypeDict | short -DecimalTypeDict | decimal -MapFieldTypeDict | map -TimestampTypeDict | timestamp - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/FieldDict.md b/docs/v2/Core/models/FieldDict.md deleted file mode 100644 index 93fd47fdc..000000000 --- a/docs/v2/Core/models/FieldDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# FieldDict - -A field in a Foundry schema. For more information on supported data types, see the -[supported field types](/docs/foundry/data-integration/datasets/#supported-field-types) user documentation. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | FieldName | Yes | | -**schema_** | FieldSchemaDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/FieldSchemaDict.md b/docs/v2/Core/models/FieldSchemaDict.md deleted file mode 100644 index 5b13a3950..000000000 --- a/docs/v2/Core/models/FieldSchemaDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# FieldSchemaDict - -The specification of the type of a Foundry schema field. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nullable** | bool | Yes | | -**customMetadata** | NotRequired[CustomMetadata] | No | | -**dataType** | FieldDataTypeDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/FilterBinaryTypeDict.md b/docs/v2/Core/models/FilterBinaryType.md similarity index 93% rename from docs/v2/Core/models/FilterBinaryTypeDict.md rename to docs/v2/Core/models/FilterBinaryType.md index 8adfe8fa0..907bc4de1 100644 --- a/docs/v2/Core/models/FilterBinaryTypeDict.md +++ b/docs/v2/Core/models/FilterBinaryType.md @@ -1,4 +1,4 @@ -# FilterBinaryTypeDict +# FilterBinaryType FilterBinaryType diff --git a/docs/v2/Core/models/FilterBooleanTypeDict.md b/docs/v2/Core/models/FilterBooleanType.md similarity index 93% rename from docs/v2/Core/models/FilterBooleanTypeDict.md rename to docs/v2/Core/models/FilterBooleanType.md index 2ff116bc4..85bc53e12 100644 --- a/docs/v2/Core/models/FilterBooleanTypeDict.md +++ b/docs/v2/Core/models/FilterBooleanType.md @@ -1,4 +1,4 @@ -# FilterBooleanTypeDict +# FilterBooleanType FilterBooleanType diff --git a/docs/v2/Core/models/FilterDateTimeTypeDict.md b/docs/v2/Core/models/FilterDateTimeType.md similarity index 93% rename from docs/v2/Core/models/FilterDateTimeTypeDict.md rename to docs/v2/Core/models/FilterDateTimeType.md index f5aa1b298..243bc555b 100644 --- a/docs/v2/Core/models/FilterDateTimeTypeDict.md +++ b/docs/v2/Core/models/FilterDateTimeType.md @@ -1,4 +1,4 @@ -# FilterDateTimeTypeDict +# FilterDateTimeType FilterDateTimeType diff --git a/docs/v2/Core/models/FilterDateTypeDict.md b/docs/v2/Core/models/FilterDateType.md similarity index 94% rename from docs/v2/Core/models/FilterDateTypeDict.md rename to docs/v2/Core/models/FilterDateType.md index 1fc24a7ef..2f70f11ec 100644 --- a/docs/v2/Core/models/FilterDateTypeDict.md +++ b/docs/v2/Core/models/FilterDateType.md @@ -1,4 +1,4 @@ -# FilterDateTypeDict +# FilterDateType FilterDateType diff --git a/docs/v2/Core/models/FilterDoubleTypeDict.md b/docs/v2/Core/models/FilterDoubleType.md similarity index 93% rename from docs/v2/Core/models/FilterDoubleTypeDict.md rename to docs/v2/Core/models/FilterDoubleType.md index ee15805c1..b9a5e1430 100644 --- a/docs/v2/Core/models/FilterDoubleTypeDict.md +++ b/docs/v2/Core/models/FilterDoubleType.md @@ -1,4 +1,4 @@ -# FilterDoubleTypeDict +# FilterDoubleType FilterDoubleType diff --git a/docs/v2/Core/models/FilterEnumTypeDict.md b/docs/v2/Core/models/FilterEnumType.md similarity index 95% rename from docs/v2/Core/models/FilterEnumTypeDict.md rename to docs/v2/Core/models/FilterEnumType.md index daad294f6..e6632b883 100644 --- a/docs/v2/Core/models/FilterEnumTypeDict.md +++ b/docs/v2/Core/models/FilterEnumType.md @@ -1,4 +1,4 @@ -# FilterEnumTypeDict +# FilterEnumType FilterEnumType diff --git a/docs/v2/Core/models/FilterFloatTypeDict.md b/docs/v2/Core/models/FilterFloatType.md similarity index 93% rename from docs/v2/Core/models/FilterFloatTypeDict.md rename to docs/v2/Core/models/FilterFloatType.md index 25ab94dea..3bd1b4198 100644 --- a/docs/v2/Core/models/FilterFloatTypeDict.md +++ b/docs/v2/Core/models/FilterFloatType.md @@ -1,4 +1,4 @@ -# FilterFloatTypeDict +# FilterFloatType FilterFloatType diff --git a/docs/v2/Core/models/FilterIntegerTypeDict.md b/docs/v2/Core/models/FilterIntegerType.md similarity index 93% rename from docs/v2/Core/models/FilterIntegerTypeDict.md rename to docs/v2/Core/models/FilterIntegerType.md index 4a57c55ed..78d003958 100644 --- a/docs/v2/Core/models/FilterIntegerTypeDict.md +++ b/docs/v2/Core/models/FilterIntegerType.md @@ -1,4 +1,4 @@ -# FilterIntegerTypeDict +# FilterIntegerType FilterIntegerType diff --git a/docs/v2/Core/models/FilterLongTypeDict.md b/docs/v2/Core/models/FilterLongType.md similarity index 94% rename from docs/v2/Core/models/FilterLongTypeDict.md rename to docs/v2/Core/models/FilterLongType.md index 0dccfb886..f53e31dc3 100644 --- a/docs/v2/Core/models/FilterLongTypeDict.md +++ b/docs/v2/Core/models/FilterLongType.md @@ -1,4 +1,4 @@ -# FilterLongTypeDict +# FilterLongType FilterLongType diff --git a/docs/v2/Core/models/FilterRidTypeDict.md b/docs/v2/Core/models/FilterRidType.md similarity index 94% rename from docs/v2/Core/models/FilterRidTypeDict.md rename to docs/v2/Core/models/FilterRidType.md index 0d2198c37..c78967097 100644 --- a/docs/v2/Core/models/FilterRidTypeDict.md +++ b/docs/v2/Core/models/FilterRidType.md @@ -1,4 +1,4 @@ -# FilterRidTypeDict +# FilterRidType FilterRidType diff --git a/docs/v2/Core/models/FilterStringTypeDict.md b/docs/v2/Core/models/FilterStringType.md similarity index 93% rename from docs/v2/Core/models/FilterStringTypeDict.md rename to docs/v2/Core/models/FilterStringType.md index 4828df3dd..a99935b81 100644 --- a/docs/v2/Core/models/FilterStringTypeDict.md +++ b/docs/v2/Core/models/FilterStringType.md @@ -1,4 +1,4 @@ -# FilterStringTypeDict +# FilterStringType FilterStringType diff --git a/docs/v2/Admin/models/AuthenticationProtocolDict.md b/docs/v2/Core/models/FilterType.md similarity index 56% rename from docs/v2/Admin/models/AuthenticationProtocolDict.md rename to docs/v2/Core/models/FilterType.md index 90a70193c..821a2208d 100644 --- a/docs/v2/Admin/models/AuthenticationProtocolDict.md +++ b/docs/v2/Core/models/FilterType.md @@ -1,6 +1,6 @@ -# AuthenticationProtocolDict +# FilterType -AuthenticationProtocol +FilterType This is a discriminator type and does not contain any fields. Instead, it is a union of of the models listed below. @@ -9,8 +9,18 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- -SamlAuthenticationProtocolDict | saml -OidcAuthenticationProtocolDict | oidc +FilterDateTimeType | dateTime +FilterDateType | date +FilterBooleanType | boolean +FilterStringType | string +FilterDoubleType | double +FilterBinaryType | binary +FilterIntegerType | integer +FilterFloatType | float +FilterRidType | rid +FilterUuidType | uuid +FilterEnumType | enum +FilterLongType | long [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/FilterTypeDict.md b/docs/v2/Core/models/FilterTypeDict.md deleted file mode 100644 index c97ac802d..000000000 --- a/docs/v2/Core/models/FilterTypeDict.md +++ /dev/null @@ -1,26 +0,0 @@ -# FilterTypeDict - -FilterType - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -FilterDateTimeTypeDict | dateTime -FilterDateTypeDict | date -FilterBooleanTypeDict | boolean -FilterStringTypeDict | string -FilterDoubleTypeDict | double -FilterBinaryTypeDict | binary -FilterIntegerTypeDict | integer -FilterFloatTypeDict | float -FilterRidTypeDict | rid -FilterUuidTypeDict | uuid -FilterEnumTypeDict | enum -FilterLongTypeDict | long - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/FilterUuidTypeDict.md b/docs/v2/Core/models/FilterUuidType.md similarity index 94% rename from docs/v2/Core/models/FilterUuidTypeDict.md rename to docs/v2/Core/models/FilterUuidType.md index 4df50ba61..02570c40a 100644 --- a/docs/v2/Core/models/FilterUuidTypeDict.md +++ b/docs/v2/Core/models/FilterUuidType.md @@ -1,4 +1,4 @@ -# FilterUuidTypeDict +# FilterUuidType FilterUuidType diff --git a/docs/v2/Core/models/FloatTypeDict.md b/docs/v2/Core/models/FloatTypeDict.md deleted file mode 100644 index c01ab804c..000000000 --- a/docs/v2/Core/models/FloatTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# FloatTypeDict - -FloatType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["float"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/FoundryLiveDeploymentDict.md b/docs/v2/Core/models/FoundryLiveDeploymentDict.md deleted file mode 100644 index 4d9db3311..000000000 --- a/docs/v2/Core/models/FoundryLiveDeploymentDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# FoundryLiveDeploymentDict - -FoundryLiveDeployment - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | NotRequired[RID] | No | The live deployment identifier. This rid is of the format 'ri.foundry-ml-live.main.live-deployment.'. | -**inputParamName** | NotRequired[str] | No | The name of the input parameter to the model which should contain the query string. | -**outputParamName** | NotRequired[str] | No | The name of the output parameter to the model which should contain the computed embedding. | -**type** | Literal["foundryLiveDeployment"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/FullRowChangeDataCaptureConfigurationDict.md b/docs/v2/Core/models/FullRowChangeDataCaptureConfigurationDict.md deleted file mode 100644 index 801f79826..000000000 --- a/docs/v2/Core/models/FullRowChangeDataCaptureConfigurationDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# FullRowChangeDataCaptureConfigurationDict - -Configuration for change data capture which resolves the latest state of the dataset based on new full rows -being pushed to the stream. For example, if a value for a row is updated, it is only sufficient to publish -the entire new state of that row to the stream. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**deletionFieldName** | FieldName | Yes | The name of a boolean field in the schema that indicates whether or not a row has been deleted. | -**orderingFieldName** | FieldName | Yes | The name of an ordering field that determines the newest state for a row in the dataset. The ordering field can only be of the following types: - Byte - Date - Decimal - Integer - Long - Short - String - Timestamp | -**type** | Literal["fullRow"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/GeoPointTypeDict.md b/docs/v2/Core/models/GeoPointTypeDict.md deleted file mode 100644 index ffe9b04ea..000000000 --- a/docs/v2/Core/models/GeoPointTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GeoPointTypeDict - -GeoPointType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["geopoint"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/GeoShapeTypeDict.md b/docs/v2/Core/models/GeoShapeTypeDict.md deleted file mode 100644 index 5e906526f..000000000 --- a/docs/v2/Core/models/GeoShapeTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GeoShapeTypeDict - -GeoShapeType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["geoshape"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/GeotimeSeriesReferenceTypeDict.md b/docs/v2/Core/models/GeotimeSeriesReferenceTypeDict.md deleted file mode 100644 index fe44af3e8..000000000 --- a/docs/v2/Core/models/GeotimeSeriesReferenceTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GeotimeSeriesReferenceTypeDict - -GeotimeSeriesReferenceType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["geotimeSeriesReference"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/IntegerTypeDict.md b/docs/v2/Core/models/IntegerTypeDict.md deleted file mode 100644 index 2d0d02040..000000000 --- a/docs/v2/Core/models/IntegerTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# IntegerTypeDict - -IntegerType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["integer"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/LmsEmbeddingModelDict.md b/docs/v2/Core/models/LmsEmbeddingModelDict.md deleted file mode 100644 index dd88063c2..000000000 --- a/docs/v2/Core/models/LmsEmbeddingModelDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# LmsEmbeddingModelDict - -A model provided by Language Model Service. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | LmsEmbeddingModelValue | Yes | | -**type** | Literal["lms"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/LongTypeDict.md b/docs/v2/Core/models/LongTypeDict.md deleted file mode 100644 index dc34d6639..000000000 --- a/docs/v2/Core/models/LongTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# LongTypeDict - -LongType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["long"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/MapFieldTypeDict.md b/docs/v2/Core/models/MapFieldTypeDict.md deleted file mode 100644 index 51e0361fe..000000000 --- a/docs/v2/Core/models/MapFieldTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MapFieldTypeDict - -MapFieldType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keySchema** | FieldSchemaDict | Yes | | -**valueSchema** | FieldSchemaDict | Yes | | -**type** | Literal["map"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/MarkingTypeDict.md b/docs/v2/Core/models/MarkingTypeDict.md deleted file mode 100644 index 9b12a89b5..000000000 --- a/docs/v2/Core/models/MarkingTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# MarkingTypeDict - -MarkingType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["marking"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/MediaReferenceDict.md b/docs/v2/Core/models/MediaReferenceDict.md deleted file mode 100644 index aedea88a5..000000000 --- a/docs/v2/Core/models/MediaReferenceDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# MediaReferenceDict - -The representation of a media reference. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**mimeType** | MediaType | Yes | | -**reference** | ReferenceDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/MediaReferenceTypeDict.md b/docs/v2/Core/models/MediaReferenceTypeDict.md deleted file mode 100644 index c8efdd4b2..000000000 --- a/docs/v2/Core/models/MediaReferenceTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# MediaReferenceTypeDict - -MediaReferenceType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["mediaReference"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/MediaSetViewItemDict.md b/docs/v2/Core/models/MediaSetViewItemDict.md deleted file mode 100644 index fd5d1d367..000000000 --- a/docs/v2/Core/models/MediaSetViewItemDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# MediaSetViewItemDict - -MediaSetViewItem - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**mediaSetRid** | MediaSetRid | Yes | | -**mediaSetViewRid** | MediaSetViewRid | Yes | | -**mediaItemRid** | MediaItemRid | Yes | | -**token** | NotRequired[MediaItemReadToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/MediaSetViewItemWrapperDict.md b/docs/v2/Core/models/MediaSetViewItemWrapperDict.md deleted file mode 100644 index 906cb4211..000000000 --- a/docs/v2/Core/models/MediaSetViewItemWrapperDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# MediaSetViewItemWrapperDict - -MediaSetViewItemWrapper - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**mediaSetViewItem** | MediaSetViewItemDict | Yes | | -**type** | Literal["mediaSetViewItem"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/NullTypeDict.md b/docs/v2/Core/models/NullTypeDict.md deleted file mode 100644 index 0fe670332..000000000 --- a/docs/v2/Core/models/NullTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# NullTypeDict - -NullType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["null"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/ReferenceDict.md b/docs/v2/Core/models/ReferenceDict.md deleted file mode 100644 index e9fb63d90..000000000 --- a/docs/v2/Core/models/ReferenceDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReferenceDict - -A union of the types supported by media reference properties. - - -## Type -```python -MediaSetViewItemWrapperDict -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/ShortTypeDict.md b/docs/v2/Core/models/ShortTypeDict.md deleted file mode 100644 index 62a43bf64..000000000 --- a/docs/v2/Core/models/ShortTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ShortTypeDict - -ShortType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["short"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/StreamSchemaDict.md b/docs/v2/Core/models/StreamSchemaDict.md deleted file mode 100644 index 9abac6427..000000000 --- a/docs/v2/Core/models/StreamSchemaDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# StreamSchemaDict - -The schema for a Foundry stream. Records pushed to this stream must match this schema. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[FieldDict] | Yes | | -**keyFieldNames** | NotRequired[List[FieldName]] | No | The names of the fields to be used as keys for partitioning records. These key fields are used to group all records with the same key into the same partition, to guarantee processing order of grouped records. These keys are not meant to uniquely identify records, and do not by themselves deduplicate records. To deduplicate records, provide a change data capture configuration for the schema. Key fields can only be of the following types: - Boolean - Byte - Date - Decimal - Integer - Long - Short - String - Timestamp For additional information on keys for Foundry streams, see the [streaming keys](/docs/foundry/building-pipelines/streaming-keys/) user documentation. | -**changeDataCapture** | NotRequired[ChangeDataCaptureConfigurationDict] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/StringTypeDict.md b/docs/v2/Core/models/StringTypeDict.md deleted file mode 100644 index 7f55f6b1c..000000000 --- a/docs/v2/Core/models/StringTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# StringTypeDict - -StringType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["string"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/StructFieldTypeDict.md b/docs/v2/Core/models/StructFieldTypeDict.md deleted file mode 100644 index 2501fbd9f..000000000 --- a/docs/v2/Core/models/StructFieldTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# StructFieldTypeDict - -StructFieldType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subFields** | List[FieldDict] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/TimeSeriesItemTypeDict.md b/docs/v2/Core/models/TimeSeriesItemTypeDict.md deleted file mode 100644 index cd06de7f8..000000000 --- a/docs/v2/Core/models/TimeSeriesItemTypeDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# TimeSeriesItemTypeDict - -A union of the types supported by time series properties. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -StringTypeDict | string -DoubleTypeDict | double - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/TimeseriesTypeDict.md b/docs/v2/Core/models/TimeseriesTypeDict.md deleted file mode 100644 index edd36266b..000000000 --- a/docs/v2/Core/models/TimeseriesTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# TimeseriesTypeDict - -TimeseriesType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**itemType** | NotRequired[TimeSeriesItemTypeDict] | No | | -**type** | Literal["timeseries"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/TimestampTypeDict.md b/docs/v2/Core/models/TimestampTypeDict.md deleted file mode 100644 index 20ffd0afc..000000000 --- a/docs/v2/Core/models/TimestampTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# TimestampTypeDict - -TimestampType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["timestamp"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/UnsupportedTypeDict.md b/docs/v2/Core/models/UnsupportedTypeDict.md deleted file mode 100644 index 245033a31..000000000 --- a/docs/v2/Core/models/UnsupportedTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnsupportedTypeDict - -UnsupportedType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**unsupportedType** | str | Yes | | -**type** | Literal["unsupported"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/VectorSimilarityFunctionDict.md b/docs/v2/Core/models/VectorSimilarityFunctionDict.md deleted file mode 100644 index 794aa88c3..000000000 --- a/docs/v2/Core/models/VectorSimilarityFunctionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# VectorSimilarityFunctionDict - -The vector similarity function to support approximate nearest neighbors search. Will result in an index -specific for the function. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | NotRequired[VectorSimilarityFunctionValue] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/VectorTypeDict.md b/docs/v2/Core/models/VectorTypeDict.md deleted file mode 100644 index 8d6360c8b..000000000 --- a/docs/v2/Core/models/VectorTypeDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# VectorTypeDict - -Represents a fixed size vector of floats. These can be used for vector similarity searches. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**dimension** | int | Yes | The dimension of the vector. | -**supportsSearchWith** | List[VectorSimilarityFunctionDict] | Yes | | -**embeddingModel** | NotRequired[EmbeddingModelDict] | No | | -**type** | Literal["vector"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Datasets/Branch.md b/docs/v2/Datasets/Branch.md index 34ec25211..f1b20c8f5 100644 --- a/docs/v2/Datasets/Branch.md +++ b/docs/v2/Datasets/Branch.md @@ -6,7 +6,6 @@ Method | HTTP request | Release Stage | [**delete**](#delete) | **DELETE** /v2/datasets/{datasetRid}/branches/{branchName} | Stable | [**get**](#get) | **GET** /v2/datasets/{datasetRid}/branches/{branchName} | Stable | [**list**](#list) | **GET** /v2/datasets/{datasetRid}/branches | Stable | -[**page**](#page) | **GET** /v2/datasets/{datasetRid}/branches | Stable | # **create** Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. @@ -210,62 +209,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListBranchesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists the Branches of a Dataset. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | - -### Return type -**ListBranchesResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# DatasetRid -dataset_rid = None -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None - - -try: - api_response = foundry_client.datasets.Dataset.Branch.page( - dataset_rid, page_size=page_size, page_token=page_token - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Branch.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Datasets/File.md b/docs/v2/Datasets/File.md index c91586a64..4d41089c3 100644 --- a/docs/v2/Datasets/File.md +++ b/docs/v2/Datasets/File.md @@ -6,7 +6,6 @@ Method | HTTP request | Release Stage | [**delete**](#delete) | **DELETE** /v2/datasets/{datasetRid}/files/{filePath} | Stable | [**get**](#get) | **GET** /v2/datasets/{datasetRid}/files/{filePath} | Stable | [**list**](#list) | **GET** /v2/datasets/{datasetRid}/files | Stable | -[**page**](#page) | **GET** /v2/datasets/{datasetRid}/files | Stable | [**upload**](#upload) | **POST** /v2/datasets/{datasetRid}/files/{filePath}/upload | Stable | # **content** @@ -315,93 +314,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListFilesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists Files contained in a Dataset. By default files are listed on the latest view of the default -branch - `master` for most enrollments. -#### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. -To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most -recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the -branch if there are no snapshot transactions. -To **list files on the resolved view of a transaction** specify the Transaction's resource identifier -as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot -transaction, or the earliest ancestor transaction if there are no snapshot transactions. -To **list files on the resolved view of a range of transactions** specify the the start transaction's resource -identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This -will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. -Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when -the start and end transactions do not belong to the same root-to-leaf path. -To **list files on a specific transaction** specify the Transaction's resource identifier as both the -`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that -Transaction. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | | | -**branch_name** | Optional[BranchName] | The name of the Branch on which to list Files. Defaults to `master` for most enrollments. | [optional] | -**end_transaction_rid** | Optional[TransactionRid] | The Resource Identifier (RID) of the end Transaction. | [optional] | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**start_transaction_rid** | Optional[TransactionRid] | The Resource Identifier (RID) of the start Transaction. | [optional] | - -### Return type -**ListFilesResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# DatasetRid -dataset_rid = None -# Optional[BranchName] | The name of the Branch on which to list Files. Defaults to `master` for most enrollments. -branch_name = None -# Optional[TransactionRid] | The Resource Identifier (RID) of the end Transaction. -end_transaction_rid = None -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[TransactionRid] | The Resource Identifier (RID) of the start Transaction. -start_transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.File.page( - dataset_rid, - branch_name=branch_name, - end_transaction_rid=end_transaction_rid, - page_size=page_size, - page_token=page_token, - start_transaction_rid=start_transaction_rid, - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling File.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Datasets/models/BranchDict.md b/docs/v2/Datasets/models/BranchDict.md deleted file mode 100644 index e212b7bbc..000000000 --- a/docs/v2/Datasets/models/BranchDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# BranchDict - -Branch - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | BranchName | Yes | | -**transactionRid** | NotRequired[TransactionRid] | No | The most recent OPEN or COMMITTED transaction on the branch. This will never be an ABORTED transaction. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Datasets/models/DatasetDict.md b/docs/v2/Datasets/models/DatasetDict.md deleted file mode 100644 index b82426df9..000000000 --- a/docs/v2/Datasets/models/DatasetDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# DatasetDict - -Dataset - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | DatasetRid | Yes | | -**name** | DatasetName | Yes | | -**parentFolderRid** | FolderRid | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Datasets/models/FileDict.md b/docs/v2/Datasets/models/FileDict.md deleted file mode 100644 index 8822bf01f..000000000 --- a/docs/v2/Datasets/models/FileDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# FileDict - -File - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**path** | FilePath | Yes | | -**transactionRid** | TransactionRid | Yes | | -**sizeBytes** | NotRequired[Long] | No | | -**updatedTime** | FileUpdatedTime | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Datasets/models/ListBranchesResponseDict.md b/docs/v2/Datasets/models/ListBranchesResponseDict.md deleted file mode 100644 index 9ba7b278b..000000000 --- a/docs/v2/Datasets/models/ListBranchesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListBranchesResponseDict - -ListBranchesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[BranchDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Datasets/models/ListFilesResponseDict.md b/docs/v2/Datasets/models/ListFilesResponseDict.md deleted file mode 100644 index 21c4c8b3b..000000000 --- a/docs/v2/Datasets/models/ListFilesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListFilesResponseDict - -ListFilesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[FileDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Datasets/models/TransactionDict.md b/docs/v2/Datasets/models/TransactionDict.md deleted file mode 100644 index ed36a8719..000000000 --- a/docs/v2/Datasets/models/TransactionDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# TransactionDict - -Transaction - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | TransactionRid | Yes | | -**transactionType** | TransactionType | Yes | | -**status** | TransactionStatus | Yes | | -**createdTime** | TransactionCreatedTime | Yes | The timestamp when the transaction was created, in ISO 8601 timestamp format. | -**closedTime** | NotRequired[datetime] | No | The timestamp when the transaction was closed, in ISO 8601 timestamp format. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/Folder.md b/docs/v2/Filesystem/Folder.md index 65d5f68b1..b633e8193 100644 --- a/docs/v2/Filesystem/Folder.md +++ b/docs/v2/Filesystem/Folder.md @@ -3,7 +3,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**children**](#children) | **GET** /v2/filesystem/folders/{folderRid}/children | Public Beta | -[**children_page**](#children_page) | **GET** /v2/filesystem/folders/{folderRid}/children | Public Beta | [**create**](#create) | **POST** /v2/filesystem/folders | Public Beta | [**get**](#get) | **GET** /v2/filesystem/folders/{folderRid} | Public Beta | @@ -57,68 +56,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListChildrenOfFolderResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **children_page** -List all child Resources of the Folder. - -This is a paged endpoint. The page size will be limited to 2,000 results per page. If no page size is -provided, this page size will also be used as the default. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**folder_rid** | FolderRid | | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListChildrenOfFolderResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# FolderRid -folder_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8" -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.filesystem.Folder.children_page( - folder_rid, page_size=page_size, page_token=page_token, preview=preview - ) - print("The children_page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Folder.children_page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Filesystem/Project.md b/docs/v2/Filesystem/Project.md index cc63e33da..83c4af598 100644 --- a/docs/v2/Filesystem/Project.md +++ b/docs/v2/Filesystem/Project.md @@ -7,7 +7,6 @@ Method | HTTP request | Release Stage | [**create_from_template**](#create_from_template) | **POST** /v2/filesystem/projects/createFromTemplate | Private Beta | [**get**](#get) | **GET** /v2/filesystem/projects/{projectRid} | Public Beta | [**organizations**](#organizations) | **GET** /v2/filesystem/projects/{projectRid}/organizations | Public Beta | -[**organizations_page**](#organizations_page) | **GET** /v2/filesystem/projects/{projectRid}/organizations | Public Beta | [**remove_organizations**](#remove_organizations) | **POST** /v2/filesystem/projects/{projectRid}/removeOrganizations | Public Beta | # **add_organizations** @@ -80,7 +79,7 @@ Name | Type | Description | Notes | **default_roles** | List[RoleId] | | | **display_name** | ResourceDisplayName | | | **organization_rids** | List[OrganizationRid] | | | -**role_grants** | Dict[RoleId, List[Union[PrincipalWithId, PrincipalWithIdDict]]] | | | +**role_grants** | Dict[RoleId, List[PrincipalWithId]] | | | **space_rid** | SpaceRid | | | **description** | Optional[str] | | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -103,7 +102,7 @@ default_roles = ["8bf49052-dc37-4528-8bf0-b551cfb71268"] display_name = "My Important Project" # List[OrganizationRid] organization_rids = ["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"] -# Dict[RoleId, List[Union[PrincipalWithId, PrincipalWithIdDict]]] +# Dict[RoleId, List[PrincipalWithId]] role_grants = { "8bf49052-dc37-4528-8bf0-b551cfb71268": [ {"principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", "principalType": "USER"} @@ -314,66 +313,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListOrganizationsOfProjectResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **organizations_page** -List of Organizations directly applied to a Project. The number of Organizations on a Project is -typically small so the `pageSize` and `pageToken` parameters are not required. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**project_rid** | ProjectRid | | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListOrganizationsOfProjectResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ProjectRid -project_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8" -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.filesystem.Project.organizations_page( - project_rid, page_size=page_size, page_token=page_token, preview=preview - ) - print("The organizations_page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Project.organizations_page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Filesystem/Resource.md b/docs/v2/Filesystem/Resource.md index b7a85f716..f7df93a8a 100644 --- a/docs/v2/Filesystem/Resource.md +++ b/docs/v2/Filesystem/Resource.md @@ -8,7 +8,6 @@ Method | HTTP request | Release Stage | [**get_access_requirements**](#get_access_requirements) | **GET** /v2/filesystem/resources/{resourceRid}/getAccessRequirements | Public Beta | [**get_by_path**](#get_by_path) | **GET** /v2/filesystem/resources/getByPath | Public Beta | [**markings**](#markings) | **GET** /v2/filesystem/resources/{resourceRid}/markings | Public Beta | -[**markings_page**](#markings_page) | **GET** /v2/filesystem/resources/{resourceRid}/markings | Public Beta | [**permanently_delete**](#permanently_delete) | **POST** /v2/filesystem/resources/{resourceRid}/permanentlyDelete | Public Beta | [**remove_markings**](#remove_markings) | **POST** /v2/filesystem/resources/{resourceRid}/removeMarkings | Public Beta | [**restore**](#restore) | **POST** /v2/filesystem/resources/{resourceRid}/restore | Public Beta | @@ -322,66 +321,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListMarkingsOfResourceResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **markings_page** -List of Markings directly applied to a resource. The number of Markings on a resource is typically small -so the `pageSize` and `pageToken` parameters are not required. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**resource_rid** | ResourceRid | | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListMarkingsOfResourceResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ResourceRid -resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.filesystem.Resource.markings_page( - resource_rid, page_size=page_size, page_token=page_token, preview=preview - ) - print("The markings_page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Resource.markings_page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Filesystem/ResourceRole.md b/docs/v2/Filesystem/ResourceRole.md index fb2216e5d..928faace1 100644 --- a/docs/v2/Filesystem/ResourceRole.md +++ b/docs/v2/Filesystem/ResourceRole.md @@ -4,7 +4,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**add**](#add) | **POST** /v2/filesystem/resources/{resourceRid}/roles/add | Public Beta | [**list**](#list) | **GET** /v2/filesystem/resources/{resourceRid}/roles | Public Beta | -[**page**](#page) | **GET** /v2/filesystem/resources/{resourceRid}/roles | Public Beta | [**remove**](#remove) | **POST** /v2/filesystem/resources/{resourceRid}/roles/remove | Public Beta | # **add** @@ -15,7 +14,7 @@ Method | HTTP request | Release Stage | Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **resource_rid** | ResourceRid | | | -**roles** | List[Union[ResourceRole, ResourceRoleDict]] | | | +**roles** | List[ResourceRole] | | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -32,7 +31,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant # ResourceRid resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" -# List[Union[ResourceRole, ResourceRoleDict]] +# List[ResourceRole] roles = [{"roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268"}] # Optional[PreviewMode] | Enables the use of preview functionality. preview = None @@ -116,72 +115,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListResourceRolesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -List the roles on a resource. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**resource_rid** | ResourceRid | | | -**include_inherited** | Optional[bool] | Whether to include inherited roles on the resource. | [optional] | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListResourceRolesResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ResourceRid -resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" -# Optional[bool] | Whether to include inherited roles on the resource. -include_inherited = None -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.filesystem.Resource.Role.page( - resource_rid, - include_inherited=include_inherited, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Role.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) @@ -201,7 +134,7 @@ See [README](../../../README.md#authorization) Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **resource_rid** | ResourceRid | | | -**roles** | List[Union[ResourceRole, ResourceRoleDict]] | | | +**roles** | List[ResourceRole] | | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -218,7 +151,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant # ResourceRid resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" -# List[Union[ResourceRole, ResourceRoleDict]] +# List[ResourceRole] roles = [{"roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268"}] # Optional[PreviewMode] | Enables the use of preview functionality. preview = None diff --git a/docs/v2/Filesystem/Space.md b/docs/v2/Filesystem/Space.md index 4f50edb34..873a8a68a 100644 --- a/docs/v2/Filesystem/Space.md +++ b/docs/v2/Filesystem/Space.md @@ -3,7 +3,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**list**](#list) | **GET** /v2/filesystem/spaces | Public Beta | -[**page**](#page) | **GET** /v2/filesystem/spaces | Public Beta | # **list** Lists all Spaces. @@ -50,63 +49,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListSpacesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists all Spaces. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListSpacesResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.filesystem.Space.page( - page_size=page_size, page_token=page_token, preview=preview - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Space.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Filesystem/models/AccessRequirementsDict.md b/docs/v2/Filesystem/models/AccessRequirementsDict.md deleted file mode 100644 index 05e8074c2..000000000 --- a/docs/v2/Filesystem/models/AccessRequirementsDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AccessRequirementsDict - -Access requirements for a resource are composed of Markings and Organizations. Organizations are disjunctive, -while Markings are conjunctive. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**organizations** | List[OrganizationDict] | Yes | | -**markings** | List[MarkingDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/EveryoneDict.md b/docs/v2/Filesystem/models/EveryoneDict.md deleted file mode 100644 index 2b51e32b6..000000000 --- a/docs/v2/Filesystem/models/EveryoneDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# EveryoneDict - -A principal representing all users of the platform. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["everyone"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/FolderDict.md b/docs/v2/Filesystem/models/FolderDict.md deleted file mode 100644 index 102258b2c..000000000 --- a/docs/v2/Filesystem/models/FolderDict.md +++ /dev/null @@ -1,24 +0,0 @@ -# FolderDict - -Folder - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | FolderRid | Yes | | -**displayName** | ResourceDisplayName | Yes | | -**description** | NotRequired[str] | No | The description associated with the Folder. | -**documentation** | NotRequired[str] | No | The documentation associated with the Folder. | -**path** | ResourcePath | Yes | | -**type** | FolderType | Yes | | -**createdBy** | CreatedBy | Yes | | -**updatedBy** | UpdatedBy | Yes | | -**createdTime** | CreatedTime | Yes | | -**updatedTime** | UpdatedTime | Yes | | -**trashStatus** | TrashStatus | Yes | The trash status of the Folder. If trashed, this could either be because the Folder itself has been trashed or because one of its ancestors has been trashed. | -**parentFolderRid** | FolderRid | Yes | The parent folder Resource Identifier (RID). For Projects, this will be the Space RID and for Spaces, this value will be the root folder (`ri.compass.main.folder.0`). | -**projectRid** | NotRequired[ProjectRid] | No | The Project Resource Identifier (RID) that the Folder lives in. If the Folder is a Space, this value will not be defined. | -**spaceRid** | SpaceRid | Yes | The Space Resource Identifier (RID) that the Folder lives in. If the Folder is a Space, this value will be the same as the Folder RID. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/ListChildrenOfFolderResponseDict.md b/docs/v2/Filesystem/models/ListChildrenOfFolderResponseDict.md deleted file mode 100644 index d6a1bf942..000000000 --- a/docs/v2/Filesystem/models/ListChildrenOfFolderResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListChildrenOfFolderResponseDict - -ListChildrenOfFolderResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[ResourceDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/ListMarkingsOfResourceResponseDict.md b/docs/v2/Filesystem/models/ListMarkingsOfResourceResponseDict.md deleted file mode 100644 index d11baec99..000000000 --- a/docs/v2/Filesystem/models/ListMarkingsOfResourceResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListMarkingsOfResourceResponseDict - -ListMarkingsOfResourceResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[MarkingId] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/ListOrganizationsOfProjectResponseDict.md b/docs/v2/Filesystem/models/ListOrganizationsOfProjectResponseDict.md deleted file mode 100644 index 13a7eeabb..000000000 --- a/docs/v2/Filesystem/models/ListOrganizationsOfProjectResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListOrganizationsOfProjectResponseDict - -ListOrganizationsOfProjectResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OrganizationRid] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/ListResourceRolesResponseDict.md b/docs/v2/Filesystem/models/ListResourceRolesResponseDict.md deleted file mode 100644 index b5c36066e..000000000 --- a/docs/v2/Filesystem/models/ListResourceRolesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListResourceRolesResponseDict - -ListResourceRolesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[ResourceRoleDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/ListSpacesResponseDict.md b/docs/v2/Filesystem/models/ListSpacesResponseDict.md deleted file mode 100644 index 054c8a0a9..000000000 --- a/docs/v2/Filesystem/models/ListSpacesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListSpacesResponseDict - -ListSpacesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[SpaceDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/MarkingDict.md b/docs/v2/Filesystem/models/MarkingDict.md deleted file mode 100644 index 65e2f9f5b..000000000 --- a/docs/v2/Filesystem/models/MarkingDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# MarkingDict - -[Markings](/docs/foundry/security/markings/) provide an additional level of access control for files, -folders, and Projects within Foundry. Markings define eligibility criteria that restrict visibility -and actions to users who meet those criteria. To access a resource, a user must be a member of all -Markings applied to a resource to access it. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**markingId** | MarkingId | Yes | | -**isDirectlyApplied** | IsDirectlyApplied | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/OrganizationDict.md b/docs/v2/Filesystem/models/OrganizationDict.md deleted file mode 100644 index 13c0c14a2..000000000 --- a/docs/v2/Filesystem/models/OrganizationDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# OrganizationDict - -[Organizations](/docs/foundry/security/orgs-and-spaces/#organizations) are access requirements applied to -Projects that enforce strict silos between groups of users and resources. Every user is a member of only -one Organization, but can be a guest member of multiple Organizations. In order to meet access requirements, -users must be a member or guest member of at least one Organization applied to a Project. -Organizations are inherited via the file hierarchy and direct dependencies. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**markingId** | MarkingId | Yes | | -**organizationRid** | OrganizationRid | Yes | | -**isDirectlyApplied** | IsDirectlyApplied | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/PrincipalWithIdDict.md b/docs/v2/Filesystem/models/PrincipalWithIdDict.md deleted file mode 100644 index 8b9ac9145..000000000 --- a/docs/v2/Filesystem/models/PrincipalWithIdDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PrincipalWithIdDict - -Represents a user principal or group principal with an ID. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**principalId** | PrincipalId | Yes | | -**principalType** | PrincipalType | Yes | | -**type** | Literal["principalWithId"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/ProjectDict.md b/docs/v2/Filesystem/models/ProjectDict.md deleted file mode 100644 index 45943fedf..000000000 --- a/docs/v2/Filesystem/models/ProjectDict.md +++ /dev/null @@ -1,21 +0,0 @@ -# ProjectDict - -Project - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ProjectRid | Yes | | -**displayName** | ResourceDisplayName | Yes | The display name of the Project. Must be unique and cannot contain a / | -**description** | NotRequired[str] | No | The description associated with the Project. | -**documentation** | NotRequired[str] | No | The documentation associated with the Project. | -**path** | ResourcePath | Yes | | -**createdBy** | CreatedBy | Yes | | -**updatedBy** | UpdatedBy | Yes | | -**createdTime** | CreatedTime | Yes | | -**updatedTime** | UpdatedTime | Yes | | -**trashStatus** | TrashStatus | Yes | The trash status of the Project. | -**spaceRid** | SpaceRid | Yes | The Space Resource Identifier (RID) that the Project lives in. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/ResourceDict.md b/docs/v2/Filesystem/models/ResourceDict.md deleted file mode 100644 index de013f27b..000000000 --- a/docs/v2/Filesystem/models/ResourceDict.md +++ /dev/null @@ -1,24 +0,0 @@ -# ResourceDict - -Resource - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ResourceRid | Yes | | -**displayName** | ResourceDisplayName | Yes | The display name of the Resource | -**description** | NotRequired[str] | No | The description of the Resource | -**documentation** | NotRequired[str] | No | The documentation associated with the Resource | -**path** | ResourcePath | Yes | The full path to the resource, including the resource name itself | -**type** | ResourceType | Yes | The type of the Resource derived from the Resource Identifier (RID). | -**createdBy** | CreatedBy | Yes | The user that created the Resource. | -**updatedBy** | UpdatedBy | Yes | The user that last updated the Resource. | -**createdTime** | CreatedTime | Yes | The timestamp that the Resource was last created. | -**updatedTime** | UpdatedTime | Yes | The timestamp that the Resource was last modified. For folders, this includes any of its descendants. For top level folders (spaces and projects), this is not updated by child updates for performance reasons. | -**trashStatus** | TrashStatus | Yes | The trash status of the Resource. If trashed, this could either be because the Resource itself has been trashed or because one of its ancestors has been trashed. | -**parentFolderRid** | FolderRid | Yes | The parent folder Resource Identifier (RID). For projects, this will be the Space RID. | -**projectRid** | ProjectRid | Yes | The Project Resource Identifier (RID) that the Resource lives in. If the Resource itself is a Project, this value will still be populated with the Project RID. | -**spaceRid** | SpaceRid | Yes | The Space Resource Identifier (RID) that the Resource lives in. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/ResourceRoleDict.md b/docs/v2/Filesystem/models/ResourceRoleDict.md deleted file mode 100644 index 3c7440225..000000000 --- a/docs/v2/Filesystem/models/ResourceRoleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ResourceRoleDict - -ResourceRole - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**resourceRolePrincipal** | ResourceRolePrincipalDict | Yes | | -**roleId** | RoleId | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/ResourceRolePrincipalDict.md b/docs/v2/Filesystem/models/ResourceRolePrincipalDict.md deleted file mode 100644 index 9b8f6a7a7..000000000 --- a/docs/v2/Filesystem/models/ResourceRolePrincipalDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ResourceRolePrincipalDict - -ResourceRolePrincipal - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -PrincipalWithIdDict | principalWithId -EveryoneDict | everyone - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Filesystem/models/SpaceDict.md b/docs/v2/Filesystem/models/SpaceDict.md deleted file mode 100644 index 43ef27f64..000000000 --- a/docs/v2/Filesystem/models/SpaceDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# SpaceDict - -Space - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | SpaceRid | Yes | | -**displayName** | ResourceDisplayName | Yes | | -**description** | NotRequired[str] | No | The description of the Space. | -**path** | ResourcePath | Yes | | -**fileSystemId** | NotRequired[FileSystemId] | No | | -**usageAccountRid** | NotRequired[UsageAccountRid] | No | | -**organizations** | List[OrganizationRid] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ExecuteQueryResponseDict.md b/docs/v2/Functions/models/ExecuteQueryResponseDict.md deleted file mode 100644 index 15bb6b009..000000000 --- a/docs/v2/Functions/models/ExecuteQueryResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExecuteQueryResponseDict - -ExecuteQueryResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | DataValue | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ParameterDict.md b/docs/v2/Functions/models/ParameterDict.md deleted file mode 100644 index c8f03798e..000000000 --- a/docs/v2/Functions/models/ParameterDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterDict - -Details about a parameter of a query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[str] | No | | -**dataType** | QueryDataTypeDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/QueryAggregationKeyTypeDict.md b/docs/v2/Functions/models/QueryAggregationKeyTypeDict.md deleted file mode 100644 index c8def0b1c..000000000 --- a/docs/v2/Functions/models/QueryAggregationKeyTypeDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# QueryAggregationKeyTypeDict - -A union of all the types supported by query aggregation keys. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateTypeDict | date -BooleanTypeDict | boolean -StringTypeDict | string -DoubleTypeDict | double -QueryAggregationRangeTypeDict | range -IntegerTypeDict | integer -TimestampTypeDict | timestamp - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/QueryAggregationRangeSubTypeDict.md b/docs/v2/Functions/models/QueryAggregationRangeSubTypeDict.md deleted file mode 100644 index 6ccfc0559..000000000 --- a/docs/v2/Functions/models/QueryAggregationRangeSubTypeDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# QueryAggregationRangeSubTypeDict - -A union of all the types supported by query aggregation ranges. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateTypeDict | date -DoubleTypeDict | double -IntegerTypeDict | integer -TimestampTypeDict | timestamp - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/QueryAggregationRangeTypeDict.md b/docs/v2/Functions/models/QueryAggregationRangeTypeDict.md deleted file mode 100644 index 3d15c61b1..000000000 --- a/docs/v2/Functions/models/QueryAggregationRangeTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregationRangeTypeDict - -QueryAggregationRangeType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | QueryAggregationRangeSubTypeDict | Yes | | -**type** | Literal["range"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/QueryAggregationValueTypeDict.md b/docs/v2/Functions/models/QueryAggregationValueTypeDict.md deleted file mode 100644 index bbd2be4be..000000000 --- a/docs/v2/Functions/models/QueryAggregationValueTypeDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# QueryAggregationValueTypeDict - -A union of all the types supported by query aggregation keys. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateTypeDict | date -DoubleTypeDict | double -TimestampTypeDict | timestamp - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/QueryArrayTypeDict.md b/docs/v2/Functions/models/QueryArrayTypeDict.md deleted file mode 100644 index d1b016f83..000000000 --- a/docs/v2/Functions/models/QueryArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryArrayTypeDict - -QueryArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | QueryDataTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/QueryDataTypeDict.md b/docs/v2/Functions/models/QueryDataTypeDict.md deleted file mode 100644 index cc31cb60a..000000000 --- a/docs/v2/Functions/models/QueryDataTypeDict.md +++ /dev/null @@ -1,33 +0,0 @@ -# QueryDataTypeDict - -A union of all the types supported by Query parameters or outputs. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateTypeDict | date -QueryStructTypeDict | struct -QuerySetTypeDict | set -StringTypeDict | string -DoubleTypeDict | double -IntegerTypeDict | integer -ThreeDimensionalAggregationDict | threeDimensionalAggregation -QueryUnionTypeDict | union -FloatTypeDict | float -LongTypeDict | long -BooleanTypeDict | boolean -UnsupportedTypeDict | unsupported -AttachmentTypeDict | attachment -NullTypeDict | null -QueryArrayTypeDict | array -TwoDimensionalAggregationDict | twoDimensionalAggregation -ValueTypeReferenceDict | valueTypeReference -TimestampTypeDict | timestamp - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/QueryDict.md b/docs/v2/Functions/models/QueryDict.md deleted file mode 100644 index 006f27675..000000000 --- a/docs/v2/Functions/models/QueryDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# QueryDict - -Query - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | QueryApiName | Yes | | -**description** | NotRequired[str] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**parameters** | Dict[ParameterId, ParameterDict] | Yes | | -**output** | QueryDataTypeDict | Yes | | -**rid** | FunctionRid | Yes | | -**version** | FunctionVersion | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/QuerySetTypeDict.md b/docs/v2/Functions/models/QuerySetTypeDict.md deleted file mode 100644 index 7ee4cc50b..000000000 --- a/docs/v2/Functions/models/QuerySetTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QuerySetTypeDict - -QuerySetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | QueryDataTypeDict | Yes | | -**type** | Literal["set"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/QueryStructFieldDict.md b/docs/v2/Functions/models/QueryStructFieldDict.md deleted file mode 100644 index fa34f0687..000000000 --- a/docs/v2/Functions/models/QueryStructFieldDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryStructFieldDict - -QueryStructField - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StructFieldName | Yes | | -**fieldType** | QueryDataTypeDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/QueryStructTypeDict.md b/docs/v2/Functions/models/QueryStructTypeDict.md deleted file mode 100644 index eadd8ce13..000000000 --- a/docs/v2/Functions/models/QueryStructTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryStructTypeDict - -QueryStructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[QueryStructFieldDict] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/QueryUnionTypeDict.md b/docs/v2/Functions/models/QueryUnionTypeDict.md deleted file mode 100644 index 200ebb65a..000000000 --- a/docs/v2/Functions/models/QueryUnionTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryUnionTypeDict - -QueryUnionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**unionTypes** | List[QueryDataTypeDict] | Yes | | -**type** | Literal["union"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ThreeDimensionalAggregationDict.md b/docs/v2/Functions/models/ThreeDimensionalAggregationDict.md deleted file mode 100644 index bd9eab2b5..000000000 --- a/docs/v2/Functions/models/ThreeDimensionalAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ThreeDimensionalAggregationDict - -ThreeDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | QueryAggregationKeyTypeDict | Yes | | -**valueType** | TwoDimensionalAggregationDict | Yes | | -**type** | Literal["threeDimensionalAggregation"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/TwoDimensionalAggregationDict.md b/docs/v2/Functions/models/TwoDimensionalAggregationDict.md deleted file mode 100644 index 0bf09bf95..000000000 --- a/docs/v2/Functions/models/TwoDimensionalAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# TwoDimensionalAggregationDict - -TwoDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | QueryAggregationKeyTypeDict | Yes | | -**valueType** | QueryAggregationValueTypeDict | Yes | | -**type** | Literal["twoDimensionalAggregation"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeArrayTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeArrayTypeDict.md deleted file mode 100644 index d5f613cb3..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ValueTypeDataTypeArrayTypeDict - -ValueTypeDataTypeArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | ValueTypeDataTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeBinaryTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeBinaryTypeDict.md deleted file mode 100644 index 95c9fd664..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeBinaryTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValueTypeDataTypeBinaryTypeDict - -ValueTypeDataTypeBinaryType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["binary"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeBooleanTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeBooleanTypeDict.md deleted file mode 100644 index fb7fc1d3a..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeBooleanTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValueTypeDataTypeBooleanTypeDict - -ValueTypeDataTypeBooleanType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["boolean"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeByteTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeByteTypeDict.md deleted file mode 100644 index 245596149..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeByteTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValueTypeDataTypeByteTypeDict - -ValueTypeDataTypeByteType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["byte"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeDateTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeDateTypeDict.md deleted file mode 100644 index dd2b40275..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeDateTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValueTypeDataTypeDateTypeDict - -ValueTypeDataTypeDateType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["date"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeDecimalTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeDecimalTypeDict.md deleted file mode 100644 index 9c9ad2828..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeDecimalTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValueTypeDataTypeDecimalTypeDict - -ValueTypeDataTypeDecimalType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["decimal"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeDict.md deleted file mode 100644 index 646fe800d..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeDict.md +++ /dev/null @@ -1,33 +0,0 @@ -# ValueTypeDataTypeDict - -The underlying base type of a value type. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -ValueTypeDataTypeDateTypeDict | date -ValueTypeDataTypeStructTypeDict | struct -ValueTypeDataTypeStringTypeDict | string -ValueTypeDataTypeByteTypeDict | byte -ValueTypeDataTypeDoubleTypeDict | double -ValueTypeDataTypeOptionalTypeDict | optional -ValueTypeDataTypeIntegerTypeDict | integer -ValueTypeDataTypeUnionTypeDict | union -ValueTypeDataTypeFloatTypeDict | float -ValueTypeDataTypeLongTypeDict | long -ValueTypeDataTypeBooleanTypeDict | boolean -ValueTypeDataTypeArrayTypeDict | array -ValueTypeDataTypeBinaryTypeDict | binary -ValueTypeDataTypeValueTypeReferenceDict | valueTypeReference -ValueTypeDataTypeShortTypeDict | short -ValueTypeDataTypeDecimalTypeDict | decimal -ValueTypeDataTypeMapTypeDict | map -ValueTypeDataTypeTimestampTypeDict | timestamp - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeDoubleTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeDoubleTypeDict.md deleted file mode 100644 index f237f87a3..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeDoubleTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValueTypeDataTypeDoubleTypeDict - -ValueTypeDataTypeDoubleType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["double"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeFloatTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeFloatTypeDict.md deleted file mode 100644 index 315aace61..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeFloatTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValueTypeDataTypeFloatTypeDict - -ValueTypeDataTypeFloatType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["float"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeIntegerTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeIntegerTypeDict.md deleted file mode 100644 index 620cf65d0..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeIntegerTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValueTypeDataTypeIntegerTypeDict - -ValueTypeDataTypeIntegerType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["integer"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeLongTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeLongTypeDict.md deleted file mode 100644 index 6fe4895d2..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeLongTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValueTypeDataTypeLongTypeDict - -ValueTypeDataTypeLongType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["long"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeMapTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeMapTypeDict.md deleted file mode 100644 index 63d891983..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeMapTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ValueTypeDataTypeMapTypeDict - -ValueTypeDataTypeMapType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | ValueTypeDataTypeDict | Yes | | -**valueType** | ValueTypeDataTypeDict | Yes | | -**type** | Literal["map"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeOptionalTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeOptionalTypeDict.md deleted file mode 100644 index 6d57f3875..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeOptionalTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ValueTypeDataTypeOptionalTypeDict - -ValueTypeDataTypeOptionalType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**wrappedType** | ValueTypeDataTypeDict | Yes | | -**type** | Literal["optional"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeShortTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeShortTypeDict.md deleted file mode 100644 index cb6a55a24..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeShortTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValueTypeDataTypeShortTypeDict - -ValueTypeDataTypeShortType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["short"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeStringTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeStringTypeDict.md deleted file mode 100644 index 1d5188419..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeStringTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValueTypeDataTypeStringTypeDict - -ValueTypeDataTypeStringType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["string"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeStructElementDict.md b/docs/v2/Functions/models/ValueTypeDataTypeStructElementDict.md deleted file mode 100644 index 552e57a81..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeStructElementDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ValueTypeDataTypeStructElementDict - -ValueTypeDataTypeStructElement - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | ValueTypeDataTypeStructFieldIdentifier | Yes | | -**fieldType** | ValueTypeDataTypeDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeStructTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeStructTypeDict.md deleted file mode 100644 index 1ffd3ed0e..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeStructTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ValueTypeDataTypeStructTypeDict - -ValueTypeDataTypeStructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[ValueTypeDataTypeStructElementDict] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeTimestampTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeTimestampTypeDict.md deleted file mode 100644 index f9a00607d..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeTimestampTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValueTypeDataTypeTimestampTypeDict - -ValueTypeDataTypeTimestampType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["timestamp"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeUnionTypeDict.md b/docs/v2/Functions/models/ValueTypeDataTypeUnionTypeDict.md deleted file mode 100644 index efaff056a..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeUnionTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ValueTypeDataTypeUnionTypeDict - -ValueTypeDataTypeUnionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**memberTypes** | List[ValueTypeDataTypeDict] | Yes | | -**type** | Literal["union"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDataTypeValueTypeReferenceDict.md b/docs/v2/Functions/models/ValueTypeDataTypeValueTypeReferenceDict.md deleted file mode 100644 index 5cc5de65d..000000000 --- a/docs/v2/Functions/models/ValueTypeDataTypeValueTypeReferenceDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ValueTypeDataTypeValueTypeReferenceDict - -ValueTypeDataTypeValueTypeReference - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ValueTypeRid | Yes | | -**versionId** | ValueTypeVersionId | Yes | | -**type** | Literal["valueTypeReference"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeDict.md b/docs/v2/Functions/models/ValueTypeDict.md deleted file mode 100644 index 4cfddd6f4..000000000 --- a/docs/v2/Functions/models/ValueTypeDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ValueTypeDict - -ValueType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ValueTypeRid | Yes | | -**version** | ValueTypeVersion | Yes | | -**versionId** | ValueTypeVersionId | Yes | | -**apiName** | ValueTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | NotRequired[ValueTypeDescription] | No | | -**baseType** | NotRequired[ValueTypeDataTypeDict] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/ValueTypeReferenceDict.md b/docs/v2/Functions/models/ValueTypeReferenceDict.md deleted file mode 100644 index 688abb09c..000000000 --- a/docs/v2/Functions/models/ValueTypeReferenceDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ValueTypeReferenceDict - -A reference to a value type that has been registered in the Ontology. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ValueTypeRid | Yes | | -**versionId** | ValueTypeVersionId | Yes | | -**type** | Literal["valueTypeReference"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Functions/models/VersionIdDict.md b/docs/v2/Functions/models/VersionIdDict.md deleted file mode 100644 index 5f201e289..000000000 --- a/docs/v2/Functions/models/VersionIdDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# VersionIdDict - -VersionId - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ValueTypeRid | Yes | | -**version** | ValueTypeVersion | Yes | | -**versionId** | ValueTypeVersionId | Yes | | -**apiName** | ValueTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | NotRequired[ValueTypeDescription] | No | | -**baseType** | NotRequired[ValueTypeDataTypeDict] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Geo/models/FeatureCollectionDict.md b/docs/v2/Geo/models/FeatureCollectionDict.md deleted file mode 100644 index 15362ef6e..000000000 --- a/docs/v2/Geo/models/FeatureCollectionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# FeatureCollectionDict - -GeoJSon 'FeatureCollection' object - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**features** | List[FeatureCollectionTypesDict] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["FeatureCollection"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Geo/models/FeatureCollectionTypesDict.md b/docs/v2/Geo/models/FeatureCollectionTypesDict.md deleted file mode 100644 index 0a07623d9..000000000 --- a/docs/v2/Geo/models/FeatureCollectionTypesDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# FeatureCollectionTypesDict - -FeatureCollectionTypes - -## Type -```python -FeatureDict -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Geo/models/FeatureDict.md b/docs/v2/Geo/models/FeatureDict.md deleted file mode 100644 index ecc799a62..000000000 --- a/docs/v2/Geo/models/FeatureDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# FeatureDict - -GeoJSon 'Feature' object - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**geometry** | NotRequired[GeometryDict] | No | | -**properties** | Dict[FeaturePropertyKey, Any] | Yes | A `Feature` object has a member with the name "properties". The value of the properties member is an object (any JSON object or a JSON null value). | -**id** | NotRequired[Any] | No | If a `Feature` has a commonly used identifier, that identifier SHOULD be included as a member of the Feature object with the name "id", and the value of this member is either a JSON string or number. | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["Feature"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Geo/models/GeoPointDict.md b/docs/v2/Geo/models/GeoPointDict.md deleted file mode 100644 index 038830c9c..000000000 --- a/docs/v2/Geo/models/GeoPointDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GeoPointDict - -GeoPoint - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | Position | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["Point"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Geo/models/GeometryCollectionDict.md b/docs/v2/Geo/models/GeometryCollectionDict.md deleted file mode 100644 index a921390aa..000000000 --- a/docs/v2/Geo/models/GeometryCollectionDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# GeometryCollectionDict - -GeoJSon geometry collection - -GeometryCollections composed of a single part or a number of parts of a -single type SHOULD be avoided when that single part or a single object -of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could -be used instead. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**geometries** | List[GeometryDict] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["GeometryCollection"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Geo/models/GeometryDict.md b/docs/v2/Geo/models/GeometryDict.md deleted file mode 100644 index c59ca369d..000000000 --- a/docs/v2/Geo/models/GeometryDict.md +++ /dev/null @@ -1,21 +0,0 @@ -# GeometryDict - -Abstract type for all GeoJSon object except Feature and FeatureCollection - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -MultiPointDict | MultiPoint -GeometryCollectionDict | GeometryCollection -MultiLineStringDict | MultiLineString -LineStringDict | LineString -MultiPolygonDict | MultiPolygon -GeoPointDict | Point -PolygonDict | Polygon - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Geo/models/LineStringDict.md b/docs/v2/Geo/models/LineStringDict.md deleted file mode 100644 index 8549cf77a..000000000 --- a/docs/v2/Geo/models/LineStringDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LineStringDict - -LineString - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | NotRequired[LineStringCoordinates] | No | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["LineString"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Geo/models/MultiLineStringDict.md b/docs/v2/Geo/models/MultiLineStringDict.md deleted file mode 100644 index e96222ee4..000000000 --- a/docs/v2/Geo/models/MultiLineStringDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiLineStringDict - -MultiLineString - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[LineStringCoordinates] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["MultiLineString"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Geo/models/MultiPointDict.md b/docs/v2/Geo/models/MultiPointDict.md deleted file mode 100644 index f4d64463c..000000000 --- a/docs/v2/Geo/models/MultiPointDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiPointDict - -MultiPoint - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[Position] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["MultiPoint"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Geo/models/MultiPolygonDict.md b/docs/v2/Geo/models/MultiPolygonDict.md deleted file mode 100644 index f99f75f3e..000000000 --- a/docs/v2/Geo/models/MultiPolygonDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiPolygonDict - -MultiPolygon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[List[LinearRing]] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["MultiPolygon"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Geo/models/PolygonDict.md b/docs/v2/Geo/models/PolygonDict.md deleted file mode 100644 index a75c2513b..000000000 --- a/docs/v2/Geo/models/PolygonDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PolygonDict - -Polygon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[LinearRing] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["Polygon"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/MediaSets/models/GetMediaItemInfoResponseDict.md b/docs/v2/MediaSets/models/GetMediaItemInfoResponseDict.md deleted file mode 100644 index cf14c3896..000000000 --- a/docs/v2/MediaSets/models/GetMediaItemInfoResponseDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# GetMediaItemInfoResponseDict - -GetMediaItemInfoResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**viewRid** | MediaSetViewRid | Yes | | -**path** | NotRequired[MediaItemPath] | No | | -**logicalTimestamp** | LogicalTimestamp | Yes | | -**attribution** | NotRequired[MediaAttributionDict] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/MediaSets/models/MediaAttributionDict.md b/docs/v2/MediaSets/models/MediaAttributionDict.md deleted file mode 100644 index 7c67e113d..000000000 --- a/docs/v2/MediaSets/models/MediaAttributionDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# MediaAttributionDict - -MediaAttribution - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**creatorId** | UserId | Yes | | -**creationTimestamp** | datetime | Yes | The timestamp when the media item was created, in ISO 8601 timestamp format. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/MediaSets/models/PutMediaItemResponseDict.md b/docs/v2/MediaSets/models/PutMediaItemResponseDict.md deleted file mode 100644 index b0eef66b2..000000000 --- a/docs/v2/MediaSets/models/PutMediaItemResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# PutMediaItemResponseDict - -PutMediaItemResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**mediaItemRid** | MediaItemRid | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/Action.md b/docs/v2/Ontologies/Action.md index de9ae6104..2e041ddf9 100644 --- a/docs/v2/Ontologies/Action.md +++ b/docs/v2/Ontologies/Action.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes | **action** | ActionTypeApiName | The API name of the action to apply. To find the API name for your action, use the **List action types** endpoint or check the **Ontology Manager**. | | **parameters** | Dict[ParameterId, Optional[DataValue]] | | | **artifact_repository** | Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. | [optional] | -**options** | Optional[Union[ApplyActionRequestOptions, ApplyActionRequestOptionsDict]] | | [optional] | +**options** | Optional[ApplyActionRequestOptions] | | [optional] | **package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | ### Return type @@ -48,7 +48,7 @@ action = "rename-employee" parameters = {"id": 80060, "newName": "Anna Smith-Doe"} # Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. artifact_repository = None -# Optional[Union[ApplyActionRequestOptions, ApplyActionRequestOptionsDict]] +# Optional[ApplyActionRequestOptions] options = None # Optional[SdkPackageName] | The package name of the generated SDK. package_name = None @@ -102,9 +102,9 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | **action** | ActionTypeApiName | The API name of the action to apply. To find the API name for your action, use the **List action types** endpoint or check the **Ontology Manager**. | | -**requests** | List[Union[BatchApplyActionRequestItem, BatchApplyActionRequestItemDict]] | | | +**requests** | List[BatchApplyActionRequestItem] | | | **artifact_repository** | Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. | [optional] | -**options** | Optional[Union[BatchApplyActionRequestOptions, BatchApplyActionRequestOptionsDict]] | | [optional] | +**options** | Optional[BatchApplyActionRequestOptions] | | [optional] | **package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | ### Return type @@ -123,14 +123,14 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant ontology = "palantir" # ActionTypeApiName | The API name of the action to apply. To find the API name for your action, use the **List action types** endpoint or check the **Ontology Manager**. action = "rename-employee" -# List[Union[BatchApplyActionRequestItem, BatchApplyActionRequestItemDict]] +# List[BatchApplyActionRequestItem] requests = [ {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}}, {"parameters": {"id": 80061, "newName": "Joe Bloggs"}}, ] # Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. artifact_repository = None -# Optional[Union[BatchApplyActionRequestOptions, BatchApplyActionRequestOptionsDict]] +# Optional[BatchApplyActionRequestOptions] options = None # Optional[SdkPackageName] | The package name of the generated SDK. package_name = None diff --git a/docs/v2/Ontologies/ActionType.md b/docs/v2/Ontologies/ActionType.md index 4583ebd8b..6081ece55 100644 --- a/docs/v2/Ontologies/ActionType.md +++ b/docs/v2/Ontologies/ActionType.md @@ -5,7 +5,6 @@ Method | HTTP request | Release Stage | [**get**](#get) | **GET** /v2/ontologies/{ontology}/actionTypes/{actionType} | Stable | [**get_by_rid**](#get_by_rid) | **GET** /v2/ontologies/{ontology}/actionTypes/byRid/{actionTypeRid} | Stable | [**list**](#list) | **GET** /v2/ontologies/{ontology}/actionTypes | Stable | -[**page**](#page) | **GET** /v2/ontologies/{ontology}/actionTypes | Stable | # **get** Gets a specific action type with the given API name. @@ -164,67 +163,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListActionTypesResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists the action types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | - -### Return type -**ListActionTypesResponseV2** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. -ontology = "palantir" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -page_size = None -# Optional[PageToken] -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.ActionType.page( - ontology, page_size=page_size, page_token=page_token - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling ActionType.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Ontologies/LinkedObject.md b/docs/v2/Ontologies/LinkedObject.md index 9df899100..032bbba5f 100644 --- a/docs/v2/Ontologies/LinkedObject.md +++ b/docs/v2/Ontologies/LinkedObject.md @@ -4,7 +4,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**get_linked_object**](#get_linked_object) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} | Stable | [**list_linked_objects**](#list_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} | Stable | -[**page_linked_objects**](#page_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} | Stable | # **get_linked_object** Get a specific linked object that originates from another object. @@ -184,110 +183,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListLinkedObjectsResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page_linked_objects** -Lists the linked objects for a specific object and the given link type. - -Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or -repeated objects in the response pages. - -For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects -are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - -Each page may be smaller or larger than the requested page size. However, it -is guaranteed that if there are more results available, at least one result will be present -in the response. - -Note that null value properties will not be returned. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | | -**primary_key** | PropertyValueEscapedString | The primary key of the object from which the links originate. To look up the expected primary key for your object type, use the `Get object type` endpoint or the **Ontology Manager**. | | -**link_type** | LinkTypeApiName | The API name of the link that exists between the object and the requested objects. To find the API name for your link type, check the **Ontology Manager**. | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. | [optional] | -**exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] | -**order_by** | Optional[OrderBy] | | [optional] | -**package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**select** | Optional[List[SelectedPropertyApiName]] | The properties of the object type that should be included in the response. Omit this parameter to get all the properties. | [optional] | - -### Return type -**ListLinkedObjectsResponseV2** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. -ontology = "palantir" -# ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. -object_type = "employee" -# PropertyValueEscapedString | The primary key of the object from which the links originate. To look up the expected primary key for your object type, use the `Get object type` endpoint or the **Ontology Manager**. -primary_key = 50030 -# LinkTypeApiName | The API name of the link that exists between the object and the requested objects. To find the API name for your link type, check the **Ontology Manager**. -link_type = "directReport" -# Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. -artifact_repository = None -# Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. -exclude_rid = None -# Optional[OrderBy] -order_by = None -# Optional[SdkPackageName] | The package name of the generated SDK. -package_name = None -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -page_size = None -# Optional[PageToken] -page_token = None -# Optional[List[SelectedPropertyApiName]] | The properties of the object type that should be included in the response. Omit this parameter to get all the properties. -select = None - - -try: - api_response = foundry_client.ontologies.LinkedObject.page_linked_objects( - ontology, - object_type, - primary_key, - link_type, - artifact_repository=artifact_repository, - exclude_rid=exclude_rid, - order_by=order_by, - package_name=package_name, - page_size=page_size, - page_token=page_token, - select=select, - ) - print("The page_linked_objects response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling LinkedObject.page_linked_objects: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Ontologies/ObjectType.md b/docs/v2/Ontologies/ObjectType.md index 7547ee772..1ebc39470 100644 --- a/docs/v2/Ontologies/ObjectType.md +++ b/docs/v2/Ontologies/ObjectType.md @@ -7,8 +7,6 @@ Method | HTTP request | Release Stage | [**get_outgoing_link_type**](#get_outgoing_link_type) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | Stable | [**list**](#list) | **GET** /v2/ontologies/{ontology}/objectTypes | Stable | [**list_outgoing_link_types**](#list_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | Stable | -[**page**](#page) | **GET** /v2/ontologies/{ontology}/objectTypes | Stable | -[**page_outgoing_link_types**](#page_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | Stable | # **get** Gets a specific object type with the given API name. @@ -291,130 +289,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListOutgoingLinkTypesResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists the object types for the given Ontology. - -Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are -more results available, at least one result will be present in the -response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | - -### Return type -**ListObjectTypesV2Response** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. -ontology = "palantir" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -page_size = None -# Optional[PageToken] -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.ObjectType.page( - ontology, page_size=page_size, page_token=page_token - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling ObjectType.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListObjectTypesV2Response | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page_outgoing_link_types** -List the outgoing links for an object type. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager** application. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | - -### Return type -**ListOutgoingLinkTypesResponseV2** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. -ontology = "palantir" -# ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager** application. -object_type = "Flight" -# Optional[PageSize] | The desired size of the page to be returned. -page_size = None -# Optional[PageToken] -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.ObjectType.page_outgoing_link_types( - ontology, object_type, page_size=page_size, page_token=page_token - ) - print("The page_outgoing_link_types response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling ObjectType.page_outgoing_link_types: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Ontologies/OntologyInterface.md b/docs/v2/Ontologies/OntologyInterface.md index 320c88f40..f6c41b9ee 100644 --- a/docs/v2/Ontologies/OntologyInterface.md +++ b/docs/v2/Ontologies/OntologyInterface.md @@ -5,7 +5,6 @@ Method | HTTP request | Release Stage | [**aggregate**](#aggregate) | **POST** /v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate | Private Beta | [**get**](#get) | **GET** /v2/ontologies/{ontology}/interfaceTypes/{interfaceType} | Public Beta | [**list**](#list) | **GET** /v2/ontologies/{ontology}/interfaceTypes | Public Beta | -[**page**](#page) | **GET** /v2/ontologies/{ontology}/interfaceTypes | Public Beta | [**search**](#search) | **POST** /v2/ontologies/{ontology}/interfaces/{interfaceType}/search | Private Beta | # **aggregate** @@ -30,11 +29,11 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | **interface_type** | InterfaceTypeApiName | The API name of the interface type. To find the API name, use the **List interface types** endpoint or check the **Ontology Manager**. | | -**aggregation** | List[Union[AggregationV2, AggregationV2Dict]] | | | -**group_by** | List[Union[AggregationGroupByV2, AggregationGroupByV2Dict]] | | | +**aggregation** | List[AggregationV2] | | | +**group_by** | List[AggregationGroupByV2] | | | **accuracy** | Optional[AggregationAccuracyRequest] | | [optional] | **preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | -**where** | Optional[Union[SearchJsonQueryV2, SearchJsonQueryV2Dict]] | | [optional] | +**where** | Optional[SearchJsonQueryV2] | | [optional] | ### Return type **AggregateObjectsResponseV2** @@ -52,12 +51,12 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant ontology = "palantir" # InterfaceTypeApiName | The API name of the interface type. To find the API name, use the **List interface types** endpoint or check the **Ontology Manager**. interface_type = "Employee" -# List[Union[AggregationV2, AggregationV2Dict]] +# List[AggregationV2] aggregation = [ {"type": "min", "field": "properties.tenure", "name": "min_tenure"}, {"type": "avg", "field": "properties.tenure", "name": "avg_tenure"}, ] -# List[Union[AggregationGroupByV2, AggregationGroupByV2Dict]] +# List[AggregationGroupByV2] group_by = [ { "field": "startDate", @@ -70,7 +69,7 @@ group_by = [ accuracy = None # Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. preview = None -# Optional[Union[SearchJsonQueryV2, SearchJsonQueryV2Dict]] +# Optional[SearchJsonQueryV2] where = {"type": "eq", "field": "name", "value": "john"} @@ -224,75 +223,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListInterfaceTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -:::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. -::: - -Lists the interface types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | - -### Return type -**ListInterfaceTypesResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. -ontology = "palantir" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -page_size = None -# Optional[PageToken] -page_token = None -# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. -preview = None - - -try: - api_response = foundry_client.ontologies.OntologyInterface.page( - ontology, page_size=page_size, page_token=page_token, preview=preview - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling OntologyInterface.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) @@ -354,11 +284,11 @@ Name | Type | Description | Notes | **other_interface_types** | List[InterfaceTypeApiName] | A list of interface type API names. Object types must implement all the mentioned interfaces in order to be included in the response. | | **selected_object_types** | List[ObjectTypeApiName] | A list of object type API names that should be included in the response. If non-empty, object types that are not mentioned will not be included in the response even if they implement the specified interface. Omit the parameter to include all object types. | | **selected_shared_property_types** | List[SharedPropertyTypeApiName] | A list of shared property type API names of the interface type that should be included in the response. Omit this parameter to include all properties of the interface type in the response. | | -**order_by** | Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] | | [optional] | +**order_by** | Optional[SearchOrderByV2] | | [optional] | **page_size** | Optional[PageSize] | | [optional] | **page_token** | Optional[PageToken] | | [optional] | **preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | -**where** | Optional[Union[SearchJsonQueryV2, SearchJsonQueryV2Dict]] | | [optional] | +**where** | Optional[SearchJsonQueryV2] | | [optional] | ### Return type **SearchObjectsResponseV2** @@ -386,7 +316,7 @@ other_interface_types = None selected_object_types = None # List[SharedPropertyTypeApiName] | A list of shared property type API names of the interface type that should be included in the response. Omit this parameter to include all properties of the interface type in the response. selected_shared_property_types = None -# Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] +# Optional[SearchOrderByV2] order_by = None # Optional[PageSize] page_size = None @@ -394,7 +324,7 @@ page_size = None page_token = None # Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. preview = None -# Optional[Union[SearchJsonQueryV2, SearchJsonQueryV2Dict]] +# Optional[SearchJsonQueryV2] where = None diff --git a/docs/v2/Ontologies/OntologyObject.md b/docs/v2/Ontologies/OntologyObject.md index 9c734eda4..8a4003b19 100644 --- a/docs/v2/Ontologies/OntologyObject.md +++ b/docs/v2/Ontologies/OntologyObject.md @@ -6,7 +6,6 @@ Method | HTTP request | Release Stage | [**count**](#count) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/count | Private Beta | [**get**](#get) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey} | Stable | [**list**](#list) | **GET** /v2/ontologies/{ontology}/objects/{objectType} | Stable | -[**page**](#page) | **GET** /v2/ontologies/{ontology}/objects/{objectType} | Stable | [**search**](#search) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/search | Stable | # **aggregate** @@ -21,12 +20,12 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | **object_type** | ObjectTypeApiName | The type of the object to aggregate on. | | -**aggregation** | List[Union[AggregationV2, AggregationV2Dict]] | | | -**group_by** | List[Union[AggregationGroupByV2, AggregationGroupByV2Dict]] | | | +**aggregation** | List[AggregationV2] | | | +**group_by** | List[AggregationGroupByV2] | | | **accuracy** | Optional[AggregationAccuracyRequest] | | [optional] | **artifact_repository** | Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. | [optional] | **package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | -**where** | Optional[Union[SearchJsonQueryV2, SearchJsonQueryV2Dict]] | | [optional] | +**where** | Optional[SearchJsonQueryV2] | | [optional] | ### Return type **AggregateObjectsResponseV2** @@ -44,12 +43,12 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant ontology = "palantir" # ObjectTypeApiName | The type of the object to aggregate on. object_type = "employee" -# List[Union[AggregationV2, AggregationV2Dict]] +# List[AggregationV2] aggregation = [ {"type": "min", "field": "properties.tenure", "name": "min_tenure"}, {"type": "avg", "field": "properties.tenure", "name": "avg_tenure"}, ] -# List[Union[AggregationGroupByV2, AggregationGroupByV2Dict]] +# List[AggregationGroupByV2] group_by = [ { "field": "startDate", @@ -64,7 +63,7 @@ accuracy = None artifact_repository = None # Optional[SdkPackageName] | The package name of the generated SDK. package_name = None -# Optional[Union[SearchJsonQueryV2, SearchJsonQueryV2Dict]] +# Optional[SearchJsonQueryV2] where = {"type": "eq", "field": "name", "value": "john"} @@ -320,102 +319,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListObjectsResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists the objects for the given Ontology and object type. - -Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or -repeated objects in the response pages. - -For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects -are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - -Each page may be smaller or larger than the requested page size. However, it -is guaranteed that if there are more results available, at least one result will be present -in the response. - -Note that null value properties will not be returned. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. | [optional] | -**exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] | -**order_by** | Optional[OrderBy] | | [optional] | -**package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | -**select** | Optional[List[SelectedPropertyApiName]] | The properties of the object type that should be included in the response. Omit this parameter to get all the properties. | [optional] | - -### Return type -**ListObjectsResponseV2** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. -ontology = "palantir" -# ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. -object_type = "employee" -# Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. -artifact_repository = None -# Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. -exclude_rid = None -# Optional[OrderBy] -order_by = None -# Optional[SdkPackageName] | The package name of the generated SDK. -package_name = None -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -page_size = None -# Optional[PageToken] -page_token = None -# Optional[List[SelectedPropertyApiName]] | The properties of the object type that should be included in the response. Omit this parameter to get all the properties. -select = None - - -try: - api_response = foundry_client.ontologies.OntologyObject.page( - ontology, - object_type, - artifact_repository=artifact_repository, - exclude_rid=exclude_rid, - order_by=order_by, - package_name=package_name, - page_size=page_size, - page_token=page_token, - select=select, - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling OntologyObject.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) @@ -464,11 +367,11 @@ Name | Type | Description | Notes | **select** | List[PropertyApiName] | The API names of the object type properties to include in the response. | | **artifact_repository** | Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. | [optional] | **exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] | -**order_by** | Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] | | [optional] | +**order_by** | Optional[SearchOrderByV2] | | [optional] | **package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | **page_size** | Optional[PageSize] | | [optional] | **page_token** | Optional[PageToken] | | [optional] | -**where** | Optional[Union[SearchJsonQueryV2, SearchJsonQueryV2Dict]] | | [optional] | +**where** | Optional[SearchJsonQueryV2] | | [optional] | ### Return type **SearchObjectsResponseV2** @@ -492,7 +395,7 @@ select = None artifact_repository = None # Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. exclude_rid = None -# Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] +# Optional[SearchOrderByV2] order_by = None # Optional[SdkPackageName] | The package name of the generated SDK. package_name = None @@ -500,7 +403,7 @@ package_name = None page_size = None # Optional[PageToken] page_token = None -# Optional[Union[SearchJsonQueryV2, SearchJsonQueryV2Dict]] +# Optional[SearchJsonQueryV2] where = {"type": "eq", "field": "age", "value": 21} diff --git a/docs/v2/Ontologies/OntologyObjectSet.md b/docs/v2/Ontologies/OntologyObjectSet.md index 0ad813614..2a0b594d6 100644 --- a/docs/v2/Ontologies/OntologyObjectSet.md +++ b/docs/v2/Ontologies/OntologyObjectSet.md @@ -20,9 +20,9 @@ Third-party applications using this endpoint via OAuth2 must request the followi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**aggregation** | List[Union[AggregationV2, AggregationV2Dict]] | | | -**group_by** | List[Union[AggregationGroupByV2, AggregationGroupByV2Dict]] | | | -**object_set** | Union[ObjectSet, ObjectSetDict] | | | +**aggregation** | List[AggregationV2] | | | +**group_by** | List[AggregationGroupByV2] | | | +**object_set** | ObjectSet | | | **accuracy** | Optional[AggregationAccuracyRequest] | | [optional] | **artifact_repository** | Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. | [optional] | **package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | @@ -41,11 +41,11 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" -# List[Union[AggregationV2, AggregationV2Dict]] +# List[AggregationV2] aggregation = None -# List[Union[AggregationGroupByV2, AggregationGroupByV2Dict]] +# List[AggregationGroupByV2] group_by = None -# Union[ObjectSet, ObjectSetDict] +# ObjectSet object_set = None # Optional[AggregationAccuracyRequest] accuracy = None @@ -97,7 +97,7 @@ following operation scopes: `api:ontologies-read api:ontologies-write`. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**object_set** | Union[ObjectSet, ObjectSetDict] | | | +**object_set** | ObjectSet | | | ### Return type **CreateTemporaryObjectSetResponseV2** @@ -113,7 +113,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" -# Union[ObjectSet, ObjectSetDict] +# ObjectSet object_set = {"type": "base", "objectType": "Employee"} @@ -210,11 +210,11 @@ Third-party applications using this endpoint via OAuth2 must request the followi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**object_set** | Union[ObjectSet, ObjectSetDict] | | | +**object_set** | ObjectSet | | | **select** | List[SelectedPropertyApiName] | | | **artifact_repository** | Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. | [optional] | **exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] | -**order_by** | Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] | | [optional] | +**order_by** | Optional[SearchOrderByV2] | | [optional] | **package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | **page_size** | Optional[PageSize] | | [optional] | **page_token** | Optional[PageToken] | | [optional] | @@ -233,7 +233,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" -# Union[ObjectSet, ObjectSetDict] +# ObjectSet object_set = {"type": "base", "objectType": "Employee"} # List[SelectedPropertyApiName] select = None @@ -241,7 +241,7 @@ select = None artifact_repository = None # Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. exclude_rid = None -# Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] +# Optional[SearchOrderByV2] order_by = None # Optional[SdkPackageName] | The package name of the generated SDK. package_name = None @@ -304,11 +304,11 @@ Third-party applications using this endpoint via OAuth2 must request the followi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**object_set** | Union[ObjectSet, ObjectSetDict] | | | +**object_set** | ObjectSet | | | **select** | List[SelectedPropertyApiName] | | | **artifact_repository** | Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. | [optional] | **exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] | -**order_by** | Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] | | [optional] | +**order_by** | Optional[SearchOrderByV2] | | [optional] | **package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | **page_size** | Optional[PageSize] | | [optional] | **page_token** | Optional[PageToken] | | [optional] | @@ -328,7 +328,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" -# Union[ObjectSet, ObjectSetDict] +# ObjectSet object_set = {"type": "base", "objectType": "Employee"} # List[SelectedPropertyApiName] select = None @@ -336,7 +336,7 @@ select = None artifact_repository = None # Optional[bool] | A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. exclude_rid = None -# Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] +# Optional[SearchOrderByV2] order_by = None # Optional[SdkPackageName] | The package name of the generated SDK. package_name = None @@ -404,11 +404,11 @@ Third-party applications using this endpoint via OAuth2 must request the followi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**object_set** | Union[ObjectSet, ObjectSetDict] | | | +**object_set** | ObjectSet | | | **select** | List[SelectedPropertyApiName] | | | **artifact_repository** | Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. | [optional] | **exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] | -**order_by** | Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] | | [optional] | +**order_by** | Optional[SearchOrderByV2] | | [optional] | **package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | **page_size** | Optional[PageSize] | | [optional] | **page_token** | Optional[PageToken] | | [optional] | @@ -428,7 +428,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" -# Union[ObjectSet, ObjectSetDict] +# ObjectSet object_set = {"type": "base", "interfaceBase": "Person"} # List[SelectedPropertyApiName] select = None @@ -436,7 +436,7 @@ select = None artifact_repository = None # Optional[bool] | A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. exclude_rid = None -# Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] +# Optional[SearchOrderByV2] order_by = None # Optional[SdkPackageName] | The package name of the generated SDK. package_name = None diff --git a/docs/v2/Ontologies/QueryType.md b/docs/v2/Ontologies/QueryType.md index 8bac9b26d..e867292df 100644 --- a/docs/v2/Ontologies/QueryType.md +++ b/docs/v2/Ontologies/QueryType.md @@ -4,7 +4,6 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**get**](#get) | **GET** /v2/ontologies/{ontology}/queryTypes/{queryApiName} | Stable | [**list**](#list) | **GET** /v2/ontologies/{ontology}/queryTypes | Stable | -[**page**](#page) | **GET** /v2/ontologies/{ontology}/queryTypes | Stable | # **get** Gets a specific query type with the given API name. @@ -108,67 +107,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListQueryTypesResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists the query types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | -**page_token** | Optional[PageToken] | | [optional] | - -### Return type -**ListQueryTypesResponseV2** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. -ontology = "palantir" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -page_size = None -# Optional[PageToken] -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.QueryType.page( - ontology, page_size=page_size, page_token=page_token - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling QueryType.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Ontologies/TimeSeriesPropertyV2.md b/docs/v2/Ontologies/TimeSeriesPropertyV2.md index 5e37af566..9e14f857f 100644 --- a/docs/v2/Ontologies/TimeSeriesPropertyV2.md +++ b/docs/v2/Ontologies/TimeSeriesPropertyV2.md @@ -167,11 +167,11 @@ Name | Type | Description | Notes | **object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | | **primary_key** | PropertyValueEscapedString | The primary key of the object with the time series property. | | **property** | PropertyApiName | The API name of the time series property. To find the API name for your time series property, check the **Ontology Manager** or use the **Get object type** endpoint. | | -**aggregate** | Optional[Union[AggregateTimeSeries, AggregateTimeSeriesDict]] | | [optional] | +**aggregate** | Optional[AggregateTimeSeries] | | [optional] | **artifact_repository** | Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. | [optional] | **format** | Optional[StreamingOutputFormat] | The output format to serialize the output binary stream in. Default is JSON. ARROW is more efficient than JSON at streaming a large sized response. | [optional] | **package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | -**range** | Optional[Union[TimeRange, TimeRangeDict]] | | [optional] | +**range** | Optional[TimeRange] | | [optional] | ### Return type **bytes** @@ -193,7 +193,7 @@ object_type = "employee" primary_key = 50030 # PropertyApiName | The API name of the time series property. To find the API name for your time series property, check the **Ontology Manager** or use the **Get object type** endpoint. property = None -# Optional[Union[AggregateTimeSeries, AggregateTimeSeriesDict]] +# Optional[AggregateTimeSeries] aggregate = None # Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. artifact_repository = None @@ -201,7 +201,7 @@ artifact_repository = None format = None # Optional[SdkPackageName] | The package name of the generated SDK. package_name = None -# Optional[Union[TimeRange, TimeRangeDict]] +# Optional[TimeRange] range = { "type": "relative", "startTime": {"when": "BEFORE", "value": 5, "unit": "MONTHS"}, diff --git a/docs/v2/Ontologies/TimeSeriesValueBankProperty.md b/docs/v2/Ontologies/TimeSeriesValueBankProperty.md index 695360318..ef138c4c9 100644 --- a/docs/v2/Ontologies/TimeSeriesValueBankProperty.md +++ b/docs/v2/Ontologies/TimeSeriesValueBankProperty.md @@ -95,7 +95,7 @@ Name | Type | Description | Notes | **property** | PropertyApiName | The API name of the time series backed property. To find the API name, check the **Ontology Manager** or use the **Get object type** endpoint. | | **artifact_repository** | Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation. | [optional] | **package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | -**range** | Optional[Union[TimeRange, TimeRangeDict]] | | [optional] | +**range** | Optional[TimeRange] | | [optional] | ### Return type **bytes** @@ -121,7 +121,7 @@ property = None artifact_repository = None # Optional[SdkPackageName] | The package name of the generated SDK. package_name = None -# Optional[Union[TimeRange, TimeRangeDict]] +# Optional[TimeRange] range = { "type": "relative", "startTime": {"when": "BEFORE", "value": 5, "unit": "MONTHS"}, diff --git a/docs/v2/Ontologies/models/AbsoluteTimeRangeDict.md b/docs/v2/Ontologies/models/AbsoluteTimeRangeDict.md deleted file mode 100644 index 42ff6bb73..000000000 --- a/docs/v2/Ontologies/models/AbsoluteTimeRangeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AbsoluteTimeRangeDict - -ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**startTime** | NotRequired[datetime] | No | | -**endTime** | NotRequired[datetime] | No | | -**type** | Literal["absolute"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AbsoluteValuePropertyExpressionDict.md b/docs/v2/Ontologies/models/AbsoluteValuePropertyExpressionDict.md deleted file mode 100644 index df6379a06..000000000 --- a/docs/v2/Ontologies/models/AbsoluteValuePropertyExpressionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AbsoluteValuePropertyExpressionDict - -Calculates absolute value of a numeric value. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**property** | DerivedPropertyDefinitionDict | Yes | | -**type** | Literal["absoluteValue"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ActionParameterArrayTypeDict.md b/docs/v2/Ontologies/models/ActionParameterArrayTypeDict.md deleted file mode 100644 index bf295e339..000000000 --- a/docs/v2/Ontologies/models/ActionParameterArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ActionParameterArrayTypeDict - -ActionParameterArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | ActionParameterTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ActionParameterTypeDict.md b/docs/v2/Ontologies/models/ActionParameterTypeDict.md deleted file mode 100644 index 2f81ea5fc..000000000 --- a/docs/v2/Ontologies/models/ActionParameterTypeDict.md +++ /dev/null @@ -1,31 +0,0 @@ -# ActionParameterTypeDict - -A union of all the types supported by Ontology Action parameters. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateTypeDict | date -OntologyInterfaceObjectTypeDict | interfaceObject -OntologyStructTypeDict | struct -StringTypeDict | string -DoubleTypeDict | double -IntegerTypeDict | integer -LongTypeDict | long -OntologyObjectTypeReferenceTypeDict | objectType -BooleanTypeDict | boolean -MarkingTypeDict | marking -AttachmentTypeDict | attachment -MediaReferenceTypeDict | mediaReference -ActionParameterArrayTypeDict | array -OntologyObjectSetTypeDict | objectSet -OntologyObjectTypeDict | object -TimestampTypeDict | timestamp - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ActionParameterV2Dict.md b/docs/v2/Ontologies/models/ActionParameterV2Dict.md deleted file mode 100644 index cff6472a8..000000000 --- a/docs/v2/Ontologies/models/ActionParameterV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ActionParameterV2Dict - -Details about a parameter of an action. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**displayName** | DisplayName | Yes | | -**description** | NotRequired[str] | No | | -**dataType** | ActionParameterTypeDict | Yes | | -**required** | bool | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ActionResultsDict.md b/docs/v2/Ontologies/models/ActionResultsDict.md deleted file mode 100644 index e071b44b8..000000000 --- a/docs/v2/Ontologies/models/ActionResultsDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ActionResultsDict - -ActionResults - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -ObjectEditsDict | edits -ObjectTypeEditsDict | largeScaleEdits - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ActionTypeV2Dict.md b/docs/v2/Ontologies/models/ActionTypeV2Dict.md deleted file mode 100644 index 55fe745ff..000000000 --- a/docs/v2/Ontologies/models/ActionTypeV2Dict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ActionTypeV2Dict - -Represents an action type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ActionTypeApiName | Yes | | -**description** | NotRequired[str] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**parameters** | Dict[ParameterId, ActionParameterV2Dict] | Yes | | -**rid** | ActionTypeRid | Yes | | -**operations** | List[LogicRuleDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ActivePropertyTypeStatusDict.md b/docs/v2/Ontologies/models/ActivePropertyTypeStatusDict.md deleted file mode 100644 index b5d47c036..000000000 --- a/docs/v2/Ontologies/models/ActivePropertyTypeStatusDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ActivePropertyTypeStatusDict - -This status indicates that the PropertyType will not change on short notice and should thus be safe to use in -user facing workflows. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["active"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AddLinkDict.md b/docs/v2/Ontologies/models/AddLinkDict.md deleted file mode 100644 index a140a12ed..000000000 --- a/docs/v2/Ontologies/models/AddLinkDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# AddLinkDict - -AddLink - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | -**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | -**aSideObject** | LinkSideObjectDict | Yes | | -**bSideObject** | LinkSideObjectDict | Yes | | -**type** | Literal["addLink"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AddObjectDict.md b/docs/v2/Ontologies/models/AddObjectDict.md deleted file mode 100644 index 0ee3c43f1..000000000 --- a/docs/v2/Ontologies/models/AddObjectDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AddObjectDict - -AddObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primaryKey** | PropertyValue | Yes | | -**objectType** | ObjectTypeApiName | Yes | | -**type** | Literal["addObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AddPropertyExpressionDict.md b/docs/v2/Ontologies/models/AddPropertyExpressionDict.md deleted file mode 100644 index 2057c4eac..000000000 --- a/docs/v2/Ontologies/models/AddPropertyExpressionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AddPropertyExpressionDict - -Adds two or more numeric values. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | List[DerivedPropertyDefinitionDict] | Yes | | -**type** | Literal["add"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AggregateObjectsResponseItemV2Dict.md b/docs/v2/Ontologies/models/AggregateObjectsResponseItemV2Dict.md deleted file mode 100644 index 029ecff01..000000000 --- a/docs/v2/Ontologies/models/AggregateObjectsResponseItemV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregateObjectsResponseItemV2Dict - -AggregateObjectsResponseItemV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**group** | Dict[AggregationGroupKeyV2, AggregationGroupValueV2] | Yes | | -**metrics** | List[AggregationMetricResultV2Dict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AggregateObjectsResponseV2Dict.md b/docs/v2/Ontologies/models/AggregateObjectsResponseV2Dict.md deleted file mode 100644 index 19ba32eb1..000000000 --- a/docs/v2/Ontologies/models/AggregateObjectsResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsResponseV2Dict - -AggregateObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**excludedItems** | NotRequired[int] | No | | -**accuracy** | AggregationAccuracy | Yes | | -**data** | List[AggregateObjectsResponseItemV2Dict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AggregateTimeSeriesDict.md b/docs/v2/Ontologies/models/AggregateTimeSeriesDict.md deleted file mode 100644 index 6965f932d..000000000 --- a/docs/v2/Ontologies/models/AggregateTimeSeriesDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregateTimeSeriesDict - -AggregateTimeSeries - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**method** | TimeSeriesAggregationMethod | Yes | | -**strategy** | TimeSeriesAggregationStrategyDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AggregationDurationGroupingV2Dict.md b/docs/v2/Ontologies/models/AggregationDurationGroupingV2Dict.md deleted file mode 100644 index 27faa4794..000000000 --- a/docs/v2/Ontologies/models/AggregationDurationGroupingV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# AggregationDurationGroupingV2Dict - -Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. -When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | int | Yes | | -**unit** | TimeUnit | Yes | | -**type** | Literal["duration"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AggregationExactGroupingV2Dict.md b/docs/v2/Ontologies/models/AggregationExactGroupingV2Dict.md deleted file mode 100644 index 73c3d735e..000000000 --- a/docs/v2/Ontologies/models/AggregationExactGroupingV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregationExactGroupingV2Dict - -Divides objects into groups according to an exact value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**maxGroupCount** | NotRequired[int] | No | | -**defaultValue** | NotRequired[str] | No | | -**type** | Literal["exact"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AggregationFixedWidthGroupingV2Dict.md b/docs/v2/Ontologies/models/AggregationFixedWidthGroupingV2Dict.md deleted file mode 100644 index afc26fb08..000000000 --- a/docs/v2/Ontologies/models/AggregationFixedWidthGroupingV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationFixedWidthGroupingV2Dict - -Divides objects into groups with the specified width. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**fixedWidth** | int | Yes | | -**type** | Literal["fixedWidth"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AggregationGroupByV2Dict.md b/docs/v2/Ontologies/models/AggregationGroupByV2Dict.md deleted file mode 100644 index ebb43512b..000000000 --- a/docs/v2/Ontologies/models/AggregationGroupByV2Dict.md +++ /dev/null @@ -1,18 +0,0 @@ -# AggregationGroupByV2Dict - -Specifies a grouping for aggregation results. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -AggregationDurationGroupingV2Dict | duration -AggregationFixedWidthGroupingV2Dict | fixedWidth -AggregationRangesGroupingV2Dict | ranges -AggregationExactGroupingV2Dict | exact - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AggregationMetricResultV2Dict.md b/docs/v2/Ontologies/models/AggregationMetricResultV2Dict.md deleted file mode 100644 index 4477c66c0..000000000 --- a/docs/v2/Ontologies/models/AggregationMetricResultV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationMetricResultV2Dict - -AggregationMetricResultV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | str | Yes | | -**value** | NotRequired[Any] | No | The value of the metric. This will be a double in the case of a numeric metric, or a date string in the case of a date metric. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AggregationRangeV2Dict.md b/docs/v2/Ontologies/models/AggregationRangeV2Dict.md deleted file mode 100644 index 727324ab9..000000000 --- a/docs/v2/Ontologies/models/AggregationRangeV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationRangeV2Dict - -Specifies a range from an inclusive start value to an exclusive end value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**startValue** | Any | Yes | Inclusive start. | -**endValue** | Any | Yes | Exclusive end. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AggregationRangesGroupingV2Dict.md b/docs/v2/Ontologies/models/AggregationRangesGroupingV2Dict.md deleted file mode 100644 index 43f3603d0..000000000 --- a/docs/v2/Ontologies/models/AggregationRangesGroupingV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationRangesGroupingV2Dict - -Divides objects into groups according to specified ranges. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**ranges** | List[AggregationRangeV2Dict] | Yes | | -**type** | Literal["ranges"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AggregationV2Dict.md b/docs/v2/Ontologies/models/AggregationV2Dict.md deleted file mode 100644 index 26857b2ab..000000000 --- a/docs/v2/Ontologies/models/AggregationV2Dict.md +++ /dev/null @@ -1,22 +0,0 @@ -# AggregationV2Dict - -Specifies an aggregation function. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -ApproximateDistinctAggregationV2Dict | approximateDistinct -MinAggregationV2Dict | min -AvgAggregationV2Dict | avg -MaxAggregationV2Dict | max -ApproximatePercentileAggregationV2Dict | approximatePercentile -CountAggregationV2Dict | count -SumAggregationV2Dict | sum -ExactDistinctAggregationV2Dict | exactDistinct - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AndQueryV2Dict.md b/docs/v2/Ontologies/models/AndQueryV2Dict.md deleted file mode 100644 index e4c4f339c..000000000 --- a/docs/v2/Ontologies/models/AndQueryV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AndQueryV2Dict - -Returns objects where every query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryV2Dict] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ApplyActionRequestOptionsDict.md b/docs/v2/Ontologies/models/ApplyActionRequestOptionsDict.md deleted file mode 100644 index b5461fea4..000000000 --- a/docs/v2/Ontologies/models/ApplyActionRequestOptionsDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ApplyActionRequestOptionsDict - -ApplyActionRequestOptions - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**mode** | NotRequired[ApplyActionMode] | No | | -**returnEdits** | NotRequired[ReturnEditsMode] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ApproximateDistinctAggregationV2Dict.md b/docs/v2/Ontologies/models/ApproximateDistinctAggregationV2Dict.md deleted file mode 100644 index 1a1399690..000000000 --- a/docs/v2/Ontologies/models/ApproximateDistinctAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ApproximateDistinctAggregationV2Dict - -Computes an approximate number of distinct values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["approximateDistinct"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ApproximatePercentileAggregationV2Dict.md b/docs/v2/Ontologies/models/ApproximatePercentileAggregationV2Dict.md deleted file mode 100644 index 2febaace8..000000000 --- a/docs/v2/Ontologies/models/ApproximatePercentileAggregationV2Dict.md +++ /dev/null @@ -1,15 +0,0 @@ -# ApproximatePercentileAggregationV2Dict - -Computes the approximate percentile value for the provided field. Requires Object Storage V2. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**approximatePercentile** | float | Yes | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["approximatePercentile"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ArraySizeConstraintDict.md b/docs/v2/Ontologies/models/ArraySizeConstraintDict.md deleted file mode 100644 index e8286db29..000000000 --- a/docs/v2/Ontologies/models/ArraySizeConstraintDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ArraySizeConstraintDict - -The parameter expects an array of values and the size of the array must fall within the defined range. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Less than | -**lte** | NotRequired[Any] | No | Less than or equal | -**gt** | NotRequired[Any] | No | Greater than | -**gte** | NotRequired[Any] | No | Greater than or equal | -**type** | Literal["arraySize"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AttachmentMetadataResponseDict.md b/docs/v2/Ontologies/models/AttachmentMetadataResponseDict.md deleted file mode 100644 index 6cd820073..000000000 --- a/docs/v2/Ontologies/models/AttachmentMetadataResponseDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# AttachmentMetadataResponseDict - -The attachment metadata response - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -AttachmentV2Dict | single -ListAttachmentsResponseV2Dict | multiple - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AttachmentV2Dict.md b/docs/v2/Ontologies/models/AttachmentV2Dict.md deleted file mode 100644 index 2c1402d42..000000000 --- a/docs/v2/Ontologies/models/AttachmentV2Dict.md +++ /dev/null @@ -1,15 +0,0 @@ -# AttachmentV2Dict - -The representation of an attachment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | -**filename** | Filename | Yes | | -**sizeBytes** | SizeBytes | Yes | | -**mediaType** | MediaType | Yes | | -**type** | Literal["single"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/AvgAggregationV2Dict.md b/docs/v2/Ontologies/models/AvgAggregationV2Dict.md deleted file mode 100644 index 659647d82..000000000 --- a/docs/v2/Ontologies/models/AvgAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AvgAggregationV2Dict - -Computes the average value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["avg"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/BatchActionObjectEditDict.md b/docs/v2/Ontologies/models/BatchActionObjectEditDict.md deleted file mode 100644 index a25055340..000000000 --- a/docs/v2/Ontologies/models/BatchActionObjectEditDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# BatchActionObjectEditDict - -BatchActionObjectEdit - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -ModifyObjectDict | modifyObject -AddObjectDict | addObject -AddLinkDict | addLink - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/BatchActionObjectEditsDict.md b/docs/v2/Ontologies/models/BatchActionObjectEditsDict.md deleted file mode 100644 index 08f0627ff..000000000 --- a/docs/v2/Ontologies/models/BatchActionObjectEditsDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# BatchActionObjectEditsDict - -BatchActionObjectEdits - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**edits** | List[BatchActionObjectEditDict] | Yes | | -**addedObjectCount** | int | Yes | | -**modifiedObjectsCount** | int | Yes | | -**deletedObjectsCount** | int | Yes | | -**addedLinksCount** | int | Yes | | -**deletedLinksCount** | int | Yes | | -**type** | Literal["edits"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/BatchActionResultsDict.md b/docs/v2/Ontologies/models/BatchActionResultsDict.md deleted file mode 100644 index c6d743364..000000000 --- a/docs/v2/Ontologies/models/BatchActionResultsDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# BatchActionResultsDict - -BatchActionResults - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -BatchActionObjectEditsDict | edits -ObjectTypeEditsDict | largeScaleEdits - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/BatchApplyActionRequestItemDict.md b/docs/v2/Ontologies/models/BatchApplyActionRequestItemDict.md deleted file mode 100644 index 7463d9359..000000000 --- a/docs/v2/Ontologies/models/BatchApplyActionRequestItemDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequestItemDict - -BatchApplyActionRequestItem - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/BatchApplyActionRequestOptionsDict.md b/docs/v2/Ontologies/models/BatchApplyActionRequestOptionsDict.md deleted file mode 100644 index 9249a88c0..000000000 --- a/docs/v2/Ontologies/models/BatchApplyActionRequestOptionsDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequestOptionsDict - -BatchApplyActionRequestOptions - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**returnEdits** | NotRequired[BatchReturnEditsMode] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/BatchApplyActionResponseV2Dict.md b/docs/v2/Ontologies/models/BatchApplyActionResponseV2Dict.md deleted file mode 100644 index 0b2980dea..000000000 --- a/docs/v2/Ontologies/models/BatchApplyActionResponseV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionResponseV2Dict - -BatchApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**edits** | NotRequired[BatchActionResultsDict] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/BlueprintIconDict.md b/docs/v2/Ontologies/models/BlueprintIconDict.md deleted file mode 100644 index cd1ca7e48..000000000 --- a/docs/v2/Ontologies/models/BlueprintIconDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# BlueprintIconDict - -BlueprintIcon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**color** | str | Yes | A hexadecimal color code. | -**name** | str | Yes | The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. Used to specify the Blueprint icon to represent the object type in a React app. | -**type** | Literal["blueprint"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/BoundingBoxValueDict.md b/docs/v2/Ontologies/models/BoundingBoxValueDict.md deleted file mode 100644 index 798b6dd2d..000000000 --- a/docs/v2/Ontologies/models/BoundingBoxValueDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# BoundingBoxValueDict - -The top left and bottom right coordinate points that make up the bounding box. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**topLeft** | WithinBoundingBoxPointDict | Yes | | -**bottomRight** | WithinBoundingBoxPointDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/CenterPointDict.md b/docs/v2/Ontologies/models/CenterPointDict.md deleted file mode 100644 index e03b9d25a..000000000 --- a/docs/v2/Ontologies/models/CenterPointDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# CenterPointDict - -The coordinate point to use as the center of the distance query. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**center** | CenterPointTypesDict | Yes | | -**distance** | DistanceDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/CenterPointTypesDict.md b/docs/v2/Ontologies/models/CenterPointTypesDict.md deleted file mode 100644 index 8e9957ba4..000000000 --- a/docs/v2/Ontologies/models/CenterPointTypesDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CenterPointTypesDict - -CenterPointTypes - -## Type -```python -GeoPointDict -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ContainsAllTermsInOrderPrefixLastTermDict.md b/docs/v2/Ontologies/models/ContainsAllTermsInOrderPrefixLastTermDict.md deleted file mode 100644 index ff788b2f9..000000000 --- a/docs/v2/Ontologies/models/ContainsAllTermsInOrderPrefixLastTermDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# ContainsAllTermsInOrderPrefixLastTermDict - -Returns objects where the specified field contains all of the terms in the order provided, -but they do have to be adjacent to each other. -The last term can be a partial prefix match. Allows you to specify a property to query on -by a variety of means. Either `field` or `propertyIdentifier` can be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | str | Yes | | -**type** | Literal["containsAllTermsInOrderPrefixLastTerm"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ContainsAllTermsInOrderQueryDict.md b/docs/v2/Ontologies/models/ContainsAllTermsInOrderQueryDict.md deleted file mode 100644 index ae86ca3f0..000000000 --- a/docs/v2/Ontologies/models/ContainsAllTermsInOrderQueryDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ContainsAllTermsInOrderQueryDict - -Returns objects where the specified field contains all of the terms in the order provided, -but they do have to be adjacent to each other. Allows you to specify a property to query on -by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | str | Yes | | -**type** | Literal["containsAllTermsInOrder"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ContainsAllTermsQueryDict.md b/docs/v2/Ontologies/models/ContainsAllTermsQueryDict.md deleted file mode 100644 index 128d5704f..000000000 --- a/docs/v2/Ontologies/models/ContainsAllTermsQueryDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# ContainsAllTermsQueryDict - -Returns objects where the specified field contains all of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on -by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | str | Yes | | -**fuzzy** | NotRequired[FuzzyV2] | No | | -**type** | Literal["containsAllTerms"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ContainsAnyTermQueryDict.md b/docs/v2/Ontologies/models/ContainsAnyTermQueryDict.md deleted file mode 100644 index 79f6c72d0..000000000 --- a/docs/v2/Ontologies/models/ContainsAnyTermQueryDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# ContainsAnyTermQueryDict - -Returns objects where the specified field contains any of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on -by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | str | Yes | | -**fuzzy** | NotRequired[FuzzyV2] | No | | -**type** | Literal["containsAnyTerm"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ContainsQueryV2Dict.md b/docs/v2/Ontologies/models/ContainsQueryV2Dict.md deleted file mode 100644 index 3ed2f6124..000000000 --- a/docs/v2/Ontologies/models/ContainsQueryV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ContainsQueryV2Dict - -Returns objects where the specified array contains a value. Allows you to specify a property to query on by a -variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | PropertyValue | Yes | | -**type** | Literal["contains"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/CountAggregationV2Dict.md b/docs/v2/Ontologies/models/CountAggregationV2Dict.md deleted file mode 100644 index 7c41407a3..000000000 --- a/docs/v2/Ontologies/models/CountAggregationV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# CountAggregationV2Dict - -Computes the total count of objects. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["count"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/CountObjectsResponseV2Dict.md b/docs/v2/Ontologies/models/CountObjectsResponseV2Dict.md deleted file mode 100644 index 3179d9dc1..000000000 --- a/docs/v2/Ontologies/models/CountObjectsResponseV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CountObjectsResponseV2Dict - -CountObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**count** | NotRequired[int] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/CreateInterfaceObjectRuleDict.md b/docs/v2/Ontologies/models/CreateInterfaceObjectRuleDict.md deleted file mode 100644 index 84d1c8258..000000000 --- a/docs/v2/Ontologies/models/CreateInterfaceObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateInterfaceObjectRuleDict - -CreateInterfaceObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | -**type** | Literal["createInterfaceObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/CreateLinkRuleDict.md b/docs/v2/Ontologies/models/CreateLinkRuleDict.md deleted file mode 100644 index 35d657225..000000000 --- a/docs/v2/Ontologies/models/CreateLinkRuleDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# CreateLinkRuleDict - -CreateLinkRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | -**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | -**aSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**bSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["createLink"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/CreateObjectRuleDict.md b/docs/v2/Ontologies/models/CreateObjectRuleDict.md deleted file mode 100644 index 81877aa63..000000000 --- a/docs/v2/Ontologies/models/CreateObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateObjectRuleDict - -CreateObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["createObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/CreateTemporaryObjectSetResponseV2Dict.md b/docs/v2/Ontologies/models/CreateTemporaryObjectSetResponseV2Dict.md deleted file mode 100644 index a7b25b3be..000000000 --- a/docs/v2/Ontologies/models/CreateTemporaryObjectSetResponseV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTemporaryObjectSetResponseV2Dict - -CreateTemporaryObjectSetResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSetRid** | ObjectSetRid | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/DeleteInterfaceObjectRuleDict.md b/docs/v2/Ontologies/models/DeleteInterfaceObjectRuleDict.md deleted file mode 100644 index 3757592b9..000000000 --- a/docs/v2/Ontologies/models/DeleteInterfaceObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# DeleteInterfaceObjectRuleDict - -DeleteInterfaceObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | -**type** | Literal["deleteInterfaceObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/DeleteLinkDict.md b/docs/v2/Ontologies/models/DeleteLinkDict.md deleted file mode 100644 index 53c66ec0c..000000000 --- a/docs/v2/Ontologies/models/DeleteLinkDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# DeleteLinkDict - -DeleteLink - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | -**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | -**aSideObject** | LinkSideObjectDict | Yes | | -**bSideObject** | LinkSideObjectDict | Yes | | -**type** | Literal["deleteLink"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/DeleteLinkRuleDict.md b/docs/v2/Ontologies/models/DeleteLinkRuleDict.md deleted file mode 100644 index c9b82b101..000000000 --- a/docs/v2/Ontologies/models/DeleteLinkRuleDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# DeleteLinkRuleDict - -DeleteLinkRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | -**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | -**aSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**bSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["deleteLink"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/DeleteObjectDict.md b/docs/v2/Ontologies/models/DeleteObjectDict.md deleted file mode 100644 index 86eeefa82..000000000 --- a/docs/v2/Ontologies/models/DeleteObjectDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# DeleteObjectDict - -DeleteObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primaryKey** | PropertyValue | Yes | | -**objectType** | ObjectTypeApiName | Yes | | -**type** | Literal["deleteObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/DeleteObjectRuleDict.md b/docs/v2/Ontologies/models/DeleteObjectRuleDict.md deleted file mode 100644 index 6fd00f1a8..000000000 --- a/docs/v2/Ontologies/models/DeleteObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# DeleteObjectRuleDict - -DeleteObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["deleteObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/DeprecatedPropertyTypeStatusDict.md b/docs/v2/Ontologies/models/DeprecatedPropertyTypeStatusDict.md deleted file mode 100644 index ba9677510..000000000 --- a/docs/v2/Ontologies/models/DeprecatedPropertyTypeStatusDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# DeprecatedPropertyTypeStatusDict - -This status indicates that the PropertyType is reaching the end of its life and will be removed as per the -deadline specified. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**message** | str | Yes | | -**deadline** | datetime | Yes | | -**replacedBy** | NotRequired[PropertyTypeRid] | No | | -**type** | Literal["deprecated"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/DerivedPropertyDefinitionDict.md b/docs/v2/Ontologies/models/DerivedPropertyDefinitionDict.md deleted file mode 100644 index 6762cd87b..000000000 --- a/docs/v2/Ontologies/models/DerivedPropertyDefinitionDict.md +++ /dev/null @@ -1,26 +0,0 @@ -# DerivedPropertyDefinitionDict - -Definition of a derived property. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -AddPropertyExpressionDict | add -AbsoluteValuePropertyExpressionDict | absoluteValue -ExtractPropertyExpressionDict | extract -SelectedPropertyExpressionDict | selection -NegatePropertyExpressionDict | negate -SubtractPropertyExpressionDict | subtract -PropertyApiNameSelectorDict | property -LeastPropertyExpressionDict | least -DividePropertyExpressionDict | divide -MultiplyPropertyExpressionDict | multiply -GreatestPropertyExpressionDict | greatest - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/DividePropertyExpressionDict.md b/docs/v2/Ontologies/models/DividePropertyExpressionDict.md deleted file mode 100644 index b23123669..000000000 --- a/docs/v2/Ontologies/models/DividePropertyExpressionDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# DividePropertyExpressionDict - -Divides the left numeric value by the right numeric value. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**left** | DerivedPropertyDefinitionDict | Yes | | -**right** | DerivedPropertyDefinitionDict | Yes | | -**type** | Literal["divide"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/DoesNotIntersectBoundingBoxQueryDict.md b/docs/v2/Ontologies/models/DoesNotIntersectBoundingBoxQueryDict.md deleted file mode 100644 index 7e1b07fdd..000000000 --- a/docs/v2/Ontologies/models/DoesNotIntersectBoundingBoxQueryDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# DoesNotIntersectBoundingBoxQueryDict - -Returns objects where the specified field does not intersect the bounding box provided. Allows you to specify a -property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not -both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | BoundingBoxValueDict | Yes | | -**type** | Literal["doesNotIntersectBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/DoesNotIntersectPolygonQueryDict.md b/docs/v2/Ontologies/models/DoesNotIntersectPolygonQueryDict.md deleted file mode 100644 index f57e74d41..000000000 --- a/docs/v2/Ontologies/models/DoesNotIntersectPolygonQueryDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# DoesNotIntersectPolygonQueryDict - -Returns objects where the specified field does not intersect the polygon provided. Allows you to specify a -property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not -both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | PolygonValueDict | Yes | | -**type** | Literal["doesNotIntersectPolygon"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/DoubleVectorDict.md b/docs/v2/Ontologies/models/DoubleVectorDict.md deleted file mode 100644 index e7ec8cb3f..000000000 --- a/docs/v2/Ontologies/models/DoubleVectorDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# DoubleVectorDict - -The vector to search with. The vector must be of the same dimension as the vectors stored in the provided -propertyIdentifier. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[float] | Yes | | -**type** | Literal["vector"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/EntrySetTypeDict.md b/docs/v2/Ontologies/models/EntrySetTypeDict.md deleted file mode 100644 index 353e4f74c..000000000 --- a/docs/v2/Ontologies/models/EntrySetTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# EntrySetTypeDict - -EntrySetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | QueryDataTypeDict | Yes | | -**valueType** | QueryDataTypeDict | Yes | | -**type** | Literal["entrySet"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/EqualsQueryV2Dict.md b/docs/v2/Ontologies/models/EqualsQueryV2Dict.md deleted file mode 100644 index 511106501..000000000 --- a/docs/v2/Ontologies/models/EqualsQueryV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# EqualsQueryV2Dict - -Returns objects where the specified field is equal to a value. Allows you to specify a property to query on -by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | PropertyValue | Yes | | -**type** | Literal["eq"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ExactDistinctAggregationV2Dict.md b/docs/v2/Ontologies/models/ExactDistinctAggregationV2Dict.md deleted file mode 100644 index 06956ab6a..000000000 --- a/docs/v2/Ontologies/models/ExactDistinctAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ExactDistinctAggregationV2Dict - -Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["exactDistinct"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ExamplePropertyTypeStatusDict.md b/docs/v2/Ontologies/models/ExamplePropertyTypeStatusDict.md deleted file mode 100644 index 1c2e41cab..000000000 --- a/docs/v2/Ontologies/models/ExamplePropertyTypeStatusDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ExamplePropertyTypeStatusDict - -This status indicates that the PropertyType is an example. It is backed by notional data that should not be -used for actual workflows, but can be used to test those workflows. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["example"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ExecuteQueryResponseDict.md b/docs/v2/Ontologies/models/ExecuteQueryResponseDict.md deleted file mode 100644 index 15bb6b009..000000000 --- a/docs/v2/Ontologies/models/ExecuteQueryResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExecuteQueryResponseDict - -ExecuteQueryResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | DataValue | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ExperimentalPropertyTypeStatusDict.md b/docs/v2/Ontologies/models/ExperimentalPropertyTypeStatusDict.md deleted file mode 100644 index b12012a38..000000000 --- a/docs/v2/Ontologies/models/ExperimentalPropertyTypeStatusDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExperimentalPropertyTypeStatusDict - -This status indicates that the PropertyType is in development. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["experimental"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ExtractPropertyExpressionDict.md b/docs/v2/Ontologies/models/ExtractPropertyExpressionDict.md deleted file mode 100644 index e7d311a03..000000000 --- a/docs/v2/Ontologies/models/ExtractPropertyExpressionDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ExtractPropertyExpressionDict - -Extracts the specified date part from a date or timestamp. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**property** | DerivedPropertyDefinitionDict | Yes | | -**part** | ExtractDatePart | Yes | | -**type** | Literal["extract"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/GetSelectedPropertyOperationDict.md b/docs/v2/Ontologies/models/GetSelectedPropertyOperationDict.md deleted file mode 100644 index 327a93b3e..000000000 --- a/docs/v2/Ontologies/models/GetSelectedPropertyOperationDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# GetSelectedPropertyOperationDict - -Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could -explode the cardinality. - -Use collectList or collectSet which will return a list of values in that case. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**selectedPropertyApiName** | PropertyApiName | Yes | | -**type** | Literal["get"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/GreatestPropertyExpressionDict.md b/docs/v2/Ontologies/models/GreatestPropertyExpressionDict.md deleted file mode 100644 index 8defa9bfe..000000000 --- a/docs/v2/Ontologies/models/GreatestPropertyExpressionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GreatestPropertyExpressionDict - -Finds greatest of two or more numeric, date or timestamp values. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | List[DerivedPropertyDefinitionDict] | Yes | | -**type** | Literal["greatest"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/GroupMemberConstraintDict.md b/docs/v2/Ontologies/models/GroupMemberConstraintDict.md deleted file mode 100644 index c2f0449b9..000000000 --- a/docs/v2/Ontologies/models/GroupMemberConstraintDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# GroupMemberConstraintDict - -The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["groupMember"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/GtQueryV2Dict.md b/docs/v2/Ontologies/models/GtQueryV2Dict.md deleted file mode 100644 index 318c9ebb1..000000000 --- a/docs/v2/Ontologies/models/GtQueryV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# GtQueryV2Dict - -Returns objects where the specified field is greater than a value. Allows you to specify a property to query on -by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | PropertyValue | Yes | | -**type** | Literal["gt"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/GteQueryV2Dict.md b/docs/v2/Ontologies/models/GteQueryV2Dict.md deleted file mode 100644 index 5edef5120..000000000 --- a/docs/v2/Ontologies/models/GteQueryV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# GteQueryV2Dict - -Returns objects where the specified field is greater than or equal to a value. Allows you to specify a property -to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | PropertyValue | Yes | | -**type** | Literal["gte"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/IconDict.md b/docs/v2/Ontologies/models/IconDict.md deleted file mode 100644 index 4614c427f..000000000 --- a/docs/v2/Ontologies/models/IconDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# IconDict - -A union currently only consisting of the BlueprintIcon (more icon types may be added in the future). - -## Type -```python -BlueprintIconDict -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/InQueryDict.md b/docs/v2/Ontologies/models/InQueryDict.md deleted file mode 100644 index c35aae982..000000000 --- a/docs/v2/Ontologies/models/InQueryDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# InQueryDict - -Returns objects where the specified field equals any of the provided values. Allows you to -specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, -but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | List[PropertyValue] | Yes | | -**type** | Literal["in"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/InterfaceLinkTypeDict.md b/docs/v2/Ontologies/models/InterfaceLinkTypeDict.md deleted file mode 100644 index 07c8dced8..000000000 --- a/docs/v2/Ontologies/models/InterfaceLinkTypeDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# InterfaceLinkTypeDict - -A link type constraint defined at the interface level where the implementation of the links is provided -by the implementing object types. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | InterfaceLinkTypeRid | Yes | | -**apiName** | InterfaceLinkTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | NotRequired[str] | No | The description of the interface link type. | -**linkedEntityApiName** | InterfaceLinkTypeLinkedEntityApiNameDict | Yes | | -**cardinality** | InterfaceLinkTypeCardinality | Yes | | -**required** | bool | Yes | Whether each implementing object type must declare at least one implementation of this link. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/InterfaceLinkTypeLinkedEntityApiNameDict.md b/docs/v2/Ontologies/models/InterfaceLinkTypeLinkedEntityApiNameDict.md deleted file mode 100644 index d6f5f81b1..000000000 --- a/docs/v2/Ontologies/models/InterfaceLinkTypeLinkedEntityApiNameDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# InterfaceLinkTypeLinkedEntityApiNameDict - -A reference to the linked entity. This can either be an object or an interface type. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -LinkedObjectTypeApiNameDict | objectTypeApiName -LinkedInterfaceTypeApiNameDict | interfaceTypeApiName - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/InterfaceSharedPropertyTypeDict.md b/docs/v2/Ontologies/models/InterfaceSharedPropertyTypeDict.md deleted file mode 100644 index 7511009fb..000000000 --- a/docs/v2/Ontologies/models/InterfaceSharedPropertyTypeDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# InterfaceSharedPropertyTypeDict - -A shared property type with an additional field to indicate whether the property must be included on every -object type that implements the interface, or whether it is optional. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | SharedPropertyTypeRid | Yes | | -**apiName** | SharedPropertyTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | NotRequired[str] | No | A short text that describes the SharedPropertyType. | -**dataType** | ObjectPropertyTypeDict | Yes | | -**required** | bool | Yes | Whether each implementing object type must declare an implementation for this property. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/InterfaceTypeDict.md b/docs/v2/Ontologies/models/InterfaceTypeDict.md deleted file mode 100644 index 3558cb52e..000000000 --- a/docs/v2/Ontologies/models/InterfaceTypeDict.md +++ /dev/null @@ -1,21 +0,0 @@ -# InterfaceTypeDict - -Represents an interface type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | InterfaceTypeRid | Yes | | -**apiName** | InterfaceTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | NotRequired[str] | No | The description of the interface. | -**properties** | Dict[SharedPropertyTypeApiName, InterfaceSharedPropertyTypeDict] | Yes | A map from a shared property type API name to the corresponding shared property type. The map describes the set of properties the interface has. A shared property type must be unique across all of the properties. | -**allProperties** | Dict[SharedPropertyTypeApiName, InterfaceSharedPropertyTypeDict] | Yes | A map from a shared property type API name to the corresponding shared property type. The map describes the set of properties the interface has, including properties from all directly and indirectly extended interfaces. | -**extendsInterfaces** | List[InterfaceTypeApiName] | Yes | A list of interface API names that this interface extends. An interface can extend other interfaces to inherit their properties. | -**allExtendsInterfaces** | List[InterfaceTypeApiName] | Yes | A list of interface API names that this interface extends, both directly and indirectly. | -**implementedByObjectTypes** | List[ObjectTypeApiName] | Yes | A list of object API names that implement this interface. | -**links** | Dict[InterfaceLinkTypeApiName, InterfaceLinkTypeDict] | Yes | A map from an interface link type API name to the corresponding interface link type. The map describes the set of link types the interface has. | -**allLinks** | Dict[InterfaceLinkTypeApiName, InterfaceLinkTypeDict] | Yes | A map from an interface link type API name to the corresponding interface link type. The map describes the set of link types the interface has, including links from all directly and indirectly extended interfaces. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/IntersectsBoundingBoxQueryDict.md b/docs/v2/Ontologies/models/IntersectsBoundingBoxQueryDict.md deleted file mode 100644 index d9faeb934..000000000 --- a/docs/v2/Ontologies/models/IntersectsBoundingBoxQueryDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# IntersectsBoundingBoxQueryDict - -Returns objects where the specified field intersects the bounding box provided. Allows you to specify a property -to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | BoundingBoxValueDict | Yes | | -**type** | Literal["intersectsBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/IntersectsPolygonQueryDict.md b/docs/v2/Ontologies/models/IntersectsPolygonQueryDict.md deleted file mode 100644 index 57505e4f0..000000000 --- a/docs/v2/Ontologies/models/IntersectsPolygonQueryDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# IntersectsPolygonQueryDict - -Returns objects where the specified field intersects the polygon provided. Allows you to specify a property to -query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | PolygonValueDict | Yes | | -**type** | Literal["intersectsPolygon"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/IsNullQueryV2Dict.md b/docs/v2/Ontologies/models/IsNullQueryV2Dict.md deleted file mode 100644 index 215f132ba..000000000 --- a/docs/v2/Ontologies/models/IsNullQueryV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# IsNullQueryV2Dict - -Returns objects based on the existence of the specified field. Allows you to specify a property to query on -by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | bool | Yes | | -**type** | Literal["isNull"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/LeastPropertyExpressionDict.md b/docs/v2/Ontologies/models/LeastPropertyExpressionDict.md deleted file mode 100644 index 79a11a193..000000000 --- a/docs/v2/Ontologies/models/LeastPropertyExpressionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LeastPropertyExpressionDict - -Finds least of two or more numeric, date or timestamp values. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | List[DerivedPropertyDefinitionDict] | Yes | | -**type** | Literal["least"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/LinkSideObjectDict.md b/docs/v2/Ontologies/models/LinkSideObjectDict.md deleted file mode 100644 index b25e11661..000000000 --- a/docs/v2/Ontologies/models/LinkSideObjectDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkSideObjectDict - -LinkSideObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primaryKey** | PropertyValue | Yes | | -**objectType** | ObjectTypeApiName | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/LinkTypeSideV2Dict.md b/docs/v2/Ontologies/models/LinkTypeSideV2Dict.md deleted file mode 100644 index c011b2664..000000000 --- a/docs/v2/Ontologies/models/LinkTypeSideV2Dict.md +++ /dev/null @@ -1,17 +0,0 @@ -# LinkTypeSideV2Dict - -LinkTypeSideV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | LinkTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**cardinality** | LinkTypeSideCardinality | Yes | | -**foreignKeyPropertyApiName** | NotRequired[PropertyApiName] | No | | -**linkTypeRid** | LinkTypeRid | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/LinkedInterfaceTypeApiNameDict.md b/docs/v2/Ontologies/models/LinkedInterfaceTypeApiNameDict.md deleted file mode 100644 index 1d91151b1..000000000 --- a/docs/v2/Ontologies/models/LinkedInterfaceTypeApiNameDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedInterfaceTypeApiNameDict - -A reference to the linked interface type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | InterfaceTypeApiName | Yes | | -**type** | Literal["interfaceTypeApiName"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/LinkedObjectTypeApiNameDict.md b/docs/v2/Ontologies/models/LinkedObjectTypeApiNameDict.md deleted file mode 100644 index 6adb8da76..000000000 --- a/docs/v2/Ontologies/models/LinkedObjectTypeApiNameDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedObjectTypeApiNameDict - -A reference to the linked object type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ObjectTypeApiName | Yes | | -**type** | Literal["objectTypeApiName"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ListActionTypesResponseV2Dict.md b/docs/v2/Ontologies/models/ListActionTypesResponseV2Dict.md deleted file mode 100644 index adf351f4b..000000000 --- a/docs/v2/Ontologies/models/ListActionTypesResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListActionTypesResponseV2Dict - -ListActionTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[ActionTypeV2Dict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ListAttachmentsResponseV2Dict.md b/docs/v2/Ontologies/models/ListAttachmentsResponseV2Dict.md deleted file mode 100644 index 51eee4802..000000000 --- a/docs/v2/Ontologies/models/ListAttachmentsResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListAttachmentsResponseV2Dict - -ListAttachmentsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[AttachmentV2Dict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | -**type** | Literal["multiple"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ListInterfaceTypesResponseDict.md b/docs/v2/Ontologies/models/ListInterfaceTypesResponseDict.md deleted file mode 100644 index 8ac71000b..000000000 --- a/docs/v2/Ontologies/models/ListInterfaceTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListInterfaceTypesResponseDict - -ListInterfaceTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[InterfaceTypeDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ListLinkedObjectsResponseV2Dict.md b/docs/v2/Ontologies/models/ListLinkedObjectsResponseV2Dict.md deleted file mode 100644 index d50feafb0..000000000 --- a/docs/v2/Ontologies/models/ListLinkedObjectsResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListLinkedObjectsResponseV2Dict - -ListLinkedObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ListObjectTypesV2ResponseDict.md b/docs/v2/Ontologies/models/ListObjectTypesV2ResponseDict.md deleted file mode 100644 index a5a4b6cc8..000000000 --- a/docs/v2/Ontologies/models/ListObjectTypesV2ResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListObjectTypesV2ResponseDict - -ListObjectTypesV2Response - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[ObjectTypeV2Dict] | Yes | The list of object types in the current page. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ListObjectsResponseV2Dict.md b/docs/v2/Ontologies/models/ListObjectsResponseV2Dict.md deleted file mode 100644 index c33fb6bad..000000000 --- a/docs/v2/Ontologies/models/ListObjectsResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListObjectsResponseV2Dict - -ListObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[OntologyObjectV2] | Yes | The list of objects in the current page. | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ListOntologiesV2ResponseDict.md b/docs/v2/Ontologies/models/ListOntologiesV2ResponseDict.md deleted file mode 100644 index abc2424f2..000000000 --- a/docs/v2/Ontologies/models/ListOntologiesV2ResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListOntologiesV2ResponseDict - -ListOntologiesV2Response - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyV2Dict] | Yes | The list of Ontologies the user has access to. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ListOutgoingLinkTypesResponseV2Dict.md b/docs/v2/Ontologies/models/ListOutgoingLinkTypesResponseV2Dict.md deleted file mode 100644 index a40a54ba1..000000000 --- a/docs/v2/Ontologies/models/ListOutgoingLinkTypesResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListOutgoingLinkTypesResponseV2Dict - -ListOutgoingLinkTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[LinkTypeSideV2Dict] | Yes | The list of link type sides in the current page. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ListQueryTypesResponseV2Dict.md b/docs/v2/Ontologies/models/ListQueryTypesResponseV2Dict.md deleted file mode 100644 index 830ec89c6..000000000 --- a/docs/v2/Ontologies/models/ListQueryTypesResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListQueryTypesResponseV2Dict - -ListQueryTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[QueryTypeV2Dict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/LoadObjectSetResponseV2Dict.md b/docs/v2/Ontologies/models/LoadObjectSetResponseV2Dict.md deleted file mode 100644 index 66c06b198..000000000 --- a/docs/v2/Ontologies/models/LoadObjectSetResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LoadObjectSetResponseV2Dict - -Represents the API response when loading an `ObjectSet`. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | The list of objects in the current Page. | -**nextPageToken** | NotRequired[PageToken] | No | | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponseDict.md b/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponseDict.md deleted file mode 100644 index 6fe0b3670..000000000 --- a/docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponseDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# LoadObjectSetV2MultipleObjectTypesResponseDict - -Represents the API response when loading an `ObjectSet`. An `interfaceToObjectTypeMappings` field is -optionally returned if the type scope of the returned object set includes any interfaces. The "type scope" -of an object set refers to whether objects contain all their properties (object-type type scope) or just the -properties that implement interface properties (interface type scope). There can be multiple type scopes in a -single object set- some objects may have all their properties and some may only have interface properties. - -The `interfaceToObjectTypeMappings` field contains mappings from `SharedPropertyTypeApiName`s on the interface(s) to -`PropertyApiName` for properties on the object(s). - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | The list of objects in the current page. | -**nextPageToken** | NotRequired[PageToken] | No | | -**totalCount** | TotalCount | Yes | | -**interfaceToObjectTypeMappings** | Dict[InterfaceTypeApiName, InterfaceToObjectTypeMappings] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesResponseDict.md b/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesResponseDict.md deleted file mode 100644 index 236cec0c1..000000000 --- a/docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesResponseDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# LoadObjectSetV2ObjectsOrInterfacesResponseDict - -Represents the API response when loading an `ObjectSet`. Objects in the returned set can either have properties -defined by an interface that the objects belong to or properties defined by the object type of the object. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | The list of objects in the current page. | -**nextPageToken** | NotRequired[PageToken] | No | | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/LogicRuleDict.md b/docs/v2/Ontologies/models/LogicRuleDict.md deleted file mode 100644 index b7c6ad345..000000000 --- a/docs/v2/Ontologies/models/LogicRuleDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# LogicRuleDict - -LogicRule - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DeleteInterfaceObjectRuleDict | deleteInterfaceObject -ModifyInterfaceObjectRuleDict | modifyInterfaceObject -ModifyObjectRuleDict | modifyObject -DeleteObjectRuleDict | deleteObject -CreateInterfaceObjectRuleDict | createInterfaceObject -DeleteLinkRuleDict | deleteLink -CreateObjectRuleDict | createObject -CreateLinkRuleDict | createLink - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/LtQueryV2Dict.md b/docs/v2/Ontologies/models/LtQueryV2Dict.md deleted file mode 100644 index 550a63207..000000000 --- a/docs/v2/Ontologies/models/LtQueryV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# LtQueryV2Dict - -Returns objects where the specified field is less than a value. Allows you to specify a property to query on -by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | PropertyValue | Yes | | -**type** | Literal["lt"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/LteQueryV2Dict.md b/docs/v2/Ontologies/models/LteQueryV2Dict.md deleted file mode 100644 index 50f16e88e..000000000 --- a/docs/v2/Ontologies/models/LteQueryV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# LteQueryV2Dict - -Returns objects where the specified field is less than or equal to a value. Allows you to specify a property to -query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | PropertyValue | Yes | | -**type** | Literal["lte"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/MaxAggregationV2Dict.md b/docs/v2/Ontologies/models/MaxAggregationV2Dict.md deleted file mode 100644 index b5063727b..000000000 --- a/docs/v2/Ontologies/models/MaxAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# MaxAggregationV2Dict - -Computes the maximum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["max"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/MediaMetadataDict.md b/docs/v2/Ontologies/models/MediaMetadataDict.md deleted file mode 100644 index 076f788a7..000000000 --- a/docs/v2/Ontologies/models/MediaMetadataDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MediaMetadataDict - -MediaMetadata - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**path** | NotRequired[MediaItemPath] | No | | -**sizeBytes** | SizeBytes | Yes | | -**mediaType** | MediaType | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/MethodObjectSetDict.md b/docs/v2/Ontologies/models/MethodObjectSetDict.md deleted file mode 100644 index da78dc322..000000000 --- a/docs/v2/Ontologies/models/MethodObjectSetDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# MethodObjectSetDict - -MethodObjectSet - -## Type -```python -ObjectSetDict -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/MinAggregationV2Dict.md b/docs/v2/Ontologies/models/MinAggregationV2Dict.md deleted file mode 100644 index c5485e619..000000000 --- a/docs/v2/Ontologies/models/MinAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# MinAggregationV2Dict - -Computes the minimum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["min"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ModifyInterfaceObjectRuleDict.md b/docs/v2/Ontologies/models/ModifyInterfaceObjectRuleDict.md deleted file mode 100644 index 3b5f50e36..000000000 --- a/docs/v2/Ontologies/models/ModifyInterfaceObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModifyInterfaceObjectRuleDict - -ModifyInterfaceObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | -**type** | Literal["modifyInterfaceObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ModifyObjectDict.md b/docs/v2/Ontologies/models/ModifyObjectDict.md deleted file mode 100644 index f126dbf56..000000000 --- a/docs/v2/Ontologies/models/ModifyObjectDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ModifyObjectDict - -ModifyObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primaryKey** | PropertyValue | Yes | | -**objectType** | ObjectTypeApiName | Yes | | -**type** | Literal["modifyObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ModifyObjectRuleDict.md b/docs/v2/Ontologies/models/ModifyObjectRuleDict.md deleted file mode 100644 index 21ef16ee3..000000000 --- a/docs/v2/Ontologies/models/ModifyObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModifyObjectRuleDict - -ModifyObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["modifyObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/MultiplyPropertyExpressionDict.md b/docs/v2/Ontologies/models/MultiplyPropertyExpressionDict.md deleted file mode 100644 index 3e67c87bd..000000000 --- a/docs/v2/Ontologies/models/MultiplyPropertyExpressionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiplyPropertyExpressionDict - -Multiplies two or more numeric values. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | List[DerivedPropertyDefinitionDict] | Yes | | -**type** | Literal["multiply"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/NearestNeighborsQueryDict.md b/docs/v2/Ontologies/models/NearestNeighborsQueryDict.md deleted file mode 100644 index 93047530e..000000000 --- a/docs/v2/Ontologies/models/NearestNeighborsQueryDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# NearestNeighborsQueryDict - -Queries support either a vector matching the embedding model defined on the property, or text that is -automatically embedded. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DoubleVectorDict | vector -NearestNeighborsQueryTextDict | text - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/NearestNeighborsQueryTextDict.md b/docs/v2/Ontologies/models/NearestNeighborsQueryTextDict.md deleted file mode 100644 index 49f5825b9..000000000 --- a/docs/v2/Ontologies/models/NearestNeighborsQueryTextDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# NearestNeighborsQueryTextDict - -Automatically embed the text in a vector using the embedding model configured for the given propertyIdentifier. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | str | Yes | | -**type** | Literal["text"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/NegatePropertyExpressionDict.md b/docs/v2/Ontologies/models/NegatePropertyExpressionDict.md deleted file mode 100644 index e9ef2ad02..000000000 --- a/docs/v2/Ontologies/models/NegatePropertyExpressionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# NegatePropertyExpressionDict - -Negates a numeric value. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**property** | DerivedPropertyDefinitionDict | Yes | | -**type** | Literal["negate"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/NotQueryV2Dict.md b/docs/v2/Ontologies/models/NotQueryV2Dict.md deleted file mode 100644 index cb3d1e7be..000000000 --- a/docs/v2/Ontologies/models/NotQueryV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# NotQueryV2Dict - -Returns objects where the query is not satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | SearchJsonQueryV2Dict | Yes | | -**type** | Literal["not"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectEditDict.md b/docs/v2/Ontologies/models/ObjectEditDict.md deleted file mode 100644 index 2d385d8a0..000000000 --- a/docs/v2/Ontologies/models/ObjectEditDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# ObjectEditDict - -ObjectEdit - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -ModifyObjectDict | modifyObject -DeleteObjectDict | deleteObject -AddObjectDict | addObject -DeleteLinkDict | deleteLink -AddLinkDict | addLink - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectEditsDict.md b/docs/v2/Ontologies/models/ObjectEditsDict.md deleted file mode 100644 index d31df6db6..000000000 --- a/docs/v2/Ontologies/models/ObjectEditsDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ObjectEditsDict - -ObjectEdits - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**edits** | List[ObjectEditDict] | Yes | | -**addedObjectCount** | int | Yes | | -**modifiedObjectsCount** | int | Yes | | -**deletedObjectsCount** | int | Yes | | -**addedLinksCount** | int | Yes | | -**deletedLinksCount** | int | Yes | | -**type** | Literal["edits"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectPropertyTypeDict.md b/docs/v2/Ontologies/models/ObjectPropertyTypeDict.md deleted file mode 100644 index bb3f804b2..000000000 --- a/docs/v2/Ontologies/models/ObjectPropertyTypeDict.md +++ /dev/null @@ -1,37 +0,0 @@ -# ObjectPropertyTypeDict - -A union of all the types supported by Ontology Object properties. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateTypeDict | date -StructTypeDict | struct -StringTypeDict | string -ByteTypeDict | byte -DoubleTypeDict | double -GeoPointTypeDict | geopoint -GeotimeSeriesReferenceTypeDict | geotimeSeriesReference -IntegerTypeDict | integer -FloatTypeDict | float -GeoShapeTypeDict | geoshape -LongTypeDict | long -BooleanTypeDict | boolean -CipherTextTypeDict | cipherText -MarkingTypeDict | marking -AttachmentTypeDict | attachment -MediaReferenceTypeDict | mediaReference -TimeseriesTypeDict | timeseries -OntologyObjectArrayTypeDict | array -ShortTypeDict | short -VectorTypeDict | vector -DecimalTypeDict | decimal -TimestampTypeDict | timestamp - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectPropertyValueConstraintDict.md b/docs/v2/Ontologies/models/ObjectPropertyValueConstraintDict.md deleted file mode 100644 index 951f17267..000000000 --- a/docs/v2/Ontologies/models/ObjectPropertyValueConstraintDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectPropertyValueConstraintDict - -The parameter value must be a property value of an object found within an object set. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["objectPropertyValue"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectQueryResultConstraintDict.md b/docs/v2/Ontologies/models/ObjectQueryResultConstraintDict.md deleted file mode 100644 index f905ff7bd..000000000 --- a/docs/v2/Ontologies/models/ObjectQueryResultConstraintDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectQueryResultConstraintDict - -The parameter value must be the primary key of an object found within an object set. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["objectQueryResult"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetAsBaseObjectTypesTypeDict.md b/docs/v2/Ontologies/models/ObjectSetAsBaseObjectTypesTypeDict.md deleted file mode 100644 index 93761a4c8..000000000 --- a/docs/v2/Ontologies/models/ObjectSetAsBaseObjectTypesTypeDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# ObjectSetAsBaseObjectTypesTypeDict - -Casts the objects in the object set to their base type and thus ensures objects are returned with all of their -properties in the resulting object set, not just the properties that implement interface properties. This is -currently unsupported and an exception will be thrown if used. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**type** | Literal["asBaseObjectTypes"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetAsTypeTypeDict.md b/docs/v2/Ontologies/models/ObjectSetAsTypeTypeDict.md deleted file mode 100644 index 802cc47cf..000000000 --- a/docs/v2/Ontologies/models/ObjectSetAsTypeTypeDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ObjectSetAsTypeTypeDict - -Casts an object set to a specified object type or interface type API name. Any object whose object type does -not match the object type provided or implement the interface type provided will be dropped from the resulting -object set. This is currently unsupported and an exception will be thrown if used. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**entityType** | str | Yes | An object type or interface type API name. | -**objectSet** | ObjectSetDict | Yes | | -**type** | Literal["asType"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetBaseTypeDict.md b/docs/v2/Ontologies/models/ObjectSetBaseTypeDict.md deleted file mode 100644 index acde17a16..000000000 --- a/docs/v2/Ontologies/models/ObjectSetBaseTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetBaseTypeDict - -ObjectSetBaseType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectType** | str | Yes | The API name of the object type. | -**type** | Literal["base"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetDict.md b/docs/v2/Ontologies/models/ObjectSetDict.md deleted file mode 100644 index 082c33e58..000000000 --- a/docs/v2/Ontologies/models/ObjectSetDict.md +++ /dev/null @@ -1,28 +0,0 @@ -# ObjectSetDict - -Represents the definition of an `ObjectSet` in the `Ontology`. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -ObjectSetSearchAroundTypeDict | searchAround -ObjectSetStaticTypeDict | static -ObjectSetIntersectionTypeDict | intersect -ObjectSetWithPropertiesTypeDict | withProperties -ObjectSetSubtractTypeDict | subtract -ObjectSetNearestNeighborsTypeDict | nearestNeighbors -ObjectSetUnionTypeDict | union -ObjectSetAsTypeTypeDict | asType -ObjectSetMethodInputTypeDict | methodInput -ObjectSetReferenceTypeDict | reference -ObjectSetFilterTypeDict | filter -ObjectSetInterfaceBaseTypeDict | interfaceBase -ObjectSetAsBaseObjectTypesTypeDict | asBaseObjectTypes -ObjectSetBaseTypeDict | base - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetFilterTypeDict.md b/docs/v2/Ontologies/models/ObjectSetFilterTypeDict.md deleted file mode 100644 index 869c981ca..000000000 --- a/docs/v2/Ontologies/models/ObjectSetFilterTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetFilterTypeDict - -ObjectSetFilterType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**where** | SearchJsonQueryV2Dict | Yes | | -**type** | Literal["filter"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetInterfaceBaseTypeDict.md b/docs/v2/Ontologies/models/ObjectSetInterfaceBaseTypeDict.md deleted file mode 100644 index 9e39c19dc..000000000 --- a/docs/v2/Ontologies/models/ObjectSetInterfaceBaseTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetInterfaceBaseTypeDict - -ObjectSetInterfaceBaseType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**interfaceType** | str | Yes | An object set with objects that implement the interface with the given interface API name. The objects in the object set will only have properties that implement properties of the given interface, unless you set the includeAllBaseObjectProperties flag. | -**includeAllBaseObjectProperties** | NotRequired[bool] | No | A flag that will return all of the underlying object properties for the objects that implement the interface. This includes properties that don't explicitly implement an SPT on the interface. | -**type** | Literal["interfaceBase"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetIntersectionTypeDict.md b/docs/v2/Ontologies/models/ObjectSetIntersectionTypeDict.md deleted file mode 100644 index daf2addc2..000000000 --- a/docs/v2/Ontologies/models/ObjectSetIntersectionTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetIntersectionTypeDict - -ObjectSetIntersectionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSets** | List[ObjectSetDict] | Yes | | -**type** | Literal["intersect"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetMethodInputTypeDict.md b/docs/v2/Ontologies/models/ObjectSetMethodInputTypeDict.md deleted file mode 100644 index 34157f169..000000000 --- a/docs/v2/Ontologies/models/ObjectSetMethodInputTypeDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ObjectSetMethodInputTypeDict - -ObjectSet which is the root of a MethodObjectSet definition. - -This feature is experimental and not yet generally available. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["methodInput"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetNearestNeighborsTypeDict.md b/docs/v2/Ontologies/models/ObjectSetNearestNeighborsTypeDict.md deleted file mode 100644 index 626fb361a..000000000 --- a/docs/v2/Ontologies/models/ObjectSetNearestNeighborsTypeDict.md +++ /dev/null @@ -1,24 +0,0 @@ -# ObjectSetNearestNeighborsTypeDict - -ObjectSet containing the top `numNeighbors` objects with `propertyIdentifier` nearest to the input vector or -text. This can only be performed on a property with type vector that has been configured to be searched with -approximate nearest neighbors using a similarity function configured in the Ontology. - -A non-zero score for each resulting object is returned when the `orderType` in the `orderBy` field is set to -`relevance`. Note that: - - Scores will not be returned if a nearestNeighbors object set is composed through union, subtraction - or intersection with non-nearestNeighbors object sets. - - If results have scores, the order of the scores will be decreasing (duplicate scores are possible). - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**propertyIdentifier** | PropertyIdentifierDict | Yes | | -**numNeighbors** | int | Yes | The number of objects to return. If the number of documents in the objectType is less than the provided value, all objects will be returned. This value is limited to 1 <= numNeighbors <= 500. | -**query** | NearestNeighborsQueryDict | Yes | | -**type** | Literal["nearestNeighbors"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetReferenceTypeDict.md b/docs/v2/Ontologies/models/ObjectSetReferenceTypeDict.md deleted file mode 100644 index fc1dc24dc..000000000 --- a/docs/v2/Ontologies/models/ObjectSetReferenceTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetReferenceTypeDict - -ObjectSetReferenceType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**reference** | ObjectSetRid | Yes | | -**type** | Literal["reference"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetSearchAroundTypeDict.md b/docs/v2/Ontologies/models/ObjectSetSearchAroundTypeDict.md deleted file mode 100644 index 1979751d1..000000000 --- a/docs/v2/Ontologies/models/ObjectSetSearchAroundTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetSearchAroundTypeDict - -ObjectSetSearchAroundType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**link** | LinkTypeApiName | Yes | | -**type** | Literal["searchAround"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetStaticTypeDict.md b/docs/v2/Ontologies/models/ObjectSetStaticTypeDict.md deleted file mode 100644 index be2504f1d..000000000 --- a/docs/v2/Ontologies/models/ObjectSetStaticTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetStaticTypeDict - -ObjectSetStaticType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objects** | List[ObjectRid] | Yes | | -**type** | Literal["static"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetSubtractTypeDict.md b/docs/v2/Ontologies/models/ObjectSetSubtractTypeDict.md deleted file mode 100644 index c71859f00..000000000 --- a/docs/v2/Ontologies/models/ObjectSetSubtractTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetSubtractTypeDict - -ObjectSetSubtractType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSets** | List[ObjectSetDict] | Yes | | -**type** | Literal["subtract"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetUnionTypeDict.md b/docs/v2/Ontologies/models/ObjectSetUnionTypeDict.md deleted file mode 100644 index 5e374eabb..000000000 --- a/docs/v2/Ontologies/models/ObjectSetUnionTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetUnionTypeDict - -ObjectSetUnionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSets** | List[ObjectSetDict] | Yes | | -**type** | Literal["union"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectSetWithPropertiesTypeDict.md b/docs/v2/Ontologies/models/ObjectSetWithPropertiesTypeDict.md deleted file mode 100644 index 871b95d74..000000000 --- a/docs/v2/Ontologies/models/ObjectSetWithPropertiesTypeDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ObjectSetWithPropertiesTypeDict - -ObjectSet which returns objects with additional derived properties. - -This feature is experimental and not yet generally available. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**derivedProperties** | Dict[DerivedPropertyApiName, DerivedPropertyDefinitionDict] | Yes | Map of the name of the derived property to return and its definition | -**type** | Literal["withProperties"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectTypeEditsDict.md b/docs/v2/Ontologies/models/ObjectTypeEditsDict.md deleted file mode 100644 index b61ab57a4..000000000 --- a/docs/v2/Ontologies/models/ObjectTypeEditsDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectTypeEditsDict - -ObjectTypeEdits - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**editedObjectTypes** | List[ObjectTypeApiName] | Yes | | -**type** | Literal["largeScaleEdits"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectTypeFullMetadataDict.md b/docs/v2/Ontologies/models/ObjectTypeFullMetadataDict.md deleted file mode 100644 index a6f493804..000000000 --- a/docs/v2/Ontologies/models/ObjectTypeFullMetadataDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# ObjectTypeFullMetadataDict - -ObjectTypeFullMetadata - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectType** | ObjectTypeV2Dict | Yes | | -**linkTypes** | List[LinkTypeSideV2Dict] | Yes | | -**implementsInterfaces** | List[InterfaceTypeApiName] | Yes | A list of interfaces that this object type implements. | -**implementsInterfaces2** | Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementationDict] | Yes | A list of interfaces that this object type implements and how it implements them. | -**sharedPropertyTypeMapping** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | A map from shared property type API name to backing local property API name for the shared property types present on this object type. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectTypeInterfaceImplementationDict.md b/docs/v2/Ontologies/models/ObjectTypeInterfaceImplementationDict.md deleted file mode 100644 index f9752ca6a..000000000 --- a/docs/v2/Ontologies/models/ObjectTypeInterfaceImplementationDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ObjectTypeInterfaceImplementationDict - -ObjectTypeInterfaceImplementation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ObjectTypeV2Dict.md b/docs/v2/Ontologies/models/ObjectTypeV2Dict.md deleted file mode 100644 index bb6a0a044..000000000 --- a/docs/v2/Ontologies/models/ObjectTypeV2Dict.md +++ /dev/null @@ -1,21 +0,0 @@ -# ObjectTypeV2Dict - -Represents an object type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ObjectTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**description** | NotRequired[str] | No | The description of the object type. | -**pluralDisplayName** | str | Yes | The plural display name of the object type. | -**icon** | IconDict | Yes | | -**primaryKey** | PropertyApiName | Yes | | -**properties** | Dict[PropertyApiName, PropertyV2Dict] | Yes | A map of the properties of the object type. | -**rid** | ObjectTypeRid | Yes | | -**titleProperty** | PropertyApiName | Yes | | -**visibility** | NotRequired[ObjectTypeVisibility] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OneOfConstraintDict.md b/docs/v2/Ontologies/models/OneOfConstraintDict.md deleted file mode 100644 index 05770d26d..000000000 --- a/docs/v2/Ontologies/models/OneOfConstraintDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# OneOfConstraintDict - -The parameter has a manually predefined set of options. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | List[ParameterOptionDict] | Yes | | -**otherValuesAllowed** | bool | Yes | A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**. | -**type** | Literal["oneOf"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OntologyArrayTypeDict.md b/docs/v2/Ontologies/models/OntologyArrayTypeDict.md deleted file mode 100644 index fe7c7d5a5..000000000 --- a/docs/v2/Ontologies/models/OntologyArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyArrayTypeDict - -OntologyArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**itemType** | OntologyDataTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OntologyDataTypeDict.md b/docs/v2/Ontologies/models/OntologyDataTypeDict.md deleted file mode 100644 index fd25e8a56..000000000 --- a/docs/v2/Ontologies/models/OntologyDataTypeDict.md +++ /dev/null @@ -1,37 +0,0 @@ -# OntologyDataTypeDict - -A union of all the primitive types used by Palantir's Ontology-based products. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateTypeDict | date -OntologyStructTypeDict | struct -OntologySetTypeDict | set -StringTypeDict | string -ByteTypeDict | byte -DoubleTypeDict | double -IntegerTypeDict | integer -FloatTypeDict | float -AnyTypeDict | any -LongTypeDict | long -BooleanTypeDict | boolean -CipherTextTypeDict | cipherText -MarkingTypeDict | marking -UnsupportedTypeDict | unsupported -OntologyArrayTypeDict | array -OntologyObjectSetTypeDict | objectSet -BinaryTypeDict | binary -ShortTypeDict | short -DecimalTypeDict | decimal -OntologyMapTypeDict | map -TimestampTypeDict | timestamp -OntologyObjectTypeDict | object - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OntologyFullMetadataDict.md b/docs/v2/Ontologies/models/OntologyFullMetadataDict.md deleted file mode 100644 index 9fdc9059f..000000000 --- a/docs/v2/Ontologies/models/OntologyFullMetadataDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# OntologyFullMetadataDict - -OntologyFullMetadata - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**ontology** | OntologyV2Dict | Yes | | -**objectTypes** | Dict[ObjectTypeApiName, ObjectTypeFullMetadataDict] | Yes | | -**actionTypes** | Dict[ActionTypeApiName, ActionTypeV2Dict] | Yes | | -**queryTypes** | Dict[QueryApiName, QueryTypeV2Dict] | Yes | | -**interfaceTypes** | Dict[InterfaceTypeApiName, InterfaceTypeDict] | Yes | | -**sharedPropertyTypes** | Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OntologyInterfaceObjectTypeDict.md b/docs/v2/Ontologies/models/OntologyInterfaceObjectTypeDict.md deleted file mode 100644 index b1406305b..000000000 --- a/docs/v2/Ontologies/models/OntologyInterfaceObjectTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyInterfaceObjectTypeDict - -OntologyInterfaceObjectType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | -**type** | Literal["interfaceObject"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OntologyMapTypeDict.md b/docs/v2/Ontologies/models/OntologyMapTypeDict.md deleted file mode 100644 index c868fef50..000000000 --- a/docs/v2/Ontologies/models/OntologyMapTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyMapTypeDict - -OntologyMapType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | OntologyDataTypeDict | Yes | | -**valueType** | OntologyDataTypeDict | Yes | | -**type** | Literal["map"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OntologyObjectArrayTypeDict.md b/docs/v2/Ontologies/models/OntologyObjectArrayTypeDict.md deleted file mode 100644 index 40bed37b5..000000000 --- a/docs/v2/Ontologies/models/OntologyObjectArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyObjectArrayTypeDict - -OntologyObjectArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | ObjectPropertyTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OntologyObjectSetTypeDict.md b/docs/v2/Ontologies/models/OntologyObjectSetTypeDict.md deleted file mode 100644 index 993c941af..000000000 --- a/docs/v2/Ontologies/models/OntologyObjectSetTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyObjectSetTypeDict - -OntologyObjectSetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectApiName** | NotRequired[ObjectTypeApiName] | No | | -**objectTypeApiName** | NotRequired[ObjectTypeApiName] | No | | -**type** | Literal["objectSet"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OntologyObjectTypeDict.md b/docs/v2/Ontologies/models/OntologyObjectTypeDict.md deleted file mode 100644 index c07be8c47..000000000 --- a/docs/v2/Ontologies/models/OntologyObjectTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyObjectTypeDict - -OntologyObjectType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectApiName** | ObjectTypeApiName | Yes | | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["object"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OntologyObjectTypeReferenceTypeDict.md b/docs/v2/Ontologies/models/OntologyObjectTypeReferenceTypeDict.md deleted file mode 100644 index bca273b75..000000000 --- a/docs/v2/Ontologies/models/OntologyObjectTypeReferenceTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# OntologyObjectTypeReferenceTypeDict - -OntologyObjectTypeReferenceType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["objectType"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OntologySetTypeDict.md b/docs/v2/Ontologies/models/OntologySetTypeDict.md deleted file mode 100644 index cd9d382db..000000000 --- a/docs/v2/Ontologies/models/OntologySetTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologySetTypeDict - -OntologySetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**itemType** | OntologyDataTypeDict | Yes | | -**type** | Literal["set"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OntologyStructFieldDict.md b/docs/v2/Ontologies/models/OntologyStructFieldDict.md deleted file mode 100644 index be5ef4364..000000000 --- a/docs/v2/Ontologies/models/OntologyStructFieldDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyStructFieldDict - -OntologyStructField - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StructFieldName | Yes | | -**fieldType** | OntologyDataTypeDict | Yes | | -**required** | bool | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OntologyStructTypeDict.md b/docs/v2/Ontologies/models/OntologyStructTypeDict.md deleted file mode 100644 index 6ecc8be41..000000000 --- a/docs/v2/Ontologies/models/OntologyStructTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyStructTypeDict - -OntologyStructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[OntologyStructFieldDict] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OntologyV2Dict.md b/docs/v2/Ontologies/models/OntologyV2Dict.md deleted file mode 100644 index 29d488079..000000000 --- a/docs/v2/Ontologies/models/OntologyV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# OntologyV2Dict - -Metadata about an Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | OntologyApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | str | Yes | | -**rid** | OntologyRid | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/OrQueryV2Dict.md b/docs/v2/Ontologies/models/OrQueryV2Dict.md deleted file mode 100644 index 0fdaa13d8..000000000 --- a/docs/v2/Ontologies/models/OrQueryV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrQueryV2Dict - -Returns objects where at least 1 query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryV2Dict] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ParameterEvaluatedConstraintDict.md b/docs/v2/Ontologies/models/ParameterEvaluatedConstraintDict.md deleted file mode 100644 index d86a98e03..000000000 --- a/docs/v2/Ontologies/models/ParameterEvaluatedConstraintDict.md +++ /dev/null @@ -1,40 +0,0 @@ -# ParameterEvaluatedConstraintDict - -A constraint that an action parameter value must satisfy in order to be considered valid. -Constraints can be configured on action parameters in the **Ontology Manager**. -Applicable constraints are determined dynamically based on parameter inputs. -Parameter values are evaluated against the final set of constraints. - -The type of the constraint. -| Type | Description | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | -| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | -| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | -| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | -| `oneOf` | The parameter has a manually predefined set of options. | -| `range` | The parameter value must be within the defined range. | -| `stringLength` | The parameter value must have a length within the defined range. | -| `stringRegexMatch` | The parameter value must match a predefined regular expression. | -| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -OneOfConstraintDict | oneOf -GroupMemberConstraintDict | groupMember -ObjectPropertyValueConstraintDict | objectPropertyValue -RangeConstraintDict | range -ArraySizeConstraintDict | arraySize -ObjectQueryResultConstraintDict | objectQueryResult -StringLengthConstraintDict | stringLength -StringRegexMatchConstraintDict | stringRegexMatch -UnevaluableConstraintDict | unevaluable - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ParameterEvaluationResultDict.md b/docs/v2/Ontologies/models/ParameterEvaluationResultDict.md deleted file mode 100644 index fc48accb8..000000000 --- a/docs/v2/Ontologies/models/ParameterEvaluationResultDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterEvaluationResultDict - -Represents the validity of a parameter against the configured constraints. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**evaluatedConstraints** | List[ParameterEvaluatedConstraintDict] | Yes | | -**required** | bool | Yes | Represents whether the parameter is a required input to the action. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ParameterOptionDict.md b/docs/v2/Ontologies/models/ParameterOptionDict.md deleted file mode 100644 index 360a0d064..000000000 --- a/docs/v2/Ontologies/models/ParameterOptionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterOptionDict - -A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**displayName** | NotRequired[DisplayName] | No | | -**value** | NotRequired[Any] | No | An allowed configured value for a parameter within an action. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/PolygonValueDict.md b/docs/v2/Ontologies/models/PolygonValueDict.md deleted file mode 100644 index 1bf71417e..000000000 --- a/docs/v2/Ontologies/models/PolygonValueDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# PolygonValueDict - -PolygonValue - -## Type -```python -PolygonDict -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/PreciseDurationDict.md b/docs/v2/Ontologies/models/PreciseDurationDict.md deleted file mode 100644 index ba717582d..000000000 --- a/docs/v2/Ontologies/models/PreciseDurationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PreciseDurationDict - -A measurement of duration. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | int | Yes | The duration value. | -**unit** | PreciseTimeUnit | Yes | | -**type** | Literal["duration"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/PropertyApiNameSelectorDict.md b/docs/v2/Ontologies/models/PropertyApiNameSelectorDict.md deleted file mode 100644 index 431d9e125..000000000 --- a/docs/v2/Ontologies/models/PropertyApiNameSelectorDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# PropertyApiNameSelectorDict - -A property api name that references properties to query on. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | PropertyApiName | Yes | | -**type** | Literal["property"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/PropertyIdentifierDict.md b/docs/v2/Ontologies/models/PropertyIdentifierDict.md deleted file mode 100644 index 7dded3a5d..000000000 --- a/docs/v2/Ontologies/models/PropertyIdentifierDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# PropertyIdentifierDict - -An identifier used to select properties or struct fields. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -PropertyApiNameSelectorDict | property -StructFieldSelectorDict | structField - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/PropertyTypeStatusDict.md b/docs/v2/Ontologies/models/PropertyTypeStatusDict.md deleted file mode 100644 index e5c9906c5..000000000 --- a/docs/v2/Ontologies/models/PropertyTypeStatusDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# PropertyTypeStatusDict - -The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DeprecatedPropertyTypeStatusDict | deprecated -ActivePropertyTypeStatusDict | active -ExperimentalPropertyTypeStatusDict | experimental -ExamplePropertyTypeStatusDict | example - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/PropertyV2Dict.md b/docs/v2/Ontologies/models/PropertyV2Dict.md deleted file mode 100644 index 3542c8d27..000000000 --- a/docs/v2/Ontologies/models/PropertyV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# PropertyV2Dict - -Details about some property of an object. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[str] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**dataType** | ObjectPropertyTypeDict | Yes | | -**rid** | PropertyTypeRid | Yes | | -**status** | NotRequired[PropertyTypeStatusDict] | No | | -**visibility** | NotRequired[PropertyTypeVisibility] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/QueryAggregationKeyTypeDict.md b/docs/v2/Ontologies/models/QueryAggregationKeyTypeDict.md deleted file mode 100644 index c8def0b1c..000000000 --- a/docs/v2/Ontologies/models/QueryAggregationKeyTypeDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# QueryAggregationKeyTypeDict - -A union of all the types supported by query aggregation keys. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateTypeDict | date -BooleanTypeDict | boolean -StringTypeDict | string -DoubleTypeDict | double -QueryAggregationRangeTypeDict | range -IntegerTypeDict | integer -TimestampTypeDict | timestamp - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/QueryAggregationRangeSubTypeDict.md b/docs/v2/Ontologies/models/QueryAggregationRangeSubTypeDict.md deleted file mode 100644 index 6ccfc0559..000000000 --- a/docs/v2/Ontologies/models/QueryAggregationRangeSubTypeDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# QueryAggregationRangeSubTypeDict - -A union of all the types supported by query aggregation ranges. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateTypeDict | date -DoubleTypeDict | double -IntegerTypeDict | integer -TimestampTypeDict | timestamp - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/QueryAggregationRangeTypeDict.md b/docs/v2/Ontologies/models/QueryAggregationRangeTypeDict.md deleted file mode 100644 index 3d15c61b1..000000000 --- a/docs/v2/Ontologies/models/QueryAggregationRangeTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregationRangeTypeDict - -QueryAggregationRangeType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | QueryAggregationRangeSubTypeDict | Yes | | -**type** | Literal["range"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/QueryAggregationValueTypeDict.md b/docs/v2/Ontologies/models/QueryAggregationValueTypeDict.md deleted file mode 100644 index bbd2be4be..000000000 --- a/docs/v2/Ontologies/models/QueryAggregationValueTypeDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# QueryAggregationValueTypeDict - -A union of all the types supported by query aggregation keys. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateTypeDict | date -DoubleTypeDict | double -TimestampTypeDict | timestamp - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/QueryArrayTypeDict.md b/docs/v2/Ontologies/models/QueryArrayTypeDict.md deleted file mode 100644 index d1b016f83..000000000 --- a/docs/v2/Ontologies/models/QueryArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryArrayTypeDict - -QueryArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | QueryDataTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/QueryDataTypeDict.md b/docs/v2/Ontologies/models/QueryDataTypeDict.md deleted file mode 100644 index 7f48087e5..000000000 --- a/docs/v2/Ontologies/models/QueryDataTypeDict.md +++ /dev/null @@ -1,35 +0,0 @@ -# QueryDataTypeDict - -A union of all the types supported by Ontology Query parameters or outputs. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DateTypeDict | date -QueryStructTypeDict | struct -QuerySetTypeDict | set -StringTypeDict | string -EntrySetTypeDict | entrySet -DoubleTypeDict | double -IntegerTypeDict | integer -ThreeDimensionalAggregationDict | threeDimensionalAggregation -QueryUnionTypeDict | union -FloatTypeDict | float -LongTypeDict | long -BooleanTypeDict | boolean -UnsupportedTypeDict | unsupported -AttachmentTypeDict | attachment -NullTypeDict | null -QueryArrayTypeDict | array -OntologyObjectSetTypeDict | objectSet -TwoDimensionalAggregationDict | twoDimensionalAggregation -OntologyObjectTypeDict | object -TimestampTypeDict | timestamp - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/QueryParameterV2Dict.md b/docs/v2/Ontologies/models/QueryParameterV2Dict.md deleted file mode 100644 index 433dd0940..000000000 --- a/docs/v2/Ontologies/models/QueryParameterV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryParameterV2Dict - -Details about a parameter of a query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[str] | No | | -**dataType** | QueryDataTypeDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/QuerySetTypeDict.md b/docs/v2/Ontologies/models/QuerySetTypeDict.md deleted file mode 100644 index 7ee4cc50b..000000000 --- a/docs/v2/Ontologies/models/QuerySetTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QuerySetTypeDict - -QuerySetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | QueryDataTypeDict | Yes | | -**type** | Literal["set"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/QueryStructFieldDict.md b/docs/v2/Ontologies/models/QueryStructFieldDict.md deleted file mode 100644 index fa34f0687..000000000 --- a/docs/v2/Ontologies/models/QueryStructFieldDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryStructFieldDict - -QueryStructField - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StructFieldName | Yes | | -**fieldType** | QueryDataTypeDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/QueryStructTypeDict.md b/docs/v2/Ontologies/models/QueryStructTypeDict.md deleted file mode 100644 index eadd8ce13..000000000 --- a/docs/v2/Ontologies/models/QueryStructTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryStructTypeDict - -QueryStructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[QueryStructFieldDict] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/QueryTypeV2Dict.md b/docs/v2/Ontologies/models/QueryTypeV2Dict.md deleted file mode 100644 index 8e81c8778..000000000 --- a/docs/v2/Ontologies/models/QueryTypeV2Dict.md +++ /dev/null @@ -1,17 +0,0 @@ -# QueryTypeV2Dict - -Represents a query type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | QueryApiName | Yes | | -**description** | NotRequired[str] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**parameters** | Dict[ParameterId, QueryParameterV2Dict] | Yes | | -**output** | QueryDataTypeDict | Yes | | -**rid** | FunctionRid | Yes | | -**version** | FunctionVersion | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/QueryUnionTypeDict.md b/docs/v2/Ontologies/models/QueryUnionTypeDict.md deleted file mode 100644 index 200ebb65a..000000000 --- a/docs/v2/Ontologies/models/QueryUnionTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryUnionTypeDict - -QueryUnionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**unionTypes** | List[QueryDataTypeDict] | Yes | | -**type** | Literal["union"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/RangeConstraintDict.md b/docs/v2/Ontologies/models/RangeConstraintDict.md deleted file mode 100644 index 58191e7ef..000000000 --- a/docs/v2/Ontologies/models/RangeConstraintDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# RangeConstraintDict - -The parameter value must be within the defined range. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Less than | -**lte** | NotRequired[Any] | No | Less than or equal | -**gt** | NotRequired[Any] | No | Greater than | -**gte** | NotRequired[Any] | No | Greater than or equal | -**type** | Literal["range"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/RelativeTimeDict.md b/docs/v2/Ontologies/models/RelativeTimeDict.md deleted file mode 100644 index f2179507b..000000000 --- a/docs/v2/Ontologies/models/RelativeTimeDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# RelativeTimeDict - -A relative time, such as "3 days before" or "2 hours after" the current moment. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**when** | RelativeTimeRelation | Yes | | -**value** | int | Yes | | -**unit** | RelativeTimeSeriesTimeUnit | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/RelativeTimeRangeDict.md b/docs/v2/Ontologies/models/RelativeTimeRangeDict.md deleted file mode 100644 index dfe8bf51f..000000000 --- a/docs/v2/Ontologies/models/RelativeTimeRangeDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# RelativeTimeRangeDict - -A relative time range for a time series query. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**startTime** | NotRequired[RelativeTimeDict] | No | | -**endTime** | NotRequired[RelativeTimeDict] | No | | -**type** | Literal["relative"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/RollingAggregateWindowPointsDict.md b/docs/v2/Ontologies/models/RollingAggregateWindowPointsDict.md deleted file mode 100644 index c88442d82..000000000 --- a/docs/v2/Ontologies/models/RollingAggregateWindowPointsDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# RollingAggregateWindowPointsDict - -Number of points in each window. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**count** | int | Yes | | -**type** | Literal["pointsCount"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SearchJsonQueryV2Dict.md b/docs/v2/Ontologies/models/SearchJsonQueryV2Dict.md deleted file mode 100644 index 10db3360a..000000000 --- a/docs/v2/Ontologies/models/SearchJsonQueryV2Dict.md +++ /dev/null @@ -1,37 +0,0 @@ -# SearchJsonQueryV2Dict - -SearchJsonQueryV2 - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -OrQueryV2Dict | or -InQueryDict | in -DoesNotIntersectPolygonQueryDict | doesNotIntersectPolygon -LtQueryV2Dict | lt -DoesNotIntersectBoundingBoxQueryDict | doesNotIntersectBoundingBox -EqualsQueryV2Dict | eq -ContainsAllTermsQueryDict | containsAllTerms -GtQueryV2Dict | gt -WithinDistanceOfQueryDict | withinDistanceOf -WithinBoundingBoxQueryDict | withinBoundingBox -ContainsQueryV2Dict | contains -NotQueryV2Dict | not -IntersectsBoundingBoxQueryDict | intersectsBoundingBox -AndQueryV2Dict | and -IsNullQueryV2Dict | isNull -ContainsAllTermsInOrderPrefixLastTermDict | containsAllTermsInOrderPrefixLastTerm -ContainsAnyTermQueryDict | containsAnyTerm -GteQueryV2Dict | gte -ContainsAllTermsInOrderQueryDict | containsAllTermsInOrder -WithinPolygonQueryDict | withinPolygon -IntersectsPolygonQueryDict | intersectsPolygon -LteQueryV2Dict | lte -StartsWithQueryDict | startsWith - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SearchObjectsResponseV2Dict.md b/docs/v2/Ontologies/models/SearchObjectsResponseV2Dict.md deleted file mode 100644 index 52c1b07e1..000000000 --- a/docs/v2/Ontologies/models/SearchObjectsResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchObjectsResponseV2Dict - -SearchObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SearchOrderByV2Dict.md b/docs/v2/Ontologies/models/SearchOrderByV2Dict.md deleted file mode 100644 index 8b5942c79..000000000 --- a/docs/v2/Ontologies/models/SearchOrderByV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchOrderByV2Dict - -Specifies the ordering of search results by a field and an ordering direction or by relevance if scores are required in a nearestNeighbors query. By default `orderType` is set to `fields`. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**orderType** | NotRequired[SearchOrderByType] | No | | -**fields** | List[SearchOrderingV2Dict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SearchOrderingV2Dict.md b/docs/v2/Ontologies/models/SearchOrderingV2Dict.md deleted file mode 100644 index c279ca3e2..000000000 --- a/docs/v2/Ontologies/models/SearchOrderingV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchOrderingV2Dict - -SearchOrderingV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**direction** | NotRequired[str] | No | Specifies the ordering direction (can be either `asc` or `desc`) | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SelectedPropertyApproximateDistinctAggregationDict.md b/docs/v2/Ontologies/models/SelectedPropertyApproximateDistinctAggregationDict.md deleted file mode 100644 index 64ca33751..000000000 --- a/docs/v2/Ontologies/models/SelectedPropertyApproximateDistinctAggregationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SelectedPropertyApproximateDistinctAggregationDict - -Computes an approximate number of distinct values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**selectedPropertyApiName** | PropertyApiName | Yes | | -**type** | Literal["approximateDistinct"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SelectedPropertyApproximatePercentileAggregationDict.md b/docs/v2/Ontologies/models/SelectedPropertyApproximatePercentileAggregationDict.md deleted file mode 100644 index e8a6955d9..000000000 --- a/docs/v2/Ontologies/models/SelectedPropertyApproximatePercentileAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SelectedPropertyApproximatePercentileAggregationDict - -Computes the approximate percentile value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**selectedPropertyApiName** | PropertyApiName | Yes | | -**approximatePercentile** | float | Yes | | -**type** | Literal["approximatePercentile"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SelectedPropertyAvgAggregationDict.md b/docs/v2/Ontologies/models/SelectedPropertyAvgAggregationDict.md deleted file mode 100644 index 8b2a33a35..000000000 --- a/docs/v2/Ontologies/models/SelectedPropertyAvgAggregationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SelectedPropertyAvgAggregationDict - -Computes the average value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**selectedPropertyApiName** | PropertyApiName | Yes | | -**type** | Literal["avg"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SelectedPropertyCollectListAggregationDict.md b/docs/v2/Ontologies/models/SelectedPropertyCollectListAggregationDict.md deleted file mode 100644 index cf21e7bfa..000000000 --- a/docs/v2/Ontologies/models/SelectedPropertyCollectListAggregationDict.md +++ /dev/null @@ -1,20 +0,0 @@ -# SelectedPropertyCollectListAggregationDict - -Lists all values of a property up to the specified limit. The maximum supported limit is 100, by default. - -NOTE: A separate count aggregation should be used to determine the total count of values, to account for -a possible truncation of the returned list. - -Ignores objects for which a property is absent, so the returned list will contain non-null values only. -Returns an empty list when none of the objects have values for a provided property. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**selectedPropertyApiName** | PropertyApiName | Yes | | -**limit** | int | Yes | Maximum number of values to collect. The maximum supported limit is 100. | -**type** | Literal["collectList"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SelectedPropertyCollectSetAggregationDict.md b/docs/v2/Ontologies/models/SelectedPropertyCollectSetAggregationDict.md deleted file mode 100644 index 57e32dcb7..000000000 --- a/docs/v2/Ontologies/models/SelectedPropertyCollectSetAggregationDict.md +++ /dev/null @@ -1,20 +0,0 @@ -# SelectedPropertyCollectSetAggregationDict - -Lists all distinct values of a property up to the specified limit. The maximum supported limit is 100. - -NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of -values, to account for a possible truncation of the returned set. - -Ignores objects for which a property is absent, so the returned list will contain non-null values only. -Returns an empty list when none of the objects have values for a provided property. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**selectedPropertyApiName** | PropertyApiName | Yes | | -**limit** | int | Yes | Maximum number of values to collect. The maximum supported limit is 100. | -**type** | Literal["collectSet"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SelectedPropertyCountAggregationDict.md b/docs/v2/Ontologies/models/SelectedPropertyCountAggregationDict.md deleted file mode 100644 index 86ab5539a..000000000 --- a/docs/v2/Ontologies/models/SelectedPropertyCountAggregationDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# SelectedPropertyCountAggregationDict - -Computes the total count of objects. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["count"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SelectedPropertyExactDistinctAggregationDict.md b/docs/v2/Ontologies/models/SelectedPropertyExactDistinctAggregationDict.md deleted file mode 100644 index f76abb230..000000000 --- a/docs/v2/Ontologies/models/SelectedPropertyExactDistinctAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SelectedPropertyExactDistinctAggregationDict - -Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**selectedPropertyApiName** | PropertyApiName | Yes | | -**type** | Literal["exactDistinct"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SelectedPropertyExpressionDict.md b/docs/v2/Ontologies/models/SelectedPropertyExpressionDict.md deleted file mode 100644 index 55625dbbc..000000000 --- a/docs/v2/Ontologies/models/SelectedPropertyExpressionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SelectedPropertyExpressionDict - -Definition for a selected property over a MethodObjectSet. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | MethodObjectSetDict | Yes | | -**operation** | SelectedPropertyOperationDict | Yes | | -**type** | Literal["selection"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SelectedPropertyMaxAggregationDict.md b/docs/v2/Ontologies/models/SelectedPropertyMaxAggregationDict.md deleted file mode 100644 index e0af3b30b..000000000 --- a/docs/v2/Ontologies/models/SelectedPropertyMaxAggregationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SelectedPropertyMaxAggregationDict - -Computes the maximum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**selectedPropertyApiName** | PropertyApiName | Yes | | -**type** | Literal["max"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SelectedPropertyMinAggregationDict.md b/docs/v2/Ontologies/models/SelectedPropertyMinAggregationDict.md deleted file mode 100644 index d09266b62..000000000 --- a/docs/v2/Ontologies/models/SelectedPropertyMinAggregationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SelectedPropertyMinAggregationDict - -Computes the minimum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**selectedPropertyApiName** | PropertyApiName | Yes | | -**type** | Literal["min"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SelectedPropertyOperationDict.md b/docs/v2/Ontologies/models/SelectedPropertyOperationDict.md deleted file mode 100644 index 142e44a93..000000000 --- a/docs/v2/Ontologies/models/SelectedPropertyOperationDict.md +++ /dev/null @@ -1,26 +0,0 @@ -# SelectedPropertyOperationDict - -Operation on a selected property, can be an aggregation function or retrieval of a single selected property - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -SelectedPropertyApproximateDistinctAggregationDict | approximateDistinct -SelectedPropertyMinAggregationDict | min -SelectedPropertyAvgAggregationDict | avg -SelectedPropertyMaxAggregationDict | max -SelectedPropertyApproximatePercentileAggregationDict | approximatePercentile -GetSelectedPropertyOperationDict | get -SelectedPropertyCountAggregationDict | count -SelectedPropertySumAggregationDict | sum -SelectedPropertyCollectListAggregationDict | collectList -SelectedPropertyExactDistinctAggregationDict | exactDistinct -SelectedPropertyCollectSetAggregationDict | collectSet - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SelectedPropertySumAggregationDict.md b/docs/v2/Ontologies/models/SelectedPropertySumAggregationDict.md deleted file mode 100644 index e020d857c..000000000 --- a/docs/v2/Ontologies/models/SelectedPropertySumAggregationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SelectedPropertySumAggregationDict - -Computes the sum of values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**selectedPropertyApiName** | PropertyApiName | Yes | | -**type** | Literal["sum"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SharedPropertyTypeDict.md b/docs/v2/Ontologies/models/SharedPropertyTypeDict.md deleted file mode 100644 index 1b172cc14..000000000 --- a/docs/v2/Ontologies/models/SharedPropertyTypeDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# SharedPropertyTypeDict - -A property type that can be shared across object types. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | SharedPropertyTypeRid | Yes | | -**apiName** | SharedPropertyTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | NotRequired[str] | No | A short text that describes the SharedPropertyType. | -**dataType** | ObjectPropertyTypeDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/StartsWithQueryDict.md b/docs/v2/Ontologies/models/StartsWithQueryDict.md deleted file mode 100644 index 5f9a6884c..000000000 --- a/docs/v2/Ontologies/models/StartsWithQueryDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# StartsWithQueryDict - -Returns objects where the specified field starts with the provided value. Allows you to specify a property to -query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | str | Yes | | -**type** | Literal["startsWith"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/StringLengthConstraintDict.md b/docs/v2/Ontologies/models/StringLengthConstraintDict.md deleted file mode 100644 index 311978cfd..000000000 --- a/docs/v2/Ontologies/models/StringLengthConstraintDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# StringLengthConstraintDict - -The parameter value must have a length within the defined range. -*This range is always inclusive.* - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Less than | -**lte** | NotRequired[Any] | No | Less than or equal | -**gt** | NotRequired[Any] | No | Greater than | -**gte** | NotRequired[Any] | No | Greater than or equal | -**type** | Literal["stringLength"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/StringRegexMatchConstraintDict.md b/docs/v2/Ontologies/models/StringRegexMatchConstraintDict.md deleted file mode 100644 index 5b1b41293..000000000 --- a/docs/v2/Ontologies/models/StringRegexMatchConstraintDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# StringRegexMatchConstraintDict - -The parameter value must match a predefined regular expression. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**regex** | str | Yes | The regular expression configured in the **Ontology Manager**. | -**configuredFailureMessage** | NotRequired[str] | No | The message indicating that the regular expression was not matched. This is configured per parameter in the **Ontology Manager**. | -**type** | Literal["stringRegexMatch"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/StructFieldSelectorDict.md b/docs/v2/Ontologies/models/StructFieldSelectorDict.md deleted file mode 100644 index ba55ab1a4..000000000 --- a/docs/v2/Ontologies/models/StructFieldSelectorDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# StructFieldSelectorDict - -A combination of a property API name and a struct field API name used to select struct fields. Note that you can -still select struct properties with only a 'PropertyApiNameSelector'; the queries will then become 'OR' queries -across the fields of the struct property, and derived property expressions will operate on the whole struct -where applicable. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**propertyApiName** | PropertyApiName | Yes | | -**structFieldApiName** | StructFieldApiName | Yes | | -**type** | Literal["structField"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/StructFieldTypeDict.md b/docs/v2/Ontologies/models/StructFieldTypeDict.md deleted file mode 100644 index 5d1e9cda6..000000000 --- a/docs/v2/Ontologies/models/StructFieldTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# StructFieldTypeDict - -StructFieldType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | StructFieldApiName | Yes | | -**dataType** | ObjectPropertyTypeDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/StructTypeDict.md b/docs/v2/Ontologies/models/StructTypeDict.md deleted file mode 100644 index d82d7ad97..000000000 --- a/docs/v2/Ontologies/models/StructTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# StructTypeDict - -StructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**structFieldTypes** | List[StructFieldTypeDict] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SubmissionCriteriaEvaluationDict.md b/docs/v2/Ontologies/models/SubmissionCriteriaEvaluationDict.md deleted file mode 100644 index 238430911..000000000 --- a/docs/v2/Ontologies/models/SubmissionCriteriaEvaluationDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# SubmissionCriteriaEvaluationDict - -Contains the status of the **submission criteria**. -**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. -These are configured in the **Ontology Manager**. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**configuredFailureMessage** | NotRequired[str] | No | The message indicating one of the **submission criteria** was not satisfied. This is configured per **submission criteria** in the **Ontology Manager**. | -**result** | ValidationResult | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SubtractPropertyExpressionDict.md b/docs/v2/Ontologies/models/SubtractPropertyExpressionDict.md deleted file mode 100644 index 6b63fffbe..000000000 --- a/docs/v2/Ontologies/models/SubtractPropertyExpressionDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# SubtractPropertyExpressionDict - -Subtracts the right numeric value from the left numeric value. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**left** | DerivedPropertyDefinitionDict | Yes | | -**right** | DerivedPropertyDefinitionDict | Yes | | -**type** | Literal["subtract"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SumAggregationV2Dict.md b/docs/v2/Ontologies/models/SumAggregationV2Dict.md deleted file mode 100644 index b5f6a83e1..000000000 --- a/docs/v2/Ontologies/models/SumAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# SumAggregationV2Dict - -Computes the sum of values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["sum"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/SyncApplyActionResponseV2Dict.md b/docs/v2/Ontologies/models/SyncApplyActionResponseV2Dict.md deleted file mode 100644 index 4a04d8082..000000000 --- a/docs/v2/Ontologies/models/SyncApplyActionResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SyncApplyActionResponseV2Dict - -SyncApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**validation** | NotRequired[ValidateActionResponseV2Dict] | No | | -**edits** | NotRequired[ActionResultsDict] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ThreeDimensionalAggregationDict.md b/docs/v2/Ontologies/models/ThreeDimensionalAggregationDict.md deleted file mode 100644 index bd9eab2b5..000000000 --- a/docs/v2/Ontologies/models/ThreeDimensionalAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ThreeDimensionalAggregationDict - -ThreeDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | QueryAggregationKeyTypeDict | Yes | | -**valueType** | TwoDimensionalAggregationDict | Yes | | -**type** | Literal["threeDimensionalAggregation"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/TimeRangeDict.md b/docs/v2/Ontologies/models/TimeRangeDict.md deleted file mode 100644 index 4071a2613..000000000 --- a/docs/v2/Ontologies/models/TimeRangeDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# TimeRangeDict - -An absolute or relative range for a time series query. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -AbsoluteTimeRangeDict | absolute -RelativeTimeRangeDict | relative - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/TimeSeriesAggregationStrategyDict.md b/docs/v2/Ontologies/models/TimeSeriesAggregationStrategyDict.md deleted file mode 100644 index 1311b9c91..000000000 --- a/docs/v2/Ontologies/models/TimeSeriesAggregationStrategyDict.md +++ /dev/null @@ -1,21 +0,0 @@ -# TimeSeriesAggregationStrategyDict - -CUMULATIVE aggregates all points up to the current point. -ROLLING aggregates all points in a rolling window whose size is either the specified number of points or -time duration. -PERIODIC aggregates all points in specified time windows. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -TimeSeriesRollingAggregateDict | rolling -TimeSeriesPeriodicAggregateDict | periodic -TimeSeriesCumulativeAggregateDict | cumulative - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/TimeSeriesCumulativeAggregateDict.md b/docs/v2/Ontologies/models/TimeSeriesCumulativeAggregateDict.md deleted file mode 100644 index af5f88853..000000000 --- a/docs/v2/Ontologies/models/TimeSeriesCumulativeAggregateDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# TimeSeriesCumulativeAggregateDict - -The cumulative aggregate is calculated progressively for each point in the input time series, -considering all preceding points up to and including the current point. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["cumulative"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/TimeSeriesPeriodicAggregateDict.md b/docs/v2/Ontologies/models/TimeSeriesPeriodicAggregateDict.md deleted file mode 100644 index 2dc260a78..000000000 --- a/docs/v2/Ontologies/models/TimeSeriesPeriodicAggregateDict.md +++ /dev/null @@ -1,23 +0,0 @@ -# TimeSeriesPeriodicAggregateDict - -Aggregates values over discrete, periodic windows for a given time series. - -A periodic window divides the time series into windows of fixed durations. -For each window, an aggregate function is applied to the points within that window. The result is a time series -with values representing the aggregate for each window. Windows with no data points are not included -in the output. - -Periodic aggregation is useful for downsampling a continuous stream of data to larger granularities such as -hourly, daily, monthly. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**windowSize** | PreciseDurationDict | Yes | | -**alignmentTimestamp** | NotRequired[datetime] | No | The timestamp used to align the result, such that ticks in the result time series will lie at integer multiples of the window duration from the alignment timestamp. Default is the first epoch timestamp (January 1, 1970, 00:00:00 UTC) so that all aggregated points have timestamps at midnight UTC at the start of each window duration. For example, for a weekly aggregate with alignment timestamp 5 January, 8:33PM, each aggregated timestamp will lie on the 7 day intervals at 8:33PM starting at 5 January. | -**windowType** | TimeSeriesWindowType | Yes | | -**type** | Literal["periodic"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/TimeSeriesPointDict.md b/docs/v2/Ontologies/models/TimeSeriesPointDict.md deleted file mode 100644 index 6ad259406..000000000 --- a/docs/v2/Ontologies/models/TimeSeriesPointDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# TimeSeriesPointDict - -A time and value pair. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**time** | datetime | Yes | An ISO 8601 timestamp | -**value** | Any | Yes | An object which is either an enum String or a double number. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/TimeSeriesRollingAggregateDict.md b/docs/v2/Ontologies/models/TimeSeriesRollingAggregateDict.md deleted file mode 100644 index da02a9886..000000000 --- a/docs/v2/Ontologies/models/TimeSeriesRollingAggregateDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# TimeSeriesRollingAggregateDict - -TimeSeriesRollingAggregate - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**windowSize** | TimeSeriesRollingAggregateWindowDict | Yes | | -**type** | Literal["rolling"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/TimeSeriesRollingAggregateWindowDict.md b/docs/v2/Ontologies/models/TimeSeriesRollingAggregateWindowDict.md deleted file mode 100644 index aa43ee8a7..000000000 --- a/docs/v2/Ontologies/models/TimeSeriesRollingAggregateWindowDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# TimeSeriesRollingAggregateWindowDict - -A rolling window is a moving subset of data points that ends at the current timestamp (inclusive) -and spans a specified duration (window size). As new data points are added, old points fall out of the -window if they are outside the specified duration. - -Rolling windows are commonly used for smoothing data, detecting trends, and reducing noise -in time series analysis. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -PreciseDurationDict | duration -RollingAggregateWindowPointsDict | pointsCount - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/TimeseriesEntryDict.md b/docs/v2/Ontologies/models/TimeseriesEntryDict.md deleted file mode 100644 index 4667f6dc8..000000000 --- a/docs/v2/Ontologies/models/TimeseriesEntryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# TimeseriesEntryDict - -A time and value pair. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**time** | datetime | Yes | An ISO 8601 timestamp | -**value** | Any | Yes | An object which is either an enum String, double number, or a geopoint. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/TwoDimensionalAggregationDict.md b/docs/v2/Ontologies/models/TwoDimensionalAggregationDict.md deleted file mode 100644 index 0bf09bf95..000000000 --- a/docs/v2/Ontologies/models/TwoDimensionalAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# TwoDimensionalAggregationDict - -TwoDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | QueryAggregationKeyTypeDict | Yes | | -**valueType** | QueryAggregationValueTypeDict | Yes | | -**type** | Literal["twoDimensionalAggregation"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/UnevaluableConstraintDict.md b/docs/v2/Ontologies/models/UnevaluableConstraintDict.md deleted file mode 100644 index 25c68ee48..000000000 --- a/docs/v2/Ontologies/models/UnevaluableConstraintDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# UnevaluableConstraintDict - -The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. -This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["unevaluable"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/ValidateActionResponseV2Dict.md b/docs/v2/Ontologies/models/ValidateActionResponseV2Dict.md deleted file mode 100644 index b38cbb8fb..000000000 --- a/docs/v2/Ontologies/models/ValidateActionResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ValidateActionResponseV2Dict - -ValidateActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**submissionCriteria** | List[SubmissionCriteriaEvaluationDict] | Yes | | -**parameters** | Dict[ParameterId, ParameterEvaluationResultDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/WithinBoundingBoxPointDict.md b/docs/v2/Ontologies/models/WithinBoundingBoxPointDict.md deleted file mode 100644 index 2548033ed..000000000 --- a/docs/v2/Ontologies/models/WithinBoundingBoxPointDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# WithinBoundingBoxPointDict - -WithinBoundingBoxPoint - -## Type -```python -GeoPointDict -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/WithinBoundingBoxQueryDict.md b/docs/v2/Ontologies/models/WithinBoundingBoxQueryDict.md deleted file mode 100644 index 9cb29cb55..000000000 --- a/docs/v2/Ontologies/models/WithinBoundingBoxQueryDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# WithinBoundingBoxQueryDict - -Returns objects where the specified field contains a point within the bounding box provided. Allows you to -specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, -but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | BoundingBoxValueDict | Yes | | -**type** | Literal["withinBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/WithinDistanceOfQueryDict.md b/docs/v2/Ontologies/models/WithinDistanceOfQueryDict.md deleted file mode 100644 index b9cce346d..000000000 --- a/docs/v2/Ontologies/models/WithinDistanceOfQueryDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# WithinDistanceOfQueryDict - -Returns objects where the specified field contains a point within the distance provided of the center point. -Allows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` -must be supplied, but not both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | CenterPointDict | Yes | | -**type** | Literal["withinDistanceOf"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Ontologies/models/WithinPolygonQueryDict.md b/docs/v2/Ontologies/models/WithinPolygonQueryDict.md deleted file mode 100644 index fb3c16985..000000000 --- a/docs/v2/Ontologies/models/WithinPolygonQueryDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# WithinPolygonQueryDict - -Returns objects where the specified field contains a point within the polygon provided. Allows you to specify a -property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not -both. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | NotRequired[PropertyApiName] | No | | -**propertyIdentifier** | NotRequired[PropertyIdentifierDict] | No | | -**value** | PolygonValueDict | Yes | | -**type** | Literal["withinPolygon"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/Build.md b/docs/v2/Orchestration/Build.md index a55b121d7..51dbb958f 100644 --- a/docs/v2/Orchestration/Build.md +++ b/docs/v2/Orchestration/Build.md @@ -7,7 +7,6 @@ Method | HTTP request | Release Stage | [**get**](#get) | **GET** /v2/orchestration/builds/{buildRid} | Public Beta | [**get_batch**](#get_batch) | **POST** /v2/orchestration/builds/getBatch | Public Beta | [**jobs**](#jobs) | **GET** /v2/orchestration/builds/{buildRid}/jobs | Public Beta | -[**jobs_page**](#jobs_page) | **GET** /v2/orchestration/builds/{buildRid}/jobs | Public Beta | [**search**](#search) | **POST** /v2/orchestration/builds/search | Private Beta | # **cancel** @@ -69,13 +68,13 @@ See [README](../../../README.md#authorization) Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **fallback_branches** | FallbackBranches | | | -**target** | Union[BuildTarget, BuildTargetDict] | The targets of the schedule. | | +**target** | BuildTarget | The targets of the schedule. | | **abort_on_failure** | Optional[AbortOnFailure] | | [optional] | **branch_name** | Optional[BranchName] | The target branch the build should run on. | [optional] | **force_build** | Optional[ForceBuild] | | [optional] | **notifications_enabled** | Optional[NotificationsEnabled] | The notification will be sent to the user that has most recently edited the schedule. No notification will be sent if the schedule has `scopeMode` set to `ProjectScope`. | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | -**retry_backoff_duration** | Optional[Union[RetryBackoffDuration, RetryBackoffDurationDict]] | | [optional] | +**retry_backoff_duration** | Optional[RetryBackoffDuration] | | [optional] | **retry_count** | Optional[RetryCount] | The number of retry attempts for failed jobs. | [optional] | ### Return type @@ -92,7 +91,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant # FallbackBranches fallback_branches = ["master"] -# Union[BuildTarget, BuildTargetDict] | The targets of the schedule. +# BuildTarget | The targets of the schedule. target = { "type": "manual", "targetRids": [ @@ -110,7 +109,7 @@ force_build = None notifications_enabled = None # Optional[PreviewMode] | Enables the use of preview functionality. preview = None -# Optional[Union[RetryBackoffDuration, RetryBackoffDurationDict]] +# Optional[RetryBackoffDuration] retry_backoff_duration = {"unit": "SECONDS", "value": 30} # Optional[RetryCount] | The number of retry attempts for failed jobs. retry_count = 1 @@ -207,7 +206,7 @@ The maximum batch size for this endpoint is 100. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**body** | List[Union[GetBuildsBatchRequestElement, GetBuildsBatchRequestElementDict]] | Body of the request | | +**body** | List[GetBuildsBatchRequestElement] | Body of the request | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -222,7 +221,7 @@ from pprint import pprint client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# List[Union[GetBuildsBatchRequestElement, GetBuildsBatchRequestElementDict]] | Body of the request +# List[GetBuildsBatchRequestElement] | Body of the request body = [{"buildRid": "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58"}] # Optional[PreviewMode] | Enables the use of preview functionality. preview = None @@ -296,64 +295,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListJobsOfBuildResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **jobs_page** -Get the Jobs in the Build. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**build_rid** | BuildRid | The RID of a Build. | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListJobsOfBuildResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# BuildRid | The RID of a Build. -build_rid = "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58" -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.orchestration.Build.jobs_page( - build_rid, page_size=page_size, page_token=page_token, preview=preview - ) - print("The jobs_page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Build.jobs_page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) @@ -372,8 +313,8 @@ Search for Builds. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**where** | Union[SearchBuildsFilter, SearchBuildsFilterDict] | | | -**order_by** | Optional[Union[SearchBuildsOrderBy, SearchBuildsOrderByDict]] | | [optional] | +**where** | SearchBuildsFilter | | | +**order_by** | Optional[SearchBuildsOrderBy] | | [optional] | **page_size** | Optional[PageSize] | The page size for the search request. If no value is provided, a default of `100` will be used. | [optional] | **page_token** | Optional[PageToken] | | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -390,9 +331,9 @@ from pprint import pprint client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# Union[SearchBuildsFilter, SearchBuildsFilterDict] +# SearchBuildsFilter where = None -# Optional[Union[SearchBuildsOrderBy, SearchBuildsOrderByDict]] +# Optional[SearchBuildsOrderBy] order_by = {"fields": [{"field": "STARTED_TIME", "direction": "ASC"}]} # Optional[PageSize] | The page size for the search request. If no value is provided, a default of `100` will be used. page_size = 100 diff --git a/docs/v2/Orchestration/Job.md b/docs/v2/Orchestration/Job.md index 87b21e22c..2b633c718 100644 --- a/docs/v2/Orchestration/Job.md +++ b/docs/v2/Orchestration/Job.md @@ -64,7 +64,7 @@ The maximum batch size for this endpoint is 500. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**body** | List[Union[GetJobsBatchRequestElement, GetJobsBatchRequestElementDict]] | Body of the request | | +**body** | List[GetJobsBatchRequestElement] | Body of the request | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -79,7 +79,7 @@ from pprint import pprint client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# List[Union[GetJobsBatchRequestElement, GetJobsBatchRequestElementDict]] | Body of the request +# List[GetJobsBatchRequestElement] | Body of the request body = [{"jobRid": "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448"}] # Optional[PreviewMode] | Enables the use of preview functionality. preview = None diff --git a/docs/v2/Orchestration/Schedule.md b/docs/v2/Orchestration/Schedule.md index 85f94f2d6..0aa440543 100644 --- a/docs/v2/Orchestration/Schedule.md +++ b/docs/v2/Orchestration/Schedule.md @@ -9,7 +9,6 @@ Method | HTTP request | Release Stage | [**replace**](#replace) | **PUT** /v2/orchestration/schedules/{scheduleRid} | Public Beta | [**run**](#run) | **POST** /v2/orchestration/schedules/{scheduleRid}/run | Public Beta | [**runs**](#runs) | **GET** /v2/orchestration/schedules/{scheduleRid}/runs | Public Beta | -[**runs_page**](#runs_page) | **GET** /v2/orchestration/schedules/{scheduleRid}/runs | Public Beta | [**unpause**](#unpause) | **POST** /v2/orchestration/schedules/{scheduleRid}/unpause | Public Beta | # **create** @@ -19,12 +18,12 @@ Creates a new Schedule. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**action** | Union[CreateScheduleRequestAction, CreateScheduleRequestActionDict] | | | +**action** | CreateScheduleRequestAction | | | **description** | Optional[str] | | [optional] | **display_name** | Optional[str] | | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | -**scope_mode** | Optional[Union[CreateScheduleRequestScopeMode, CreateScheduleRequestScopeModeDict]] | | [optional] | -**trigger** | Optional[Union[Trigger, TriggerDict]] | The schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty. | [optional] | +**scope_mode** | Optional[CreateScheduleRequestScopeMode] | | [optional] | +**trigger** | Optional[Trigger] | The schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty. | [optional] | ### Return type **Schedule** @@ -38,7 +37,7 @@ from pprint import pprint client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# Union[CreateScheduleRequestAction, CreateScheduleRequestActionDict] +# CreateScheduleRequestAction action = { "abortOnFailure": False, "forceBuild": False, @@ -61,9 +60,9 @@ description = "Run all the transforms at midnight" display_name = "My Daily Schedule" # Optional[PreviewMode] | Enables the use of preview functionality. preview = None -# Optional[Union[CreateScheduleRequestScopeMode, CreateScheduleRequestScopeModeDict]] +# Optional[CreateScheduleRequestScopeMode] scope_mode = {"type": "user"} -# Optional[Union[Trigger, TriggerDict]] | The schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty. +# Optional[Trigger] | The schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty. trigger = {"type": "time", "cronExpression": "0 0 * * *", "timeZone": "UTC"} @@ -254,12 +253,12 @@ Replace the Schedule with the specified rid. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **schedule_rid** | ScheduleRid | | | -**action** | Union[ReplaceScheduleRequestAction, ReplaceScheduleRequestActionDict] | | | +**action** | ReplaceScheduleRequestAction | | | **description** | Optional[str] | | [optional] | **display_name** | Optional[str] | | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | -**scope_mode** | Optional[Union[ReplaceScheduleRequestScopeMode, ReplaceScheduleRequestScopeModeDict]] | | [optional] | -**trigger** | Optional[Union[Trigger, TriggerDict]] | The schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty. | [optional] | +**scope_mode** | Optional[ReplaceScheduleRequestScopeMode] | | [optional] | +**trigger** | Optional[Trigger] | The schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty. | [optional] | ### Return type **Schedule** @@ -275,7 +274,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant # ScheduleRid schedule_rid = None -# Union[ReplaceScheduleRequestAction, ReplaceScheduleRequestActionDict] +# ReplaceScheduleRequestAction action = { "abortOnFailure": False, "forceBuild": False, @@ -298,9 +297,9 @@ description = "Run all the transforms at midnight" display_name = "My Daily Schedule" # Optional[PreviewMode] | Enables the use of preview functionality. preview = None -# Optional[Union[ReplaceScheduleRequestScopeMode, ReplaceScheduleRequestScopeModeDict]] +# Optional[ReplaceScheduleRequestScopeMode] scope_mode = {"type": "user"} -# Optional[Union[Trigger, TriggerDict]] | The schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty. +# Optional[Trigger] | The schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty. trigger = {"type": "time", "cronExpression": "0 0 * * *", "timeZone": "UTC"} @@ -431,65 +430,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListRunsOfScheduleResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **runs_page** -Get the most recent runs of a Schedule. If no page size is provided, a page size of 100 will be used. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**schedule_rid** | ScheduleRid | | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | - -### Return type -**ListRunsOfScheduleResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ScheduleRid -schedule_rid = None -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None - - -try: - api_response = foundry_client.orchestration.Schedule.runs_page( - schedule_rid, page_size=page_size, page_token=page_token, preview=preview - ) - print("The runs_page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Schedule.runs_page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/Orchestration/models/ActionDict.md b/docs/v2/Orchestration/models/ActionDict.md deleted file mode 100644 index 20cc6c577..000000000 --- a/docs/v2/Orchestration/models/ActionDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# ActionDict - -Action - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**target** | BuildTargetDict | Yes | | -**branchName** | BranchName | Yes | The target branch the schedule should run on. | -**fallbackBranches** | FallbackBranches | Yes | | -**forceBuild** | ForceBuild | Yes | | -**retryCount** | NotRequired[RetryCount] | No | | -**retryBackoffDuration** | NotRequired[RetryBackoffDurationDict] | No | | -**abortOnFailure** | AbortOnFailure | Yes | | -**notificationsEnabled** | NotificationsEnabled | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/AndTriggerDict.md b/docs/v2/Orchestration/models/AndTriggerDict.md deleted file mode 100644 index 2b7259fe6..000000000 --- a/docs/v2/Orchestration/models/AndTriggerDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AndTriggerDict - -Trigger after all of the given triggers emit an event. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**triggers** | List[TriggerDict] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/BuildDict.md b/docs/v2/Orchestration/models/BuildDict.md deleted file mode 100644 index feb98f551..000000000 --- a/docs/v2/Orchestration/models/BuildDict.md +++ /dev/null @@ -1,20 +0,0 @@ -# BuildDict - -Build - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | BuildRid | Yes | The RID of a Build. | -**branchName** | BranchName | Yes | The branch that the build is running on. | -**createdTime** | CreatedTime | Yes | The timestamp that the build was created. | -**createdBy** | CreatedBy | Yes | The user who created the build. | -**fallbackBranches** | FallbackBranches | Yes | | -**jobRids** | List[JobRid] | Yes | | -**retryCount** | RetryCount | Yes | | -**retryBackoffDuration** | RetryBackoffDurationDict | Yes | | -**abortOnFailure** | AbortOnFailure | Yes | | -**status** | BuildStatus | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/BuildTargetDict.md b/docs/v2/Orchestration/models/BuildTargetDict.md deleted file mode 100644 index 44f22e185..000000000 --- a/docs/v2/Orchestration/models/BuildTargetDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# BuildTargetDict - -The targets of the build. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -UpstreamTargetDict | upstream -ManualTargetDict | manual -ConnectingTargetDict | connecting - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ConnectingTargetDict.md b/docs/v2/Orchestration/models/ConnectingTargetDict.md deleted file mode 100644 index 95a01f6ef..000000000 --- a/docs/v2/Orchestration/models/ConnectingTargetDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ConnectingTargetDict - -All datasets between the input datasets (exclusive) and the -target datasets (inclusive) except for the datasets to ignore. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**inputRids** | List[BuildableRid] | Yes | The upstream input datasets (exclusive). | -**targetRids** | List[BuildableRid] | Yes | The downstream target datasets (inclusive). | -**ignoredRids** | List[BuildableRid] | Yes | The datasets between the input datasets and target datasets to exclude. | -**type** | Literal["connecting"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/CreateScheduleRequestActionDict.md b/docs/v2/Orchestration/models/CreateScheduleRequestActionDict.md deleted file mode 100644 index 46ddfb25f..000000000 --- a/docs/v2/Orchestration/models/CreateScheduleRequestActionDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# CreateScheduleRequestActionDict - -CreateScheduleRequestAction - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**abortOnFailure** | NotRequired[AbortOnFailure] | No | | -**forceBuild** | NotRequired[ForceBuild] | No | | -**retryBackoffDuration** | NotRequired[RetryBackoffDurationDict] | No | | -**retryCount** | NotRequired[RetryCount] | No | | -**fallbackBranches** | NotRequired[FallbackBranches] | No | | -**branchName** | NotRequired[BranchName] | No | The target branch the schedule should run on. | -**notificationsEnabled** | NotRequired[NotificationsEnabled] | No | | -**target** | CreateScheduleRequestBuildTargetDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/CreateScheduleRequestBuildTargetDict.md b/docs/v2/Orchestration/models/CreateScheduleRequestBuildTargetDict.md deleted file mode 100644 index 928c8a663..000000000 --- a/docs/v2/Orchestration/models/CreateScheduleRequestBuildTargetDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# CreateScheduleRequestBuildTargetDict - -The targets of the build. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -CreateScheduleRequestUpstreamTargetDict | upstream -CreateScheduleRequestManualTargetDict | manual -CreateScheduleRequestConnectingTargetDict | connecting - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/CreateScheduleRequestConnectingTargetDict.md b/docs/v2/Orchestration/models/CreateScheduleRequestConnectingTargetDict.md deleted file mode 100644 index f97a8fcfb..000000000 --- a/docs/v2/Orchestration/models/CreateScheduleRequestConnectingTargetDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# CreateScheduleRequestConnectingTargetDict - -CreateScheduleRequestConnectingTarget - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**ignoredRids** | NotRequired[List[BuildableRid]] | No | The datasets between the input datasets and target datasets to exclude. | -**targetRids** | List[BuildableRid] | Yes | The downstream target datasets (inclusive). | -**inputRids** | List[BuildableRid] | Yes | The upstream input datasets (exclusive). | -**type** | Literal["connecting"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/CreateScheduleRequestManualTargetDict.md b/docs/v2/Orchestration/models/CreateScheduleRequestManualTargetDict.md deleted file mode 100644 index 060896c5e..000000000 --- a/docs/v2/Orchestration/models/CreateScheduleRequestManualTargetDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateScheduleRequestManualTargetDict - -CreateScheduleRequestManualTarget - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**targetRids** | List[BuildableRid] | Yes | | -**type** | Literal["manual"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/CreateScheduleRequestProjectScopeDict.md b/docs/v2/Orchestration/models/CreateScheduleRequestProjectScopeDict.md deleted file mode 100644 index ea8879cd2..000000000 --- a/docs/v2/Orchestration/models/CreateScheduleRequestProjectScopeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateScheduleRequestProjectScopeDict - -CreateScheduleRequestProjectScope - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**projectRids** | List[ProjectRid] | Yes | | -**type** | Literal["project"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/CreateScheduleRequestScopeModeDict.md b/docs/v2/Orchestration/models/CreateScheduleRequestScopeModeDict.md deleted file mode 100644 index a9a4ca11e..000000000 --- a/docs/v2/Orchestration/models/CreateScheduleRequestScopeModeDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# CreateScheduleRequestScopeModeDict - -The boundaries for the schedule build. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -CreateScheduleRequestProjectScopeDict | project -CreateScheduleRequestUserScopeDict | user - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/CreateScheduleRequestUpstreamTargetDict.md b/docs/v2/Orchestration/models/CreateScheduleRequestUpstreamTargetDict.md deleted file mode 100644 index 0a97519c1..000000000 --- a/docs/v2/Orchestration/models/CreateScheduleRequestUpstreamTargetDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# CreateScheduleRequestUpstreamTargetDict - -CreateScheduleRequestUpstreamTarget - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**ignoredRids** | NotRequired[List[BuildableRid]] | No | The datasets to ignore when calculating the final set of dataset to build. | -**targetRids** | List[BuildableRid] | Yes | The target datasets. | -**type** | Literal["upstream"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/CreateScheduleRequestUserScopeDict.md b/docs/v2/Orchestration/models/CreateScheduleRequestUserScopeDict.md deleted file mode 100644 index ee2cdfb90..000000000 --- a/docs/v2/Orchestration/models/CreateScheduleRequestUserScopeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateScheduleRequestUserScopeDict - -CreateScheduleRequestUserScope - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["user"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/DatasetJobOutputDict.md b/docs/v2/Orchestration/models/DatasetJobOutputDict.md deleted file mode 100644 index 7076c2936..000000000 --- a/docs/v2/Orchestration/models/DatasetJobOutputDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# DatasetJobOutputDict - -DatasetJobOutput - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**datasetRid** | DatasetRid | Yes | | -**outputTransactionRid** | NotRequired[TransactionRid] | No | | -**type** | Literal["datasetJobOutput"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/DatasetUpdatedTriggerDict.md b/docs/v2/Orchestration/models/DatasetUpdatedTriggerDict.md deleted file mode 100644 index 4c0c7f733..000000000 --- a/docs/v2/Orchestration/models/DatasetUpdatedTriggerDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# DatasetUpdatedTriggerDict - -Trigger whenever a new transaction is committed to the -dataset on the target branch. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**datasetRid** | DatasetRid | Yes | | -**branchName** | BranchName | Yes | | -**type** | Literal["datasetUpdated"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/GetBuildsBatchRequestElementDict.md b/docs/v2/Orchestration/models/GetBuildsBatchRequestElementDict.md deleted file mode 100644 index 2bf934eea..000000000 --- a/docs/v2/Orchestration/models/GetBuildsBatchRequestElementDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetBuildsBatchRequestElementDict - -GetBuildsBatchRequestElement - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**buildRid** | BuildRid | Yes | The RID of a Build. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/GetBuildsBatchResponseDict.md b/docs/v2/Orchestration/models/GetBuildsBatchResponseDict.md deleted file mode 100644 index 9632b5c8f..000000000 --- a/docs/v2/Orchestration/models/GetBuildsBatchResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetBuildsBatchResponseDict - -GetBuildsBatchResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | Dict[BuildRid, BuildDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/GetJobsBatchRequestElementDict.md b/docs/v2/Orchestration/models/GetJobsBatchRequestElementDict.md deleted file mode 100644 index 8a48999fa..000000000 --- a/docs/v2/Orchestration/models/GetJobsBatchRequestElementDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetJobsBatchRequestElementDict - -GetJobsBatchRequestElement - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**jobRid** | JobRid | Yes | The RID of a Job. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/GetJobsBatchResponseDict.md b/docs/v2/Orchestration/models/GetJobsBatchResponseDict.md deleted file mode 100644 index f469e0cf3..000000000 --- a/docs/v2/Orchestration/models/GetJobsBatchResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetJobsBatchResponseDict - -GetJobsBatchResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | Dict[JobRid, JobDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/JobDict.md b/docs/v2/Orchestration/models/JobDict.md deleted file mode 100644 index 1e0ae3129..000000000 --- a/docs/v2/Orchestration/models/JobDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# JobDict - -Job - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | JobRid | Yes | The RID of a Job. | -**buildRid** | BuildRid | Yes | The RID of the Build that the Job belongs to. | -**startedTime** | JobStartedTime | Yes | The time this job started waiting for the dependencies to be resolved. | -**finishedTime** | NotRequired[datetime] | No | The time this job was finished. | -**jobStatus** | JobStatus | Yes | | -**outputs** | List[JobOutputDict] | Yes | Outputs of the Job. Only outputs with supported types are listed here; unsupported types are omitted. Currently supported types are Dataset and Media Set outputs. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/JobOutputDict.md b/docs/v2/Orchestration/models/JobOutputDict.md deleted file mode 100644 index 8798a98f3..000000000 --- a/docs/v2/Orchestration/models/JobOutputDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# JobOutputDict - -Other types of Job Outputs exist in Foundry. Currently, only Dataset and Media Set are supported by the API. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -DatasetJobOutputDict | datasetJobOutput -TransactionalMediaSetJobOutputDict | transactionalMediaSetJobOutput - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/JobSucceededTriggerDict.md b/docs/v2/Orchestration/models/JobSucceededTriggerDict.md deleted file mode 100644 index 9cc131409..000000000 --- a/docs/v2/Orchestration/models/JobSucceededTriggerDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# JobSucceededTriggerDict - -Trigger whenever a job succeeds on the dataset and on the target -branch. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**datasetRid** | DatasetRid | Yes | | -**branchName** | BranchName | Yes | | -**type** | Literal["jobSucceeded"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ListJobsOfBuildResponseDict.md b/docs/v2/Orchestration/models/ListJobsOfBuildResponseDict.md deleted file mode 100644 index 00634b8fe..000000000 --- a/docs/v2/Orchestration/models/ListJobsOfBuildResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListJobsOfBuildResponseDict - -ListJobsOfBuildResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[JobDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ListRunsOfScheduleResponseDict.md b/docs/v2/Orchestration/models/ListRunsOfScheduleResponseDict.md deleted file mode 100644 index e9f72a049..000000000 --- a/docs/v2/Orchestration/models/ListRunsOfScheduleResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListRunsOfScheduleResponseDict - -ListRunsOfScheduleResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[ScheduleRunDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ManualTargetDict.md b/docs/v2/Orchestration/models/ManualTargetDict.md deleted file mode 100644 index 5b6db7dd7..000000000 --- a/docs/v2/Orchestration/models/ManualTargetDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ManualTargetDict - -Manually specify all datasets to build. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**targetRids** | List[BuildableRid] | Yes | | -**type** | Literal["manual"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/MediaSetUpdatedTriggerDict.md b/docs/v2/Orchestration/models/MediaSetUpdatedTriggerDict.md deleted file mode 100644 index b90dfd68c..000000000 --- a/docs/v2/Orchestration/models/MediaSetUpdatedTriggerDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# MediaSetUpdatedTriggerDict - -Trigger whenever an update is made to a media set on the target -branch. For transactional media sets, this happens when a transaction -is committed. For non-transactional media sets, this event happens -eventually (but not necessary immediately) after an update. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**mediaSetRid** | MediaSetRid | Yes | | -**branchName** | BranchName | Yes | | -**type** | Literal["mediaSetUpdated"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/NewLogicTriggerDict.md b/docs/v2/Orchestration/models/NewLogicTriggerDict.md deleted file mode 100644 index 9c1578320..000000000 --- a/docs/v2/Orchestration/models/NewLogicTriggerDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# NewLogicTriggerDict - -Trigger whenever a new JobSpec is put on the dataset and on -that branch. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**branchName** | BranchName | Yes | | -**datasetRid** | DatasetRid | Yes | | -**type** | Literal["newLogic"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/OrTriggerDict.md b/docs/v2/Orchestration/models/OrTriggerDict.md deleted file mode 100644 index 10cf4b582..000000000 --- a/docs/v2/Orchestration/models/OrTriggerDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrTriggerDict - -Trigger whenever any of the given triggers emit an event. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**triggers** | List[TriggerDict] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ProjectScopeDict.md b/docs/v2/Orchestration/models/ProjectScopeDict.md deleted file mode 100644 index 1e29e00c8..000000000 --- a/docs/v2/Orchestration/models/ProjectScopeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectScopeDict - -The schedule will only build resources in the following projects. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**projectRids** | List[ProjectRid] | Yes | | -**type** | Literal["project"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ReplaceScheduleRequestActionDict.md b/docs/v2/Orchestration/models/ReplaceScheduleRequestActionDict.md deleted file mode 100644 index fdfbf3764..000000000 --- a/docs/v2/Orchestration/models/ReplaceScheduleRequestActionDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# ReplaceScheduleRequestActionDict - -ReplaceScheduleRequestAction - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**abortOnFailure** | NotRequired[AbortOnFailure] | No | | -**forceBuild** | NotRequired[ForceBuild] | No | | -**retryBackoffDuration** | NotRequired[RetryBackoffDurationDict] | No | | -**retryCount** | NotRequired[RetryCount] | No | | -**fallbackBranches** | NotRequired[FallbackBranches] | No | | -**branchName** | NotRequired[BranchName] | No | The target branch the schedule should run on. | -**notificationsEnabled** | NotRequired[NotificationsEnabled] | No | | -**target** | ReplaceScheduleRequestBuildTargetDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ReplaceScheduleRequestBuildTargetDict.md b/docs/v2/Orchestration/models/ReplaceScheduleRequestBuildTargetDict.md deleted file mode 100644 index 5eb81b552..000000000 --- a/docs/v2/Orchestration/models/ReplaceScheduleRequestBuildTargetDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ReplaceScheduleRequestBuildTargetDict - -The targets of the build. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -ReplaceScheduleRequestUpstreamTargetDict | upstream -ReplaceScheduleRequestManualTargetDict | manual -ReplaceScheduleRequestConnectingTargetDict | connecting - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ReplaceScheduleRequestConnectingTargetDict.md b/docs/v2/Orchestration/models/ReplaceScheduleRequestConnectingTargetDict.md deleted file mode 100644 index f13977be1..000000000 --- a/docs/v2/Orchestration/models/ReplaceScheduleRequestConnectingTargetDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ReplaceScheduleRequestConnectingTargetDict - -ReplaceScheduleRequestConnectingTarget - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**ignoredRids** | NotRequired[List[BuildableRid]] | No | The datasets between the input datasets and target datasets to exclude. | -**targetRids** | List[BuildableRid] | Yes | The downstream target datasets (inclusive). | -**inputRids** | List[BuildableRid] | Yes | The upstream input datasets (exclusive). | -**type** | Literal["connecting"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ReplaceScheduleRequestManualTargetDict.md b/docs/v2/Orchestration/models/ReplaceScheduleRequestManualTargetDict.md deleted file mode 100644 index 02715925e..000000000 --- a/docs/v2/Orchestration/models/ReplaceScheduleRequestManualTargetDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReplaceScheduleRequestManualTargetDict - -ReplaceScheduleRequestManualTarget - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**targetRids** | List[BuildableRid] | Yes | | -**type** | Literal["manual"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ReplaceScheduleRequestProjectScopeDict.md b/docs/v2/Orchestration/models/ReplaceScheduleRequestProjectScopeDict.md deleted file mode 100644 index ee5ee1cb4..000000000 --- a/docs/v2/Orchestration/models/ReplaceScheduleRequestProjectScopeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReplaceScheduleRequestProjectScopeDict - -ReplaceScheduleRequestProjectScope - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**projectRids** | List[ProjectRid] | Yes | | -**type** | Literal["project"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ReplaceScheduleRequestScopeModeDict.md b/docs/v2/Orchestration/models/ReplaceScheduleRequestScopeModeDict.md deleted file mode 100644 index f9d8116e3..000000000 --- a/docs/v2/Orchestration/models/ReplaceScheduleRequestScopeModeDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ReplaceScheduleRequestScopeModeDict - -The boundaries for the schedule build. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -ReplaceScheduleRequestProjectScopeDict | project -ReplaceScheduleRequestUserScopeDict | user - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ReplaceScheduleRequestUpstreamTargetDict.md b/docs/v2/Orchestration/models/ReplaceScheduleRequestUpstreamTargetDict.md deleted file mode 100644 index a546bcef1..000000000 --- a/docs/v2/Orchestration/models/ReplaceScheduleRequestUpstreamTargetDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ReplaceScheduleRequestUpstreamTargetDict - -ReplaceScheduleRequestUpstreamTarget - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**ignoredRids** | NotRequired[List[BuildableRid]] | No | The datasets to ignore when calculating the final set of dataset to build. | -**targetRids** | List[BuildableRid] | Yes | The target datasets. | -**type** | Literal["upstream"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ReplaceScheduleRequestUserScopeDict.md b/docs/v2/Orchestration/models/ReplaceScheduleRequestUserScopeDict.md deleted file mode 100644 index acd231578..000000000 --- a/docs/v2/Orchestration/models/ReplaceScheduleRequestUserScopeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ReplaceScheduleRequestUserScopeDict - -ReplaceScheduleRequestUserScope - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["user"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/RetryBackoffDurationDict.md b/docs/v2/Orchestration/models/RetryBackoffDurationDict.md deleted file mode 100644 index 310d7f30f..000000000 --- a/docs/v2/Orchestration/models/RetryBackoffDurationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# RetryBackoffDurationDict - -The duration to wait before retrying after a Job fails. - - -## Type -```python -DurationDict -``` - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ScheduleDict.md b/docs/v2/Orchestration/models/ScheduleDict.md deleted file mode 100644 index 579735f89..000000000 --- a/docs/v2/Orchestration/models/ScheduleDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# ScheduleDict - -Schedule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ScheduleRid | Yes | | -**displayName** | NotRequired[str] | No | | -**description** | NotRequired[str] | No | | -**currentVersionRid** | ScheduleVersionRid | Yes | The RID of the current schedule version | -**createdTime** | CreatedTime | Yes | | -**createdBy** | CreatedBy | Yes | | -**updatedTime** | UpdatedTime | Yes | | -**updatedBy** | UpdatedBy | Yes | | -**paused** | SchedulePaused | Yes | | -**trigger** | NotRequired[TriggerDict] | No | The schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty. | -**action** | ActionDict | Yes | | -**scopeMode** | ScopeModeDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ScheduleRunDict.md b/docs/v2/Orchestration/models/ScheduleRunDict.md deleted file mode 100644 index 39084a0db..000000000 --- a/docs/v2/Orchestration/models/ScheduleRunDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ScheduleRunDict - -ScheduleRun - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ScheduleRunRid | Yes | The RID of a schedule run | -**scheduleRid** | ScheduleRid | Yes | | -**scheduleVersionRid** | ScheduleVersionRid | Yes | | -**createdTime** | CreatedTime | Yes | The time at which the schedule run was created. | -**createdBy** | NotRequired[CreatedBy] | No | The Foundry user who manually invoked this schedule run. Automatic trigger runs have this field set to empty. | -**result** | NotRequired[ScheduleRunResultDict] | No | The result of triggering the schedule. If empty, it means the service is still working on triggering the schedule. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ScheduleRunErrorDict.md b/docs/v2/Orchestration/models/ScheduleRunErrorDict.md deleted file mode 100644 index 3045f9525..000000000 --- a/docs/v2/Orchestration/models/ScheduleRunErrorDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ScheduleRunErrorDict - -An error occurred attempting to run the schedule. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**errorName** | ScheduleRunErrorName | Yes | | -**description** | str | Yes | | -**type** | Literal["error"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ScheduleRunIgnoredDict.md b/docs/v2/Orchestration/models/ScheduleRunIgnoredDict.md deleted file mode 100644 index 27787722d..000000000 --- a/docs/v2/Orchestration/models/ScheduleRunIgnoredDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ScheduleRunIgnoredDict - -The schedule is not running as all targets are up-to-date. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["ignored"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ScheduleRunResultDict.md b/docs/v2/Orchestration/models/ScheduleRunResultDict.md deleted file mode 100644 index 21fd258d4..000000000 --- a/docs/v2/Orchestration/models/ScheduleRunResultDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# ScheduleRunResultDict - -The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, -ignored if all targets are up-to-date or error. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -ScheduleRunIgnoredDict | ignored -ScheduleRunSubmittedDict | submitted -ScheduleRunErrorDict | error - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ScheduleRunSubmittedDict.md b/docs/v2/Orchestration/models/ScheduleRunSubmittedDict.md deleted file mode 100644 index 823a72299..000000000 --- a/docs/v2/Orchestration/models/ScheduleRunSubmittedDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ScheduleRunSubmittedDict - -The schedule has been successfully triggered. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**buildRid** | BuildRid | Yes | | -**type** | Literal["submitted"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ScheduleSucceededTriggerDict.md b/docs/v2/Orchestration/models/ScheduleSucceededTriggerDict.md deleted file mode 100644 index 800975e83..000000000 --- a/docs/v2/Orchestration/models/ScheduleSucceededTriggerDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ScheduleSucceededTriggerDict - -Trigger whenever the specified schedule completes its action -successfully. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**scheduleRid** | ScheduleRid | Yes | | -**type** | Literal["scheduleSucceeded"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ScheduleVersionDict.md b/docs/v2/Orchestration/models/ScheduleVersionDict.md deleted file mode 100644 index e272991ba..000000000 --- a/docs/v2/Orchestration/models/ScheduleVersionDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ScheduleVersionDict - -ScheduleVersion - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ScheduleVersionRid | Yes | The RID of a schedule version | -**scheduleRid** | ScheduleRid | Yes | | -**createdTime** | CreatedTime | Yes | The time the schedule version was created | -**createdBy** | CreatedBy | Yes | The Foundry user who created the schedule version | -**trigger** | NotRequired[TriggerDict] | No | | -**action** | ActionDict | Yes | | -**scopeMode** | ScopeModeDict | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/ScopeModeDict.md b/docs/v2/Orchestration/models/ScopeModeDict.md deleted file mode 100644 index 12a35f72b..000000000 --- a/docs/v2/Orchestration/models/ScopeModeDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ScopeModeDict - -The boundaries for the schedule build. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -ProjectScopeDict | project -UserScopeDict | user - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/SearchBuildsAndFilterDict.md b/docs/v2/Orchestration/models/SearchBuildsAndFilterDict.md deleted file mode 100644 index df513df64..000000000 --- a/docs/v2/Orchestration/models/SearchBuildsAndFilterDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchBuildsAndFilterDict - -Returns the Builds where every filter is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**items** | List[SearchBuildsFilterDict] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/SearchBuildsEqualsFilterDict.md b/docs/v2/Orchestration/models/SearchBuildsEqualsFilterDict.md deleted file mode 100644 index e2ebb843a..000000000 --- a/docs/v2/Orchestration/models/SearchBuildsEqualsFilterDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchBuildsEqualsFilterDict - -SearchBuildsEqualsFilter - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | SearchBuildsEqualsFilterField | Yes | | -**value** | Any | Yes | | -**type** | Literal["eq"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/SearchBuildsFilterDict.md b/docs/v2/Orchestration/models/SearchBuildsFilterDict.md deleted file mode 100644 index 0d39af383..000000000 --- a/docs/v2/Orchestration/models/SearchBuildsFilterDict.md +++ /dev/null @@ -1,20 +0,0 @@ -# SearchBuildsFilterDict - -SearchBuildsFilter - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -SearchBuildsNotFilterDict | not -SearchBuildsOrFilterDict | or -SearchBuildsAndFilterDict | and -SearchBuildsLtFilterDict | lt -SearchBuildsGteFilterDict | gte -SearchBuildsEqualsFilterDict | eq - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/SearchBuildsGteFilterDict.md b/docs/v2/Orchestration/models/SearchBuildsGteFilterDict.md deleted file mode 100644 index 5ba43c27b..000000000 --- a/docs/v2/Orchestration/models/SearchBuildsGteFilterDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchBuildsGteFilterDict - -SearchBuildsGteFilter - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | SearchBuildsGteFilterField | Yes | | -**value** | Any | Yes | | -**type** | Literal["gte"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/SearchBuildsLtFilterDict.md b/docs/v2/Orchestration/models/SearchBuildsLtFilterDict.md deleted file mode 100644 index 8f0dd2fce..000000000 --- a/docs/v2/Orchestration/models/SearchBuildsLtFilterDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchBuildsLtFilterDict - -SearchBuildsLtFilter - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | SearchBuildsLtFilterField | Yes | | -**value** | Any | Yes | | -**type** | Literal["lt"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/SearchBuildsNotFilterDict.md b/docs/v2/Orchestration/models/SearchBuildsNotFilterDict.md deleted file mode 100644 index 5f01dc11a..000000000 --- a/docs/v2/Orchestration/models/SearchBuildsNotFilterDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchBuildsNotFilterDict - -Returns the Builds where the filter is not satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | SearchBuildsFilterDict | Yes | | -**type** | Literal["not"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/SearchBuildsOrFilterDict.md b/docs/v2/Orchestration/models/SearchBuildsOrFilterDict.md deleted file mode 100644 index 45fde8894..000000000 --- a/docs/v2/Orchestration/models/SearchBuildsOrFilterDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchBuildsOrFilterDict - -Returns the Builds where at least one filter is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**items** | List[SearchBuildsFilterDict] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/SearchBuildsOrderByDict.md b/docs/v2/Orchestration/models/SearchBuildsOrderByDict.md deleted file mode 100644 index 2f2233262..000000000 --- a/docs/v2/Orchestration/models/SearchBuildsOrderByDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# SearchBuildsOrderByDict - -SearchBuildsOrderBy - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[SearchBuildsOrderByItemDict] | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/SearchBuildsOrderByItemDict.md b/docs/v2/Orchestration/models/SearchBuildsOrderByItemDict.md deleted file mode 100644 index 5750ebdda..000000000 --- a/docs/v2/Orchestration/models/SearchBuildsOrderByItemDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchBuildsOrderByItemDict - -SearchBuildsOrderByItem - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | SearchBuildsOrderByField | Yes | | -**direction** | OrderByDirection | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/SearchBuildsResponseDict.md b/docs/v2/Orchestration/models/SearchBuildsResponseDict.md deleted file mode 100644 index 658533165..000000000 --- a/docs/v2/Orchestration/models/SearchBuildsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchBuildsResponseDict - -SearchBuildsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[BuildDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/TimeTriggerDict.md b/docs/v2/Orchestration/models/TimeTriggerDict.md deleted file mode 100644 index b5deee786..000000000 --- a/docs/v2/Orchestration/models/TimeTriggerDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# TimeTriggerDict - -Trigger on a time based schedule. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**cronExpression** | CronExpression | Yes | | -**timeZone** | ZoneId | Yes | | -**type** | Literal["time"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/TransactionalMediaSetJobOutputDict.md b/docs/v2/Orchestration/models/TransactionalMediaSetJobOutputDict.md deleted file mode 100644 index 76788dec6..000000000 --- a/docs/v2/Orchestration/models/TransactionalMediaSetJobOutputDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# TransactionalMediaSetJobOutputDict - -TransactionalMediaSetJobOutput - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**mediaSetRid** | MediaSetRid | Yes | | -**transactionId** | NotRequired[str] | No | | -**type** | Literal["transactionalMediaSetJobOutput"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/TriggerDict.md b/docs/v2/Orchestration/models/TriggerDict.md deleted file mode 100644 index f8d0722d9..000000000 --- a/docs/v2/Orchestration/models/TriggerDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# TriggerDict - -Trigger - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -JobSucceededTriggerDict | jobSucceeded -OrTriggerDict | or -NewLogicTriggerDict | newLogic -AndTriggerDict | and -DatasetUpdatedTriggerDict | datasetUpdated -ScheduleSucceededTriggerDict | scheduleSucceeded -MediaSetUpdatedTriggerDict | mediaSetUpdated -TimeTriggerDict | time - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/UpstreamTargetDict.md b/docs/v2/Orchestration/models/UpstreamTargetDict.md deleted file mode 100644 index 211838548..000000000 --- a/docs/v2/Orchestration/models/UpstreamTargetDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# UpstreamTargetDict - -Target the specified datasets along with all upstream datasets except the ignored datasets. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**targetRids** | List[BuildableRid] | Yes | The target datasets. | -**ignoredRids** | List[BuildableRid] | Yes | The datasets to ignore when calculating the final set of dataset to build. | -**type** | Literal["upstream"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Orchestration/models/UserScopeDict.md b/docs/v2/Orchestration/models/UserScopeDict.md deleted file mode 100644 index e65c15e55..000000000 --- a/docs/v2/Orchestration/models/UserScopeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# UserScopeDict - -When triggered, the schedule will build all resources that the -associated user is permitted to build. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["user"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/SqlQueries/models/CanceledQueryStatusDict.md b/docs/v2/SqlQueries/models/CanceledQueryStatusDict.md deleted file mode 100644 index 78f11b5ba..000000000 --- a/docs/v2/SqlQueries/models/CanceledQueryStatusDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CanceledQueryStatusDict - -CanceledQueryStatus - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["canceled"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/SqlQueries/models/FailedQueryStatusDict.md b/docs/v2/SqlQueries/models/FailedQueryStatusDict.md deleted file mode 100644 index 62430d60c..000000000 --- a/docs/v2/SqlQueries/models/FailedQueryStatusDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# FailedQueryStatusDict - -FailedQueryStatus - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**errorMessage** | str | Yes | An error message describing why the query failed. | -**type** | Literal["failed"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/SqlQueries/models/QueryStatusDict.md b/docs/v2/SqlQueries/models/QueryStatusDict.md deleted file mode 100644 index 3126dd4db..000000000 --- a/docs/v2/SqlQueries/models/QueryStatusDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# QueryStatusDict - -QueryStatus - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -RunningQueryStatusDict | running -CanceledQueryStatusDict | canceled -FailedQueryStatusDict | failed -SucceededQueryStatusDict | succeeded - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/SqlQueries/models/RunningQueryStatusDict.md b/docs/v2/SqlQueries/models/RunningQueryStatusDict.md deleted file mode 100644 index 2dc5b20c2..000000000 --- a/docs/v2/SqlQueries/models/RunningQueryStatusDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# RunningQueryStatusDict - -RunningQueryStatus - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**queryId** | QueryId | Yes | | -**type** | Literal["running"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/SqlQueries/models/SucceededQueryStatusDict.md b/docs/v2/SqlQueries/models/SucceededQueryStatusDict.md deleted file mode 100644 index 4c5657784..000000000 --- a/docs/v2/SqlQueries/models/SucceededQueryStatusDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SucceededQueryStatusDict - -SucceededQueryStatus - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**queryId** | QueryId | Yes | | -**type** | Literal["succeeded"] | Yes | None | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Streams/Dataset.md b/docs/v2/Streams/Dataset.md index 69a5d6f2f..59dd603e7 100644 --- a/docs/v2/Streams/Dataset.md +++ b/docs/v2/Streams/Dataset.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **name** | DatasetName | | | **parent_folder_rid** | FolderRid | | | -**schema** | Union[StreamSchema, StreamSchemaDict] | The Foundry schema to apply to the new stream. | | +**schema** | StreamSchema | The Foundry schema to apply to the new stream. | | **branch_name** | Optional[BranchName] | The branch to create the initial stream on. If not specified, the default branch will be used ('master' for most enrollments). | [optional] | **compressed** | Optional[Compressed] | Whether or not compression is enabled for the stream. Defaults to false. | [optional] | **partitions_count** | Optional[PartitionsCount] | The number of partitions for the Foundry stream. Generally, each partition can handle about 5 mb/s of data, so for higher volume streams, more partitions are recommended. If not specified, 1 partition is used. This value cannot be changed later. | [optional] | @@ -39,7 +39,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant name = "My Dataset" # FolderRid parent_folder_rid = "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791" -# Union[StreamSchema, StreamSchemaDict] | The Foundry schema to apply to the new stream. +# StreamSchema | The Foundry schema to apply to the new stream. schema = None # Optional[BranchName] | The branch to create the initial stream on. If not specified, the default branch will be used ('master' for most enrollments). branch_name = "master" diff --git a/docs/v2/Streams/Stream.md b/docs/v2/Streams/Stream.md index 91123c85d..20f68e699 100644 --- a/docs/v2/Streams/Stream.md +++ b/docs/v2/Streams/Stream.md @@ -19,7 +19,7 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **dataset_rid** | DatasetRid | | | **branch_name** | BranchName | | | -**schema** | Union[CreateStreamRequestStreamSchema, CreateStreamRequestStreamSchemaDict] | The Foundry schema for this stream. | | +**schema** | CreateStreamRequestStreamSchema | The Foundry schema for this stream. | | **compressed** | Optional[Compressed] | Whether or not compression is enabled for the stream. Defaults to false. | [optional] | **partitions_count** | Optional[PartitionsCount] | The number of partitions for the Foundry stream. Defaults to 1. Generally, each partition can handle about 5 mb/s of data, so for higher volume streams, more partitions are recommended. | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -41,7 +41,7 @@ client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palant dataset_rid = None # BranchName branch_name = "master" -# Union[CreateStreamRequestStreamSchema, CreateStreamRequestStreamSchemaDict] | The Foundry schema for this stream. +# CreateStreamRequestStreamSchema | The Foundry schema for this stream. schema = None # Optional[Compressed] | Whether or not compression is enabled for the stream. Defaults to false. compressed = False @@ -347,7 +347,7 @@ Name | Type | Description | Notes | **compressed** | Optional[Compressed] | Whether or not compression is enabled for the stream. If omitted, the compression setting of the existing stream on the branch will be used. | [optional] | **partitions_count** | Optional[PartitionsCount] | The number of partitions for the Foundry stream. Generally, each partition can handle about 5 mb/s of data, so for higher volume streams, more partitions are recommended. If omitted, the partitions count of the existing stream on the branch will be used. | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | -**schema** | Optional[Union[StreamSchema, StreamSchemaDict]] | The Foundry schema to apply to the new stream. If omitted, the schema of the existing stream on the branch will be used. | [optional] | +**schema** | Optional[StreamSchema] | The Foundry schema to apply to the new stream. If omitted, the schema of the existing stream on the branch will be used. | [optional] | **stream_type** | Optional[StreamType] | A conceptual representation of the expected shape of the data for a stream. HIGH_THROUGHPUT and LOW_LATENCY are not compatible with each other. Defaults to LOW_LATENCY. If omitted, the stream type of the existing stream on the branch will be used. | [optional] | ### Return type @@ -372,7 +372,7 @@ compressed = False partitions_count = 1 # Optional[PreviewMode] | Enables the use of preview functionality. preview = None -# Optional[Union[StreamSchema, StreamSchemaDict]] | The Foundry schema to apply to the new stream. If omitted, the schema of the existing stream on the branch will be used. +# Optional[StreamSchema] | The Foundry schema to apply to the new stream. If omitted, the schema of the existing stream on the branch will be used. schema = None # Optional[StreamType] | A conceptual representation of the expected shape of the data for a stream. HIGH_THROUGHPUT and LOW_LATENCY are not compatible with each other. Defaults to LOW_LATENCY. If omitted, the stream type of the existing stream on the branch will be used. stream_type = "LOW_LATENCY" diff --git a/docs/v2/Streams/models/CreateStreamRequestStreamSchemaDict.md b/docs/v2/Streams/models/CreateStreamRequestStreamSchemaDict.md deleted file mode 100644 index 7492ae5df..000000000 --- a/docs/v2/Streams/models/CreateStreamRequestStreamSchemaDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# CreateStreamRequestStreamSchemaDict - -CreateStreamRequestStreamSchema - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyFieldNames** | NotRequired[List[FieldName]] | No | The names of the fields to be used as keys for partitioning records. These key fields are used to group all records with the same key into the same partition, to guarantee processing order of grouped records. These keys are not meant to uniquely identify records, and do not by themselves deduplicate records. To deduplicate records, provide a change data capture configuration for the schema. Key fields can only be of the following types: - Boolean - Byte - Date - Decimal - Integer - Long - Short - String - Timestamp For additional information on keys for Foundry streams, see the [streaming keys](/docs/foundry/building-pipelines/streaming-keys/) user documentation. | -**fields** | List[FieldDict] | Yes | | -**changeDataCapture** | NotRequired[ChangeDataCaptureConfigurationDict] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Streams/models/DatasetDict.md b/docs/v2/Streams/models/DatasetDict.md deleted file mode 100644 index b82426df9..000000000 --- a/docs/v2/Streams/models/DatasetDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# DatasetDict - -Dataset - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | DatasetRid | Yes | | -**name** | DatasetName | Yes | | -**parentFolderRid** | FolderRid | Yes | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Streams/models/StreamDict.md b/docs/v2/Streams/models/StreamDict.md deleted file mode 100644 index 826cb9b61..000000000 --- a/docs/v2/Streams/models/StreamDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# StreamDict - -Stream - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**branchName** | BranchName | Yes | | -**schema_** | StreamSchemaDict | Yes | The Foundry schema for this stream. | -**viewRid** | ViewRid | Yes | The view that this stream corresponds to. | -**partitionsCount** | PartitionsCount | Yes | The number of partitions for the Foundry stream. Defaults to 1. Generally, each partition can handle about 5 mb/s of data, so for higher volume streams, more partitions are recommended. | -**streamType** | StreamType | Yes | A conceptual representation of the expected shape of the data for a stream. HIGH_THROUGHPUT and LOW_LATENCY are not compatible with each other. Defaults to LOW_LATENCY. | -**compressed** | Compressed | Yes | Whether or not compression is enabled for the stream. Defaults to false. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ThirdPartyApplications/Version.md b/docs/v2/ThirdPartyApplications/Version.md index 1e9fccaa5..7ff0f9999 100644 --- a/docs/v2/ThirdPartyApplications/Version.md +++ b/docs/v2/ThirdPartyApplications/Version.md @@ -5,7 +5,6 @@ Method | HTTP request | Release Stage | [**delete**](#delete) | **DELETE** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | Stable | [**get**](#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | Stable | [**list**](#list) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions | Stable | -[**page**](#page) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions | Stable | [**upload**](#upload) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/upload | Stable | [**upload_snapshot**](#upload_snapshot) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/uploadSnapshot | Private Beta | @@ -168,67 +167,6 @@ except foundry.PalantirRPCException as e: -### Authorization - -See [README](../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListVersionsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) - -# **page** -Lists all Versions. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**third_party_application_rid** | ThirdPartyApplicationRid | An RID identifying a third-party application created in Developer Console. | | -**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | -**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] | - -### Return type -**ListVersionsResponse** - -### Example - -```python -from foundry.v2 import FoundryClient -import foundry -from pprint import pprint - -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -# ThirdPartyApplicationRid | An RID identifying a third-party application created in Developer Console. -third_party_application_rid = ( - "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" -) -# Optional[PageSize] | The page size to use for the endpoint. -page_size = None -# 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. -page_token = None - - -try: - api_response = ( - foundry_client.third_party_applications.ThirdPartyApplication.Website.Version.page( - third_party_application_rid, page_size=page_size, page_token=page_token - ) - ) - print("The page response:\n") - pprint(api_response) -except foundry.PalantirRPCException as e: - print("HTTP error when calling Version.page: %s\n" % e) - -``` - - - ### Authorization See [README](../../../README.md#authorization) diff --git a/docs/v2/ThirdPartyApplications/models/ListVersionsResponseDict.md b/docs/v2/ThirdPartyApplications/models/ListVersionsResponseDict.md deleted file mode 100644 index 6b6ed9c09..000000000 --- a/docs/v2/ThirdPartyApplications/models/ListVersionsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListVersionsResponseDict - -ListVersionsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[VersionDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ThirdPartyApplications/models/ThirdPartyApplicationDict.md b/docs/v2/ThirdPartyApplications/models/ThirdPartyApplicationDict.md deleted file mode 100644 index bed2fca74..000000000 --- a/docs/v2/ThirdPartyApplications/models/ThirdPartyApplicationDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ThirdPartyApplicationDict - -ThirdPartyApplication - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ThirdPartyApplicationRid | Yes | An RID identifying a third-party application created in Developer Console. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ThirdPartyApplications/models/VersionDict.md b/docs/v2/ThirdPartyApplications/models/VersionDict.md deleted file mode 100644 index 6ebdfef3b..000000000 --- a/docs/v2/ThirdPartyApplications/models/VersionDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# VersionDict - -Version - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**version** | VersionVersion | Yes | The semantic version of the Website. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ThirdPartyApplications/models/WebsiteDict.md b/docs/v2/ThirdPartyApplications/models/WebsiteDict.md deleted file mode 100644 index c656ff2e4..000000000 --- a/docs/v2/ThirdPartyApplications/models/WebsiteDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# WebsiteDict - -Website - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**deployedVersion** | NotRequired[VersionVersion] | No | The version of the Website that is currently deployed. | -**subdomains** | List[Subdomain] | Yes | The subdomains from which the Website is currently served. | - - -[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/foundry/_core/__init__.py b/foundry/_core/__init__.py index a332348b6..71f41c8ac 100644 --- a/foundry/_core/__init__.py +++ b/foundry/_core/__init__.py @@ -26,9 +26,9 @@ from foundry._core.compute_module_pipeline_auth import ComputeModulePipelineAuth from foundry._core.confidential_client_auth import ConfidentialClientAuth from foundry._core.config import Config -from foundry._core.foundry_token_auth_client import UserTokenAuth from foundry._core.public_client_auth import PublicClientAuth from foundry._core.resource_iterator import ResourceIterator +from foundry._core.user_token_auth_client import UserTokenAuth from foundry._core.utils import RID from foundry._core.utils import UUID from foundry._core.utils import Long diff --git a/foundry/_core/api_client.py b/foundry/_core/api_client.py index 6b57164a6..a6f326bc0 100644 --- a/foundry/_core/api_client.py +++ b/foundry/_core/api_client.py @@ -341,15 +341,6 @@ def __init__( self._session = HttpClient(hostname, config) self._auth._parameterize(hostname, config) - @property - @deprecated( - "Accessing the session directly is deprecated. Please configure the session using the new Config class." - ) - def session(self): - # DEPRECATED: This ensures that users who were previously accessing the PalantirSession - # will have code that continues to work (now we just return the ApiClient) - return self - def call_api(self, request_info: RequestInfo) -> Any: """Makes the HTTP request (synchronous)""" response_mode = ( diff --git a/foundry/_core/compute_module_pipeline_auth.py b/foundry/_core/compute_module_pipeline_auth.py index 8d91d6654..16e2896b4 100644 --- a/foundry/_core/compute_module_pipeline_auth.py +++ b/foundry/_core/compute_module_pipeline_auth.py @@ -23,8 +23,8 @@ import httpx -from foundry._core.foundry_token_auth_client import Auth -from foundry._core.foundry_token_auth_client import Token +from foundry._core.user_token_auth_client import Auth +from foundry._core.user_token_auth_client import Token from foundry._errors.environment_not_configured import EnvironmentNotConfigured from foundry._errors.not_authenticated import NotAuthenticated diff --git a/foundry/_core/foundry_token_auth_client.py b/foundry/_core/user_token_auth_client.py similarity index 100% rename from foundry/_core/foundry_token_auth_client.py rename to foundry/_core/user_token_auth_client.py diff --git a/foundry/v1/cli.py b/foundry/v1/cli.py index 9dcc2ceeb..01e117fc3 100644 --- a/foundry/v1/cli.py +++ b/foundry/v1/cli.py @@ -594,85 +594,6 @@ def datasets_dataset_file_list( click.echo(repr(result)) -@datasets_dataset_file.command("page") -@click.argument("dataset_rid", type=str, required=True) -@click.option( - "--branch_id", - type=str, - required=False, - help="""The identifier (name) of the Branch on which to list Files. Defaults to `master` for most enrollments.""", -) -@click.option( - "--end_transaction_rid", - type=str, - required=False, - help="""The Resource Identifier (RID) of the end Transaction.""", -) -@click.option( - "--page_size", - type=int, - required=False, - help="""The desired size of the page to be returned. Defaults to 1,000. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.option( - "--start_transaction_rid", - type=str, - required=False, - help="""The Resource Identifier (RID) of the start Transaction.""", -) -@click.pass_obj -def datasets_dataset_file_page( - client: foundry.v1.FoundryClient, - dataset_rid: str, - branch_id: typing.Optional[str], - end_transaction_rid: typing.Optional[str], - page_size: typing.Optional[int], - page_token: typing.Optional[str], - start_transaction_rid: typing.Optional[str], -): - """ - Lists Files contained in a Dataset. By default files are listed on the latest view of the default - branch - `master` for most enrollments. - - #### Advanced Usage - - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - - To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most - recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the - branch if there are no snapshot transactions. - - To **list files on the resolved view of a transaction** specify the Transaction's resource identifier - as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot - transaction, or the earliest ancestor transaction if there are no snapshot transactions. - - To **list files on the resolved view of a range of transactions** specify the the start transaction's resource - identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This - will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. - Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when - the start and end transactions do not belong to the same root-to-leaf path. - - To **list files on a specific transaction** specify the Transaction's resource identifier as both the - `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that - Transaction. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - """ - result = client.datasets.Dataset.File.page( - dataset_rid=dataset_rid, - branch_id=branch_id, - end_transaction_rid=end_transaction_rid, - page_size=page_size, - page_token=page_token, - start_transaction_rid=start_transaction_rid, - ) - click.echo(repr(result)) - - @datasets_dataset_file.command("read") @click.argument("dataset_rid", type=str, required=True) @click.argument("file_path", type=str, required=True) @@ -915,38 +836,6 @@ def datasets_dataset_branch_list( click.echo(repr(result)) -@datasets_dataset_branch.command("page") -@click.argument("dataset_rid", type=str, required=True) -@click.option( - "--page_size", - type=int, - required=False, - help="""The desired size of the page to be returned. Defaults to 1,000. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.pass_obj -def datasets_dataset_branch_page( - client: foundry.v1.FoundryClient, - dataset_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], -): - """ - Lists the Branches of a Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - """ - result = client.datasets.Dataset.Branch.page( - dataset_rid=dataset_rid, - page_size=page_size, - page_token=page_token, - ) - click.echo(repr(result)) - - @cli.group("geo") def geo(): pass @@ -1232,138 +1121,6 @@ def ontologies_ontology_object_list_linked_objects( click.echo(repr(result)) -@ontologies_ontology_object.command("page") -@click.argument("ontology_rid", type=str, required=True) -@click.argument("object_type", type=str, required=True) -@click.option("--order_by", type=str, required=False, help="""""") -@click.option( - "--page_size", - type=int, - required=False, - help="""The desired size of the page to be returned. Defaults to 1,000. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.option( - "--properties", - type=str, - required=False, - help="""The properties of the object type that should be included in the response. Omit this parameter to get all -the properties. -""", -) -@click.pass_obj -def ontologies_ontology_object_page( - client: foundry.v1.FoundryClient, - ontology_rid: str, - object_type: str, - order_by: typing.Optional[str], - page_size: typing.Optional[int], - page_token: typing.Optional[str], - properties: typing.Optional[str], -): - """ - Lists the objects for the given Ontology and object type. - - This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.OntologyObject.page( - ontology_rid=ontology_rid, - object_type=object_type, - order_by=order_by, - page_size=page_size, - page_token=page_token, - properties=None if properties is None else json.loads(properties), - ) - click.echo(repr(result)) - - -@ontologies_ontology_object.command("page_linked_objects") -@click.argument("ontology_rid", type=str, required=True) -@click.argument("object_type", type=str, required=True) -@click.argument("primary_key", type=str, required=True) -@click.argument("link_type", type=str, required=True) -@click.option("--order_by", type=str, required=False, help="""""") -@click.option( - "--page_size", - type=int, - required=False, - help="""The desired size of the page to be returned. Defaults to 1,000. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.option( - "--properties", - type=str, - required=False, - help="""The properties of the object type that should be included in the response. Omit this parameter to get all -the properties. -""", -) -@click.pass_obj -def ontologies_ontology_object_page_linked_objects( - client: foundry.v1.FoundryClient, - ontology_rid: str, - object_type: str, - primary_key: str, - link_type: str, - order_by: typing.Optional[str], - page_size: typing.Optional[int], - page_token: typing.Optional[str], - properties: typing.Optional[str], -): - """ - Lists the linked objects for a specific object and the given link type. - - This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.OntologyObject.page_linked_objects( - ontology_rid=ontology_rid, - object_type=object_type, - primary_key=primary_key, - link_type=link_type, - order_by=order_by, - page_size=page_size, - page_token=page_token, - properties=None if properties is None else json.loads(properties), - ) - click.echo(repr(result)) - - @ontologies_ontology_object.command("search") @click.argument("ontology_rid", type=str, required=True) @click.argument("object_type", type=str, required=True) @@ -1529,41 +1286,6 @@ def ontologies_ontology_query_type_list( click.echo(repr(result)) -@ontologies_ontology_query_type.command("page") -@click.argument("ontology_rid", type=str, required=True) -@click.option( - "--page_size", - type=int, - required=False, - help="""The desired size of the page to be returned. Defaults to 100. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.pass_obj -def ontologies_ontology_query_type_page( - client: foundry.v1.FoundryClient, - ontology_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], -): - """ - Lists the query types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.Ontology.QueryType.page( - ontology_rid=ontology_rid, - page_size=page_size, - page_token=page_token, - ) - click.echo(repr(result)) - - @ontologies_ontology.group("object_type") def ontologies_ontology_object_type(): pass @@ -1684,73 +1406,6 @@ def ontologies_ontology_object_type_list_outgoing_link_types( click.echo(repr(result)) -@ontologies_ontology_object_type.command("page") -@click.argument("ontology_rid", type=str, required=True) -@click.option( - "--page_size", - type=int, - required=False, - help="""The desired size of the page to be returned. Defaults to 500. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.pass_obj -def ontologies_ontology_object_type_page( - client: foundry.v1.FoundryClient, - ontology_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], -): - """ - Lists the object types for the given Ontology. - - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.Ontology.ObjectType.page( - ontology_rid=ontology_rid, - page_size=page_size, - page_token=page_token, - ) - click.echo(repr(result)) - - -@ontologies_ontology_object_type.command("page_outgoing_link_types") -@click.argument("ontology_rid", type=str, required=True) -@click.argument("object_type", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The desired size of the page to be returned.""" -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.pass_obj -def ontologies_ontology_object_type_page_outgoing_link_types( - client: foundry.v1.FoundryClient, - ontology_rid: str, - object_type: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], -): - """ - List the outgoing links for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - """ - result = client.ontologies.Ontology.ObjectType.page_outgoing_link_types( - ontology_rid=ontology_rid, - object_type=object_type, - page_size=page_size, - page_token=page_token, - ) - click.echo(repr(result)) - - @ontologies_ontology.group("action_type") def ontologies_ontology_action_type(): pass @@ -1813,41 +1468,6 @@ def ontologies_ontology_action_type_list( click.echo(repr(result)) -@ontologies_ontology_action_type.command("page") -@click.argument("ontology_rid", type=str, required=True) -@click.option( - "--page_size", - type=int, - required=False, - help="""The desired size of the page to be returned. Defaults to 500. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.pass_obj -def ontologies_ontology_action_type_page( - client: foundry.v1.FoundryClient, - ontology_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], -): - """ - Lists the action types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.Ontology.ActionType.page( - ontology_rid=ontology_rid, - page_size=page_size, - page_token=page_token, - ) - click.echo(repr(result)) - - @ontologies.group("attachment") def ontologies_attachment(): pass diff --git a/foundry/v1/core/models.py b/foundry/v1/core/models.py index c2c56e6cb..fcc05d9cd 100644 --- a/foundry/v1/core/models.py +++ b/foundry/v1/core/models.py @@ -18,7 +18,6 @@ import typing import pydantic -import typing_extensions from foundry import _core as core @@ -29,25 +28,20 @@ class AnyType(pydantic.BaseModel): type: typing.Literal["any"] = "any" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AnyTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AnyTypeDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) -class AnyTypeDict(typing_extensions.TypedDict): - """AnyType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["any"] - - -class AttachmentTypeDict(typing_extensions.TypedDict): +class AttachmentType(pydantic.BaseModel): """AttachmentType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + type: typing.Literal["attachment"] = "attachment" + model_config = {"extra": "allow", "populate_by_name": True} - type: typing.Literal["attachment"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) class BinaryType(pydantic.BaseModel): @@ -56,17 +50,9 @@ class BinaryType(pydantic.BaseModel): type: typing.Literal["binary"] = "binary" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BinaryTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(BinaryTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class BinaryTypeDict(typing_extensions.TypedDict): - """BinaryType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["binary"] + return self.model_dump(by_alias=True, exclude_none=True) class BooleanType(pydantic.BaseModel): @@ -75,17 +61,9 @@ class BooleanType(pydantic.BaseModel): type: typing.Literal["boolean"] = "boolean" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BooleanTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(BooleanTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class BooleanTypeDict(typing_extensions.TypedDict): - """BooleanType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["boolean"] + return self.model_dump(by_alias=True, exclude_none=True) class ByteType(pydantic.BaseModel): @@ -94,17 +72,9 @@ class ByteType(pydantic.BaseModel): type: typing.Literal["byte"] = "byte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ByteTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ByteTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ByteTypeDict(typing_extensions.TypedDict): - """ByteType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["byte"] + return self.model_dump(by_alias=True, exclude_none=True) class CipherTextType(pydantic.BaseModel): @@ -116,20 +86,9 @@ class CipherTextType(pydantic.BaseModel): type: typing.Literal["cipherText"] = "cipherText" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CipherTextTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(CipherTextTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class CipherTextTypeDict(typing_extensions.TypedDict): - """CipherTextType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - defaultCipherChannel: typing_extensions.NotRequired[str] - """An optional Cipher Channel RID which can be used for encryption updates to empty values.""" - - type: typing.Literal["cipherText"] + return self.model_dump(by_alias=True, exclude_none=True) ContentLength = core.Long @@ -146,17 +105,9 @@ class DateType(pydantic.BaseModel): type: typing.Literal["date"] = "date" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DateTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DateTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DateTypeDict(typing_extensions.TypedDict): - """DateType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["date"] + return self.model_dump(by_alias=True, exclude_none=True) class DecimalType(pydantic.BaseModel): @@ -171,23 +122,9 @@ class DecimalType(pydantic.BaseModel): type: typing.Literal["decimal"] = "decimal" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DecimalTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DecimalTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DecimalTypeDict(typing_extensions.TypedDict): - """DecimalType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - precision: typing_extensions.NotRequired[int] - """The total number of digits of the Decimal type. The maximum value is 38.""" - - scale: typing_extensions.NotRequired[int] - """The number of digits to the right of the decimal point. The maximum value is 38.""" - - type: typing.Literal["decimal"] + return self.model_dump(by_alias=True, exclude_none=True) DisplayName = str @@ -214,17 +151,9 @@ class DoubleType(pydantic.BaseModel): type: typing.Literal["double"] = "double" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DoubleTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DoubleTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DoubleTypeDict(typing_extensions.TypedDict): - """DoubleType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["double"] + return self.model_dump(by_alias=True, exclude_none=True) FilePath = str @@ -241,17 +170,9 @@ class FloatType(pydantic.BaseModel): type: typing.Literal["float"] = "float" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FloatTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(FloatTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class FloatTypeDict(typing_extensions.TypedDict): - """FloatType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["float"] + return self.model_dump(by_alias=True, exclude_none=True) FolderRid = core.RID @@ -264,17 +185,9 @@ class IntegerType(pydantic.BaseModel): type: typing.Literal["integer"] = "integer" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "IntegerTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(IntegerTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class IntegerTypeDict(typing_extensions.TypedDict): - """IntegerType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["integer"] + return self.model_dump(by_alias=True, exclude_none=True) class LongType(pydantic.BaseModel): @@ -283,17 +196,9 @@ class LongType(pydantic.BaseModel): type: typing.Literal["long"] = "long" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LongTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(LongTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class LongTypeDict(typing_extensions.TypedDict): - """LongType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["long"] + return self.model_dump(by_alias=True, exclude_none=True) class MarkingType(pydantic.BaseModel): @@ -302,17 +207,9 @@ class MarkingType(pydantic.BaseModel): type: typing.Literal["marking"] = "marking" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MarkingTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MarkingTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MarkingTypeDict(typing_extensions.TypedDict): - """MarkingType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["marking"] + return self.model_dump(by_alias=True, exclude_none=True) MediaType = str @@ -322,12 +219,15 @@ class MarkingTypeDict(typing_extensions.TypedDict): """ -class NullTypeDict(typing_extensions.TypedDict): +class NullType(pydantic.BaseModel): """NullType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + type: typing.Literal["null"] = "null" + model_config = {"extra": "allow", "populate_by_name": True} - type: typing.Literal["null"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) OperationScope = str @@ -360,17 +260,9 @@ class ShortType(pydantic.BaseModel): type: typing.Literal["short"] = "short" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ShortTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ShortTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ShortTypeDict(typing_extensions.TypedDict): - """ShortType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["short"] + return self.model_dump(by_alias=True, exclude_none=True) SizeBytes = core.Long @@ -383,17 +275,9 @@ class StringType(pydantic.BaseModel): type: typing.Literal["string"] = "string" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StringTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(StringTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class StringTypeDict(typing_extensions.TypedDict): - """StringType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["string"] + return self.model_dump(by_alias=True, exclude_none=True) StructFieldName = str @@ -406,17 +290,9 @@ class TimestampType(pydantic.BaseModel): type: typing.Literal["timestamp"] = "timestamp" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TimestampTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(TimestampTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class TimestampTypeDict(typing_extensions.TypedDict): - """TimestampType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["timestamp"] + return self.model_dump(by_alias=True, exclude_none=True) TotalCount = core.Long @@ -430,69 +306,44 @@ class UnsupportedType(pydantic.BaseModel): type: typing.Literal["unsupported"] = "unsupported" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "UnsupportedTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(UnsupportedTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class UnsupportedTypeDict(typing_extensions.TypedDict): - """UnsupportedType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - unsupportedType: str - type: typing.Literal["unsupported"] + return self.model_dump(by_alias=True, exclude_none=True) __all__ = [ "AnyType", - "AnyTypeDict", - "AttachmentTypeDict", + "AttachmentType", "BinaryType", - "BinaryTypeDict", "BooleanType", - "BooleanTypeDict", "ByteType", - "ByteTypeDict", "CipherTextType", - "CipherTextTypeDict", "ContentLength", "ContentType", "DateType", - "DateTypeDict", "DecimalType", - "DecimalTypeDict", "DisplayName", "DistanceUnit", "DoubleType", - "DoubleTypeDict", "FilePath", "Filename", "FloatType", - "FloatTypeDict", "FolderRid", "IntegerType", - "IntegerTypeDict", "LongType", - "LongTypeDict", "MarkingType", - "MarkingTypeDict", "MediaType", - "NullTypeDict", + "NullType", "OperationScope", "PageSize", "PageToken", "PreviewMode", "ReleaseStatus", "ShortType", - "ShortTypeDict", "SizeBytes", "StringType", - "StringTypeDict", "StructFieldName", "TimestampType", - "TimestampTypeDict", "TotalCount", "UnsupportedType", - "UnsupportedTypeDict", ] diff --git a/foundry/v1/datasets/branch.py b/foundry/v1/datasets/branch.py index e9f04ff08..e97d5b9d4 100644 --- a/foundry/v1/datasets/branch.py +++ b/foundry/v1/datasets/branch.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -251,64 +250,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - dataset_rid: datasets_models.DatasetRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> datasets_models.ListBranchesResponse: - """ - Lists the Branches of a Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - :param dataset_rid: The Resource Identifier (RID) of the Dataset on which to list Branches. - :type dataset_rid: DatasetRid - :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: datasets_models.ListBranchesResponse - """ - - warnings.warn( - "The client.datasets.Branch.page(...) method has been deprecated. Please use client.datasets.Branch.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v1/datasets/{datasetRid}/branches", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - }, - path_params={ - "datasetRid": dataset_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=datasets_models.ListBranchesResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _BranchClientRaw: def __init__(self, client: BranchClient) -> None: @@ -316,13 +257,11 @@ def create(_: datasets_models.Branch): ... def delete(_: None): ... def get(_: datasets_models.Branch): ... def list(_: datasets_models.ListBranchesResponse): ... - def page(_: datasets_models.ListBranchesResponse): ... self.create = core.with_raw_response(create, client.create) self.delete = core.with_raw_response(delete, client.delete) self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) class _BranchClientStreaming: @@ -330,9 +269,7 @@ def __init__(self, client: BranchClient) -> None: def create(_: datasets_models.Branch): ... def get(_: datasets_models.Branch): ... def list(_: datasets_models.ListBranchesResponse): ... - def page(_: datasets_models.ListBranchesResponse): ... self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v1/datasets/client.py b/foundry/v1/datasets/client.py deleted file mode 100644 index d3734372e..000000000 --- a/foundry/v1/datasets/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v1.datasets._client import DatasetsClient - -__all__ = [ - "DatasetsClient", -] diff --git a/foundry/v1/datasets/file.py b/foundry/v1/datasets/file.py index 8543c6eec..c60fea941 100644 --- a/foundry/v1/datasets/file.py +++ b/foundry/v1/datasets/file.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -283,99 +282,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - dataset_rid: datasets_models.DatasetRid, - *, - branch_id: typing.Optional[datasets_models.BranchId] = None, - end_transaction_rid: typing.Optional[datasets_models.TransactionRid] = None, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - start_transaction_rid: typing.Optional[datasets_models.TransactionRid] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> datasets_models.ListFilesResponse: - """ - Lists Files contained in a Dataset. By default files are listed on the latest view of the default - branch - `master` for most enrollments. - - #### Advanced Usage - - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - - To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most - recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the - branch if there are no snapshot transactions. - - To **list files on the resolved view of a transaction** specify the Transaction's resource identifier - as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot - transaction, or the earliest ancestor transaction if there are no snapshot transactions. - - To **list files on the resolved view of a range of transactions** specify the the start transaction's resource - identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This - will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. - Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when - the start and end transactions do not belong to the same root-to-leaf path. - - To **list files on a specific transaction** specify the Transaction's resource identifier as both the - `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that - Transaction. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - :param dataset_rid: The Resource Identifier (RID) of the Dataset on which to list Files. - :type dataset_rid: DatasetRid - :param branch_id: The identifier (name) of the Branch on which to list Files. Defaults to `master` for most enrollments. - :type branch_id: Optional[BranchId] - :param end_transaction_rid: The Resource Identifier (RID) of the end Transaction. - :type end_transaction_rid: Optional[TransactionRid] - :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param start_transaction_rid: The Resource Identifier (RID) of the start Transaction. - :type start_transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: datasets_models.ListFilesResponse - """ - - warnings.warn( - "The client.datasets.File.page(...) method has been deprecated. Please use client.datasets.File.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v1/datasets/{datasetRid}/files", - query_params={ - "branchId": branch_id, - "endTransactionRid": end_transaction_rid, - "pageSize": page_size, - "pageToken": page_token, - "startTransactionRid": start_transaction_rid, - }, - path_params={ - "datasetRid": dataset_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=datasets_models.ListFilesResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -545,14 +451,12 @@ def __init__(self, client: FileClient) -> None: def delete(_: None): ... def get(_: datasets_models.File): ... def list(_: datasets_models.ListFilesResponse): ... - def page(_: datasets_models.ListFilesResponse): ... def read(_: bytes): ... def upload(_: datasets_models.File): ... self.delete = core.with_raw_response(delete, client.delete) self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) self.read = core.with_raw_response(read, client.read) self.upload = core.with_raw_response(upload, client.upload) @@ -561,12 +465,10 @@ class _FileClientStreaming: def __init__(self, client: FileClient) -> None: def get(_: datasets_models.File): ... def list(_: datasets_models.ListFilesResponse): ... - def page(_: datasets_models.ListFilesResponse): ... def read(_: bytes): ... def upload(_: datasets_models.File): ... self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) self.read = core.with_streaming_response(read, client.read) self.upload = core.with_streaming_response(upload, client.upload) diff --git a/foundry/v1/datasets/models.py b/foundry/v1/datasets/models.py index 6b35905a0..af9335579 100644 --- a/foundry/v1/datasets/models.py +++ b/foundry/v1/datasets/models.py @@ -19,7 +19,6 @@ from datetime import datetime import pydantic -import typing_extensions from foundry import _core as core from foundry.v1.core import models as core_models @@ -32,18 +31,9 @@ class Branch(pydantic.BaseModel): transaction_rid: typing.Optional[TransactionRid] = pydantic.Field(alias=str("transactionRid"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BranchDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(BranchDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class BranchDict(typing_extensions.TypedDict): - """A Branch of a Dataset.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - branchId: BranchId - transactionRid: typing_extensions.NotRequired[TransactionRid] + return self.model_dump(by_alias=True, exclude_none=True) BranchId = str @@ -58,19 +48,9 @@ class Dataset(pydantic.BaseModel): parent_folder_rid: core_models.FolderRid = pydantic.Field(alias=str("parentFolderRid")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DatasetDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DatasetDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DatasetDict(typing_extensions.TypedDict): - """Dataset""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: DatasetRid - name: DatasetName - parentFolderRid: core_models.FolderRid + return self.model_dump(by_alias=True, exclude_none=True) DatasetName = str @@ -90,20 +70,9 @@ class File(pydantic.BaseModel): updated_time: datetime = pydantic.Field(alias=str("updatedTime")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FileDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(FileDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class FileDict(typing_extensions.TypedDict): - """File""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - path: core_models.FilePath - transactionRid: TransactionRid - sizeBytes: typing_extensions.NotRequired[core.Long] - updatedTime: datetime + return self.model_dump(by_alias=True, exclude_none=True) class ListBranchesResponse(pydantic.BaseModel): @@ -115,21 +84,9 @@ class ListBranchesResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListBranchesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListBranchesResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListBranchesResponseDict(typing_extensions.TypedDict): - """ListBranchesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[BranchDict] - """The list of branches in the current page.""" + return self.model_dump(by_alias=True, exclude_none=True) class ListFilesResponse(pydantic.BaseModel): @@ -139,18 +96,9 @@ class ListFilesResponse(pydantic.BaseModel): data: typing.List[File] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListFilesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ListFilesResponseDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ListFilesResponseDict(typing_extensions.TypedDict): - """A page of Files and an optional page token that can be used to retrieve the next page.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[FileDict] + return self.model_dump(by_alias=True, exclude_none=True) TableExportFormat = typing.Literal["ARROW", "CSV"] @@ -171,24 +119,9 @@ class Transaction(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TransactionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(TransactionDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class TransactionDict(typing_extensions.TypedDict): - """An operation that modifies the files within a dataset.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: TransactionRid - transactionType: TransactionType - status: TransactionStatus - createdTime: datetime - """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" - - closedTime: typing_extensions.NotRequired[datetime] - """The timestamp when the transaction was closed, in ISO 8601 timestamp format.""" + return self.model_dump(by_alias=True, exclude_none=True) TransactionRid = core.RID @@ -205,21 +138,15 @@ class TransactionDict(typing_extensions.TypedDict): __all__ = [ "Branch", - "BranchDict", "BranchId", "Dataset", - "DatasetDict", "DatasetName", "DatasetRid", "File", - "FileDict", "ListBranchesResponse", - "ListBranchesResponseDict", "ListFilesResponse", - "ListFilesResponseDict", "TableExportFormat", "Transaction", - "TransactionDict", "TransactionRid", "TransactionStatus", "TransactionType", diff --git a/foundry/v1/ontologies/action.py b/foundry/v1/ontologies/action.py index accfe8470..3a7000d97 100644 --- a/foundry/v1/ontologies/action.py +++ b/foundry/v1/ontologies/action.py @@ -122,11 +122,7 @@ def apply_batch( ontology_rid: ontologies_models.OntologyRid, action_type: ontologies_models.ActionTypeApiName, *, - requests: typing.List[ - typing.Union[ - ontologies_models.ApplyActionRequest, ontologies_models.ApplyActionRequestDict - ] - ], + requests: typing.List[ontologies_models.ApplyActionRequest], request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> ontologies_models.BatchApplyActionResponse: @@ -148,7 +144,7 @@ def apply_batch( :param action_type: The API name of the action to apply. To find the API name for your action, use the **List action types** endpoint or check the **Ontology Manager**. :type action_type: ActionTypeApiName :param requests: - :type requests: List[Union[ApplyActionRequest, ApplyActionRequestDict]] + :type requests: List[ApplyActionRequest] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -174,12 +170,7 @@ def apply_batch( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "requests": typing.List[ - typing.Union[ - ontologies_models.ApplyActionRequest, - ontologies_models.ApplyActionRequestDict, - ] - ], + "requests": typing.List[ontologies_models.ApplyActionRequest], }, ), response_type=ontologies_models.BatchApplyActionResponse, diff --git a/foundry/v1/ontologies/action_type.py b/foundry/v1/ontologies/action_type.py index ed7ae7535..607b37c47 100644 --- a/foundry/v1/ontologies/action_type.py +++ b/foundry/v1/ontologies/action_type.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -150,85 +149,20 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - ontology_rid: ontologies_models.OntologyRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.ListActionTypesResponse: - """ - Lists the action types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. - :type ontology_rid: OntologyRid - :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.ListActionTypesResponse - """ - - warnings.warn( - "The client.ontologies.ActionType.page(...) method has been deprecated. Please use client.ontologies.ActionType.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/actionTypes", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - }, - path_params={ - "ontologyRid": ontology_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=ontologies_models.ListActionTypesResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _ActionTypeClientRaw: def __init__(self, client: ActionTypeClient) -> None: def get(_: ontologies_models.ActionType): ... def list(_: ontologies_models.ListActionTypesResponse): ... - def page(_: ontologies_models.ListActionTypesResponse): ... self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) class _ActionTypeClientStreaming: def __init__(self, client: ActionTypeClient) -> None: def get(_: ontologies_models.ActionType): ... def list(_: ontologies_models.ListActionTypesResponse): ... - def page(_: ontologies_models.ListActionTypesResponse): ... self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v1/ontologies/client.py b/foundry/v1/ontologies/client.py deleted file mode 100644 index e7dd28d33..000000000 --- a/foundry/v1/ontologies/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v1.ontologies._client import OntologiesClient - -__all__ = [ - "OntologiesClient", -] diff --git a/foundry/v1/ontologies/errors.py b/foundry/v1/ontologies/errors.py index 1f19a084c..e38305e32 100644 --- a/foundry/v1/ontologies/errors.py +++ b/foundry/v1/ontologies/errors.py @@ -753,7 +753,7 @@ class InvalidQueryParameterValueParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - parameterDataType: ontologies_models.QueryDataTypeDict + parameterDataType: ontologies_models.QueryDataType parameterId: ontologies_models.ParameterId parameterValue: typing_extensions.NotRequired[ontologies_models.DataValue] diff --git a/foundry/v1/ontologies/models.py b/foundry/v1/ontologies/models.py index 91fe645c6..4509acc90 100644 --- a/foundry/v1/ontologies/models.py +++ b/foundry/v1/ontologies/models.py @@ -39,9 +39,9 @@ class ActionType(pydantic.BaseModel): operations: typing.List[LogicRule] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ActionTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ActionTypeDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) ActionTypeApiName = str @@ -51,20 +51,6 @@ def to_dict(self) -> "ActionTypeDict": """ -class ActionTypeDict(typing_extensions.TypedDict): - """Represents an action type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ActionTypeApiName - description: typing_extensions.NotRequired[str] - displayName: typing_extensions.NotRequired[core_models.DisplayName] - status: core_models.ReleaseStatus - parameters: typing.Dict[ParameterId, ParameterDict] - rid: ActionTypeRid - operations: typing.List[LogicRuleDict] - - ActionTypeRid = core.RID """The unique resource identifier of an action type, useful for interacting with other Foundry APIs.""" @@ -77,21 +63,9 @@ class AggregateObjectsResponse(pydantic.BaseModel): data: typing.List[AggregateObjectsResponseItem] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregateObjectsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregateObjectsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregateObjectsResponseDict(typing_extensions.TypedDict): - """AggregateObjectsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - excludedItems: typing_extensions.NotRequired[int] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[AggregateObjectsResponseItemDict] + return self.model_dump(by_alias=True, exclude_none=True) class AggregateObjectsResponseItem(pydantic.BaseModel): @@ -101,20 +75,9 @@ class AggregateObjectsResponseItem(pydantic.BaseModel): metrics: typing.List[AggregationMetricResult] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregateObjectsResponseItemDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregateObjectsResponseItemDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregateObjectsResponseItemDict(typing_extensions.TypedDict): - """AggregateObjectsResponseItem""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - group: typing.Dict[AggregationGroupKey, AggregationGroupValue] - metrics: typing.List[AggregationMetricResultDict] + return self.model_dump(by_alias=True, exclude_none=True) Aggregation = typing_extensions.Annotated[ @@ -131,20 +94,6 @@ class AggregateObjectsResponseItemDict(typing_extensions.TypedDict): """Specifies an aggregation function.""" -AggregationDict = typing_extensions.Annotated[ - typing.Union[ - "ApproximateDistinctAggregationDict", - "MinAggregationDict", - "AvgAggregationDict", - "MaxAggregationDict", - "CountAggregationDict", - "SumAggregationDict", - ], - pydantic.Field(discriminator="type"), -] -"""Specifies an aggregation function.""" - - class AggregationDurationGrouping(pydantic.BaseModel): """ Divides objects into groups according to an interval. Note that this grouping applies only on date types. @@ -156,24 +105,9 @@ class AggregationDurationGrouping(pydantic.BaseModel): type: typing.Literal["duration"] = "duration" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregationDurationGroupingDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregationDurationGroupingDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregationDurationGroupingDict(typing_extensions.TypedDict): - """ - Divides objects into groups according to an interval. Note that this grouping applies only on date types. - The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - duration: Duration - type: typing.Literal["duration"] + return self.model_dump(by_alias=True, exclude_none=True) class AggregationExactGrouping(pydantic.BaseModel): @@ -184,21 +118,9 @@ class AggregationExactGrouping(pydantic.BaseModel): type: typing.Literal["exact"] = "exact" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregationExactGroupingDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregationExactGroupingDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregationExactGroupingDict(typing_extensions.TypedDict): - """Divides objects into groups according to an exact value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - maxGroupCount: typing_extensions.NotRequired[int] - type: typing.Literal["exact"] + return self.model_dump(by_alias=True, exclude_none=True) class AggregationFixedWidthGrouping(pydantic.BaseModel): @@ -209,21 +131,9 @@ class AggregationFixedWidthGrouping(pydantic.BaseModel): type: typing.Literal["fixedWidth"] = "fixedWidth" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregationFixedWidthGroupingDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregationFixedWidthGroupingDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregationFixedWidthGroupingDict(typing_extensions.TypedDict): - """Divides objects into groups with the specified width.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - fixedWidth: int - type: typing.Literal["fixedWidth"] + return self.model_dump(by_alias=True, exclude_none=True) AggregationGroupBy = typing_extensions.Annotated[ @@ -238,18 +148,6 @@ class AggregationFixedWidthGroupingDict(typing_extensions.TypedDict): """Specifies a grouping for aggregation results.""" -AggregationGroupByDict = typing_extensions.Annotated[ - typing.Union[ - AggregationDurationGroupingDict, - AggregationFixedWidthGroupingDict, - "AggregationRangesGroupingDict", - AggregationExactGroupingDict, - ], - pydantic.Field(discriminator="type"), -] -"""Specifies a grouping for aggregation results.""" - - AggregationGroupKey = str """AggregationGroupKey""" @@ -271,21 +169,9 @@ class AggregationMetricResult(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregationMetricResultDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregationMetricResultDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregationMetricResultDict(typing_extensions.TypedDict): - """AggregationMetricResult""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: str - value: typing_extensions.NotRequired[float] - """TBD""" + return self.model_dump(by_alias=True, exclude_none=True) class AggregationRange(pydantic.BaseModel): @@ -305,27 +191,9 @@ class AggregationRange(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregationRangeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AggregationRangeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AggregationRangeDict(typing_extensions.TypedDict): - """Specifies a date range from an inclusive start date to an exclusive end date.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - lt: typing_extensions.NotRequired[typing.Any] - """Exclusive end date.""" - - lte: typing_extensions.NotRequired[typing.Any] - """Inclusive end date.""" - - gt: typing_extensions.NotRequired[typing.Any] - """Exclusive start date.""" - - gte: typing_extensions.NotRequired[typing.Any] - """Inclusive start date.""" + return self.model_dump(by_alias=True, exclude_none=True) class AggregationRangesGrouping(pydantic.BaseModel): @@ -336,21 +204,9 @@ class AggregationRangesGrouping(pydantic.BaseModel): type: typing.Literal["ranges"] = "ranges" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregationRangesGroupingDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregationRangesGroupingDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregationRangesGroupingDict(typing_extensions.TypedDict): - """Divides objects into groups according to specified ranges.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - ranges: typing.List[AggregationRangeDict] - type: typing.Literal["ranges"] + return self.model_dump(by_alias=True, exclude_none=True) class AllTermsQuery(pydantic.BaseModel): @@ -365,23 +221,9 @@ class AllTermsQuery(pydantic.BaseModel): type: typing.Literal["allTerms"] = "allTerms" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AllTermsQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AllTermsQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AllTermsQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - value: str - fuzzy: typing_extensions.NotRequired[Fuzzy] - type: typing.Literal["allTerms"] + return self.model_dump(by_alias=True, exclude_none=True) class AndQuery(pydantic.BaseModel): @@ -391,18 +233,9 @@ class AndQuery(pydantic.BaseModel): type: typing.Literal["and"] = "and" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AndQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AndQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AndQueryDict(typing_extensions.TypedDict): - """Returns objects where every query is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: typing.List[SearchJsonQueryDict] - type: typing.Literal["and"] + return self.model_dump(by_alias=True, exclude_none=True) class AnyTermQuery(pydantic.BaseModel): @@ -417,23 +250,9 @@ class AnyTermQuery(pydantic.BaseModel): type: typing.Literal["anyTerm"] = "anyTerm" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AnyTermQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AnyTermQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AnyTermQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field contains any of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - value: str - fuzzy: typing_extensions.NotRequired[Fuzzy] - type: typing.Literal["anyTerm"] + return self.model_dump(by_alias=True, exclude_none=True) ApplyActionMode = typing.Literal["VALIDATE_ONLY", "VALIDATE_AND_EXECUTE"] @@ -446,19 +265,9 @@ class ApplyActionRequest(pydantic.BaseModel): parameters: typing.Dict[ParameterId, typing.Optional[DataValue]] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ApplyActionRequestDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ApplyActionRequestDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ApplyActionRequestDict(typing_extensions.TypedDict): - """ApplyActionRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: typing.Dict[ParameterId, typing.Optional[DataValue]] + return self.model_dump(by_alias=True, exclude_none=True) class ApplyActionRequestOptions(pydantic.BaseModel): @@ -468,20 +277,9 @@ class ApplyActionRequestOptions(pydantic.BaseModel): return_edits: typing.Optional[ReturnEditsMode] = pydantic.Field(alias=str("returnEdits"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ApplyActionRequestOptionsDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ApplyActionRequestOptionsDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ApplyActionRequestOptionsDict(typing_extensions.TypedDict): - """ApplyActionRequestOptions""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - mode: typing_extensions.NotRequired[ApplyActionMode] - returnEdits: typing_extensions.NotRequired[ReturnEditsMode] + return self.model_dump(by_alias=True, exclude_none=True) class ApplyActionResponse(pydantic.BaseModel): @@ -489,17 +287,9 @@ class ApplyActionResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ApplyActionResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ApplyActionResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ApplyActionResponseDict(typing_extensions.TypedDict): - """ApplyActionResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore + return self.model_dump(by_alias=True, exclude_none=True) class ApproximateDistinctAggregation(pydantic.BaseModel): @@ -510,21 +300,9 @@ class ApproximateDistinctAggregation(pydantic.BaseModel): type: typing.Literal["approximateDistinct"] = "approximateDistinct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ApproximateDistinctAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ApproximateDistinctAggregationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ApproximateDistinctAggregationDict(typing_extensions.TypedDict): - """Computes an approximate number of distinct values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - name: typing_extensions.NotRequired[AggregationMetricName] - type: typing.Literal["approximateDistinct"] + return self.model_dump(by_alias=True, exclude_none=True) class ArraySizeConstraint(pydantic.BaseModel): @@ -545,31 +323,9 @@ class ArraySizeConstraint(pydantic.BaseModel): type: typing.Literal["arraySize"] = "arraySize" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ArraySizeConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ArraySizeConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ArraySizeConstraintDict(typing_extensions.TypedDict): - """The parameter expects an array of values and the size of the array must fall within the defined range.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - lt: typing_extensions.NotRequired[typing.Any] - """Less than""" - - lte: typing_extensions.NotRequired[typing.Any] - """Less than or equal""" - - gt: typing_extensions.NotRequired[typing.Any] - """Greater than""" - - gte: typing_extensions.NotRequired[typing.Any] - """Greater than or equal""" - - type: typing.Literal["arraySize"] + return self.model_dump(by_alias=True, exclude_none=True) ArtifactRepositoryRid = core.RID @@ -585,20 +341,9 @@ class Attachment(pydantic.BaseModel): media_type: core_models.MediaType = pydantic.Field(alias=str("mediaType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AttachmentDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AttachmentDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AttachmentDict(typing_extensions.TypedDict): - """The representation of an attachment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: AttachmentRid - filename: core_models.Filename - sizeBytes: core_models.SizeBytes - mediaType: core_models.MediaType + return self.model_dump(by_alias=True, exclude_none=True) AttachmentRid = core.RID @@ -613,19 +358,9 @@ class AvgAggregation(pydantic.BaseModel): type: typing.Literal["avg"] = "avg" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AvgAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AvgAggregationDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AvgAggregationDict(typing_extensions.TypedDict): - """Computes the average value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - name: typing_extensions.NotRequired[AggregationMetricName] - type: typing.Literal["avg"] + return self.model_dump(by_alias=True, exclude_none=True) class BatchApplyActionResponse(pydantic.BaseModel): @@ -633,17 +368,9 @@ class BatchApplyActionResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BatchApplyActionResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - BatchApplyActionResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class BatchApplyActionResponseDict(typing_extensions.TypedDict): - """BatchApplyActionResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore + return self.model_dump(by_alias=True, exclude_none=True) class ContainsQuery(pydantic.BaseModel): @@ -654,19 +381,9 @@ class ContainsQuery(pydantic.BaseModel): type: typing.Literal["contains"] = "contains" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ContainsQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ContainsQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ContainsQueryDict(typing_extensions.TypedDict): - """Returns objects where the specified array contains a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - value: PropertyValue - type: typing.Literal["contains"] + return self.model_dump(by_alias=True, exclude_none=True) class CountAggregation(pydantic.BaseModel): @@ -676,18 +393,9 @@ class CountAggregation(pydantic.BaseModel): type: typing.Literal["count"] = "count" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CountAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(CountAggregationDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class CountAggregationDict(typing_extensions.TypedDict): - """Computes the total count of objects.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: typing_extensions.NotRequired[AggregationMetricName] - type: typing.Literal["count"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateInterfaceObjectRule(pydantic.BaseModel): @@ -697,20 +405,9 @@ class CreateInterfaceObjectRule(pydantic.BaseModel): type: typing.Literal["createInterfaceObject"] = "createInterfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateInterfaceObjectRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateInterfaceObjectRuleDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class CreateInterfaceObjectRuleDict(typing_extensions.TypedDict): - """CreateInterfaceObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - interfaceTypeApiName: InterfaceTypeApiName - type: typing.Literal["createInterfaceObject"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateLinkRule(pydantic.BaseModel): @@ -723,21 +420,9 @@ class CreateLinkRule(pydantic.BaseModel): type: typing.Literal["createLink"] = "createLink" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateLinkRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(CreateLinkRuleDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class CreateLinkRuleDict(typing_extensions.TypedDict): - """CreateLinkRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - linkTypeApiNameAtoB: LinkTypeApiName - linkTypeApiNameBtoA: LinkTypeApiName - aSideObjectTypeApiName: ObjectTypeApiName - bSideObjectTypeApiName: ObjectTypeApiName - type: typing.Literal["createLink"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateObjectRule(pydantic.BaseModel): @@ -747,18 +432,9 @@ class CreateObjectRule(pydantic.BaseModel): type: typing.Literal["createObject"] = "createObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateObjectRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(CreateObjectRuleDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class CreateObjectRuleDict(typing_extensions.TypedDict): - """CreateObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeApiName: ObjectTypeApiName - type: typing.Literal["createObject"] + return self.model_dump(by_alias=True, exclude_none=True) DataValue = typing.Any @@ -801,20 +477,9 @@ class DeleteInterfaceObjectRule(pydantic.BaseModel): type: typing.Literal["deleteInterfaceObject"] = "deleteInterfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DeleteInterfaceObjectRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - DeleteInterfaceObjectRuleDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class DeleteInterfaceObjectRuleDict(typing_extensions.TypedDict): - """DeleteInterfaceObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - interfaceTypeApiName: InterfaceTypeApiName - type: typing.Literal["deleteInterfaceObject"] + return self.model_dump(by_alias=True, exclude_none=True) class DeleteLinkRule(pydantic.BaseModel): @@ -827,21 +492,9 @@ class DeleteLinkRule(pydantic.BaseModel): type: typing.Literal["deleteLink"] = "deleteLink" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DeleteLinkRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DeleteLinkRuleDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DeleteLinkRuleDict(typing_extensions.TypedDict): - """DeleteLinkRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - linkTypeApiNameAtoB: LinkTypeApiName - linkTypeApiNameBtoA: LinkTypeApiName - aSideObjectTypeApiName: ObjectTypeApiName - bSideObjectTypeApiName: ObjectTypeApiName - type: typing.Literal["deleteLink"] + return self.model_dump(by_alias=True, exclude_none=True) class DeleteObjectRule(pydantic.BaseModel): @@ -851,18 +504,9 @@ class DeleteObjectRule(pydantic.BaseModel): type: typing.Literal["deleteObject"] = "deleteObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DeleteObjectRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DeleteObjectRuleDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DeleteObjectRuleDict(typing_extensions.TypedDict): - """DeleteObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeApiName: ObjectTypeApiName - type: typing.Literal["deleteObject"] + return self.model_dump(by_alias=True, exclude_none=True) DerivedPropertyApiName = str @@ -873,14 +517,17 @@ class DeleteObjectRuleDict(typing_extensions.TypedDict): """An ISO 8601 formatted duration.""" -class EntrySetTypeDict(typing_extensions.TypedDict): +class EntrySetType(pydantic.BaseModel): """EntrySetType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + key_type: QueryDataType = pydantic.Field(alias=str("keyType")) # type: ignore[literal-required] + value_type: QueryDataType = pydantic.Field(alias=str("valueType")) # type: ignore[literal-required] + type: typing.Literal["entrySet"] = "entrySet" + model_config = {"extra": "allow", "populate_by_name": True} - keyType: QueryDataTypeDict - valueType: QueryDataTypeDict - type: typing.Literal["entrySet"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) class EqualsQuery(pydantic.BaseModel): @@ -891,19 +538,9 @@ class EqualsQuery(pydantic.BaseModel): type: typing.Literal["eq"] = "eq" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "EqualsQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(EqualsQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class EqualsQueryDict(typing_extensions.TypedDict): - """Returns objects where the specified field is equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - value: PropertyValue - type: typing.Literal["eq"] + return self.model_dump(by_alias=True, exclude_none=True) class ExecuteQueryResponse(pydantic.BaseModel): @@ -912,19 +549,9 @@ class ExecuteQueryResponse(pydantic.BaseModel): value: DataValue model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ExecuteQueryResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ExecuteQueryResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ExecuteQueryResponseDict(typing_extensions.TypedDict): - """ExecuteQueryResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: DataValue + return self.model_dump(by_alias=True, exclude_none=True) FieldNameV1 = str @@ -959,19 +586,9 @@ class GroupMemberConstraint(pydantic.BaseModel): type: typing.Literal["groupMember"] = "groupMember" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GroupMemberConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GroupMemberConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GroupMemberConstraintDict(typing_extensions.TypedDict): - """The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["groupMember"] + return self.model_dump(by_alias=True, exclude_none=True) class GtQuery(pydantic.BaseModel): @@ -982,19 +599,9 @@ class GtQuery(pydantic.BaseModel): type: typing.Literal["gt"] = "gt" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GtQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(GtQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class GtQueryDict(typing_extensions.TypedDict): - """Returns objects where the specified field is greater than a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - value: PropertyValue - type: typing.Literal["gt"] + return self.model_dump(by_alias=True, exclude_none=True) class GteQuery(pydantic.BaseModel): @@ -1005,19 +612,9 @@ class GteQuery(pydantic.BaseModel): type: typing.Literal["gte"] = "gte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GteQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(GteQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class GteQueryDict(typing_extensions.TypedDict): - """Returns objects where the specified field is greater than or equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - value: PropertyValue - type: typing.Literal["gte"] + return self.model_dump(by_alias=True, exclude_none=True) InterfaceTypeApiName = str @@ -1039,19 +636,9 @@ class IsNullQuery(pydantic.BaseModel): type: typing.Literal["isNull"] = "isNull" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "IsNullQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(IsNullQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class IsNullQueryDict(typing_extensions.TypedDict): - """Returns objects based on the existence of the specified field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - value: bool - type: typing.Literal["isNull"] + return self.model_dump(by_alias=True, exclude_none=True) LinkTypeApiName = str @@ -1072,28 +659,15 @@ class LinkTypeSide(pydantic.BaseModel): foreign_key_property_api_name: typing.Optional[PropertyApiName] = pydantic.Field(alias=str("foreignKeyPropertyApiName"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LinkTypeSideDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(LinkTypeSideDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) LinkTypeSideCardinality = typing.Literal["ONE", "MANY"] """LinkTypeSideCardinality""" -class LinkTypeSideDict(typing_extensions.TypedDict): - """LinkTypeSide""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: LinkTypeApiName - displayName: core_models.DisplayName - status: core_models.ReleaseStatus - objectTypeApiName: ObjectTypeApiName - cardinality: LinkTypeSideCardinality - foreignKeyPropertyApiName: typing_extensions.NotRequired[PropertyApiName] - - class ListActionTypesResponse(pydantic.BaseModel): """ListActionTypesResponse""" @@ -1101,20 +675,9 @@ class ListActionTypesResponse(pydantic.BaseModel): data: typing.List[ActionType] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListActionTypesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListActionTypesResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListActionTypesResponseDict(typing_extensions.TypedDict): - """ListActionTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[ActionTypeDict] + return self.model_dump(by_alias=True, exclude_none=True) class ListLinkedObjectsResponse(pydantic.BaseModel): @@ -1124,20 +687,9 @@ class ListLinkedObjectsResponse(pydantic.BaseModel): data: typing.List[OntologyObject] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListLinkedObjectsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListLinkedObjectsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListLinkedObjectsResponseDict(typing_extensions.TypedDict): - """ListLinkedObjectsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[OntologyObjectDict] + return self.model_dump(by_alias=True, exclude_none=True) class ListObjectTypesResponse(pydantic.BaseModel): @@ -1149,21 +701,9 @@ class ListObjectTypesResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListObjectTypesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListObjectTypesResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListObjectTypesResponseDict(typing_extensions.TypedDict): - """ListObjectTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[ObjectTypeDict] - """The list of object types in the current page.""" + return self.model_dump(by_alias=True, exclude_none=True) class ListObjectsResponse(pydantic.BaseModel): @@ -1176,23 +716,9 @@ class ListObjectsResponse(pydantic.BaseModel): total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListObjectsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListObjectsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListObjectsResponseDict(typing_extensions.TypedDict): - """ListObjectsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[OntologyObjectDict] - """The list of objects in the current page.""" - - totalCount: core_models.TotalCount + return self.model_dump(by_alias=True, exclude_none=True) class ListOntologiesResponse(pydantic.BaseModel): @@ -1203,20 +729,9 @@ class ListOntologiesResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListOntologiesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListOntologiesResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListOntologiesResponseDict(typing_extensions.TypedDict): - """ListOntologiesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[OntologyDict] - """The list of Ontologies the user has access to.""" + return self.model_dump(by_alias=True, exclude_none=True) class ListOutgoingLinkTypesResponse(pydantic.BaseModel): @@ -1228,21 +743,9 @@ class ListOutgoingLinkTypesResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListOutgoingLinkTypesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListOutgoingLinkTypesResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListOutgoingLinkTypesResponseDict(typing_extensions.TypedDict): - """ListOutgoingLinkTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[LinkTypeSideDict] - """The list of link type sides in the current page.""" + return self.model_dump(by_alias=True, exclude_none=True) class ListQueryTypesResponse(pydantic.BaseModel): @@ -1252,20 +755,9 @@ class ListQueryTypesResponse(pydantic.BaseModel): data: typing.List[QueryType] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListQueryTypesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListQueryTypesResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListQueryTypesResponseDict(typing_extensions.TypedDict): - """ListQueryTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[QueryTypeDict] + return self.model_dump(by_alias=True, exclude_none=True) LogicRule = typing_extensions.Annotated[ @@ -1284,22 +776,6 @@ class ListQueryTypesResponseDict(typing_extensions.TypedDict): """LogicRule""" -LogicRuleDict = typing_extensions.Annotated[ - typing.Union[ - DeleteInterfaceObjectRuleDict, - "ModifyInterfaceObjectRuleDict", - "ModifyObjectRuleDict", - DeleteObjectRuleDict, - CreateInterfaceObjectRuleDict, - DeleteLinkRuleDict, - CreateObjectRuleDict, - CreateLinkRuleDict, - ], - pydantic.Field(discriminator="type"), -] -"""LogicRule""" - - class LtQuery(pydantic.BaseModel): """Returns objects where the specified field is less than a value.""" @@ -1308,19 +784,9 @@ class LtQuery(pydantic.BaseModel): type: typing.Literal["lt"] = "lt" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LtQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(LtQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class LtQueryDict(typing_extensions.TypedDict): - """Returns objects where the specified field is less than a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - value: PropertyValue - type: typing.Literal["lt"] + return self.model_dump(by_alias=True, exclude_none=True) class LteQuery(pydantic.BaseModel): @@ -1331,19 +797,9 @@ class LteQuery(pydantic.BaseModel): type: typing.Literal["lte"] = "lte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LteQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(LteQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class LteQueryDict(typing_extensions.TypedDict): - """Returns objects where the specified field is less than or equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - value: PropertyValue - type: typing.Literal["lte"] + return self.model_dump(by_alias=True, exclude_none=True) class MaxAggregation(pydantic.BaseModel): @@ -1354,19 +810,9 @@ class MaxAggregation(pydantic.BaseModel): type: typing.Literal["max"] = "max" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MaxAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MaxAggregationDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MaxAggregationDict(typing_extensions.TypedDict): - """Computes the maximum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - name: typing_extensions.NotRequired[AggregationMetricName] - type: typing.Literal["max"] + return self.model_dump(by_alias=True, exclude_none=True) class MinAggregation(pydantic.BaseModel): @@ -1377,19 +823,9 @@ class MinAggregation(pydantic.BaseModel): type: typing.Literal["min"] = "min" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MinAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MinAggregationDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MinAggregationDict(typing_extensions.TypedDict): - """Computes the minimum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - name: typing_extensions.NotRequired[AggregationMetricName] - type: typing.Literal["min"] + return self.model_dump(by_alias=True, exclude_none=True) class ModifyInterfaceObjectRule(pydantic.BaseModel): @@ -1399,20 +835,9 @@ class ModifyInterfaceObjectRule(pydantic.BaseModel): type: typing.Literal["modifyInterfaceObject"] = "modifyInterfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ModifyInterfaceObjectRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ModifyInterfaceObjectRuleDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ModifyInterfaceObjectRuleDict(typing_extensions.TypedDict): - """ModifyInterfaceObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - interfaceTypeApiName: InterfaceTypeApiName - type: typing.Literal["modifyInterfaceObject"] + return self.model_dump(by_alias=True, exclude_none=True) class ModifyObjectRule(pydantic.BaseModel): @@ -1422,18 +847,9 @@ class ModifyObjectRule(pydantic.BaseModel): type: typing.Literal["modifyObject"] = "modifyObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ModifyObjectRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ModifyObjectRuleDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ModifyObjectRuleDict(typing_extensions.TypedDict): - """ModifyObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeApiName: ObjectTypeApiName - type: typing.Literal["modifyObject"] + return self.model_dump(by_alias=True, exclude_none=True) class NotQuery(pydantic.BaseModel): @@ -1443,18 +859,9 @@ class NotQuery(pydantic.BaseModel): type: typing.Literal["not"] = "not" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "NotQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(NotQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class NotQueryDict(typing_extensions.TypedDict): - """Returns objects where the query is not satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: SearchJsonQueryDict - type: typing.Literal["not"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectPropertyValueConstraint(pydantic.BaseModel): @@ -1463,19 +870,9 @@ class ObjectPropertyValueConstraint(pydantic.BaseModel): type: typing.Literal["objectPropertyValue"] = "objectPropertyValue" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectPropertyValueConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectPropertyValueConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectPropertyValueConstraintDict(typing_extensions.TypedDict): - """The parameter value must be a property value of an object found within an object set.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["objectPropertyValue"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectQueryResultConstraint(pydantic.BaseModel): @@ -1484,19 +881,9 @@ class ObjectQueryResultConstraint(pydantic.BaseModel): type: typing.Literal["objectQueryResult"] = "objectQueryResult" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectQueryResultConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectQueryResultConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectQueryResultConstraintDict(typing_extensions.TypedDict): - """The parameter value must be the primary key of an object found within an object set.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["objectQueryResult"] + return self.model_dump(by_alias=True, exclude_none=True) ObjectRid = core.RID @@ -1526,9 +913,9 @@ class ObjectType(pydantic.BaseModel): rid: ObjectTypeRid model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ObjectTypeDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) ObjectTypeApiName = str @@ -1538,27 +925,6 @@ def to_dict(self) -> "ObjectTypeDict": """ -class ObjectTypeDict(typing_extensions.TypedDict): - """Represents an object type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ObjectTypeApiName - displayName: typing_extensions.NotRequired[core_models.DisplayName] - status: core_models.ReleaseStatus - description: typing_extensions.NotRequired[str] - """The description of the object type.""" - - visibility: typing_extensions.NotRequired[ObjectTypeVisibility] - primaryKey: typing.List[PropertyApiName] - """The primary key of the object. This is a list of properties that can be used to uniquely identify the object.""" - - properties: typing.Dict[PropertyApiName, PropertyDict] - """A map of the properties of the object type.""" - - rid: ObjectTypeRid - - ObjectTypeRid = core.RID """The unique resource identifier of an object type, useful for interacting with other Foundry APIs.""" @@ -1577,21 +943,9 @@ class OneOfConstraint(pydantic.BaseModel): type: typing.Literal["oneOf"] = "oneOf" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OneOfConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OneOfConstraintDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OneOfConstraintDict(typing_extensions.TypedDict): - """The parameter has a manually predefined set of options.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - options: typing.List[ParameterOptionDict] - otherValuesAllowed: bool - """A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**.""" - - type: typing.Literal["oneOf"] + return self.model_dump(by_alias=True, exclude_none=True) class Ontology(pydantic.BaseModel): @@ -1603,9 +957,9 @@ class Ontology(pydantic.BaseModel): rid: OntologyRid model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OntologyDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) OntologyApiName = str @@ -1619,18 +973,9 @@ class OntologyArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyArrayTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OntologyArrayTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OntologyArrayTypeDict(typing_extensions.TypedDict): - """OntologyArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - itemType: OntologyDataTypeDict - type: typing.Literal["array"] + return self.model_dump(by_alias=True, exclude_none=True) OntologyDataType = typing_extensions.Annotated[ @@ -1663,93 +1008,31 @@ class OntologyArrayTypeDict(typing_extensions.TypedDict): """A union of all the primitive types used by Palantir's Ontology-based products.""" -OntologyDataTypeDict = typing_extensions.Annotated[ - typing.Union[ - core_models.DateTypeDict, - "OntologyStructTypeDict", - "OntologySetTypeDict", - core_models.StringTypeDict, - core_models.ByteTypeDict, - core_models.DoubleTypeDict, - core_models.IntegerTypeDict, - core_models.FloatTypeDict, - core_models.AnyTypeDict, - core_models.LongTypeDict, - core_models.BooleanTypeDict, - core_models.CipherTextTypeDict, - core_models.MarkingTypeDict, - core_models.UnsupportedTypeDict, - OntologyArrayTypeDict, - "OntologyObjectSetTypeDict", - core_models.BinaryTypeDict, - core_models.ShortTypeDict, - core_models.DecimalTypeDict, - "OntologyMapTypeDict", - core_models.TimestampTypeDict, - "OntologyObjectTypeDict", - ], - pydantic.Field(discriminator="type"), -] -"""A union of all the primitive types used by Palantir's Ontology-based products.""" - - -class OntologyDict(typing_extensions.TypedDict): - """Metadata about an Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: OntologyApiName - displayName: core_models.DisplayName - description: str - rid: OntologyRid - - class OntologyMapType(pydantic.BaseModel): """OntologyMapType""" - key_type: OntologyDataType = pydantic.Field(alias=str("keyType")) # type: ignore[literal-required] - value_type: OntologyDataType = pydantic.Field(alias=str("valueType")) # type: ignore[literal-required] - type: typing.Literal["map"] = "map" - model_config = {"extra": "allow", "populate_by_name": True} - - def to_dict(self) -> "OntologyMapTypeDict": - """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OntologyMapTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OntologyMapTypeDict(typing_extensions.TypedDict): - """OntologyMapType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: OntologyDataTypeDict - valueType: OntologyDataTypeDict - type: typing.Literal["map"] - - -class OntologyObject(pydantic.BaseModel): - """Represents an object in the Ontology.""" - - properties: typing.Dict[PropertyApiName, typing.Optional[PropertyValue]] - """A map of the property values of the object.""" - - rid: ObjectRid + key_type: OntologyDataType = pydantic.Field(alias=str("keyType")) # type: ignore[literal-required] + value_type: OntologyDataType = pydantic.Field(alias=str("valueType")) # type: ignore[literal-required] + type: typing.Literal["map"] = "map" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyObjectDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OntologyObjectDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) -class OntologyObjectDict(typing_extensions.TypedDict): +class OntologyObject(pydantic.BaseModel): """Represents an object in the Ontology.""" - __pydantic_config__ = {"extra": "allow"} # type: ignore - properties: typing.Dict[PropertyApiName, typing.Optional[PropertyValue]] """A map of the property values of the object.""" rid: ObjectRid + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) class OntologyObjectSetType(pydantic.BaseModel): @@ -1760,21 +1043,9 @@ class OntologyObjectSetType(pydantic.BaseModel): type: typing.Literal["objectSet"] = "objectSet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyObjectSetTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OntologyObjectSetTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class OntologyObjectSetTypeDict(typing_extensions.TypedDict): - """OntologyObjectSetType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectApiName: typing_extensions.NotRequired[ObjectTypeApiName] - objectTypeApiName: typing_extensions.NotRequired[ObjectTypeApiName] - type: typing.Literal["objectSet"] + return self.model_dump(by_alias=True, exclude_none=True) class OntologyObjectType(pydantic.BaseModel): @@ -1785,21 +1056,9 @@ class OntologyObjectType(pydantic.BaseModel): type: typing.Literal["object"] = "object" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyObjectTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OntologyObjectTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class OntologyObjectTypeDict(typing_extensions.TypedDict): - """OntologyObjectType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectApiName: ObjectTypeApiName - objectTypeApiName: ObjectTypeApiName - type: typing.Literal["object"] + return self.model_dump(by_alias=True, exclude_none=True) OntologyRid = core.RID @@ -1816,18 +1075,9 @@ class OntologySetType(pydantic.BaseModel): type: typing.Literal["set"] = "set" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologySetTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OntologySetTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OntologySetTypeDict(typing_extensions.TypedDict): - """OntologySetType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - itemType: OntologyDataTypeDict - type: typing.Literal["set"] + return self.model_dump(by_alias=True, exclude_none=True) class OntologyStructField(pydantic.BaseModel): @@ -1838,21 +1088,9 @@ class OntologyStructField(pydantic.BaseModel): required: bool model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyStructFieldDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OntologyStructFieldDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class OntologyStructFieldDict(typing_extensions.TypedDict): - """OntologyStructField""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: core_models.StructFieldName - fieldType: OntologyDataTypeDict - required: bool + return self.model_dump(by_alias=True, exclude_none=True) class OntologyStructType(pydantic.BaseModel): @@ -1862,20 +1100,9 @@ class OntologyStructType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyStructTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OntologyStructTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class OntologyStructTypeDict(typing_extensions.TypedDict): - """OntologyStructType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: typing.List[OntologyStructFieldDict] - type: typing.Literal["struct"] + return self.model_dump(by_alias=True, exclude_none=True) class OrQuery(pydantic.BaseModel): @@ -1885,18 +1112,9 @@ class OrQuery(pydantic.BaseModel): type: typing.Literal["or"] = "or" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OrQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OrQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OrQueryDict(typing_extensions.TypedDict): - """Returns objects where at least 1 query is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: typing.List[SearchJsonQueryDict] - type: typing.Literal["or"] + return self.model_dump(by_alias=True, exclude_none=True) OrderBy = str @@ -1923,20 +1141,9 @@ class Parameter(pydantic.BaseModel): required: bool model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ParameterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ParameterDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ParameterDict(typing_extensions.TypedDict): - """Details about a parameter of an action or query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: typing_extensions.NotRequired[str] - baseType: ValueType - dataType: typing_extensions.NotRequired[OntologyDataTypeDict] - required: bool + return self.model_dump(by_alias=True, exclude_none=True) ParameterEvaluatedConstraint = typing_extensions.Annotated[ @@ -1974,41 +1181,6 @@ class ParameterDict(typing_extensions.TypedDict): """ -ParameterEvaluatedConstraintDict = typing_extensions.Annotated[ - typing.Union[ - OneOfConstraintDict, - GroupMemberConstraintDict, - ObjectPropertyValueConstraintDict, - "RangeConstraintDict", - ArraySizeConstraintDict, - ObjectQueryResultConstraintDict, - "StringLengthConstraintDict", - "StringRegexMatchConstraintDict", - "UnevaluableConstraintDict", - ], - pydantic.Field(discriminator="type"), -] -""" -A constraint that an action parameter value must satisfy in order to be considered valid. -Constraints can be configured on action parameters in the **Ontology Manager**. -Applicable constraints are determined dynamically based on parameter inputs. -Parameter values are evaluated against the final set of constraints. - -The type of the constraint. -| Type | Description | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | -| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | -| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | -| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | -| `oneOf` | The parameter has a manually predefined set of options. | -| `range` | The parameter value must be within the defined range. | -| `stringLength` | The parameter value must have a length within the defined range. | -| `stringRegexMatch` | The parameter value must match a predefined regular expression. | -| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | -""" - - class ParameterEvaluationResult(pydantic.BaseModel): """Represents the validity of a parameter against the configured constraints.""" @@ -2019,22 +1191,9 @@ class ParameterEvaluationResult(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ParameterEvaluationResultDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ParameterEvaluationResultDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ParameterEvaluationResultDict(typing_extensions.TypedDict): - """Represents the validity of a parameter against the configured constraints.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - result: ValidationResult - evaluatedConstraints: typing.List[ParameterEvaluatedConstraintDict] - required: bool - """Represents whether the parameter is a required input to the action.""" + return self.model_dump(by_alias=True, exclude_none=True) ParameterId = str @@ -2053,19 +1212,9 @@ class ParameterOption(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ParameterOptionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ParameterOptionDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ParameterOptionDict(typing_extensions.TypedDict): - """A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - displayName: typing_extensions.NotRequired[core_models.DisplayName] - value: typing_extensions.NotRequired[typing.Any] - """An allowed configured value for a parameter within an action.""" + return self.model_dump(by_alias=True, exclude_none=True) class PhraseQuery(pydantic.BaseModel): @@ -2076,19 +1225,9 @@ class PhraseQuery(pydantic.BaseModel): type: typing.Literal["phrase"] = "phrase" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "PhraseQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(PhraseQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class PhraseQueryDict(typing_extensions.TypedDict): - """Returns objects where the specified field contains the provided value as a substring.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - value: str - type: typing.Literal["phrase"] + return self.model_dump(by_alias=True, exclude_none=True) class PrefixQuery(pydantic.BaseModel): @@ -2099,19 +1238,9 @@ class PrefixQuery(pydantic.BaseModel): type: typing.Literal["prefix"] = "prefix" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "PrefixQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(PrefixQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class PrefixQueryDict(typing_extensions.TypedDict): - """Returns objects where the specified field starts with the provided value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - value: str - type: typing.Literal["prefix"] + return self.model_dump(by_alias=True, exclude_none=True) PrimaryKeyValue = typing.Any @@ -2126,9 +1255,9 @@ class Property(pydantic.BaseModel): base_type: ValueType = pydantic.Field(alias=str("baseType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "PropertyDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(PropertyDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) PropertyApiName = str @@ -2138,16 +1267,6 @@ def to_dict(self) -> "PropertyDict": """ -class PropertyDict(typing_extensions.TypedDict): - """Details about some property of an object.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: typing_extensions.NotRequired[str] - displayName: typing_extensions.NotRequired[core_models.DisplayName] - baseType: ValueType - - PropertyFilter = str """ Represents a filter used on properties. @@ -2219,46 +1338,47 @@ class PropertyDict(typing_extensions.TypedDict): """Represents the value of a property in string format. This is used in URL parameters.""" -QueryAggregationKeyTypeDict = typing_extensions.Annotated[ +QueryAggregationKeyType = typing_extensions.Annotated[ typing.Union[ - core_models.DateTypeDict, - core_models.BooleanTypeDict, - core_models.StringTypeDict, - core_models.DoubleTypeDict, - "QueryAggregationRangeTypeDict", - core_models.IntegerTypeDict, - core_models.TimestampTypeDict, + core_models.DateType, + core_models.BooleanType, + core_models.StringType, + core_models.DoubleType, + "QueryAggregationRangeType", + core_models.IntegerType, + core_models.TimestampType, ], pydantic.Field(discriminator="type"), ] """A union of all the types supported by query aggregation keys.""" -QueryAggregationRangeSubTypeDict = typing_extensions.Annotated[ +QueryAggregationRangeSubType = typing_extensions.Annotated[ typing.Union[ - core_models.DateTypeDict, - core_models.DoubleTypeDict, - core_models.IntegerTypeDict, - core_models.TimestampTypeDict, + core_models.DateType, + core_models.DoubleType, + core_models.IntegerType, + core_models.TimestampType, ], pydantic.Field(discriminator="type"), ] """A union of all the types supported by query aggregation ranges.""" -class QueryAggregationRangeTypeDict(typing_extensions.TypedDict): +class QueryAggregationRangeType(pydantic.BaseModel): """QueryAggregationRangeType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + sub_type: QueryAggregationRangeSubType = pydantic.Field(alias=str("subType")) # type: ignore[literal-required] + type: typing.Literal["range"] = "range" + model_config = {"extra": "allow", "populate_by_name": True} - subType: QueryAggregationRangeSubTypeDict - type: typing.Literal["range"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -QueryAggregationValueTypeDict = typing_extensions.Annotated[ - typing.Union[ - core_models.DateTypeDict, core_models.DoubleTypeDict, core_models.TimestampTypeDict - ], +QueryAggregationValueType = typing_extensions.Annotated[ + typing.Union[core_models.DateType, core_models.DoubleType, core_models.TimestampType], pydantic.Field(discriminator="type"), ] """A union of all the types supported by query aggregation keys.""" @@ -2268,37 +1388,40 @@ class QueryAggregationRangeTypeDict(typing_extensions.TypedDict): """The name of the Query in the API.""" -class QueryArrayTypeDict(typing_extensions.TypedDict): +class QueryArrayType(pydantic.BaseModel): """QueryArrayType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + sub_type: QueryDataType = pydantic.Field(alias=str("subType")) # type: ignore[literal-required] + type: typing.Literal["array"] = "array" + model_config = {"extra": "allow", "populate_by_name": True} - subType: QueryDataTypeDict - type: typing.Literal["array"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -QueryDataTypeDict = typing_extensions.Annotated[ +QueryDataType = typing_extensions.Annotated[ typing.Union[ - core_models.DateTypeDict, - "QueryStructTypeDict", - "QuerySetTypeDict", - core_models.StringTypeDict, - EntrySetTypeDict, - core_models.DoubleTypeDict, - core_models.IntegerTypeDict, - "ThreeDimensionalAggregationDict", - "QueryUnionTypeDict", - core_models.FloatTypeDict, - core_models.LongTypeDict, - core_models.BooleanTypeDict, - core_models.UnsupportedTypeDict, - core_models.AttachmentTypeDict, - core_models.NullTypeDict, - QueryArrayTypeDict, - OntologyObjectSetTypeDict, - "TwoDimensionalAggregationDict", - OntologyObjectTypeDict, - core_models.TimestampTypeDict, + core_models.DateType, + "QueryStructType", + "QuerySetType", + core_models.StringType, + EntrySetType, + core_models.DoubleType, + core_models.IntegerType, + "ThreeDimensionalAggregation", + "QueryUnionType", + core_models.FloatType, + core_models.LongType, + core_models.BooleanType, + core_models.UnsupportedType, + core_models.AttachmentType, + core_models.NullType, + QueryArrayType, + OntologyObjectSetType, + "TwoDimensionalAggregation", + OntologyObjectType, + core_models.TimestampType, ], pydantic.Field(discriminator="type"), ] @@ -2309,31 +1432,40 @@ class QueryArrayTypeDict(typing_extensions.TypedDict): """QueryRuntimeErrorParameter""" -class QuerySetTypeDict(typing_extensions.TypedDict): +class QuerySetType(pydantic.BaseModel): """QuerySetType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + sub_type: QueryDataType = pydantic.Field(alias=str("subType")) # type: ignore[literal-required] + type: typing.Literal["set"] = "set" + model_config = {"extra": "allow", "populate_by_name": True} - subType: QueryDataTypeDict - type: typing.Literal["set"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -class QueryStructFieldDict(typing_extensions.TypedDict): +class QueryStructField(pydantic.BaseModel): """QueryStructField""" - __pydantic_config__ = {"extra": "allow"} # type: ignore - name: core_models.StructFieldName - fieldType: QueryDataTypeDict + field_type: QueryDataType = pydantic.Field(alias=str("fieldType")) # type: ignore[literal-required] + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -class QueryStructTypeDict(typing_extensions.TypedDict): +class QueryStructType(pydantic.BaseModel): """QueryStructType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + fields: typing.List[QueryStructField] + type: typing.Literal["struct"] = "struct" + model_config = {"extra": "allow", "populate_by_name": True} - fields: typing.List[QueryStructFieldDict] - type: typing.Literal["struct"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) class QueryType(pydantic.BaseModel): @@ -2348,32 +1480,21 @@ class QueryType(pydantic.BaseModel): version: FunctionVersion model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QueryTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class QueryTypeDict(typing_extensions.TypedDict): - """Represents a query type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: QueryApiName - description: typing_extensions.NotRequired[str] - displayName: typing_extensions.NotRequired[core_models.DisplayName] - parameters: typing.Dict[ParameterId, ParameterDict] - output: typing_extensions.NotRequired[OntologyDataTypeDict] - rid: FunctionRid - version: FunctionVersion + return self.model_dump(by_alias=True, exclude_none=True) -class QueryUnionTypeDict(typing_extensions.TypedDict): +class QueryUnionType(pydantic.BaseModel): """QueryUnionType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + union_types: typing.List[QueryDataType] = pydantic.Field(alias=str("unionTypes")) # type: ignore[literal-required] + type: typing.Literal["union"] = "union" + model_config = {"extra": "allow", "populate_by_name": True} - unionTypes: typing.List[QueryDataTypeDict] - type: typing.Literal["union"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) class RangeConstraint(pydantic.BaseModel): @@ -2394,29 +1515,9 @@ class RangeConstraint(pydantic.BaseModel): type: typing.Literal["range"] = "range" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "RangeConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(RangeConstraintDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class RangeConstraintDict(typing_extensions.TypedDict): - """The parameter value must be within the defined range.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - lt: typing_extensions.NotRequired[typing.Any] - """Less than""" - - lte: typing_extensions.NotRequired[typing.Any] - """Less than or equal""" - - gt: typing_extensions.NotRequired[typing.Any] - """Greater than""" - - gte: typing_extensions.NotRequired[typing.Any] - """Greater than or equal""" - - type: typing.Literal["range"] + return self.model_dump(by_alias=True, exclude_none=True) ReturnEditsMode = typing.Literal["ALL", "ALL_V2_WITH_DELETIONS", "NONE"] @@ -2449,28 +1550,6 @@ class RangeConstraintDict(typing_extensions.TypedDict): """SearchJsonQuery""" -SearchJsonQueryDict = typing_extensions.Annotated[ - typing.Union[ - OrQueryDict, - PrefixQueryDict, - LtQueryDict, - AllTermsQueryDict, - EqualsQueryDict, - GtQueryDict, - ContainsQueryDict, - NotQueryDict, - PhraseQueryDict, - AndQueryDict, - IsNullQueryDict, - GteQueryDict, - AnyTermQueryDict, - LteQueryDict, - ], - pydantic.Field(discriminator="type"), -] -"""SearchJsonQuery""" - - class SearchObjectsResponse(pydantic.BaseModel): """SearchObjectsResponse""" @@ -2479,21 +1558,9 @@ class SearchObjectsResponse(pydantic.BaseModel): total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchObjectsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SearchObjectsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SearchObjectsResponseDict(typing_extensions.TypedDict): - """SearchObjectsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[OntologyObjectDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - totalCount: core_models.TotalCount + return self.model_dump(by_alias=True, exclude_none=True) class SearchOrderBy(pydantic.BaseModel): @@ -2502,17 +1569,9 @@ class SearchOrderBy(pydantic.BaseModel): fields: typing.List[SearchOrdering] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchOrderByDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(SearchOrderByDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class SearchOrderByDict(typing_extensions.TypedDict): - """Specifies the ordering of search results by a field and an ordering direction.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: typing.List[SearchOrderingDict] + return self.model_dump(by_alias=True, exclude_none=True) SearchOrderByType = typing.Literal["fields", "relevance"] @@ -2528,19 +1587,9 @@ class SearchOrdering(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchOrderingDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(SearchOrderingDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class SearchOrderingDict(typing_extensions.TypedDict): - """SearchOrdering""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - direction: typing_extensions.NotRequired[str] - """Specifies the ordering direction (can be either `asc` or `desc`)""" + return self.model_dump(by_alias=True, exclude_none=True) SelectedPropertyApiName = str @@ -2595,34 +1644,9 @@ class StringLengthConstraint(pydantic.BaseModel): type: typing.Literal["stringLength"] = "stringLength" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StringLengthConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - StringLengthConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class StringLengthConstraintDict(typing_extensions.TypedDict): - """ - The parameter value must have a length within the defined range. - *This range is always inclusive.* - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - lt: typing_extensions.NotRequired[typing.Any] - """Less than""" - - lte: typing_extensions.NotRequired[typing.Any] - """Less than or equal""" - - gt: typing_extensions.NotRequired[typing.Any] - """Greater than""" - - gte: typing_extensions.NotRequired[typing.Any] - """Greater than or equal""" - - type: typing.Literal["stringLength"] + return self.model_dump(by_alias=True, exclude_none=True) class StringRegexMatchConstraint(pydantic.BaseModel): @@ -2640,28 +1664,9 @@ class StringRegexMatchConstraint(pydantic.BaseModel): type: typing.Literal["stringRegexMatch"] = "stringRegexMatch" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StringRegexMatchConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - StringRegexMatchConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class StringRegexMatchConstraintDict(typing_extensions.TypedDict): - """The parameter value must match a predefined regular expression.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - regex: str - """The regular expression configured in the **Ontology Manager**.""" - - configuredFailureMessage: typing_extensions.NotRequired[str] - """ - The message indicating that the regular expression was not matched. - This is configured per parameter in the **Ontology Manager**. - """ - - type: typing.Literal["stringRegexMatch"] + return self.model_dump(by_alias=True, exclude_none=True) class SubmissionCriteriaEvaluation(pydantic.BaseModel): @@ -2680,29 +1685,9 @@ class SubmissionCriteriaEvaluation(pydantic.BaseModel): result: ValidationResult model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SubmissionCriteriaEvaluationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SubmissionCriteriaEvaluationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SubmissionCriteriaEvaluationDict(typing_extensions.TypedDict): - """ - Contains the status of the **submission criteria**. - **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. - These are configured in the **Ontology Manager**. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - configuredFailureMessage: typing_extensions.NotRequired[str] - """ - The message indicating one of the **submission criteria** was not satisfied. - This is configured per **submission criteria** in the **Ontology Manager**. - """ - - result: ValidationResult + return self.model_dump(by_alias=True, exclude_none=True) class SumAggregation(pydantic.BaseModel): @@ -2713,39 +1698,35 @@ class SumAggregation(pydantic.BaseModel): type: typing.Literal["sum"] = "sum" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SumAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(SumAggregationDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) -class SumAggregationDict(typing_extensions.TypedDict): - """Computes the sum of values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - name: typing_extensions.NotRequired[AggregationMetricName] - type: typing.Literal["sum"] - - -class ThreeDimensionalAggregationDict(typing_extensions.TypedDict): +class ThreeDimensionalAggregation(pydantic.BaseModel): """ThreeDimensionalAggregation""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + key_type: QueryAggregationKeyType = pydantic.Field(alias=str("keyType")) # type: ignore[literal-required] + value_type: TwoDimensionalAggregation = pydantic.Field(alias=str("valueType")) # type: ignore[literal-required] + type: typing.Literal["threeDimensionalAggregation"] = "threeDimensionalAggregation" + model_config = {"extra": "allow", "populate_by_name": True} - keyType: QueryAggregationKeyTypeDict - valueType: TwoDimensionalAggregationDict - type: typing.Literal["threeDimensionalAggregation"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -class TwoDimensionalAggregationDict(typing_extensions.TypedDict): +class TwoDimensionalAggregation(pydantic.BaseModel): """TwoDimensionalAggregation""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + key_type: QueryAggregationKeyType = pydantic.Field(alias=str("keyType")) # type: ignore[literal-required] + value_type: QueryAggregationValueType = pydantic.Field(alias=str("valueType")) # type: ignore[literal-required] + type: typing.Literal["twoDimensionalAggregation"] = "twoDimensionalAggregation" + model_config = {"extra": "allow", "populate_by_name": True} - keyType: QueryAggregationKeyTypeDict - valueType: QueryAggregationValueTypeDict - type: typing.Literal["twoDimensionalAggregation"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) class UnevaluableConstraint(pydantic.BaseModel): @@ -2757,22 +1738,9 @@ class UnevaluableConstraint(pydantic.BaseModel): type: typing.Literal["unevaluable"] = "unevaluable" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "UnevaluableConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - UnevaluableConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class UnevaluableConstraintDict(typing_extensions.TypedDict): - """ - The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. - This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["unevaluable"] + return self.model_dump(by_alias=True, exclude_none=True) class ValidateActionResponse(pydantic.BaseModel): @@ -2783,21 +1751,9 @@ class ValidateActionResponse(pydantic.BaseModel): parameters: typing.Dict[ParameterId, ParameterEvaluationResult] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValidateActionResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValidateActionResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValidateActionResponseDict(typing_extensions.TypedDict): - """ValidateActionResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - result: ValidationResult - submissionCriteria: typing.List[SubmissionCriteriaEvaluationDict] - parameters: typing.Dict[ParameterId, ParameterEvaluationResultDict] + return self.model_dump(by_alias=True, exclude_none=True) ValidationResult = typing.Literal["VALID", "INVALID"] @@ -2833,256 +1789,160 @@ class ValidateActionResponseDict(typing_extensions.TypedDict): core.resolve_forward_references(Aggregation, globalns=globals(), localns=locals()) -core.resolve_forward_references(AggregationDict, globalns=globals(), localns=locals()) core.resolve_forward_references(AggregationGroupBy, globalns=globals(), localns=locals()) -core.resolve_forward_references(AggregationGroupByDict, globalns=globals(), localns=locals()) core.resolve_forward_references(LogicRule, globalns=globals(), localns=locals()) -core.resolve_forward_references(LogicRuleDict, globalns=globals(), localns=locals()) core.resolve_forward_references(OntologyDataType, globalns=globals(), localns=locals()) -core.resolve_forward_references(OntologyDataTypeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(ParameterEvaluatedConstraint, globalns=globals(), localns=locals()) -core.resolve_forward_references( - ParameterEvaluatedConstraintDict, globalns=globals(), localns=locals() -) -core.resolve_forward_references(QueryAggregationKeyTypeDict, globalns=globals(), localns=locals()) -core.resolve_forward_references( - QueryAggregationRangeSubTypeDict, globalns=globals(), localns=locals() -) -core.resolve_forward_references(QueryAggregationValueTypeDict, globalns=globals(), localns=locals()) -core.resolve_forward_references(QueryDataTypeDict, globalns=globals(), localns=locals()) +core.resolve_forward_references(QueryAggregationKeyType, globalns=globals(), localns=locals()) +core.resolve_forward_references(QueryAggregationRangeSubType, globalns=globals(), localns=locals()) +core.resolve_forward_references(QueryAggregationValueType, globalns=globals(), localns=locals()) +core.resolve_forward_references(QueryDataType, globalns=globals(), localns=locals()) core.resolve_forward_references(SearchJsonQuery, globalns=globals(), localns=locals()) -core.resolve_forward_references(SearchJsonQueryDict, globalns=globals(), localns=locals()) __all__ = [ "ActionRid", "ActionType", "ActionTypeApiName", - "ActionTypeDict", "ActionTypeRid", "AggregateObjectsResponse", - "AggregateObjectsResponseDict", "AggregateObjectsResponseItem", - "AggregateObjectsResponseItemDict", "Aggregation", - "AggregationDict", "AggregationDurationGrouping", - "AggregationDurationGroupingDict", "AggregationExactGrouping", - "AggregationExactGroupingDict", "AggregationFixedWidthGrouping", - "AggregationFixedWidthGroupingDict", "AggregationGroupBy", - "AggregationGroupByDict", "AggregationGroupKey", "AggregationGroupValue", "AggregationMetricName", "AggregationMetricResult", - "AggregationMetricResultDict", "AggregationRange", - "AggregationRangeDict", "AggregationRangesGrouping", - "AggregationRangesGroupingDict", "AllTermsQuery", - "AllTermsQueryDict", "AndQuery", - "AndQueryDict", "AnyTermQuery", - "AnyTermQueryDict", "ApplyActionMode", "ApplyActionRequest", - "ApplyActionRequestDict", "ApplyActionRequestOptions", - "ApplyActionRequestOptionsDict", "ApplyActionResponse", - "ApplyActionResponseDict", "ApproximateDistinctAggregation", - "ApproximateDistinctAggregationDict", "ArraySizeConstraint", - "ArraySizeConstraintDict", "ArtifactRepositoryRid", "Attachment", - "AttachmentDict", "AttachmentRid", "AvgAggregation", - "AvgAggregationDict", "BatchApplyActionResponse", - "BatchApplyActionResponseDict", "ContainsQuery", - "ContainsQueryDict", "CountAggregation", - "CountAggregationDict", "CreateInterfaceObjectRule", - "CreateInterfaceObjectRuleDict", "CreateLinkRule", - "CreateLinkRuleDict", "CreateObjectRule", - "CreateObjectRuleDict", "DataValue", "DeleteInterfaceObjectRule", - "DeleteInterfaceObjectRuleDict", "DeleteLinkRule", - "DeleteLinkRuleDict", "DeleteObjectRule", - "DeleteObjectRuleDict", "DerivedPropertyApiName", "Duration", - "EntrySetTypeDict", + "EntrySetType", "EqualsQuery", - "EqualsQueryDict", "ExecuteQueryResponse", - "ExecuteQueryResponseDict", "FieldNameV1", "FilterValue", "FunctionRid", "FunctionVersion", "Fuzzy", "GroupMemberConstraint", - "GroupMemberConstraintDict", "GtQuery", - "GtQueryDict", "GteQuery", - "GteQueryDict", "InterfaceTypeApiName", "InterfaceTypeRid", "IsNullQuery", - "IsNullQueryDict", "LinkTypeApiName", "LinkTypeSide", "LinkTypeSideCardinality", - "LinkTypeSideDict", "ListActionTypesResponse", - "ListActionTypesResponseDict", "ListLinkedObjectsResponse", - "ListLinkedObjectsResponseDict", "ListObjectTypesResponse", - "ListObjectTypesResponseDict", "ListObjectsResponse", - "ListObjectsResponseDict", "ListOntologiesResponse", - "ListOntologiesResponseDict", "ListOutgoingLinkTypesResponse", - "ListOutgoingLinkTypesResponseDict", "ListQueryTypesResponse", - "ListQueryTypesResponseDict", "LogicRule", - "LogicRuleDict", "LtQuery", - "LtQueryDict", "LteQuery", - "LteQueryDict", "MaxAggregation", - "MaxAggregationDict", "MinAggregation", - "MinAggregationDict", "ModifyInterfaceObjectRule", - "ModifyInterfaceObjectRuleDict", "ModifyObjectRule", - "ModifyObjectRuleDict", "NotQuery", - "NotQueryDict", "ObjectPropertyValueConstraint", - "ObjectPropertyValueConstraintDict", "ObjectQueryResultConstraint", - "ObjectQueryResultConstraintDict", "ObjectRid", "ObjectSetRid", "ObjectType", "ObjectTypeApiName", - "ObjectTypeDict", "ObjectTypeRid", "ObjectTypeVisibility", "OneOfConstraint", - "OneOfConstraintDict", "Ontology", "OntologyApiName", "OntologyArrayType", - "OntologyArrayTypeDict", "OntologyDataType", - "OntologyDataTypeDict", - "OntologyDict", "OntologyMapType", - "OntologyMapTypeDict", "OntologyObject", - "OntologyObjectDict", "OntologyObjectSetType", - "OntologyObjectSetTypeDict", "OntologyObjectType", - "OntologyObjectTypeDict", "OntologyRid", "OntologySetType", - "OntologySetTypeDict", "OntologyStructField", - "OntologyStructFieldDict", "OntologyStructType", - "OntologyStructTypeDict", "OrQuery", - "OrQueryDict", "OrderBy", "Parameter", - "ParameterDict", "ParameterEvaluatedConstraint", - "ParameterEvaluatedConstraintDict", "ParameterEvaluationResult", - "ParameterEvaluationResultDict", "ParameterId", "ParameterOption", - "ParameterOptionDict", "PhraseQuery", - "PhraseQueryDict", "PrefixQuery", - "PrefixQueryDict", "PrimaryKeyValue", "Property", "PropertyApiName", - "PropertyDict", "PropertyFilter", "PropertyId", "PropertyValue", "PropertyValueEscapedString", - "QueryAggregationKeyTypeDict", - "QueryAggregationRangeSubTypeDict", - "QueryAggregationRangeTypeDict", - "QueryAggregationValueTypeDict", + "QueryAggregationKeyType", + "QueryAggregationRangeSubType", + "QueryAggregationRangeType", + "QueryAggregationValueType", "QueryApiName", - "QueryArrayTypeDict", - "QueryDataTypeDict", + "QueryArrayType", + "QueryDataType", "QueryRuntimeErrorParameter", - "QuerySetTypeDict", - "QueryStructFieldDict", - "QueryStructTypeDict", + "QuerySetType", + "QueryStructField", + "QueryStructType", "QueryType", - "QueryTypeDict", - "QueryUnionTypeDict", + "QueryUnionType", "RangeConstraint", - "RangeConstraintDict", "ReturnEditsMode", "SdkPackageName", "SearchJsonQuery", - "SearchJsonQueryDict", "SearchObjectsResponse", - "SearchObjectsResponseDict", "SearchOrderBy", - "SearchOrderByDict", "SearchOrderByType", "SearchOrdering", - "SearchOrderingDict", "SelectedPropertyApiName", "SharedPropertyTypeApiName", "SharedPropertyTypeRid", "StringLengthConstraint", - "StringLengthConstraintDict", "StringRegexMatchConstraint", - "StringRegexMatchConstraintDict", "SubmissionCriteriaEvaluation", - "SubmissionCriteriaEvaluationDict", "SumAggregation", - "SumAggregationDict", - "ThreeDimensionalAggregationDict", - "TwoDimensionalAggregationDict", + "ThreeDimensionalAggregation", + "TwoDimensionalAggregation", "UnevaluableConstraint", - "UnevaluableConstraintDict", "ValidateActionResponse", - "ValidateActionResponseDict", "ValidationResult", "ValueType", ] diff --git a/foundry/v1/ontologies/object_type.py b/foundry/v1/ontologies/object_type.py index da6b85445..d1db700c1 100644 --- a/foundry/v1/ontologies/object_type.py +++ b/foundry/v1/ontologies/object_type.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -260,131 +259,6 @@ def list_outgoing_link_types( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - ontology_rid: ontologies_models.OntologyRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.ListObjectTypesResponse: - """ - Lists the object types for the given Ontology. - - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. - :type ontology_rid: OntologyRid - :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.ListObjectTypesResponse - """ - - warnings.warn( - "The client.ontologies.ObjectType.page(...) method has been deprecated. Please use client.ontologies.ObjectType.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objectTypes", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - }, - path_params={ - "ontologyRid": ontology_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=ontologies_models.ListObjectTypesResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page_outgoing_link_types( - self, - ontology_rid: ontologies_models.OntologyRid, - object_type: ontologies_models.ObjectTypeApiName, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.ListOutgoingLinkTypesResponse: - """ - List the outgoing links for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology_rid: The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager** application. - :type ontology_rid: OntologyRid - :param object_type: The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager** application. - :type object_type: ObjectTypeApiName - :param page_size: The desired size of the page to be returned. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.ListOutgoingLinkTypesResponse - """ - - warnings.warn( - "The client.ontologies.ObjectType.page_outgoing_link_types(...) method has been deprecated. Please use client.ontologies.ObjectType.list_outgoing_link_types(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - }, - path_params={ - "ontologyRid": ontology_rid, - "objectType": object_type, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=ontologies_models.ListOutgoingLinkTypesResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _ObjectTypeClientRaw: def __init__(self, client: ObjectTypeClient) -> None: @@ -392,8 +266,6 @@ def get(_: ontologies_models.ObjectType): ... def get_outgoing_link_type(_: ontologies_models.LinkTypeSide): ... def list(_: ontologies_models.ListObjectTypesResponse): ... def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponse): ... - def page(_: ontologies_models.ListObjectTypesResponse): ... - def page_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponse): ... self.get = core.with_raw_response(get, client.get) self.get_outgoing_link_type = core.with_raw_response( @@ -403,10 +275,6 @@ def page_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponse) self.list_outgoing_link_types = core.with_raw_response( list_outgoing_link_types, client.list_outgoing_link_types ) - self.page = core.with_raw_response(page, client.page) - self.page_outgoing_link_types = core.with_raw_response( - page_outgoing_link_types, client.page_outgoing_link_types - ) class _ObjectTypeClientStreaming: @@ -415,8 +283,6 @@ def get(_: ontologies_models.ObjectType): ... def get_outgoing_link_type(_: ontologies_models.LinkTypeSide): ... def list(_: ontologies_models.ListObjectTypesResponse): ... def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponse): ... - def page(_: ontologies_models.ListObjectTypesResponse): ... - def page_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponse): ... self.get = core.with_streaming_response(get, client.get) self.get_outgoing_link_type = core.with_streaming_response( @@ -426,7 +292,3 @@ def page_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponse) self.list_outgoing_link_types = core.with_streaming_response( list_outgoing_link_types, client.list_outgoing_link_types ) - self.page = core.with_streaming_response(page, client.page) - self.page_outgoing_link_types = core.with_streaming_response( - page_outgoing_link_types, client.page_outgoing_link_types - ) diff --git a/foundry/v1/ontologies/ontology_object.py b/foundry/v1/ontologies/ontology_object.py index 94f52c1b4..0a5804a00 100644 --- a/foundry/v1/ontologies/ontology_object.py +++ b/foundry/v1/ontologies/ontology_object.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -56,17 +55,9 @@ def aggregate( ontology_rid: ontologies_models.OntologyRid, object_type: ontologies_models.ObjectTypeApiName, *, - aggregation: typing.List[ - typing.Union[ontologies_models.Aggregation, ontologies_models.AggregationDict] - ], - group_by: typing.List[ - typing.Union[ - ontologies_models.AggregationGroupBy, ontologies_models.AggregationGroupByDict - ] - ], - query: typing.Optional[ - typing.Union[ontologies_models.SearchJsonQuery, ontologies_models.SearchJsonQueryDict] - ] = None, + aggregation: typing.List[ontologies_models.Aggregation], + group_by: typing.List[ontologies_models.AggregationGroupBy], + query: typing.Optional[ontologies_models.SearchJsonQuery] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> ontologies_models.AggregateObjectsResponse: @@ -80,11 +71,11 @@ def aggregate( :param object_type: The type of the object to aggregate on. :type object_type: ObjectTypeApiName :param aggregation: - :type aggregation: List[Union[Aggregation, AggregationDict]] + :type aggregation: List[Aggregation] :param group_by: - :type group_by: List[Union[AggregationGroupBy, AggregationGroupByDict]] + :type group_by: List[AggregationGroupBy] :param query: - :type query: Optional[Union[SearchJsonQuery, SearchJsonQueryDict]] + :type query: Optional[SearchJsonQuery] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -112,23 +103,9 @@ def aggregate( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "aggregation": typing.List[ - typing.Union[ - ontologies_models.Aggregation, ontologies_models.AggregationDict - ] - ], - "query": typing.Optional[ - typing.Union[ - ontologies_models.SearchJsonQuery, - ontologies_models.SearchJsonQueryDict, - ] - ], - "groupBy": typing.List[ - typing.Union[ - ontologies_models.AggregationGroupBy, - ontologies_models.AggregationGroupByDict, - ] - ], + "aggregation": typing.List[ontologies_models.Aggregation], + "query": typing.Optional[ontologies_models.SearchJsonQuery], + "groupBy": typing.List[ontologies_models.AggregationGroupBy], }, ), response_type=ontologies_models.AggregateObjectsResponse, @@ -425,184 +402,6 @@ def list_linked_objects( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - ontology_rid: ontologies_models.OntologyRid, - object_type: ontologies_models.ObjectTypeApiName, - *, - order_by: typing.Optional[ontologies_models.OrderBy] = None, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - properties: typing.Optional[typing.List[ontologies_models.SelectedPropertyApiName]] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.ListObjectsResponse: - """ - Lists the objects for the given Ontology and object type. - - This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. - :type ontology_rid: OntologyRid - :param object_type: The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. - :type object_type: ObjectTypeApiName - :param order_by: - :type order_by: Optional[OrderBy] - :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param properties: The properties of the object type that should be included in the response. Omit this parameter to get all the properties. - :type properties: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.ListObjectsResponse - """ - - warnings.warn( - "The client.ontologies.OntologyObject.page(...) method has been deprecated. Please use client.ontologies.OntologyObject.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}", - query_params={ - "orderBy": order_by, - "pageSize": page_size, - "pageToken": page_token, - "properties": properties, - }, - path_params={ - "ontologyRid": ontology_rid, - "objectType": object_type, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=ontologies_models.ListObjectsResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page_linked_objects( - self, - ontology_rid: ontologies_models.OntologyRid, - object_type: ontologies_models.ObjectTypeApiName, - primary_key: ontologies_models.PropertyValueEscapedString, - link_type: ontologies_models.LinkTypeApiName, - *, - order_by: typing.Optional[ontologies_models.OrderBy] = None, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - properties: typing.Optional[typing.List[ontologies_models.SelectedPropertyApiName]] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.ListLinkedObjectsResponse: - """ - Lists the linked objects for a specific object and the given link type. - - This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. - :type ontology_rid: OntologyRid - :param object_type: The API name of the object from which the links originate. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. - :type object_type: ObjectTypeApiName - :param primary_key: The primary key of the object from which the links originate. To look up the expected primary key for your object type, use the `Get object type` endpoint or the **Ontology Manager**. - :type primary_key: PropertyValueEscapedString - :param link_type: The API name of the link that exists between the object and the requested objects. To find the API name for your link type, check the **Ontology Manager**. - :type link_type: LinkTypeApiName - :param order_by: - :type order_by: Optional[OrderBy] - :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param properties: The properties of the object type that should be included in the response. Omit this parameter to get all the properties. - :type properties: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.ListLinkedObjectsResponse - """ - - warnings.warn( - "The client.ontologies.OntologyObject.page_linked_objects(...) method has been deprecated. Please use client.ontologies.OntologyObject.list_linked_objects(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}", - query_params={ - "orderBy": order_by, - "pageSize": page_size, - "pageToken": page_token, - "properties": properties, - }, - path_params={ - "ontologyRid": ontology_rid, - "objectType": object_type, - "primaryKey": primary_key, - "linkType": link_type, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=ontologies_models.ListLinkedObjectsResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -612,12 +411,8 @@ def search( object_type: ontologies_models.ObjectTypeApiName, *, fields: typing.List[ontologies_models.PropertyApiName], - query: typing.Union[ - ontologies_models.SearchJsonQuery, ontologies_models.SearchJsonQueryDict - ], - order_by: typing.Optional[ - typing.Union[ontologies_models.SearchOrderBy, ontologies_models.SearchOrderByDict] - ] = None, + query: ontologies_models.SearchJsonQuery, + order_by: typing.Optional[ontologies_models.SearchOrderBy] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -656,9 +451,9 @@ def search( :param fields: The API names of the object type properties to include in the response. :type fields: List[PropertyApiName] :param query: - :type query: Union[SearchJsonQuery, SearchJsonQueryDict] + :type query: SearchJsonQuery :param order_by: - :type order_by: Optional[Union[SearchOrderBy, SearchOrderByDict]] + :type order_by: Optional[SearchOrderBy] :param page_size: :type page_size: Optional[PageSize] :param page_token: @@ -692,14 +487,8 @@ def search( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "query": typing.Union[ - ontologies_models.SearchJsonQuery, ontologies_models.SearchJsonQueryDict - ], - "orderBy": typing.Optional[ - typing.Union[ - ontologies_models.SearchOrderBy, ontologies_models.SearchOrderByDict - ] - ], + "query": ontologies_models.SearchJsonQuery, + "orderBy": typing.Optional[ontologies_models.SearchOrderBy], "pageSize": typing.Optional[core_models.PageSize], "pageToken": typing.Optional[core_models.PageToken], "fields": typing.List[ontologies_models.PropertyApiName], @@ -720,8 +509,6 @@ def get(_: ontologies_models.OntologyObject): ... def get_linked_object(_: ontologies_models.OntologyObject): ... def list(_: ontologies_models.ListObjectsResponse): ... def list_linked_objects(_: ontologies_models.ListLinkedObjectsResponse): ... - def page(_: ontologies_models.ListObjectsResponse): ... - def page_linked_objects(_: ontologies_models.ListLinkedObjectsResponse): ... def search(_: ontologies_models.SearchObjectsResponse): ... self.aggregate = core.with_raw_response(aggregate, client.aggregate) @@ -731,10 +518,6 @@ def search(_: ontologies_models.SearchObjectsResponse): ... self.list_linked_objects = core.with_raw_response( list_linked_objects, client.list_linked_objects ) - self.page = core.with_raw_response(page, client.page) - self.page_linked_objects = core.with_raw_response( - page_linked_objects, client.page_linked_objects - ) self.search = core.with_raw_response(search, client.search) @@ -745,8 +528,6 @@ def get(_: ontologies_models.OntologyObject): ... def get_linked_object(_: ontologies_models.OntologyObject): ... def list(_: ontologies_models.ListObjectsResponse): ... def list_linked_objects(_: ontologies_models.ListLinkedObjectsResponse): ... - def page(_: ontologies_models.ListObjectsResponse): ... - def page_linked_objects(_: ontologies_models.ListLinkedObjectsResponse): ... def search(_: ontologies_models.SearchObjectsResponse): ... self.aggregate = core.with_streaming_response(aggregate, client.aggregate) @@ -758,8 +539,4 @@ def search(_: ontologies_models.SearchObjectsResponse): ... self.list_linked_objects = core.with_streaming_response( list_linked_objects, client.list_linked_objects ) - self.page = core.with_streaming_response(page, client.page) - self.page_linked_objects = core.with_streaming_response( - page_linked_objects, client.page_linked_objects - ) self.search = core.with_streaming_response(search, client.search) diff --git a/foundry/v1/ontologies/query_type.py b/foundry/v1/ontologies/query_type.py index 112f1d0ec..1d5ef6f57 100644 --- a/foundry/v1/ontologies/query_type.py +++ b/foundry/v1/ontologies/query_type.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -150,85 +149,20 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - ontology_rid: ontologies_models.OntologyRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.ListQueryTypesResponse: - """ - Lists the query types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. - :type ontology_rid: OntologyRid - :param page_size: The desired size of the page to be returned. Defaults to 100. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.ListQueryTypesResponse - """ - - warnings.warn( - "The client.ontologies.QueryType.page(...) method has been deprecated. Please use client.ontologies.QueryType.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/queryTypes", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - }, - path_params={ - "ontologyRid": ontology_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=ontologies_models.ListQueryTypesResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _QueryTypeClientRaw: def __init__(self, client: QueryTypeClient) -> None: def get(_: ontologies_models.QueryType): ... def list(_: ontologies_models.ListQueryTypesResponse): ... - def page(_: ontologies_models.ListQueryTypesResponse): ... self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) class _QueryTypeClientStreaming: def __init__(self, client: QueryTypeClient) -> None: def get(_: ontologies_models.QueryType): ... def list(_: ontologies_models.ListQueryTypesResponse): ... - def page(_: ontologies_models.ListQueryTypesResponse): ... self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/admin/client.py b/foundry/v2/admin/client.py deleted file mode 100644 index e01c24a73..000000000 --- a/foundry/v2/admin/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v2.admin._client import AdminClient - -__all__ = [ - "AdminClient", -] diff --git a/foundry/v2/admin/group.py b/foundry/v2/admin/group.py index 06cc5083d..161b22c59 100644 --- a/foundry/v2/admin/group.py +++ b/foundry/v2/admin/group.py @@ -14,7 +14,6 @@ import typing -import warnings from functools import cached_property import annotated_types @@ -238,12 +237,7 @@ def get( def get_batch( self, body: typing_extensions.Annotated[ - typing.List[ - typing.Union[ - admin_models.GetGroupsBatchRequestElement, - admin_models.GetGroupsBatchRequestElementDict, - ] - ], + typing.List[admin_models.GetGroupsBatchRequestElement], annotated_types.Len(min_length=1, max_length=500), ], *, @@ -255,7 +249,7 @@ def get_batch( The maximum batch size for this endpoint is 500. :param body: Body of the request - :type body: List[Union[GetGroupsBatchRequestElement, GetGroupsBatchRequestElementDict]] + :type body: List[GetGroupsBatchRequestElement] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -274,7 +268,7 @@ def get_batch( }, body=body, body_type=typing_extensions.Annotated[ - typing.List[admin_models.GetGroupsBatchRequestElementDict], + typing.List[admin_models.GetGroupsBatchRequestElement], annotated_types.Len(min_length=1, max_length=500), ], response_type=admin_models.GetGroupsBatchResponse, @@ -330,65 +324,13 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.ListGroupsResponse: - """ - Lists all Groups. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: admin_models.ListGroupsResponse - """ - - warnings.warn( - "The client.admin.Group.page(...) method has been deprecated. Please use client.admin.Group.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/groups", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=admin_models.ListGroupsResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected def search( self, *, - where: typing.Union[admin_models.GroupSearchFilter, admin_models.GroupSearchFilterDict], + where: admin_models.GroupSearchFilter, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -398,7 +340,7 @@ def search( Perform a case-insensitive prefix search for groups based on group name. :param where: - :type where: Union[GroupSearchFilter, GroupSearchFilterDict] + :type where: GroupSearchFilter :param page_size: :type page_size: Optional[PageSize] :param page_token: @@ -429,9 +371,7 @@ def search( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "where": typing.Union[ - admin_models.GroupSearchFilter, admin_models.GroupSearchFilterDict - ], + "where": admin_models.GroupSearchFilter, "pageSize": typing.Optional[core_models.PageSize], "pageToken": typing.Optional[core_models.PageToken], }, @@ -453,7 +393,6 @@ def delete(_: None): ... def get(_: admin_models.Group): ... def get_batch(_: admin_models.GetGroupsBatchResponse): ... def list(_: admin_models.ListGroupsResponse): ... - def page(_: admin_models.ListGroupsResponse): ... def search(_: admin_models.SearchGroupsResponse): ... self.create = core.with_raw_response(create, client.create) @@ -461,7 +400,6 @@ def search(_: admin_models.SearchGroupsResponse): ... self.get = core.with_raw_response(get, client.get) self.get_batch = core.with_raw_response(get_batch, client.get_batch) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) self.search = core.with_raw_response(search, client.search) @@ -471,12 +409,10 @@ def create(_: admin_models.Group): ... def get(_: admin_models.Group): ... def get_batch(_: admin_models.GetGroupsBatchResponse): ... def list(_: admin_models.ListGroupsResponse): ... - def page(_: admin_models.ListGroupsResponse): ... def search(_: admin_models.SearchGroupsResponse): ... self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) self.get_batch = core.with_streaming_response(get_batch, client.get_batch) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) self.search = core.with_streaming_response(search, client.search) diff --git a/foundry/v2/admin/group_member.py b/foundry/v2/admin/group_member.py index 200045e6f..112d3f98e 100644 --- a/foundry/v2/admin/group_member.py +++ b/foundry/v2/admin/group_member.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -174,72 +173,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - group_id: core_models.PrincipalId, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - transitive: typing.Optional[bool] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.ListGroupMembersResponse: - """ - Lists all members (which can be a User or a Group) of a given Group. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, - it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. - To get the next page, make the same request again, but set the value of the `pageToken` query parameter - to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field - in the response, you are on the last page. - - :param group_id: - :type group_id: PrincipalId - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :param transitive: When true, includes the transitive members of groups contained within this group. For example, say the Group has member Group A, and Group A has member User B. If `transitive=false` only Group A will be returned, but if `transitive=true` then Group A and User B will be returned. This will recursively resolve Groups through all layers of nesting. Defaults to false. - :type transitive: Optional[bool] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: admin_models.ListGroupMembersResponse - """ - - warnings.warn( - "The client.admin.GroupMember.page(...) method has been deprecated. Please use client.admin.GroupMember.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/groups/{groupId}/groupMembers", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "transitive": transitive, - }, - path_params={ - "groupId": group_id, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=admin_models.ListGroupMembersResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -305,19 +238,15 @@ class _GroupMemberClientRaw: def __init__(self, client: GroupMemberClient) -> None: def add(_: None): ... def list(_: admin_models.ListGroupMembersResponse): ... - def page(_: admin_models.ListGroupMembersResponse): ... def remove(_: None): ... self.add = core.with_raw_response(add, client.add) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) self.remove = core.with_raw_response(remove, client.remove) class _GroupMemberClientStreaming: def __init__(self, client: GroupMemberClient) -> None: def list(_: admin_models.ListGroupMembersResponse): ... - def page(_: admin_models.ListGroupMembersResponse): ... self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/admin/group_membership.py b/foundry/v2/admin/group_membership.py index e93ffa341..d3bef5671 100644 --- a/foundry/v2/admin/group_membership.py +++ b/foundry/v2/admin/group_membership.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -108,86 +107,16 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - user_id: core_models.PrincipalId, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - transitive: typing.Optional[bool] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.ListGroupMembershipsResponse: - """ - Lists all Groups a given User is a member of. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, - it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. - To get the next page, make the same request again, but set the value of the `pageToken` query parameter - to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field - in the response, you are on the last page. - - :param user_id: - :type user_id: PrincipalId - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :param transitive: When true, includes the transitive memberships of the Groups the User is a member of. For example, say the User is a member of Group A, and Group A is a member of Group B. If `transitive=false` only Group A will be returned, but if `transitive=true` then Groups A and B will be returned. This will recursively resolve Groups through all layers of nesting. Defaults to false. - :type transitive: Optional[bool] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: admin_models.ListGroupMembershipsResponse - """ - - warnings.warn( - "The client.admin.GroupMembership.page(...) method has been deprecated. Please use client.admin.GroupMembership.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/users/{userId}/groupMemberships", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "transitive": transitive, - }, - path_params={ - "userId": user_id, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=admin_models.ListGroupMembershipsResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _GroupMembershipClientRaw: def __init__(self, client: GroupMembershipClient) -> None: def list(_: admin_models.ListGroupMembershipsResponse): ... - def page(_: admin_models.ListGroupMembershipsResponse): ... self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) class _GroupMembershipClientStreaming: def __init__(self, client: GroupMembershipClient) -> None: def list(_: admin_models.ListGroupMembershipsResponse): ... - def page(_: admin_models.ListGroupMembershipsResponse): ... self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/admin/host.py b/foundry/v2/admin/host.py index d64a257f4..ed66ba390 100644 --- a/foundry/v2/admin/host.py +++ b/foundry/v2/admin/host.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -110,87 +109,16 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - enrollment_rid: core_models.EnrollmentRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.ListHostsResponse: - """ - Lists all Hosts. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param enrollment_rid: - :type enrollment_rid: EnrollmentRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: admin_models.ListHostsResponse - - :raises EnrollmentNotFound: The given Enrollment could not be found. - :raises ListHostsPermissionDenied: You do not have permission to list hosts for this enrollment - """ - - warnings.warn( - "The client.admin.Host.page(...) method has been deprecated. Please use client.admin.Host.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/enrollments/{enrollmentRid}/hosts", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "enrollmentRid": enrollment_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=admin_models.ListHostsResponse, - request_timeout=request_timeout, - throwable_errors={ - "EnrollmentNotFound": admin_errors.EnrollmentNotFound, - "ListHostsPermissionDenied": admin_errors.ListHostsPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _HostClientRaw: def __init__(self, client: HostClient) -> None: def list(_: admin_models.ListHostsResponse): ... - def page(_: admin_models.ListHostsResponse): ... self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) class _HostClientStreaming: def __init__(self, client: HostClient) -> None: def list(_: admin_models.ListHostsResponse): ... - def page(_: admin_models.ListHostsResponse): ... self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/admin/marking.py b/foundry/v2/admin/marking.py index 44d35835f..c1e78ec68 100644 --- a/foundry/v2/admin/marking.py +++ b/foundry/v2/admin/marking.py @@ -14,7 +14,6 @@ import typing -import warnings from functools import cached_property import annotated_types @@ -79,9 +78,7 @@ def create( *, category_id: admin_models.MarkingCategoryId, initial_members: typing.List[core_models.PrincipalId], - initial_role_assignments: typing.List[ - typing.Union[admin_models.MarkingRoleUpdate, admin_models.MarkingRoleUpdateDict] - ], + initial_role_assignments: typing.List[admin_models.MarkingRoleUpdate], name: admin_models.MarkingName, description: typing.Optional[str] = None, preview: typing.Optional[core_models.PreviewMode] = None, @@ -95,7 +92,7 @@ def create( :param initial_members: Users and Groups that will be able to view resources protected by this Marking. This can be changed later through the MarkingMember operations. :type initial_members: List[PrincipalId] :param initial_role_assignments: The initial roles that will be assigned when the Marking is created. At least one ADMIN role must be provided. This can be changed later through the MarkingRoleAssignment operations. WARNING: If you do not include your own principal ID or the ID of a Group that you are a member of, you will create a Marking that you cannot administer. - :type initial_role_assignments: List[Union[MarkingRoleUpdate, MarkingRoleUpdateDict]] + :type initial_role_assignments: List[MarkingRoleUpdate] :param name: :type name: MarkingName :param description: @@ -135,11 +132,7 @@ def create( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "initialRoleAssignments": typing.List[ - typing.Union[ - admin_models.MarkingRoleUpdate, admin_models.MarkingRoleUpdateDict - ] - ], + "initialRoleAssignments": typing.List[admin_models.MarkingRoleUpdate], "initialMembers": typing.List[core_models.PrincipalId], "name": admin_models.MarkingName, "description": typing.Optional[str], @@ -215,12 +208,7 @@ def get( def get_batch( self, body: typing_extensions.Annotated[ - typing.List[ - typing.Union[ - admin_models.GetMarkingsBatchRequestElement, - admin_models.GetMarkingsBatchRequestElementDict, - ] - ], + typing.List[admin_models.GetMarkingsBatchRequestElement], annotated_types.Len(min_length=1, max_length=500), ], *, @@ -233,7 +221,7 @@ def get_batch( The maximum batch size for this endpoint is 500. :param body: Body of the request - :type body: List[Union[GetMarkingsBatchRequestElement, GetMarkingsBatchRequestElementDict]] + :type body: List[GetMarkingsBatchRequestElement] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -256,7 +244,7 @@ def get_batch( }, body=body, body_type=typing_extensions.Annotated[ - typing.List[admin_models.GetMarkingsBatchRequestElementDict], + typing.List[admin_models.GetMarkingsBatchRequestElement], annotated_types.Len(min_length=1, max_length=500), ], response_type=admin_models.GetMarkingsBatchResponse, @@ -314,60 +302,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.ListMarkingsResponse: - """ - Maximum page size 100. - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: admin_models.ListMarkingsResponse - """ - - warnings.warn( - "The client.admin.Marking.page(...) method has been deprecated. Please use client.admin.Marking.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/markings", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=admin_models.ListMarkingsResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _MarkingClientRaw: def __init__(self, client: MarkingClient) -> None: @@ -375,13 +309,11 @@ def create(_: admin_models.Marking): ... def get(_: admin_models.Marking): ... def get_batch(_: admin_models.GetMarkingsBatchResponse): ... def list(_: admin_models.ListMarkingsResponse): ... - def page(_: admin_models.ListMarkingsResponse): ... self.create = core.with_raw_response(create, client.create) self.get = core.with_raw_response(get, client.get) self.get_batch = core.with_raw_response(get_batch, client.get_batch) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) class _MarkingClientStreaming: @@ -390,10 +322,8 @@ def create(_: admin_models.Marking): ... def get(_: admin_models.Marking): ... def get_batch(_: admin_models.GetMarkingsBatchResponse): ... def list(_: admin_models.ListMarkingsResponse): ... - def page(_: admin_models.ListMarkingsResponse): ... self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) self.get_batch = core.with_streaming_response(get_batch, client.get_batch) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/admin/marking_category.py b/foundry/v2/admin/marking_category.py index 92a767d64..e849e1576 100644 --- a/foundry/v2/admin/marking_category.py +++ b/foundry/v2/admin/marking_category.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -148,78 +147,20 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.ListMarkingCategoriesResponse: - """ - Maximum page size 100. - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: admin_models.ListMarkingCategoriesResponse - """ - - warnings.warn( - "The client.admin.MarkingCategory.page(...) method has been deprecated. Please use client.admin.MarkingCategory.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/markingCategories", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=admin_models.ListMarkingCategoriesResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _MarkingCategoryClientRaw: def __init__(self, client: MarkingCategoryClient) -> None: def get(_: admin_models.MarkingCategory): ... def list(_: admin_models.ListMarkingCategoriesResponse): ... - def page(_: admin_models.ListMarkingCategoriesResponse): ... self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) class _MarkingCategoryClientStreaming: def __init__(self, client: MarkingCategoryClient) -> None: def get(_: admin_models.MarkingCategory): ... def list(_: admin_models.ListMarkingCategoriesResponse): ... - def page(_: admin_models.ListMarkingCategoriesResponse): ... self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/admin/marking_member.py b/foundry/v2/admin/marking_member.py index ff8dfd426..43471f5c0 100644 --- a/foundry/v2/admin/marking_member.py +++ b/foundry/v2/admin/marking_member.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -177,75 +176,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - marking_id: core_models.MarkingId, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - transitive: typing.Optional[bool] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.ListMarkingMembersResponse: - """ - Lists all principals who can view resources protected by the given Marking. Ignores the `pageSize` parameter. - Requires `api:admin-write` because only marking administrators can view marking members. - - :param marking_id: - :type marking_id: MarkingId - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] - :param transitive: When true, includes the transitive members of groups contained within groups that are members of this Marking. For example, say the Marking has member Group A, and Group A has member User B. If `transitive=false` only Group A will be returned, but if `transitive=true` then Group A and User B will be returned. This will recursively resolve Groups through all layers of nesting. Defaults to false. - :type transitive: Optional[bool] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: admin_models.ListMarkingMembersResponse - - :raises ListMarkingMembersPermissionDenied: The provided token does not have permission to list the members of this marking. - """ - - warnings.warn( - "The client.admin.MarkingMember.page(...) method has been deprecated. Please use client.admin.MarkingMember.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/markings/{markingId}/markingMembers", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - "transitive": transitive, - }, - path_params={ - "markingId": marking_id, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=admin_models.ListMarkingMembersResponse, - request_timeout=request_timeout, - throwable_errors={ - "ListMarkingMembersPermissionDenied": admin_errors.ListMarkingMembersPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -310,19 +240,15 @@ class _MarkingMemberClientRaw: def __init__(self, client: MarkingMemberClient) -> None: def add(_: None): ... def list(_: admin_models.ListMarkingMembersResponse): ... - def page(_: admin_models.ListMarkingMembersResponse): ... def remove(_: None): ... self.add = core.with_raw_response(add, client.add) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) self.remove = core.with_raw_response(remove, client.remove) class _MarkingMemberClientStreaming: def __init__(self, client: MarkingMemberClient) -> None: def list(_: admin_models.ListMarkingMembersResponse): ... - def page(_: admin_models.ListMarkingMembersResponse): ... self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/admin/marking_role_assignment.py b/foundry/v2/admin/marking_role_assignment.py index ac8e01add..4dd386e0c 100644 --- a/foundry/v2/admin/marking_role_assignment.py +++ b/foundry/v2/admin/marking_role_assignment.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -56,9 +55,7 @@ def add( self, marking_id: core_models.MarkingId, *, - role_assignments: typing.List[ - typing.Union[admin_models.MarkingRoleUpdate, admin_models.MarkingRoleUpdateDict] - ], + role_assignments: typing.List[admin_models.MarkingRoleUpdate], preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -68,7 +65,7 @@ def add( :param marking_id: :type marking_id: MarkingId :param role_assignments: - :type role_assignments: List[Union[MarkingRoleUpdate, MarkingRoleUpdateDict]] + :type role_assignments: List[MarkingRoleUpdate] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -98,11 +95,7 @@ def add( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "roleAssignments": typing.List[ - typing.Union[ - admin_models.MarkingRoleUpdate, admin_models.MarkingRoleUpdateDict - ] - ], + "roleAssignments": typing.List[admin_models.MarkingRoleUpdate], }, ), response_type=None, @@ -168,66 +161,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - marking_id: core_models.MarkingId, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.ListMarkingRoleAssignmentsResponse: - """ - List all principals who are assigned a role for the given Marking. Ignores the `pageSize` parameter. - - :param marking_id: - :type marking_id: MarkingId - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: admin_models.ListMarkingRoleAssignmentsResponse - """ - - warnings.warn( - "The client.admin.MarkingRoleAssignment.page(...) method has been deprecated. Please use client.admin.MarkingRoleAssignment.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/markings/{markingId}/roleAssignments", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "markingId": marking_id, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=admin_models.ListMarkingRoleAssignmentsResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -235,9 +168,7 @@ def remove( self, marking_id: core_models.MarkingId, *, - role_assignments: typing.List[ - typing.Union[admin_models.MarkingRoleUpdate, admin_models.MarkingRoleUpdateDict] - ], + role_assignments: typing.List[admin_models.MarkingRoleUpdate], preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -247,7 +178,7 @@ def remove( :param marking_id: :type marking_id: MarkingId :param role_assignments: - :type role_assignments: List[Union[MarkingRoleUpdate, MarkingRoleUpdateDict]] + :type role_assignments: List[MarkingRoleUpdate] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -281,11 +212,7 @@ def remove( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "roleAssignments": typing.List[ - typing.Union[ - admin_models.MarkingRoleUpdate, admin_models.MarkingRoleUpdateDict - ] - ], + "roleAssignments": typing.List[admin_models.MarkingRoleUpdate], }, ), response_type=None, @@ -306,19 +233,15 @@ class _MarkingRoleAssignmentClientRaw: def __init__(self, client: MarkingRoleAssignmentClient) -> None: def add(_: None): ... def list(_: admin_models.ListMarkingRoleAssignmentsResponse): ... - def page(_: admin_models.ListMarkingRoleAssignmentsResponse): ... def remove(_: None): ... self.add = core.with_raw_response(add, client.add) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) self.remove = core.with_raw_response(remove, client.remove) class _MarkingRoleAssignmentClientStreaming: def __init__(self, client: MarkingRoleAssignmentClient) -> None: def list(_: admin_models.ListMarkingRoleAssignmentsResponse): ... - def page(_: admin_models.ListMarkingRoleAssignmentsResponse): ... self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/admin/models.py b/foundry/v2/admin/models.py index 39b4feb95..69a64f64a 100644 --- a/foundry/v2/admin/models.py +++ b/foundry/v2/admin/models.py @@ -43,13 +43,6 @@ """AuthenticationProtocol""" -AuthenticationProtocolDict = typing_extensions.Annotated[ - typing.Union["SamlAuthenticationProtocolDict", "OidcAuthenticationProtocolDict"], - pydantic.Field(discriminator="type"), -] -"""AuthenticationProtocol""" - - class AuthenticationProvider(pydantic.BaseModel): """AuthenticationProvider""" @@ -68,31 +61,9 @@ class AuthenticationProvider(pydantic.BaseModel): protocol: AuthenticationProtocol model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AuthenticationProviderDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AuthenticationProviderDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AuthenticationProviderDict(typing_extensions.TypedDict): - """AuthenticationProvider""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: AuthenticationProviderRid - name: AuthenticationProviderName - realm: core_models.Realm - enabled: AuthenticationProviderEnabled - """Whether users can log in using this provider.""" - - supportedHosts: typing.List[HostName] - """This provider can only be utilized from these hosts.""" - - supportedUsernamePatterns: typing.List[str] - """Users who enter usernames that match these patterns will be redirected to this authentication provider.""" - - protocol: AuthenticationProtocolDict + return self.model_dump(by_alias=True, exclude_none=True) AuthenticationProviderEnabled = bool @@ -118,22 +89,9 @@ class CertificateInfo(pydantic.BaseModel): usage_type: CertificateUsageType = pydantic.Field(alias=str("usageType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CertificateInfoDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(CertificateInfoDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class CertificateInfoDict(typing_extensions.TypedDict): - """CertificateInfo""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - pemCertificate: str - """The certificate, in PEM format.""" - - commonName: typing_extensions.NotRequired[str] - expiryDate: datetime - usageType: CertificateUsageType + return self.model_dump(by_alias=True, exclude_none=True) CertificateUsageType = typing.Literal["ENCRYPTION", "SIGNING", "UNSPECIFIED"] @@ -148,19 +106,9 @@ class Enrollment(pydantic.BaseModel): created_time: typing.Optional[core_models.CreatedTime] = pydantic.Field(alias=str("createdTime"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "EnrollmentDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(EnrollmentDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class EnrollmentDict(typing_extensions.TypedDict): - """Enrollment""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: core_models.EnrollmentRid - name: EnrollmentName - createdTime: typing_extensions.NotRequired[core_models.CreatedTime] + return self.model_dump(by_alias=True, exclude_none=True) EnrollmentName = str @@ -173,19 +121,9 @@ class GetGroupsBatchRequestElement(pydantic.BaseModel): group_id: core_models.PrincipalId = pydantic.Field(alias=str("groupId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GetGroupsBatchRequestElementDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GetGroupsBatchRequestElementDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GetGroupsBatchRequestElementDict(typing_extensions.TypedDict): - """GetGroupsBatchRequestElement""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - groupId: core_models.PrincipalId + return self.model_dump(by_alias=True, exclude_none=True) class GetGroupsBatchResponse(pydantic.BaseModel): @@ -194,19 +132,9 @@ class GetGroupsBatchResponse(pydantic.BaseModel): data: typing.Dict[core_models.PrincipalId, Group] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GetGroupsBatchResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GetGroupsBatchResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GetGroupsBatchResponseDict(typing_extensions.TypedDict): - """GetGroupsBatchResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.Dict[core_models.PrincipalId, GroupDict] + return self.model_dump(by_alias=True, exclude_none=True) class GetMarkingsBatchRequestElement(pydantic.BaseModel): @@ -215,19 +143,9 @@ class GetMarkingsBatchRequestElement(pydantic.BaseModel): marking_id: core_models.MarkingId = pydantic.Field(alias=str("markingId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GetMarkingsBatchRequestElementDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GetMarkingsBatchRequestElementDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GetMarkingsBatchRequestElementDict(typing_extensions.TypedDict): - """GetMarkingsBatchRequestElement""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - markingId: core_models.MarkingId + return self.model_dump(by_alias=True, exclude_none=True) class GetMarkingsBatchResponse(pydantic.BaseModel): @@ -236,19 +154,9 @@ class GetMarkingsBatchResponse(pydantic.BaseModel): data: typing.Dict[core_models.MarkingId, Marking] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GetMarkingsBatchResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GetMarkingsBatchResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GetMarkingsBatchResponseDict(typing_extensions.TypedDict): - """GetMarkingsBatchResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.Dict[core_models.MarkingId, MarkingDict] + return self.model_dump(by_alias=True, exclude_none=True) class GetUserMarkingsResponse(pydantic.BaseModel): @@ -262,23 +170,9 @@ class GetUserMarkingsResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GetUserMarkingsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GetUserMarkingsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GetUserMarkingsResponseDict(typing_extensions.TypedDict): - """GetUserMarkingsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - view: typing.List[core_models.MarkingId] - """ - The markings that the user has access to. The user will be able to access resources protected with these - markings. This includes organization markings for organizations in which the user is a guest member. - """ + return self.model_dump(by_alias=True, exclude_none=True) class GetUsersBatchRequestElement(pydantic.BaseModel): @@ -287,19 +181,9 @@ class GetUsersBatchRequestElement(pydantic.BaseModel): user_id: core_models.PrincipalId = pydantic.Field(alias=str("userId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GetUsersBatchRequestElementDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GetUsersBatchRequestElementDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GetUsersBatchRequestElementDict(typing_extensions.TypedDict): - """GetUsersBatchRequestElement""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - userId: core_models.PrincipalId + return self.model_dump(by_alias=True, exclude_none=True) class GetUsersBatchResponse(pydantic.BaseModel): @@ -308,19 +192,9 @@ class GetUsersBatchResponse(pydantic.BaseModel): data: typing.Dict[core_models.PrincipalId, User] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GetUsersBatchResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GetUsersBatchResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GetUsersBatchResponseDict(typing_extensions.TypedDict): - """GetUsersBatchResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.Dict[core_models.PrincipalId, UserDict] + return self.model_dump(by_alias=True, exclude_none=True) class Group(pydantic.BaseModel): @@ -342,29 +216,9 @@ class Group(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GroupDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(GroupDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class GroupDict(typing_extensions.TypedDict): - """Group""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: core_models.PrincipalId - name: GroupName - """The name of the Group.""" - - description: typing_extensions.NotRequired[str] - """A description of the Group.""" - - realm: core_models.Realm - organizations: typing.List[core_models.OrganizationRid] - """The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed.""" - - attributes: typing.Dict[AttributeName, AttributeValues] - """A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change.""" + return self.model_dump(by_alias=True, exclude_none=True) class GroupMember(pydantic.BaseModel): @@ -374,18 +228,9 @@ class GroupMember(pydantic.BaseModel): principal_id: core_models.PrincipalId = pydantic.Field(alias=str("principalId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GroupMemberDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(GroupMemberDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class GroupMemberDict(typing_extensions.TypedDict): - """GroupMember""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - principalType: core_models.PrincipalType - principalId: core_models.PrincipalId + return self.model_dump(by_alias=True, exclude_none=True) class GroupMembership(pydantic.BaseModel): @@ -394,17 +239,9 @@ class GroupMembership(pydantic.BaseModel): group_id: core_models.PrincipalId = pydantic.Field(alias=str("groupId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GroupMembershipDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(GroupMembershipDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class GroupMembershipDict(typing_extensions.TypedDict): - """GroupMembership""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - groupId: core_models.PrincipalId + return self.model_dump(by_alias=True, exclude_none=True) GroupMembershipExpiration = datetime @@ -426,21 +263,9 @@ class GroupProviderInfo(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GroupProviderInfoDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(GroupProviderInfoDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class GroupProviderInfoDict(typing_extensions.TypedDict): - """GroupProviderInfo""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - providerId: 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. - """ + return self.model_dump(by_alias=True, exclude_none=True) class GroupSearchFilter(pydantic.BaseModel): @@ -450,18 +275,9 @@ class GroupSearchFilter(pydantic.BaseModel): value: str model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GroupSearchFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(GroupSearchFilterDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class GroupSearchFilterDict(typing_extensions.TypedDict): - """GroupSearchFilter""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: PrincipalFilterType - value: str + return self.model_dump(by_alias=True, exclude_none=True) class Host(pydantic.BaseModel): @@ -470,17 +286,9 @@ class Host(pydantic.BaseModel): host_name: HostName = pydantic.Field(alias=str("hostName")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "HostDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(HostDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class HostDict(typing_extensions.TypedDict): - """Host""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - hostName: HostName + return self.model_dump(by_alias=True, exclude_none=True) HostName = str @@ -494,21 +302,9 @@ class ListAuthenticationProvidersResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListAuthenticationProvidersResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListAuthenticationProvidersResponseDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class ListAuthenticationProvidersResponseDict(typing_extensions.TypedDict): - """ListAuthenticationProvidersResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[AuthenticationProviderDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListGroupMembersResponse(pydantic.BaseModel): @@ -518,20 +314,9 @@ class ListGroupMembersResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListGroupMembersResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListGroupMembersResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListGroupMembersResponseDict(typing_extensions.TypedDict): - """ListGroupMembersResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[GroupMemberDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListGroupMembershipsResponse(pydantic.BaseModel): @@ -541,20 +326,9 @@ class ListGroupMembershipsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListGroupMembershipsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListGroupMembershipsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListGroupMembershipsResponseDict(typing_extensions.TypedDict): - """ListGroupMembershipsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[GroupMembershipDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListGroupsResponse(pydantic.BaseModel): @@ -564,20 +338,9 @@ class ListGroupsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListGroupsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListGroupsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListGroupsResponseDict(typing_extensions.TypedDict): - """ListGroupsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[GroupDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListHostsResponse(pydantic.BaseModel): @@ -587,18 +350,9 @@ class ListHostsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListHostsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ListHostsResponseDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ListHostsResponseDict(typing_extensions.TypedDict): - """ListHostsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[HostDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListMarkingCategoriesResponse(pydantic.BaseModel): @@ -608,20 +362,9 @@ class ListMarkingCategoriesResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListMarkingCategoriesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListMarkingCategoriesResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListMarkingCategoriesResponseDict(typing_extensions.TypedDict): - """ListMarkingCategoriesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[MarkingCategoryDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListMarkingMembersResponse(pydantic.BaseModel): @@ -631,20 +374,9 @@ class ListMarkingMembersResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListMarkingMembersResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListMarkingMembersResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListMarkingMembersResponseDict(typing_extensions.TypedDict): - """ListMarkingMembersResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[MarkingMemberDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListMarkingRoleAssignmentsResponse(pydantic.BaseModel): @@ -654,21 +386,9 @@ class ListMarkingRoleAssignmentsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListMarkingRoleAssignmentsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListMarkingRoleAssignmentsResponseDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class ListMarkingRoleAssignmentsResponseDict(typing_extensions.TypedDict): - """ListMarkingRoleAssignmentsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[MarkingRoleAssignmentDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListMarkingsResponse(pydantic.BaseModel): @@ -678,20 +398,9 @@ class ListMarkingsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListMarkingsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListMarkingsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListMarkingsResponseDict(typing_extensions.TypedDict): - """ListMarkingsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[MarkingDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListUsersResponse(pydantic.BaseModel): @@ -701,18 +410,9 @@ class ListUsersResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListUsersResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ListUsersResponseDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ListUsersResponseDict(typing_extensions.TypedDict): - """ListUsersResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[UserDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class Marking(pydantic.BaseModel): @@ -729,9 +429,9 @@ class Marking(pydantic.BaseModel): created_by: typing.Optional[core_models.CreatedBy] = pydantic.Field(alias=str("createdBy"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MarkingDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MarkingDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) class MarkingCategory(pydantic.BaseModel): @@ -747,24 +447,9 @@ class MarkingCategory(pydantic.BaseModel): created_by: typing.Optional[core_models.CreatedBy] = pydantic.Field(alias=str("createdBy"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MarkingCategoryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MarkingCategoryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MarkingCategoryDict(typing_extensions.TypedDict): - """MarkingCategory""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: MarkingCategoryId - name: MarkingCategoryName - description: typing_extensions.NotRequired[str] - categoryType: MarkingCategoryType - markingType: MarkingType - markings: typing.List[core_models.MarkingId] - createdTime: core_models.CreatedTime - createdBy: typing_extensions.NotRequired[core_models.CreatedBy] + return self.model_dump(by_alias=True, exclude_none=True) MarkingCategoryId = str @@ -782,22 +467,6 @@ class MarkingCategoryDict(typing_extensions.TypedDict): """MarkingCategoryType""" -class MarkingDict(typing_extensions.TypedDict): - """Marking""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: core_models.MarkingId - categoryId: MarkingCategoryId - name: MarkingName - description: typing_extensions.NotRequired[str] - organization: typing_extensions.NotRequired[core_models.OrganizationRid] - """If this marking is associated with an Organization, its RID will be populated here.""" - - createdTime: core_models.CreatedTime - createdBy: typing_extensions.NotRequired[core_models.CreatedBy] - - class MarkingMember(pydantic.BaseModel): """MarkingMember""" @@ -805,18 +474,9 @@ class MarkingMember(pydantic.BaseModel): principal_id: core_models.PrincipalId = pydantic.Field(alias=str("principalId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MarkingMemberDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MarkingMemberDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MarkingMemberDict(typing_extensions.TypedDict): - """MarkingMember""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - principalType: core_models.PrincipalType - principalId: core_models.PrincipalId + return self.model_dump(by_alias=True, exclude_none=True) MarkingName = str @@ -840,21 +500,9 @@ class MarkingRoleAssignment(pydantic.BaseModel): role: MarkingRole model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MarkingRoleAssignmentDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - MarkingRoleAssignmentDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class MarkingRoleAssignmentDict(typing_extensions.TypedDict): - """MarkingRoleAssignment""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - principalType: core_models.PrincipalType - principalId: core_models.PrincipalId - role: MarkingRole + return self.model_dump(by_alias=True, exclude_none=True) class MarkingRoleUpdate(pydantic.BaseModel): @@ -864,18 +512,9 @@ class MarkingRoleUpdate(pydantic.BaseModel): principal_id: core_models.PrincipalId = pydantic.Field(alias=str("principalId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MarkingRoleUpdateDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MarkingRoleUpdateDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MarkingRoleUpdateDict(typing_extensions.TypedDict): - """MarkingRoleUpdate""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - role: MarkingRole - principalId: core_models.PrincipalId + return self.model_dump(by_alias=True, exclude_none=True) MarkingType = typing.Literal["MANDATORY", "CBAC"] @@ -888,19 +527,9 @@ class OidcAuthenticationProtocol(pydantic.BaseModel): type: typing.Literal["oidc"] = "oidc" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OidcAuthenticationProtocolDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OidcAuthenticationProtocolDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class OidcAuthenticationProtocolDict(typing_extensions.TypedDict): - """OidcAuthenticationProtocol""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["oidc"] + return self.model_dump(by_alias=True, exclude_none=True) class Organization(pydantic.BaseModel): @@ -923,30 +552,9 @@ class Organization(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OrganizationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OrganizationDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OrganizationDict(typing_extensions.TypedDict): - """Organization""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: core_models.OrganizationRid - name: OrganizationName - description: typing_extensions.NotRequired[str] - markingId: core_models.MarkingId - """ - The ID of this Organization's underlying marking. Organization guest access can be managed - by updating the membership of this Marking. - """ - - host: typing_extensions.NotRequired[HostName] - """ - The primary host name of the Organization. This should be used when constructing URLs for users of this - Organization. - """ + return self.model_dump(by_alias=True, exclude_none=True) OrganizationName = str @@ -968,20 +576,9 @@ class SamlAuthenticationProtocol(pydantic.BaseModel): type: typing.Literal["saml"] = "saml" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SamlAuthenticationProtocolDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SamlAuthenticationProtocolDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SamlAuthenticationProtocolDict(typing_extensions.TypedDict): - """SamlAuthenticationProtocol""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - serviceProviderMetadata: SamlServiceProviderMetadataDict - type: typing.Literal["saml"] + return self.model_dump(by_alias=True, exclude_none=True) class SamlServiceProviderMetadata(pydantic.BaseModel): @@ -1005,34 +602,9 @@ class SamlServiceProviderMetadata(pydantic.BaseModel): certificates: typing.List[CertificateInfo] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SamlServiceProviderMetadataDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SamlServiceProviderMetadataDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SamlServiceProviderMetadataDict(typing_extensions.TypedDict): - """Information that describes a Foundry Authentication Provider as a SAML service provider. All information listed here is generated by Foundry.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - entityId: str - """The static SAML entity ID that represents this service provider.""" - - metadataUrl: str - """A public URL from which this service provider metadata can be downloaded as XML.""" - - acsUrls: typing.List[str] - """ - The Assertion Consumer Service (ACS) URLs for this service provider, to which the SAML identity provider - redirects authentication responses. - """ - - logoutUrls: typing.List[str] - """The URLs for this service provider to which the SAML identity provider sends logout requests.""" - - certificates: typing.List[CertificateInfoDict] + return self.model_dump(by_alias=True, exclude_none=True) class SearchGroupsResponse(pydantic.BaseModel): @@ -1042,20 +614,9 @@ class SearchGroupsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchGroupsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SearchGroupsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SearchGroupsResponseDict(typing_extensions.TypedDict): - """SearchGroupsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[GroupDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class SearchUsersResponse(pydantic.BaseModel): @@ -1065,20 +626,9 @@ class SearchUsersResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchUsersResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SearchUsersResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SearchUsersResponseDict(typing_extensions.TypedDict): - """SearchUsersResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[UserDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class User(pydantic.BaseModel): @@ -1110,39 +660,9 @@ class User(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "UserDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(UserDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class UserDict(typing_extensions.TypedDict): - """User""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: core_models.PrincipalId - username: UserUsername - """The Foundry username of the User. This is unique within the realm.""" - - givenName: typing_extensions.NotRequired[str] - """The given name of the User.""" - - familyName: typing_extensions.NotRequired[str] - """The family name (last name) of the User.""" - - email: typing_extensions.NotRequired[str] - """The email at which to contact a User. Multiple users may have the same email address.""" - - realm: core_models.Realm - organization: typing_extensions.NotRequired[core_models.OrganizationRid] - """The RID of the user's primary Organization. This will be blank for third-party application service users.""" - - attributes: typing.Dict[AttributeName, AttributeValues] - """ - A map of the User's attributes. Attributes prefixed with "multipass:" are reserved for internal use by - Foundry and are subject to change. Additional attributes may be configured by Foundry administrators in - Control Panel and populated by the User's SSO provider upon login. - """ + return self.model_dump(by_alias=True, exclude_none=True) class UserProviderInfo(pydantic.BaseModel): @@ -1156,21 +676,9 @@ class UserProviderInfo(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "UserProviderInfoDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(UserProviderInfoDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class UserProviderInfoDict(typing_extensions.TypedDict): - """UserProviderInfo""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - providerId: ProviderId - """ - The ID of the User in the external authentication provider. This value is determined by the authentication provider. - At most one User can have a given provider ID in a given Realm. - """ + return self.model_dump(by_alias=True, exclude_none=True) class UserSearchFilter(pydantic.BaseModel): @@ -1180,18 +688,9 @@ class UserSearchFilter(pydantic.BaseModel): value: str model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "UserSearchFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(UserSearchFilterDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class UserSearchFilterDict(typing_extensions.TypedDict): - """UserSearchFilter""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: PrincipalFilterType - value: str + return self.model_dump(by_alias=True, exclude_none=True) UserUsername = str @@ -1200,110 +699,68 @@ class UserSearchFilterDict(typing_extensions.TypedDict): core.resolve_forward_references(AttributeValues, globalns=globals(), localns=locals()) core.resolve_forward_references(AuthenticationProtocol, globalns=globals(), localns=locals()) -core.resolve_forward_references(AuthenticationProtocolDict, globalns=globals(), localns=locals()) __all__ = [ "AttributeName", "AttributeValue", "AttributeValues", "AuthenticationProtocol", - "AuthenticationProtocolDict", "AuthenticationProvider", - "AuthenticationProviderDict", "AuthenticationProviderEnabled", "AuthenticationProviderName", "AuthenticationProviderRid", "CertificateInfo", - "CertificateInfoDict", "CertificateUsageType", "Enrollment", - "EnrollmentDict", "EnrollmentName", "GetGroupsBatchRequestElement", - "GetGroupsBatchRequestElementDict", "GetGroupsBatchResponse", - "GetGroupsBatchResponseDict", "GetMarkingsBatchRequestElement", - "GetMarkingsBatchRequestElementDict", "GetMarkingsBatchResponse", - "GetMarkingsBatchResponseDict", "GetUserMarkingsResponse", - "GetUserMarkingsResponseDict", "GetUsersBatchRequestElement", - "GetUsersBatchRequestElementDict", "GetUsersBatchResponse", - "GetUsersBatchResponseDict", "Group", - "GroupDict", "GroupMember", - "GroupMemberDict", "GroupMembership", - "GroupMembershipDict", "GroupMembershipExpiration", "GroupName", "GroupProviderInfo", - "GroupProviderInfoDict", "GroupSearchFilter", - "GroupSearchFilterDict", "Host", - "HostDict", "HostName", "ListAuthenticationProvidersResponse", - "ListAuthenticationProvidersResponseDict", "ListGroupMembersResponse", - "ListGroupMembersResponseDict", "ListGroupMembershipsResponse", - "ListGroupMembershipsResponseDict", "ListGroupsResponse", - "ListGroupsResponseDict", "ListHostsResponse", - "ListHostsResponseDict", "ListMarkingCategoriesResponse", - "ListMarkingCategoriesResponseDict", "ListMarkingMembersResponse", - "ListMarkingMembersResponseDict", "ListMarkingRoleAssignmentsResponse", - "ListMarkingRoleAssignmentsResponseDict", "ListMarkingsResponse", - "ListMarkingsResponseDict", "ListUsersResponse", - "ListUsersResponseDict", "Marking", "MarkingCategory", - "MarkingCategoryDict", "MarkingCategoryId", "MarkingCategoryName", "MarkingCategoryType", - "MarkingDict", "MarkingMember", - "MarkingMemberDict", "MarkingName", "MarkingRole", "MarkingRoleAssignment", - "MarkingRoleAssignmentDict", "MarkingRoleUpdate", - "MarkingRoleUpdateDict", "MarkingType", "OidcAuthenticationProtocol", - "OidcAuthenticationProtocolDict", "Organization", - "OrganizationDict", "OrganizationName", "PrincipalFilterType", "ProviderId", "SamlAuthenticationProtocol", - "SamlAuthenticationProtocolDict", "SamlServiceProviderMetadata", - "SamlServiceProviderMetadataDict", "SearchGroupsResponse", - "SearchGroupsResponseDict", "SearchUsersResponse", - "SearchUsersResponseDict", "User", - "UserDict", "UserProviderInfo", - "UserProviderInfoDict", "UserSearchFilter", - "UserSearchFilterDict", "UserUsername", ] diff --git a/foundry/v2/admin/user.py b/foundry/v2/admin/user.py index 99eba46fe..b5907caaf 100644 --- a/foundry/v2/admin/user.py +++ b/foundry/v2/admin/user.py @@ -14,7 +14,6 @@ import typing -import warnings from functools import cached_property import annotated_types @@ -163,12 +162,7 @@ def get( def get_batch( self, body: typing_extensions.Annotated[ - typing.List[ - typing.Union[ - admin_models.GetUsersBatchRequestElement, - admin_models.GetUsersBatchRequestElementDict, - ] - ], + typing.List[admin_models.GetUsersBatchRequestElement], annotated_types.Len(min_length=1, max_length=500), ], *, @@ -180,7 +174,7 @@ def get_batch( The maximum batch size for this endpoint is 500. :param body: Body of the request - :type body: List[Union[GetUsersBatchRequestElement, GetUsersBatchRequestElementDict]] + :type body: List[GetUsersBatchRequestElement] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -199,7 +193,7 @@ def get_batch( }, body=body, body_type=typing_extensions.Annotated[ - typing.List[admin_models.GetUsersBatchRequestElementDict], + typing.List[admin_models.GetUsersBatchRequestElement], annotated_types.Len(min_length=1, max_length=500), ], response_type=admin_models.GetUsersBatchResponse, @@ -343,58 +337,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> admin_models.ListUsersResponse: - """ - Lists all Users. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: admin_models.ListUsersResponse - """ - - warnings.warn( - "The client.admin.User.page(...) method has been deprecated. Please use client.admin.User.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/admin/users", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=admin_models.ListUsersResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -449,7 +391,7 @@ def profile_picture( def search( self, *, - where: typing.Union[admin_models.UserSearchFilter, admin_models.UserSearchFilterDict], + where: admin_models.UserSearchFilter, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -459,7 +401,7 @@ def search( Perform a case-insensitive prefix search for users based on username, given name and family name. :param where: - :type where: Union[UserSearchFilter, UserSearchFilterDict] + :type where: UserSearchFilter :param page_size: :type page_size: Optional[PageSize] :param page_token: @@ -490,9 +432,7 @@ def search( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "where": typing.Union[ - admin_models.UserSearchFilter, admin_models.UserSearchFilterDict - ], + "where": admin_models.UserSearchFilter, "pageSize": typing.Optional[core_models.PageSize], "pageToken": typing.Optional[core_models.PageToken], }, @@ -515,7 +455,6 @@ def get_batch(_: admin_models.GetUsersBatchResponse): ... def get_current(_: admin_models.User): ... def get_markings(_: admin_models.GetUserMarkingsResponse): ... def list(_: admin_models.ListUsersResponse): ... - def page(_: admin_models.ListUsersResponse): ... def profile_picture(_: typing.Optional[bytes]): ... def search(_: admin_models.SearchUsersResponse): ... @@ -525,7 +464,6 @@ def search(_: admin_models.SearchUsersResponse): ... self.get_current = core.with_raw_response(get_current, client.get_current) self.get_markings = core.with_raw_response(get_markings, client.get_markings) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) self.profile_picture = core.with_raw_response(profile_picture, client.profile_picture) self.search = core.with_raw_response(search, client.search) @@ -537,7 +475,6 @@ def get_batch(_: admin_models.GetUsersBatchResponse): ... def get_current(_: admin_models.User): ... def get_markings(_: admin_models.GetUserMarkingsResponse): ... def list(_: admin_models.ListUsersResponse): ... - def page(_: admin_models.ListUsersResponse): ... def profile_picture(_: typing.Optional[bytes]): ... def search(_: admin_models.SearchUsersResponse): ... @@ -546,6 +483,5 @@ def search(_: admin_models.SearchUsersResponse): ... self.get_current = core.with_streaming_response(get_current, client.get_current) self.get_markings = core.with_streaming_response(get_markings, client.get_markings) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) self.profile_picture = core.with_streaming_response(profile_picture, client.profile_picture) self.search = core.with_streaming_response(search, client.search) diff --git a/foundry/v2/aip_agents/agent.py b/foundry/v2/aip_agents/agent.py index a32c3adf7..6c639af8e 100644 --- a/foundry/v2/aip_agents/agent.py +++ b/foundry/v2/aip_agents/agent.py @@ -14,7 +14,6 @@ import typing -import warnings from functools import cached_property import pydantic @@ -124,66 +123,6 @@ def all_sessions( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def all_sessions_page( - self, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> aip_agents_models.AgentsSessionsPage: - """ - List all conversation sessions between the calling user and all accessible Agents that were created by this client. - Sessions are returned in order of most recently updated first. - - :param page_size: The maximum number of sessions to return in a single page. The maximum allowed value is 100. Defaults to 100 if not specified. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :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: aip_agents_models.AgentsSessionsPage - - :raises ListSessionsForAgentsPermissionDenied: Could not allSessions the Agent. - """ - - warnings.warn( - "The client.aip_agents.Agent.all_sessions_page(...) method has been deprecated. Please use client.aip_agents.Agent.all_sessions(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/aipAgents/agents/allSessions", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=aip_agents_models.AgentsSessionsPage, - request_timeout=request_timeout, - throwable_errors={ - "ListSessionsForAgentsPermissionDenied": aip_agents_errors.ListSessionsForAgentsPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -247,22 +186,16 @@ def get( class _AgentClientRaw: def __init__(self, client: AgentClient) -> None: def all_sessions(_: aip_agents_models.AgentsSessionsPage): ... - def all_sessions_page(_: aip_agents_models.AgentsSessionsPage): ... def get(_: aip_agents_models.Agent): ... self.all_sessions = core.with_raw_response(all_sessions, client.all_sessions) - self.all_sessions_page = core.with_raw_response(all_sessions_page, client.all_sessions_page) self.get = core.with_raw_response(get, client.get) class _AgentClientStreaming: def __init__(self, client: AgentClient) -> None: def all_sessions(_: aip_agents_models.AgentsSessionsPage): ... - def all_sessions_page(_: aip_agents_models.AgentsSessionsPage): ... def get(_: aip_agents_models.Agent): ... self.all_sessions = core.with_streaming_response(all_sessions, client.all_sessions) - self.all_sessions_page = core.with_streaming_response( - all_sessions_page, client.all_sessions_page - ) self.get = core.with_streaming_response(get, client.get) diff --git a/foundry/v2/aip_agents/agent_version.py b/foundry/v2/aip_agents/agent_version.py index 3bc932f64..1f5f9c612 100644 --- a/foundry/v2/aip_agents/agent_version.py +++ b/foundry/v2/aip_agents/agent_version.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -157,85 +156,20 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - agent_rid: aip_agents_models.AgentRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> aip_agents_models.ListAgentVersionsResponse: - """ - List all versions for an AIP Agent. - Versions are returned in descending order, by most recent versions first. - - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). - :type agent_rid: AgentRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: aip_agents_models.ListAgentVersionsResponse - """ - - warnings.warn( - "The client.aip_agents.AgentVersion.page(...) method has been deprecated. Please use client.aip_agents.AgentVersion.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/aipAgents/agents/{agentRid}/agentVersions", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "agentRid": agent_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=aip_agents_models.ListAgentVersionsResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _AgentVersionClientRaw: def __init__(self, client: AgentVersionClient) -> None: def get(_: aip_agents_models.AgentVersion): ... def list(_: aip_agents_models.ListAgentVersionsResponse): ... - def page(_: aip_agents_models.ListAgentVersionsResponse): ... self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) class _AgentVersionClientStreaming: def __init__(self, client: AgentVersionClient) -> None: def get(_: aip_agents_models.AgentVersion): ... def list(_: aip_agents_models.ListAgentVersionsResponse): ... - def page(_: aip_agents_models.ListAgentVersionsResponse): ... self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/aip_agents/client.py b/foundry/v2/aip_agents/client.py deleted file mode 100644 index 9aa53fc3f..000000000 --- a/foundry/v2/aip_agents/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v2.aip_agents._client import AipAgentsClient - -__all__ = [ - "AipAgentsClient", -] diff --git a/foundry/v2/aip_agents/models.py b/foundry/v2/aip_agents/models.py index 79913e41f..8658e20c9 100644 --- a/foundry/v2/aip_agents/models.py +++ b/foundry/v2/aip_agents/models.py @@ -45,28 +45,9 @@ class Agent(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AgentDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AgentDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AgentDict(typing_extensions.TypedDict): - """Agent""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: AgentRid - """An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" - - version: AgentVersionString - """The version of this instance of the Agent.""" - - metadata: AgentMetadataDict - parameters: typing.Dict[ParameterId, ParameterDict] - """ - The types and names of variables configured for the Agent in [AIP Agent Studio](/docs/foundry/agent-studio/overview/) in the [application state](/docs/foundry/agent-studio/application-state/). - These variables can be used to send custom values in prompts sent to an Agent to customize and control the Agent's behavior. - """ + return self.model_dump(by_alias=True, exclude_none=True) AgentMarkdownResponse = str @@ -90,27 +71,9 @@ class AgentMetadata(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AgentMetadataDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AgentMetadataDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AgentMetadataDict(typing_extensions.TypedDict): - """Metadata for an Agent.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - displayName: str - """The name of the Agent.""" - - description: typing_extensions.NotRequired[str] - """The description for the Agent.""" - - inputPlaceholder: typing_extensions.NotRequired[str] - """The default text to show as the placeholder input for chats with the Agent.""" - - suggestedPrompts: typing.List[str] - """Prompts to show to the user as example messages to start a conversation with the Agent.""" + return self.model_dump(by_alias=True, exclude_none=True) AgentRid = core.RID @@ -124,20 +87,9 @@ class AgentSessionRagContextResponse(pydantic.BaseModel): function_retrieved_contexts: typing.List[FunctionRetrievedContext] = pydantic.Field(alias=str("functionRetrievedContexts")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AgentSessionRagContextResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AgentSessionRagContextResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AgentSessionRagContextResponseDict(typing_extensions.TypedDict): - """Context retrieved from an Agent's configured context data sources which was relevant to the supplied user message.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectContexts: typing.List[ObjectContextDict] - functionRetrievedContexts: typing.List[FunctionRetrievedContextDict] + return self.model_dump(by_alias=True, exclude_none=True) class AgentVersion(pydantic.BaseModel): @@ -151,9 +103,9 @@ class AgentVersion(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AgentVersionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AgentVersionDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) class AgentVersionDetails(pydantic.BaseModel): @@ -167,35 +119,9 @@ class AgentVersionDetails(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AgentVersionDetailsDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AgentVersionDetailsDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AgentVersionDetailsDict(typing_extensions.TypedDict): - """Semantic version details for an Agent.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - major: int - """The major version of the Agent. Incremented every time the Agent is published.""" - - minor: int - """The minor version of the Agent. Incremented every time the Agent is saved.""" - - -class AgentVersionDict(typing_extensions.TypedDict): - """AgentVersion""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - string: AgentVersionString - """The semantic version of the Agent, formatted as "majorVersion.minorVersion".""" - - version: AgentVersionDetailsDict - """Semantic version details of the Agent.""" + return self.model_dump(by_alias=True, exclude_none=True) AgentVersionString = str @@ -217,28 +143,9 @@ class AgentsSessionsPage(pydantic.BaseModel): data: typing.List[Session] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AgentsSessionsPageDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AgentsSessionsPageDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AgentsSessionsPageDict(typing_extensions.TypedDict): - """ - A page of results for sessions across all accessible Agents for the calling user. - Sessions are returned in order of most recently updated first. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - """ - The page token that should be used when requesting the next page of results. - Empty if there are no more results to retrieve. - """ - - data: typing.List[SessionDict] + return self.model_dump(by_alias=True, exclude_none=True) class CancelSessionResponse(pydantic.BaseModel): @@ -252,23 +159,9 @@ class CancelSessionResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CancelSessionResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CancelSessionResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class CancelSessionResponseDict(typing_extensions.TypedDict): - """CancelSessionResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - result: typing_extensions.NotRequired[SessionExchangeResultDict] - """ - If the `response` field was specified, this returns the result that was added to the session for the canceled exchange, with the client-provided response. - If no `response` was specified in the request, this returns an empty response, as no exchange was added to the session. - """ + return self.model_dump(by_alias=True, exclude_none=True) class Content(pydantic.BaseModel): @@ -283,22 +176,9 @@ class Content(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ContentDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ContentDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ContentDict(typing_extensions.TypedDict): - """Content""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - exchanges: typing.List[SessionExchangeDict] - """ - The conversation history for the session, represented as a list of exchanges. - Each exchange represents an initiating message from the user and the Agent's response. - Exchanges are returned in chronological order, starting with the first exchange. - """ + return self.model_dump(by_alias=True, exclude_none=True) class FunctionRetrievedContext(pydantic.BaseModel): @@ -312,24 +192,9 @@ class FunctionRetrievedContext(pydantic.BaseModel): type: typing.Literal["functionRetrievedContext"] = "functionRetrievedContext" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FunctionRetrievedContextDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - FunctionRetrievedContextDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class FunctionRetrievedContextDict(typing_extensions.TypedDict): - """Context retrieved from running a function to include as additional context in the prompt to the Agent.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - functionRid: functions_models.FunctionRid - functionVersion: functions_models.FunctionVersion - retrievedPrompt: str - """String content returned from a context retrieval function.""" - - type: typing.Literal["functionRetrievedContext"] + return self.model_dump(by_alias=True, exclude_none=True) InputContext = typing_extensions.Annotated[ @@ -338,13 +203,6 @@ class FunctionRetrievedContextDict(typing_extensions.TypedDict): """Custom retrieved [context](/docs/foundry/agent-studio/retrieval-context/) to provide to an Agent for continuing a session.""" -InputContextDict = typing_extensions.Annotated[ - typing.Union[FunctionRetrievedContextDict, "ObjectContextDict"], - pydantic.Field(discriminator="type"), -] -"""Custom retrieved [context](/docs/foundry/agent-studio/retrieval-context/) to provide to an Agent for continuing a session.""" - - class ListAgentVersionsResponse(pydantic.BaseModel): """ListAgentVersionsResponse""" @@ -352,20 +210,9 @@ class ListAgentVersionsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListAgentVersionsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListAgentVersionsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListAgentVersionsResponseDict(typing_extensions.TypedDict): - """ListAgentVersionsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[AgentVersionDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListSessionsResponse(pydantic.BaseModel): @@ -375,20 +222,9 @@ class ListSessionsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListSessionsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListSessionsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListSessionsResponseDict(typing_extensions.TypedDict): - """ListSessionsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[SessionDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) MessageId = core.UUID @@ -410,23 +246,9 @@ class ObjectContext(pydantic.BaseModel): type: typing.Literal["objectContext"] = "objectContext" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectContextDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ObjectContextDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ObjectContextDict(typing_extensions.TypedDict): - """Details of relevant retrieved object instances for a user's message to include as additional context in the prompt to the Agent.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectRids: typing.List[ontologies_models.ObjectRid] - """The RIDs of the relevant object instances to include in the prompt.""" - - propertyTypeRids: typing.List[ontologies_models.PropertyTypeRid] - """The RIDs of the property types for the given objects to include in the prompt.""" - - type: typing.Literal["objectContext"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetParameter(pydantic.BaseModel): @@ -438,22 +260,9 @@ class ObjectSetParameter(pydantic.BaseModel): type: typing.Literal["objectSet"] = "objectSet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetParameterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetParameterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetParameterDict(typing_extensions.TypedDict): - """ObjectSetParameter""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - expectedObjectTypes: typing.List[ontologies_models.ObjectTypeId] - """The types of objects that are expected in ObjectSet values passed for this variable.""" - - type: typing.Literal["objectSet"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetParameterValue(pydantic.BaseModel): @@ -469,26 +278,9 @@ class ObjectSetParameterValue(pydantic.BaseModel): type: typing.Literal["objectSet"] = "objectSet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetParameterValueDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetParameterValueDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetParameterValueDict(typing_extensions.TypedDict): - """A value passed for `ObjectSetParameter` application variable types.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ontologies_models.ObjectSetDict - ontology: ontologies_models.OntologyIdentifier - """ - The API name of the Ontology for the provided `ObjectSet`. - To find the API name, use the `List ontologies` endpoint or check the [Ontology Manager](/docs/foundry/ontology-manager/overview/). - """ - - type: typing.Literal["objectSet"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetParameterValueUpdate(pydantic.BaseModel): @@ -498,20 +290,9 @@ class ObjectSetParameterValueUpdate(pydantic.BaseModel): type: typing.Literal["objectSet"] = "objectSet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetParameterValueUpdateDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetParameterValueUpdateDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetParameterValueUpdateDict(typing_extensions.TypedDict): - """ObjectSetParameterValueUpdate""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: ontologies_models.ObjectSetRid - type: typing.Literal["objectSet"] + return self.model_dump(by_alias=True, exclude_none=True) class Parameter(pydantic.BaseModel): @@ -531,9 +312,9 @@ class Parameter(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ParameterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ParameterDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) ParameterAccessMode = typing.Literal["READ_ONLY", "READ_WRITE"] @@ -543,24 +324,6 @@ def to_dict(self) -> "ParameterDict": """ -class ParameterDict(typing_extensions.TypedDict): - """A variable configured in the application state of an Agent in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameterType: ParameterTypeDict - """Details of the types of values accepted and defaults for this variable.""" - - access: ParameterAccessMode - """The access mode controls how the Agent is able to interact with the variable.""" - - description: typing_extensions.NotRequired[str] - """ - A description to explain the use of this variable. - This description is injected into the Agent's prompt to provide context for when to use the variable. - """ - - ParameterId = str """The unique identifier for a variable configured in the application state of an Agent in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" @@ -571,13 +334,6 @@ class ParameterDict(typing_extensions.TypedDict): """ParameterType""" -ParameterTypeDict = typing_extensions.Annotated[ - typing.Union["StringParameterDict", ObjectSetParameterDict], - pydantic.Field(discriminator="type"), -] -"""ParameterType""" - - ParameterValue = typing_extensions.Annotated[ typing.Union["StringParameterValue", ObjectSetParameterValue], pydantic.Field(discriminator="type"), @@ -585,13 +341,6 @@ class ParameterDict(typing_extensions.TypedDict): """The value provided for a variable configured in the [application state](/docs/foundry/agent-studio/application-state/) of an Agent.""" -ParameterValueDict = typing_extensions.Annotated[ - typing.Union["StringParameterValueDict", ObjectSetParameterValueDict], - pydantic.Field(discriminator="type"), -] -"""The value provided for a variable configured in the [application state](/docs/foundry/agent-studio/application-state/) of an Agent.""" - - ParameterValueUpdate = typing_extensions.Annotated[ typing.Union["StringParameterValue", ObjectSetParameterValueUpdate], pydantic.Field(discriminator="type"), @@ -603,17 +352,6 @@ class ParameterDict(typing_extensions.TypedDict): """ -ParameterValueUpdateDict = typing_extensions.Annotated[ - typing.Union["StringParameterValueDict", ObjectSetParameterValueUpdateDict], - pydantic.Field(discriminator="type"), -] -""" -A value update for an [application variable](/docs/foundry/agent-studio/application-state/) generated by the Agent. -For `StringParameter` types, this will be the updated string value. -For `ObjectSetParameter` types, this will be a Resource Identifier (RID) for the updated object set. -""" - - class Session(pydantic.BaseModel): """Session""" @@ -635,31 +373,9 @@ class Session(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SessionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(SessionDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class SessionDict(typing_extensions.TypedDict): - """Session""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: SessionRid - """The Resource Identifier (RID) of the conversation session.""" - - metadata: SessionMetadataDict - """Metadata about the session.""" - - agentRid: AgentRid - """The Resource Identifier (RID) of the Agent associated with the session.""" - - agentVersion: AgentVersionString - """ - The version of the Agent associated with the session. - This can be set by clients on session creation. - If not specified, defaults to use the latest published version of the Agent at session creation time. - """ + return self.model_dump(by_alias=True, exclude_none=True) class SessionExchange(pydantic.BaseModel): @@ -680,9 +396,9 @@ class SessionExchange(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SessionExchangeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(SessionExchangeDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) class SessionExchangeContexts(pydantic.BaseModel): @@ -693,39 +409,9 @@ class SessionExchangeContexts(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SessionExchangeContextsDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SessionExchangeContextsDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SessionExchangeContextsDict(typing_extensions.TypedDict): - """Retrieved context which was passed to the Agent as input for the exchange.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectContexts: typing.List[ObjectContextDict] - """Relevant object context for the user's message that was included in the prompt to the Agent.""" - - -class SessionExchangeDict(typing_extensions.TypedDict): - """Represents an individual exchange between a user and an Agent in a conversation session.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - userInput: UserTextInputDict - """The user message that initiated the exchange.""" - - contexts: typing_extensions.NotRequired[SessionExchangeContextsDict] - """ - Additional retrieved context that was included in the prompt to the Agent. - This may include context that was passed by the client with the user input, or relevant context that was automatically retrieved and added based on available data sources configured on the Agent. - Empty if no additional context was included in the prompt. - """ - - result: SessionExchangeResultDict - """The final result for the exchange.""" + return self.model_dump(by_alias=True, exclude_none=True) class SessionExchangeResult(pydantic.BaseModel): @@ -751,35 +437,9 @@ class SessionExchangeResult(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SessionExchangeResultDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SessionExchangeResultDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SessionExchangeResultDict(typing_extensions.TypedDict): - """The returned result from the Agent for a session exchange.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - agentMarkdownResponse: AgentMarkdownResponse - """The final text response generated by the Agent. Responses are formatted using markdown.""" - - parameterUpdates: typing.Dict[ParameterId, ParameterValueUpdateDict] - """ - Any updates to application variable values which were generated by the Agent for this exchange. - Updates can only be generated for application variables configured with `READ_WRITE` access on the Agent in AIP Agent Studio. - """ - - totalTokensUsed: typing_extensions.NotRequired[int] - """Total tokens used to compute the result. Omitted if token usage information is not supported by the model used for the session.""" - - interruptedOutput: bool - """ - True if the exchange was canceled. - In that case, the response (if any) was provided by the client as part of the cancellation request rather than by the Agent. - """ + return self.model_dump(by_alias=True, exclude_none=True) class SessionMetadata(pydantic.BaseModel): @@ -809,37 +469,9 @@ class SessionMetadata(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SessionMetadataDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(SessionMetadataDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class SessionMetadataDict(typing_extensions.TypedDict): - """Metadata for a conversation session with an Agent.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - title: str - """The title of the session.""" - - createdTime: datetime - """The time the session was created.""" - - updatedTime: datetime - """The time the session was last updated.""" - - messageCount: int - """ - The count of messages in the session. - Includes both user messages and Agent replies, so each complete exchange counts as two messages. - """ - - estimatedExpiresTime: datetime - """ - The estimated time at which the session is due to expire. - Once a session has expired, it can no longer be accessed and a new session must be created. - The expiry time is automatically extended when new exchanges are added to the session. - """ + return self.model_dump(by_alias=True, exclude_none=True) SessionRid = core.RID @@ -855,20 +487,9 @@ class StringParameter(pydantic.BaseModel): type: typing.Literal["string"] = "string" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StringParameterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(StringParameterDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class StringParameterDict(typing_extensions.TypedDict): - """StringParameter""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - defaultValue: typing_extensions.NotRequired[str] - """The default value to use for this variable.""" - - type: typing.Literal["string"] + return self.model_dump(by_alias=True, exclude_none=True) class StringParameterValue(pydantic.BaseModel): @@ -878,20 +499,9 @@ class StringParameterValue(pydantic.BaseModel): type: typing.Literal["string"] = "string" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StringParameterValueDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - StringParameterValueDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class StringParameterValueDict(typing_extensions.TypedDict): - """A value passed for `StringParameter` application variable types.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: str - type: typing.Literal["string"] + return self.model_dump(by_alias=True, exclude_none=True) class UserTextInput(pydantic.BaseModel): @@ -902,91 +512,50 @@ class UserTextInput(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "UserTextInputDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(UserTextInputDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class UserTextInputDict(typing_extensions.TypedDict): - """UserTextInput""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - text: str - """The user message text.""" + return self.model_dump(by_alias=True, exclude_none=True) core.resolve_forward_references(InputContext, globalns=globals(), localns=locals()) -core.resolve_forward_references(InputContextDict, globalns=globals(), localns=locals()) core.resolve_forward_references(ParameterType, globalns=globals(), localns=locals()) -core.resolve_forward_references(ParameterTypeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(ParameterValue, globalns=globals(), localns=locals()) -core.resolve_forward_references(ParameterValueDict, globalns=globals(), localns=locals()) core.resolve_forward_references(ParameterValueUpdate, globalns=globals(), localns=locals()) -core.resolve_forward_references(ParameterValueUpdateDict, globalns=globals(), localns=locals()) __all__ = [ "Agent", - "AgentDict", "AgentMarkdownResponse", "AgentMetadata", - "AgentMetadataDict", "AgentRid", "AgentSessionRagContextResponse", - "AgentSessionRagContextResponseDict", "AgentVersion", "AgentVersionDetails", - "AgentVersionDetailsDict", - "AgentVersionDict", "AgentVersionString", "AgentsSessionsPage", - "AgentsSessionsPageDict", "CancelSessionResponse", - "CancelSessionResponseDict", "Content", - "ContentDict", "FunctionRetrievedContext", - "FunctionRetrievedContextDict", "InputContext", - "InputContextDict", "ListAgentVersionsResponse", - "ListAgentVersionsResponseDict", "ListSessionsResponse", - "ListSessionsResponseDict", "MessageId", "ObjectContext", - "ObjectContextDict", "ObjectSetParameter", - "ObjectSetParameterDict", "ObjectSetParameterValue", - "ObjectSetParameterValueDict", "ObjectSetParameterValueUpdate", - "ObjectSetParameterValueUpdateDict", "Parameter", "ParameterAccessMode", - "ParameterDict", "ParameterId", "ParameterType", - "ParameterTypeDict", "ParameterValue", - "ParameterValueDict", "ParameterValueUpdate", - "ParameterValueUpdateDict", "Session", - "SessionDict", "SessionExchange", "SessionExchangeContexts", - "SessionExchangeContextsDict", - "SessionExchangeDict", "SessionExchangeResult", - "SessionExchangeResultDict", "SessionMetadata", - "SessionMetadataDict", "SessionRid", "StringParameter", - "StringParameterDict", "StringParameterValue", - "StringParameterValueDict", "UserTextInput", - "UserTextInputDict", ] diff --git a/foundry/v2/aip_agents/session.py b/foundry/v2/aip_agents/session.py index ab41c5c02..29b0bacc6 100644 --- a/foundry/v2/aip_agents/session.py +++ b/foundry/v2/aip_agents/session.py @@ -14,7 +14,6 @@ import typing -import warnings from functools import cached_property import pydantic @@ -69,17 +68,10 @@ def blocking_continue( session_rid: aip_agents_models.SessionRid, *, parameter_inputs: typing.Dict[ - aip_agents_models.ParameterId, - typing.Union[aip_agents_models.ParameterValue, aip_agents_models.ParameterValueDict], + aip_agents_models.ParameterId, aip_agents_models.ParameterValue ], - user_input: typing.Union[ - aip_agents_models.UserTextInput, aip_agents_models.UserTextInputDict - ], - contexts_override: typing.Optional[ - typing.List[ - typing.Union[aip_agents_models.InputContext, aip_agents_models.InputContextDict] - ] - ] = None, + user_input: aip_agents_models.UserTextInput, + contexts_override: typing.Optional[typing.List[aip_agents_models.InputContext]] = None, preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -97,11 +89,11 @@ def blocking_continue( :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid :param parameter_inputs: Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. - :type parameter_inputs: Dict[ParameterId, Union[ParameterValue, ParameterValueDict]] + :type parameter_inputs: Dict[ParameterId, ParameterValue] :param user_input: The user message for the Agent to respond to. - :type user_input: Union[UserTextInput, UserTextInputDict] + :type user_input: UserTextInput :param contexts_override: If set, automatic [context retrieval](/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. - :type contexts_override: Optional[List[Union[InputContext, InputContextDict]]] + :type contexts_override: Optional[List[InputContext]] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -146,23 +138,12 @@ def blocking_continue( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "userInput": typing.Union[ - aip_agents_models.UserTextInput, aip_agents_models.UserTextInputDict - ], + "userInput": aip_agents_models.UserTextInput, "parameterInputs": typing.Dict[ - aip_agents_models.ParameterId, - typing.Union[ - aip_agents_models.ParameterValue, - aip_agents_models.ParameterValueDict, - ], + aip_agents_models.ParameterId, aip_agents_models.ParameterValue ], "contextsOverride": typing.Optional[ - typing.List[ - typing.Union[ - aip_agents_models.InputContext, - aip_agents_models.InputContextDict, - ] - ] + typing.List[aip_agents_models.InputContext] ], }, ), @@ -450,73 +431,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - agent_rid: aip_agents_models.AgentRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> aip_agents_models.ListSessionsResponse: - """ - List all conversation sessions between the calling user and an Agent that was created by this client. - This does not list sessions for the user created by other clients. - For example, any sessions created by the user in AIP Agent Studio will not be listed here. - Sessions are returned in order of most recently updated first. - - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). - :type agent_rid: AgentRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: aip_agents_models.ListSessionsResponse - - :raises AgentNotFound: The given Agent could not be found. - """ - - warnings.warn( - "The client.aip_agents.Session.page(...) method has been deprecated. Please use client.aip_agents.Session.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/aipAgents/agents/{agentRid}/sessions", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "agentRid": agent_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=aip_agents_models.ListSessionsResponse, - request_timeout=request_timeout, - throwable_errors={ - "AgentNotFound": aip_agents_errors.AgentNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -526,12 +440,9 @@ def rag_context( session_rid: aip_agents_models.SessionRid, *, parameter_inputs: typing.Dict[ - aip_agents_models.ParameterId, - typing.Union[aip_agents_models.ParameterValue, aip_agents_models.ParameterValueDict], - ], - user_input: typing.Union[ - aip_agents_models.UserTextInput, aip_agents_models.UserTextInputDict + aip_agents_models.ParameterId, aip_agents_models.ParameterValue ], + user_input: aip_agents_models.UserTextInput, preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -545,9 +456,9 @@ def rag_context( :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid :param parameter_inputs: Any values for [application variables](/docs/foundry/agent-studio/application-state/) to use for the context retrieval. - :type parameter_inputs: Dict[ParameterId, Union[ParameterValue, ParameterValueDict]] + :type parameter_inputs: Dict[ParameterId, ParameterValue] :param user_input: The user message to retrieve relevant context for from the configured Agent data sources. - :type user_input: Union[UserTextInput, UserTextInputDict] + :type user_input: UserTextInput :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -585,15 +496,9 @@ def rag_context( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "userInput": typing.Union[ - aip_agents_models.UserTextInput, aip_agents_models.UserTextInputDict - ], + "userInput": aip_agents_models.UserTextInput, "parameterInputs": typing.Dict[ - aip_agents_models.ParameterId, - typing.Union[ - aip_agents_models.ParameterValue, - aip_agents_models.ParameterValueDict, - ], + aip_agents_models.ParameterId, aip_agents_models.ParameterValue ], }, ), @@ -620,17 +525,10 @@ def streaming_continue( session_rid: aip_agents_models.SessionRid, *, parameter_inputs: typing.Dict[ - aip_agents_models.ParameterId, - typing.Union[aip_agents_models.ParameterValue, aip_agents_models.ParameterValueDict], + aip_agents_models.ParameterId, aip_agents_models.ParameterValue ], - user_input: typing.Union[ - aip_agents_models.UserTextInput, aip_agents_models.UserTextInputDict - ], - contexts_override: typing.Optional[ - typing.List[ - typing.Union[aip_agents_models.InputContext, aip_agents_models.InputContextDict] - ] - ] = None, + user_input: aip_agents_models.UserTextInput, + contexts_override: typing.Optional[typing.List[aip_agents_models.InputContext]] = None, message_id: typing.Optional[aip_agents_models.MessageId] = None, preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -650,11 +548,11 @@ def streaming_continue( :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid :param parameter_inputs: Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. - :type parameter_inputs: Dict[ParameterId, Union[ParameterValue, ParameterValueDict]] + :type parameter_inputs: Dict[ParameterId, ParameterValue] :param user_input: The user message for the Agent to respond to. - :type user_input: Union[UserTextInput, UserTextInputDict] + :type user_input: UserTextInput :param contexts_override: If set, automatic [context](/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. - :type contexts_override: Optional[List[Union[InputContext, InputContextDict]]] + :type contexts_override: Optional[List[InputContext]] :param message_id: A client-generated Universally Unique Identifier (UUID) to identify the message, which the client can use to cancel the exchange before the streaming response is complete. :type message_id: Optional[MessageId] :param preview: Enables the use of preview functionality. @@ -698,23 +596,12 @@ def streaming_continue( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "userInput": typing.Union[ - aip_agents_models.UserTextInput, aip_agents_models.UserTextInputDict - ], + "userInput": aip_agents_models.UserTextInput, "parameterInputs": typing.Dict[ - aip_agents_models.ParameterId, - typing.Union[ - aip_agents_models.ParameterValue, - aip_agents_models.ParameterValueDict, - ], + aip_agents_models.ParameterId, aip_agents_models.ParameterValue ], "contextsOverride": typing.Optional[ - typing.List[ - typing.Union[ - aip_agents_models.InputContext, - aip_agents_models.InputContextDict, - ] - ] + typing.List[aip_agents_models.InputContext] ], "messageId": typing.Optional[aip_agents_models.MessageId], }, @@ -812,7 +699,6 @@ def cancel(_: aip_agents_models.CancelSessionResponse): ... def create(_: aip_agents_models.Session): ... def get(_: aip_agents_models.Session): ... def list(_: aip_agents_models.ListSessionsResponse): ... - def page(_: aip_agents_models.ListSessionsResponse): ... def rag_context(_: aip_agents_models.AgentSessionRagContextResponse): ... def streaming_continue(_: bytes): ... def update_title(_: None): ... @@ -822,7 +708,6 @@ def update_title(_: None): ... self.create = core.with_raw_response(create, client.create) self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) self.rag_context = core.with_raw_response(rag_context, client.rag_context) self.streaming_continue = core.with_raw_response( streaming_continue, client.streaming_continue @@ -837,7 +722,6 @@ def cancel(_: aip_agents_models.CancelSessionResponse): ... def create(_: aip_agents_models.Session): ... def get(_: aip_agents_models.Session): ... def list(_: aip_agents_models.ListSessionsResponse): ... - def page(_: aip_agents_models.ListSessionsResponse): ... def rag_context(_: aip_agents_models.AgentSessionRagContextResponse): ... def streaming_continue(_: bytes): ... @@ -848,7 +732,6 @@ def streaming_continue(_: bytes): ... self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) self.rag_context = core.with_streaming_response(rag_context, client.rag_context) self.streaming_continue = core.with_streaming_response( streaming_continue, client.streaming_continue diff --git a/foundry/v2/cli.py b/foundry/v2/cli.py index 30b026d62..1ec9b6998 100644 --- a/foundry/v2/cli.py +++ b/foundry/v2/cli.py @@ -171,36 +171,6 @@ def admin_user_list( click.echo(repr(result)) -@admin_user.command("page") -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.pass_obj -def admin_user_page( - client: foundry.v2.FoundryClient, - page_size: typing.Optional[int], - page_token: typing.Optional[str], -): - """ - Lists all Users. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - """ - result = client.admin.User.page( - page_size=page_size, - page_token=page_token, - ) - click.echo(repr(result)) - - @admin_user.command("profile_picture") @click.argument("user_id", type=str, required=True) @click.pass_obj @@ -295,58 +265,6 @@ def admin_user_group_membership_list( click.echo(repr(result)) -@admin_user_group_membership.command("page") -@click.argument("user_id", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--transitive", - type=bool, - required=False, - help="""When true, includes the transitive memberships of the Groups the User is a member of. For example, say the -User is a member of Group A, and Group A is a member of Group B. If `transitive=false` only Group A will -be returned, but if `transitive=true` then Groups A and B will be returned. This -will recursively resolve Groups through all layers of nesting. - -Defaults to false. -""", -) -@click.pass_obj -def admin_user_group_membership_page( - client: foundry.v2.FoundryClient, - user_id: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - transitive: typing.Optional[bool], -): - """ - Lists all Groups a given User is a member of. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, - it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. - To get the next page, make the same request again, but set the value of the `pageToken` query parameter - to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field - in the response, you are on the last page. - - """ - result = client.admin.User.GroupMembership.page( - user_id=user_id, - page_size=page_size, - page_token=page_token, - transitive=transitive, - ) - click.echo(repr(result)) - - @admin_user.group("user_provider_info") def admin_user_user_provider_info(): pass @@ -526,39 +444,6 @@ def admin_marking_category_list( click.echo(repr(result)) -@admin_marking_category.command("page") -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def admin_marking_category_page( - client: foundry.v2.FoundryClient, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Maximum page size 100. - """ - result = client.admin.MarkingCategory.page( - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @admin.group("marking") def admin_marking(): pass @@ -690,39 +575,6 @@ def admin_marking_list( click.echo(repr(result)) -@admin_marking.command("page") -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def admin_marking_page( - client: foundry.v2.FoundryClient, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Maximum page size 100. - """ - result = client.admin.Marking.page( - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @admin_marking.group("marking_role_assignment") def admin_marking_marking_role_assignment(): pass @@ -787,43 +639,6 @@ def admin_marking_marking_role_assignment_list( click.echo(repr(result)) -@admin_marking_marking_role_assignment.command("page") -@click.argument("marking_id", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def admin_marking_marking_role_assignment_page( - client: foundry.v2.FoundryClient, - marking_id: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - List all principals who are assigned a role for the given Marking. Ignores the `pageSize` parameter. - - """ - result = client.admin.Marking.MarkingRoleAssignment.page( - marking_id=marking_id, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @admin_marking_marking_role_assignment.command("remove") @click.argument("marking_id", type=str, required=True) @click.option("--role_assignments", type=str, required=True, help="""""") @@ -925,58 +740,6 @@ def admin_marking_marking_member_list( click.echo(repr(result)) -@admin_marking_marking_member.command("page") -@click.argument("marking_id", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.option( - "--transitive", - type=bool, - required=False, - help="""When true, includes the transitive members of groups contained within groups that are members of this -Marking. For example, say the Marking has member Group A, and Group A has member User B. If -`transitive=false` only Group A will be returned, but if `transitive=true` then Group A and User B -will be returned. This will recursively resolve Groups through all layers of nesting. - -Defaults to false. -""", -) -@click.pass_obj -def admin_marking_marking_member_page( - client: foundry.v2.FoundryClient, - marking_id: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], - transitive: typing.Optional[bool], -): - """ - Lists all principals who can view resources protected by the given Marking. Ignores the `pageSize` parameter. - Requires `api:admin-write` because only marking administrators can view marking members. - - """ - result = client.admin.Marking.MarkingMember.page( - marking_id=marking_id, - page_size=page_size, - page_token=page_token, - preview=preview, - transitive=transitive, - ) - click.echo(repr(result)) - - @admin_marking_marking_member.command("remove") @click.argument("marking_id", type=str, required=True) @click.option("--principal_ids", type=str, required=True, help="""""") @@ -1120,36 +883,6 @@ def admin_group_list( click.echo(repr(result)) -@admin_group.command("page") -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.pass_obj -def admin_group_page( - client: foundry.v2.FoundryClient, - page_size: typing.Optional[int], - page_token: typing.Optional[str], -): - """ - Lists all Groups. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - """ - result = client.admin.Group.page( - page_size=page_size, - page_token=page_token, - ) - click.echo(repr(result)) - - @admin_group.command("search") @click.option("--where", type=str, required=True, help="""""") @click.option("--page_size", type=int, required=False, help="""""") @@ -1250,58 +983,6 @@ def admin_group_group_member_list( click.echo(repr(result)) -@admin_group_group_member.command("page") -@click.argument("group_id", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--transitive", - type=bool, - required=False, - help="""When true, includes the transitive members of groups contained within this group. For example, say the -Group has member Group A, and Group A has member User B. If `transitive=false` only Group A will -be returned, but if `transitive=true` then Group A and User B will be returned. This -will recursively resolve Groups through all layers of nesting. - -Defaults to false. -""", -) -@click.pass_obj -def admin_group_group_member_page( - client: foundry.v2.FoundryClient, - group_id: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - transitive: typing.Optional[bool], -): - """ - Lists all members (which can be a User or a Group) of a given Group. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, - it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. - To get the next page, make the same request again, but set the value of the `pageToken` query parameter - to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field - in the response, you are on the last page. - - """ - result = client.admin.Group.GroupMember.page( - group_id=group_id, - page_size=page_size, - page_token=page_token, - transitive=transitive, - ) - click.echo(repr(result)) - - @admin_group_group_member.command("remove") @click.argument("group_id", type=str, required=True) @click.option("--principal_ids", type=str, required=True, help="""""") @@ -1561,56 +1242,18 @@ def admin_enrollment_authentication_provider_preregister_user( attributes=None if attributes is None else json.loads(attributes), email=email, family_name=family_name, - given_name=given_name, - preview=preview, - ) - click.echo(repr(result)) - - -@admin_enrollment.group("host") -def admin_enrollment_host(): - pass - - -@admin_enrollment_host.command("list") -@click.argument("enrollment_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def admin_enrollment_host_list( - client: foundry.v2.FoundryClient, - enrollment_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Lists all Hosts. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - """ - result = client.admin.Enrollment.Host.list( - enrollment_rid=enrollment_rid, - page_size=page_size, - page_token=page_token, + given_name=given_name, preview=preview, ) click.echo(repr(result)) -@admin_enrollment_host.command("page") +@admin_enrollment.group("host") +def admin_enrollment_host(): + pass + + +@admin_enrollment_host.command("list") @click.argument("enrollment_rid", type=str, required=True) @click.option( "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" @@ -1627,7 +1270,7 @@ def admin_enrollment_host_list( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def admin_enrollment_host_page( +def admin_enrollment_host_list( client: foundry.v2.FoundryClient, enrollment_rid: str, page_size: typing.Optional[int], @@ -1639,7 +1282,7 @@ def admin_enrollment_host_page( This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. """ - result = client.admin.Enrollment.Host.page( + result = client.admin.Enrollment.Host.list( enrollment_rid=enrollment_rid, page_size=page_size, page_token=page_token, @@ -1691,39 +1334,6 @@ def aip_agents_agent_all_sessions( click.echo(repr(result)) -@aip_agents_agent.command("all_sessions_page") -@click.option( - "--page_size", - type=int, - required=False, - help="""The maximum number of sessions to return in a single page. The maximum allowed value is 100. -Defaults to 100 if not specified. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def aip_agents_agent_all_sessions_page( - client: foundry.v2.FoundryClient, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - List all conversation sessions between the calling user and all accessible Agents that were created by this client. - Sessions are returned in order of most recently updated first. - - """ - result = client.aip_agents.Agent.all_sessions_page( - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @aip_agents_agent.command("get") @click.argument("agent_rid", type=str, required=True) @click.option( @@ -1961,46 +1571,6 @@ def aip_agents_agent_session_list( click.echo(repr(result)) -@aip_agents_agent_session.command("page") -@click.argument("agent_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def aip_agents_agent_session_page( - client: foundry.v2.FoundryClient, - agent_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - List all conversation sessions between the calling user and an Agent that was created by this client. - This does not list sessions for the user created by other clients. - For example, any sessions created by the user in AIP Agent Studio will not be listed here. - Sessions are returned in order of most recently updated first. - - """ - result = client.aip_agents.Agent.Session.page( - agent_rid=agent_rid, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @aip_agents_agent_session.command("rag_context") @click.argument("agent_rid", type=str, required=True) @click.argument("session_rid", type=str, required=True) @@ -2243,44 +1813,6 @@ def aip_agents_agent_agent_version_list( click.echo(repr(result)) -@aip_agents_agent_agent_version.command("page") -@click.argument("agent_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def aip_agents_agent_agent_version_page( - client: foundry.v2.FoundryClient, - agent_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - List all versions for an AIP Agent. - Versions are returned in descending order, by most recent versions first. - - """ - result = client.aip_agents.Agent.AgentVersion.page( - agent_rid=agent_rid, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @cli.group("connectivity") def connectivity(): pass @@ -2588,44 +2120,6 @@ def connectivity_connection_table_import_list( click.echo(repr(result)) -@connectivity_connection_table_import.command("page") -@click.argument("connection_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def connectivity_connection_table_import_page( - client: foundry.v2.FoundryClient, - connection_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Lists all table imports defined for this connection. - Only table imports that the user has permissions to view will be returned. - - """ - result = client.connectivity.Connection.TableImport.page( - connection_rid=connection_rid, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @connectivity_connection.group("file_import") def connectivity_connection_file_import(): pass @@ -2802,44 +2296,6 @@ def connectivity_connection_file_import_list( click.echo(repr(result)) -@connectivity_connection_file_import.command("page") -@click.argument("connection_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def connectivity_connection_file_import_page( - client: foundry.v2.FoundryClient, - connection_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Lists all file imports defined for this connection. - Only file imports that the user has permissions to view will be returned. - - """ - result = client.connectivity.Connection.FileImport.page( - connection_rid=connection_rid, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @connectivity_connection_file_import.command("replace") @click.argument("connection_rid", type=str, required=True) @click.argument("file_import_rid", type=str, required=True) @@ -3151,81 +2607,9 @@ def datasets_dataset_file_delete( @click.option( "--end_transaction_rid", type=str, - required=False, - help="""The Resource Identifier (RID) of the end Transaction. -""", -) -@click.option( - "--start_transaction_rid", - type=str, - required=False, - help="""The Resource Identifier (RID) of the start Transaction. -""", -) -@click.pass_obj -def datasets_dataset_file_get( - client: foundry.v2.FoundryClient, - dataset_rid: str, - file_path: str, - branch_name: typing.Optional[str], - end_transaction_rid: typing.Optional[str], - start_transaction_rid: typing.Optional[str], -): - """ - Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest - view of the default branch - `master` for most enrollments. - #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - To **get a file's metadata from a specific Branch** specify the Branch's name as `branchName`. This will - retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest - ancestor transaction of the branch if there are no snapshot transactions. - To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier - as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot - transaction, or the earliest ancestor transaction if there are no snapshot transactions. - To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's - resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. - This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the - `endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path. - To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the - `startTransactionRid` and `endTransactionRid`. - - """ - result = client.datasets.Dataset.File.get( - dataset_rid=dataset_rid, - file_path=file_path, - branch_name=branch_name, - end_transaction_rid=end_transaction_rid, - start_transaction_rid=start_transaction_rid, - ) - click.echo(repr(result)) - - -@datasets_dataset_file.command("list") -@click.argument("dataset_rid", type=str, required=True) -@click.option( - "--branch_name", - type=str, - required=False, - help="""The name of the Branch on which to list Files. Defaults to `master` for most enrollments. -""", -) -@click.option( - "--end_transaction_rid", - type=str, - required=False, - help="""The Resource Identifier (RID) of the end Transaction. -""", -) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", + required=False, + help="""The Resource Identifier (RID) of the end Transaction. +""", ) @click.option( "--start_transaction_rid", @@ -3235,48 +2619,44 @@ def datasets_dataset_file_get( """, ) @click.pass_obj -def datasets_dataset_file_list( +def datasets_dataset_file_get( client: foundry.v2.FoundryClient, dataset_rid: str, + file_path: str, branch_name: typing.Optional[str], end_transaction_rid: typing.Optional[str], - page_size: typing.Optional[int], - page_token: typing.Optional[str], start_transaction_rid: typing.Optional[str], ): """ - Lists Files contained in a Dataset. By default files are listed on the latest view of the default - branch - `master` for most enrollments. + Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest + view of the default branch - `master` for most enrollments. #### Advanced Usage See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most - recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the - branch if there are no snapshot transactions. - To **list files on the resolved view of a transaction** specify the Transaction's resource identifier - as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot + To **get a file's metadata from a specific Branch** specify the Branch's name as `branchName`. This will + retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest + ancestor transaction of the branch if there are no snapshot transactions. + To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier + as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions. - To **list files on the resolved view of a range of transactions** specify the the start transaction's resource - identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This - will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. - Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when - the start and end transactions do not belong to the same root-to-leaf path. - To **list files on a specific transaction** specify the Transaction's resource identifier as both the - `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that - Transaction. + To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's + resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. + This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the + `endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path. + To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the + `startTransactionRid` and `endTransactionRid`. """ - result = client.datasets.Dataset.File.list( + result = client.datasets.Dataset.File.get( dataset_rid=dataset_rid, + file_path=file_path, branch_name=branch_name, end_transaction_rid=end_transaction_rid, - page_size=page_size, - page_token=page_token, start_transaction_rid=start_transaction_rid, ) click.echo(repr(result)) -@datasets_dataset_file.command("page") +@datasets_dataset_file.command("list") @click.argument("dataset_rid", type=str, required=True) @click.option( "--branch_name", @@ -3311,7 +2691,7 @@ def datasets_dataset_file_list( """, ) @click.pass_obj -def datasets_dataset_file_page( +def datasets_dataset_file_list( client: foundry.v2.FoundryClient, dataset_rid: str, branch_name: typing.Optional[str], @@ -3341,7 +2721,7 @@ def datasets_dataset_file_page( Transaction. """ - result = client.datasets.Dataset.File.page( + result = client.datasets.Dataset.File.list( dataset_rid=dataset_rid, branch_name=branch_name, end_transaction_rid=end_transaction_rid, @@ -3674,38 +3054,6 @@ def datasets_dataset_branch_list( click.echo(repr(result)) -@datasets_dataset_branch.command("page") -@click.argument("dataset_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.pass_obj -def datasets_dataset_branch_page( - client: foundry.v2.FoundryClient, - dataset_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], -): - """ - Lists the Branches of a Dataset. - - """ - result = client.datasets.Dataset.Branch.page( - dataset_rid=dataset_rid, - page_size=page_size, - page_token=page_token, - ) - click.echo(repr(result)) - - @cli.group("filesystem") def filesystem(): pass @@ -3751,41 +3099,6 @@ def filesystem_space_list( click.echo(repr(result)) -@filesystem_space.command("page") -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def filesystem_space_page( - client: foundry.v2.FoundryClient, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Lists all Spaces. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - """ - result = client.filesystem.Space.page( - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @filesystem.group("resource") def filesystem_resource(): pass @@ -3946,44 +3259,6 @@ def filesystem_resource_markings( click.echo(repr(result)) -@filesystem_resource.command("markings_page") -@click.argument("resource_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def filesystem_resource_markings_page( - client: foundry.v2.FoundryClient, - resource_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - List of Markings directly applied to a resource. The number of Markings on a resource is typically small - so the `pageSize` and `pageToken` parameters are not required. - - """ - result = client.filesystem.Resource.markings_page( - resource_rid=resource_rid, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @filesystem_resource.command("permanently_delete") @click.argument("resource_rid", type=str, required=True) @click.option( @@ -4126,51 +3401,6 @@ def filesystem_resource_resource_role_list( click.echo(repr(result)) -@filesystem_resource_resource_role.command("page") -@click.argument("resource_rid", type=str, required=True) -@click.option( - "--include_inherited", - type=bool, - required=False, - help="""Whether to include inherited roles on the resource.""", -) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def filesystem_resource_resource_role_page( - client: foundry.v2.FoundryClient, - resource_rid: str, - include_inherited: typing.Optional[bool], - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - List the roles on a resource. - - """ - result = client.filesystem.Resource.Role.page( - resource_rid=resource_rid, - include_inherited=include_inherited, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @filesystem_resource_resource_role.command("remove") @click.argument("resource_rid", type=str, required=True) @click.option("--roles", type=str, required=True, help="""""") @@ -4355,44 +3585,6 @@ def filesystem_project_organizations( click.echo(repr(result)) -@filesystem_project.command("organizations_page") -@click.argument("project_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def filesystem_project_organizations_page( - client: foundry.v2.FoundryClient, - project_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - List of Organizations directly applied to a Project. The number of Organizations on a Project is - typically small so the `pageSize` and `pageToken` parameters are not required. - - """ - result = client.filesystem.Project.organizations_page( - project_rid=project_rid, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @filesystem_project.command("remove_organizations") @click.argument("project_rid", type=str, required=True) @click.option("--organization_rids", type=str, required=True, help="""""") @@ -4402,67 +3594,27 @@ def filesystem_project_organizations_page( @click.pass_obj def filesystem_project_remove_organizations( client: foundry.v2.FoundryClient, - project_rid: str, - organization_rids: str, - preview: typing.Optional[bool], -): - """ - Removes Organizations from a Project. - """ - result = client.filesystem.Project.remove_organizations( - project_rid=project_rid, - organization_rids=json.loads(organization_rids), - preview=preview, - ) - click.echo(repr(result)) - - -@filesystem.group("folder") -def filesystem_folder(): - pass - - -@filesystem_folder.command("children") -@click.argument("folder_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def filesystem_folder_children( - client: foundry.v2.FoundryClient, - folder_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], + project_rid: str, + organization_rids: str, preview: typing.Optional[bool], ): """ - List all child Resources of the Folder. - - This is a paged endpoint. The page size will be limited to 2,000 results per page. If no page size is - provided, this page size will also be used as the default. - + Removes Organizations from a Project. """ - result = client.filesystem.Folder.children( - folder_rid=folder_rid, - page_size=page_size, - page_token=page_token, + result = client.filesystem.Project.remove_organizations( + project_rid=project_rid, + organization_rids=json.loads(organization_rids), preview=preview, ) click.echo(repr(result)) -@filesystem_folder.command("children_page") +@filesystem.group("folder") +def filesystem_folder(): + pass + + +@filesystem_folder.command("children") @click.argument("folder_rid", type=str, required=True) @click.option( "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" @@ -4479,7 +3631,7 @@ def filesystem_folder_children( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def filesystem_folder_children_page( +def filesystem_folder_children( client: foundry.v2.FoundryClient, folder_rid: str, page_size: typing.Optional[int], @@ -4493,7 +3645,7 @@ def filesystem_folder_children_page( provided, this page size will also be used as the default. """ - result = client.filesystem.Folder.children_page( + result = client.filesystem.Folder.children( folder_rid=folder_rid, page_size=page_size, page_token=page_token, @@ -5924,94 +5076,6 @@ def ontologies_ontology_object_list( click.echo(repr(result)) -@ontologies_ontology_object.command("page") -@click.argument("ontology", type=str, required=True) -@click.argument("object_type", type=str, required=True) -@click.option( - "--artifact_repository", - type=str, - required=False, - help="""The repository associated with a marketplace installation. -""", -) -@click.option( - "--exclude_rid", - type=bool, - required=False, - help="""A flag to exclude the retrieval of the `__rid` property. -Setting this to true may improve performance of this endpoint for object types in OSV2. -""", -) -@click.option("--order_by", type=str, required=False, help="""""") -@click.option( - "--package_name", - type=str, - required=False, - help="""The package name of the generated SDK. -""", -) -@click.option( - "--page_size", - type=int, - required=False, - help="""The desired size of the page to be returned. Defaults to 1,000. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.option( - "--select", - type=str, - required=False, - help="""The properties of the object type that should be included in the response. Omit this parameter to get all -the properties. -""", -) -@click.pass_obj -def ontologies_ontology_object_page( - client: foundry.v2.FoundryClient, - ontology: str, - object_type: str, - artifact_repository: typing.Optional[str], - exclude_rid: typing.Optional[bool], - order_by: typing.Optional[str], - package_name: typing.Optional[str], - page_size: typing.Optional[int], - page_token: typing.Optional[str], - select: typing.Optional[str], -): - """ - Lists the objects for the given Ontology and object type. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.OntologyObject.page( - ontology=ontology, - object_type=object_type, - artifact_repository=artifact_repository, - exclude_rid=exclude_rid, - order_by=order_by, - package_name=package_name, - page_size=page_size, - page_token=page_token, - select=None if select is None else json.loads(select), - ) - click.echo(repr(result)) - - @ontologies_ontology_object.command("search") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @@ -6253,55 +5317,6 @@ def ontologies_ontology_interface_list( click.echo(repr(result)) -@ontologies_ontology_interface.command("page") -@click.argument("ontology", type=str, required=True) -@click.option( - "--page_size", - type=int, - required=False, - help="""The desired size of the page to be returned. Defaults to 500. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.option( - "--preview", - type=bool, - required=False, - help="""A boolean flag that, when set to true, enables the use of beta features in preview mode. -""", -) -@click.pass_obj -def ontologies_ontology_interface_page( - client: foundry.v2.FoundryClient, - ontology: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - :::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. - ::: - - Lists the interface types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.OntologyInterface.page( - ontology=ontology, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @ontologies_ontology_interface.command("search") @click.argument("ontology", type=str, required=True) @click.argument("interface_type", type=str, required=True) @@ -6549,41 +5564,6 @@ def ontologies_ontology_query_type_list( click.echo(repr(result)) -@ontologies_ontology_query_type.command("page") -@click.argument("ontology", type=str, required=True) -@click.option( - "--page_size", - type=int, - required=False, - help="""The desired size of the page to be returned. Defaults to 100. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.pass_obj -def ontologies_ontology_query_type_page( - client: foundry.v2.FoundryClient, - ontology: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], -): - """ - Lists the query types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.Ontology.QueryType.page( - ontology=ontology, - page_size=page_size, - page_token=page_token, - ) - click.echo(repr(result)) - - @ontologies_ontology.group("object_type") def ontologies_ontology_object_type(): pass @@ -6625,117 +5605,50 @@ def ontologies_ontology_object_type_get( def ontologies_ontology_object_type_get_full_metadata( client: foundry.v2.FoundryClient, ontology: str, - object_type: str, - preview: typing.Optional[bool], -): - """ - Gets the full metadata for a specific object type with the given API name. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.Ontology.ObjectType.get_full_metadata( - ontology=ontology, - object_type=object_type, - preview=preview, - ) - click.echo(repr(result)) - - -@ontologies_ontology_object_type.command("get_outgoing_link_type") -@click.argument("ontology", type=str, required=True) -@click.argument("object_type", type=str, required=True) -@click.argument("link_type", type=str, required=True) -@click.pass_obj -def ontologies_ontology_object_type_get_outgoing_link_type( - client: foundry.v2.FoundryClient, - ontology: str, - object_type: str, - link_type: str, -): - """ - Get an outgoing link for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - """ - result = client.ontologies.Ontology.ObjectType.get_outgoing_link_type( - ontology=ontology, - object_type=object_type, - link_type=link_type, - ) - click.echo(repr(result)) - - -@ontologies_ontology_object_type.command("list") -@click.argument("ontology", type=str, required=True) -@click.option( - "--page_size", - type=int, - required=False, - help="""The desired size of the page to be returned. Defaults to 500. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.pass_obj -def ontologies_ontology_object_type_list( - client: foundry.v2.FoundryClient, - ontology: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], -): - """ - Lists the object types for the given Ontology. - - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. + object_type: str, + preview: typing.Optional[bool], +): + """ + Gets the full metadata for a specific object type with the given API name. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. """ - result = client.ontologies.Ontology.ObjectType.list( + result = client.ontologies.Ontology.ObjectType.get_full_metadata( ontology=ontology, - page_size=page_size, - page_token=page_token, + object_type=object_type, + preview=preview, ) click.echo(repr(result)) -@ontologies_ontology_object_type.command("list_outgoing_link_types") +@ontologies_ontology_object_type.command("get_outgoing_link_type") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The desired size of the page to be returned.""" -) -@click.option("--page_token", type=str, required=False, help="""""") +@click.argument("link_type", type=str, required=True) @click.pass_obj -def ontologies_ontology_object_type_list_outgoing_link_types( +def ontologies_ontology_object_type_get_outgoing_link_type( client: foundry.v2.FoundryClient, ontology: str, object_type: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], + link_type: str, ): """ - List the outgoing links for an object type. + Get an outgoing link for an object type. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. """ - result = client.ontologies.Ontology.ObjectType.list_outgoing_link_types( + result = client.ontologies.Ontology.ObjectType.get_outgoing_link_type( ontology=ontology, object_type=object_type, - page_size=page_size, - page_token=page_token, + link_type=link_type, ) click.echo(repr(result)) -@ontologies_ontology_object_type.command("page") +@ontologies_ontology_object_type.command("list") @click.argument("ontology", type=str, required=True) @click.option( "--page_size", @@ -6747,7 +5660,7 @@ def ontologies_ontology_object_type_list_outgoing_link_types( ) @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj -def ontologies_ontology_object_type_page( +def ontologies_ontology_object_type_list( client: foundry.v2.FoundryClient, ontology: str, page_size: typing.Optional[int], @@ -6763,7 +5676,7 @@ def ontologies_ontology_object_type_page( Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. """ - result = client.ontologies.Ontology.ObjectType.page( + result = client.ontologies.Ontology.ObjectType.list( ontology=ontology, page_size=page_size, page_token=page_token, @@ -6771,7 +5684,7 @@ def ontologies_ontology_object_type_page( click.echo(repr(result)) -@ontologies_ontology_object_type.command("page_outgoing_link_types") +@ontologies_ontology_object_type.command("list_outgoing_link_types") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.option( @@ -6779,7 +5692,7 @@ def ontologies_ontology_object_type_page( ) @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj -def ontologies_ontology_object_type_page_outgoing_link_types( +def ontologies_ontology_object_type_list_outgoing_link_types( client: foundry.v2.FoundryClient, ontology: str, object_type: str, @@ -6793,7 +5706,7 @@ def ontologies_ontology_object_type_page_outgoing_link_types( following operation scopes: `api:ontologies-read`. """ - result = client.ontologies.Ontology.ObjectType.page_outgoing_link_types( + result = client.ontologies.Ontology.ObjectType.list_outgoing_link_types( ontology=ontology, object_type=object_type, page_size=page_size, @@ -6886,41 +5799,6 @@ def ontologies_ontology_action_type_list( click.echo(repr(result)) -@ontologies_ontology_action_type.command("page") -@click.argument("ontology", type=str, required=True) -@click.option( - "--page_size", - type=int, - required=False, - help="""The desired size of the page to be returned. Defaults to 500. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.pass_obj -def ontologies_ontology_action_type_page( - client: foundry.v2.FoundryClient, - ontology: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], -): - """ - Lists the action types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.Ontology.ActionType.page( - ontology=ontology, - page_size=page_size, - page_token=page_token, - ) - click.echo(repr(result)) - - @ontologies.group("media_reference_property") def ontologies_media_reference_property(): pass @@ -7253,100 +6131,6 @@ def ontologies_linked_object_list_linked_objects( click.echo(repr(result)) -@ontologies_linked_object.command("page_linked_objects") -@click.argument("ontology", type=str, required=True) -@click.argument("object_type", type=str, required=True) -@click.argument("primary_key", type=str, required=True) -@click.argument("link_type", type=str, required=True) -@click.option( - "--artifact_repository", - type=str, - required=False, - help="""The repository associated with a marketplace installation. -""", -) -@click.option( - "--exclude_rid", - type=bool, - required=False, - help="""A flag to exclude the retrieval of the `__rid` property. -Setting this to true may improve performance of this endpoint for object types in OSV2. -""", -) -@click.option("--order_by", type=str, required=False, help="""""") -@click.option( - "--package_name", - type=str, - required=False, - help="""The package name of the generated SDK. -""", -) -@click.option( - "--page_size", - type=int, - required=False, - help="""The desired size of the page to be returned. Defaults to 1,000. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. -""", -) -@click.option("--page_token", type=str, required=False, help="""""") -@click.option( - "--select", - type=str, - required=False, - help="""The properties of the object type that should be included in the response. Omit this parameter to get all -the properties. -""", -) -@click.pass_obj -def ontologies_linked_object_page_linked_objects( - client: foundry.v2.FoundryClient, - ontology: str, - object_type: str, - primary_key: str, - link_type: str, - artifact_repository: typing.Optional[str], - exclude_rid: typing.Optional[bool], - order_by: typing.Optional[str], - package_name: typing.Optional[str], - page_size: typing.Optional[int], - page_token: typing.Optional[str], - select: typing.Optional[str], -): - """ - Lists the linked objects for a specific object and the given link type. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.LinkedObject.page_linked_objects( - ontology=ontology, - object_type=object_type, - primary_key=primary_key, - link_type=link_type, - artifact_repository=artifact_repository, - exclude_rid=exclude_rid, - order_by=order_by, - package_name=package_name, - page_size=page_size, - page_token=page_token, - select=None if select is None else json.loads(select), - ) - click.echo(repr(result)) - - @ontologies.group("attachment_property") def ontologies_attachment_property(): pass @@ -8000,43 +6784,6 @@ def orchestration_schedule_runs( click.echo(repr(result)) -@orchestration_schedule.command("runs_page") -@click.argument("schedule_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def orchestration_schedule_runs_page( - client: foundry.v2.FoundryClient, - schedule_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Get the most recent runs of a Schedule. If no page size is provided, a page size of 100 will be used. - - """ - result = client.orchestration.Schedule.runs_page( - schedule_rid=schedule_rid, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @orchestration_schedule.command("unpause") @click.argument("schedule_rid", type=str, required=True) @click.option( @@ -8267,42 +7014,6 @@ def orchestration_build_jobs( click.echo(repr(result)) -@orchestration_build.command("jobs_page") -@click.argument("build_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) -@click.pass_obj -def orchestration_build_jobs_page( - client: foundry.v2.FoundryClient, - build_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], - preview: typing.Optional[bool], -): - """ - Get the Jobs in the Build. - """ - result = client.orchestration.Build.jobs_page( - build_rid=build_rid, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - @orchestration_build.command("search") @click.option("--where", type=str, required=True, help="""""") @click.option("--order_by", type=str, required=False, help="""""") @@ -9019,39 +7730,6 @@ def third_party_applications_third_party_application_website_version_list( click.echo(repr(result)) -@third_party_applications_third_party_application_website_version.command("page") -@click.argument("third_party_application_rid", type=str, required=True) -@click.option( - "--page_size", type=int, required=False, help="""The page size to use for the endpoint.""" -) -@click.option( - "--page_token", - type=str, - required=False, - help="""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.""", -) -@click.pass_obj -def third_party_applications_third_party_application_website_version_page( - client: foundry.v2.FoundryClient, - third_party_application_rid: str, - page_size: typing.Optional[int], - page_token: typing.Optional[str], -): - """ - Lists all Versions. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - """ - result = client.third_party_applications.ThirdPartyApplication.Website.Version.page( - third_party_application_rid=third_party_application_rid, - page_size=page_size, - page_token=page_token, - ) - click.echo(repr(result)) - - @third_party_applications_third_party_application_website_version.command("upload") @click.argument("third_party_application_rid", type=str, required=True) @click.argument("body", type=click.File("rb"), required=True) diff --git a/foundry/v2/connectivity/client.py b/foundry/v2/connectivity/client.py deleted file mode 100644 index bd777168b..000000000 --- a/foundry/v2/connectivity/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v2.connectivity._client import ConnectivityClient - -__all__ = [ - "ConnectivityClient", -] diff --git a/foundry/v2/connectivity/connection.py b/foundry/v2/connectivity/connection.py index ba066d498..35ff5299e 100644 --- a/foundry/v2/connectivity/connection.py +++ b/foundry/v2/connectivity/connection.py @@ -76,10 +76,7 @@ def TableImport(self): def create( self, *, - configuration: typing.Union[ - connectivity_models.CreateConnectionRequestConnectionConfiguration, - connectivity_models.CreateConnectionRequestConnectionConfigurationDict, - ], + configuration: connectivity_models.CreateConnectionRequestConnectionConfiguration, display_name: connectivity_models.ConnectionDisplayName, parent_folder_rid: filesystem_models.FolderRid, preview: typing.Optional[core_models.PreviewMode] = None, @@ -98,7 +95,7 @@ def create( use the Foundry UI instead. :param configuration: - :type configuration: Union[CreateConnectionRequestConnectionConfiguration, CreateConnectionRequestConnectionConfigurationDict] + :type configuration: CreateConnectionRequestConnectionConfiguration :param display_name: The display name of the Connection. The display name must not be blank. :type display_name: ConnectionDisplayName :param parent_folder_rid: @@ -137,10 +134,7 @@ def create( "Body", { # type: ignore "parentFolderRid": filesystem_models.FolderRid, - "configuration": typing.Union[ - connectivity_models.CreateConnectionRequestConnectionConfiguration, - connectivity_models.CreateConnectionRequestConnectionConfigurationDict, - ], + "configuration": connectivity_models.CreateConnectionRequestConnectionConfiguration, "displayName": connectivity_models.ConnectionDisplayName, }, ), diff --git a/foundry/v2/connectivity/file_import.py b/foundry/v2/connectivity/file_import.py index 1e71d7757..16ee6011d 100644 --- a/foundry/v2/connectivity/file_import.py +++ b/foundry/v2/connectivity/file_import.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -60,11 +59,7 @@ def create( *, dataset_rid: datasets_models.DatasetRid, display_name: connectivity_models.FileImportDisplayName, - file_import_filters: typing.List[ - typing.Union[ - connectivity_models.FileImportFilter, connectivity_models.FileImportFilterDict - ] - ], + file_import_filters: typing.List[connectivity_models.FileImportFilter], import_mode: connectivity_models.FileImportMode, branch_name: typing.Optional[datasets_models.BranchName] = None, preview: typing.Optional[core_models.PreviewMode] = None, @@ -81,7 +76,7 @@ def create( :param display_name: :type display_name: FileImportDisplayName :param file_import_filters: Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) - :type file_import_filters: List[Union[FileImportFilter, FileImportFilterDict]] + :type file_import_filters: List[FileImportFilter] :param import_mode: :type import_mode: FileImportMode :param branch_name: The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. @@ -138,12 +133,7 @@ def create( "displayName": connectivity_models.FileImportDisplayName, "branchName": typing.Optional[datasets_models.BranchName], "subfolder": typing.Optional[str], - "fileImportFilters": typing.List[ - typing.Union[ - connectivity_models.FileImportFilter, - connectivity_models.FileImportFilterDict, - ] - ], + "fileImportFilters": typing.List[connectivity_models.FileImportFilter], }, ), response_type=connectivity_models.FileImport, @@ -382,67 +372,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - connection_rid: connectivity_models.ConnectionRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> connectivity_models.ListFileImportsResponse: - """ - Lists all file imports defined for this connection. - Only file imports that the user has permissions to view will be returned. - - :param connection_rid: - :type connection_rid: ConnectionRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: connectivity_models.ListFileImportsResponse - """ - - warnings.warn( - "The client.connectivity.FileImport.page(...) method has been deprecated. Please use client.connectivity.FileImport.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/connectivity/connections/{connectionRid}/fileImports", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "connectionRid": connection_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=connectivity_models.ListFileImportsResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -453,11 +382,7 @@ def replace( *, dataset_rid: datasets_models.DatasetRid, display_name: connectivity_models.FileImportDisplayName, - file_import_filters: typing.List[ - typing.Union[ - connectivity_models.FileImportFilter, connectivity_models.FileImportFilterDict - ] - ], + file_import_filters: typing.List[connectivity_models.FileImportFilter], import_mode: connectivity_models.FileImportMode, branch_name: typing.Optional[datasets_models.BranchName] = None, preview: typing.Optional[core_models.PreviewMode] = None, @@ -476,7 +401,7 @@ def replace( :param display_name: :type display_name: FileImportDisplayName :param file_import_filters: Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) - :type file_import_filters: List[Union[FileImportFilter, FileImportFilterDict]] + :type file_import_filters: List[FileImportFilter] :param import_mode: :type import_mode: FileImportMode :param branch_name: The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. @@ -530,12 +455,7 @@ def replace( "displayName": connectivity_models.FileImportDisplayName, "branchName": typing.Optional[datasets_models.BranchName], "subfolder": typing.Optional[str], - "fileImportFilters": typing.List[ - typing.Union[ - connectivity_models.FileImportFilter, - connectivity_models.FileImportFilterDict, - ] - ], + "fileImportFilters": typing.List[connectivity_models.FileImportFilter], }, ), response_type=connectivity_models.FileImport, @@ -561,7 +481,6 @@ def delete(_: None): ... def execute(_: core_models.BuildRid): ... def get(_: connectivity_models.FileImport): ... def list(_: connectivity_models.ListFileImportsResponse): ... - def page(_: connectivity_models.ListFileImportsResponse): ... def replace(_: connectivity_models.FileImport): ... self.create = core.with_raw_response(create, client.create) @@ -569,7 +488,6 @@ def replace(_: connectivity_models.FileImport): ... self.execute = core.with_raw_response(execute, client.execute) self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) self.replace = core.with_raw_response(replace, client.replace) @@ -579,12 +497,10 @@ def create(_: connectivity_models.FileImport): ... def execute(_: core_models.BuildRid): ... def get(_: connectivity_models.FileImport): ... def list(_: connectivity_models.ListFileImportsResponse): ... - def page(_: connectivity_models.ListFileImportsResponse): ... def replace(_: connectivity_models.FileImport): ... self.create = core.with_streaming_response(create, client.create) self.execute = core.with_streaming_response(execute, client.execute) self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) self.replace = core.with_streaming_response(replace, client.replace) diff --git a/foundry/v2/connectivity/models.py b/foundry/v2/connectivity/models.py index da732fdd8..2fbe34443 100644 --- a/foundry/v2/connectivity/models.py +++ b/foundry/v2/connectivity/models.py @@ -42,28 +42,9 @@ class ApiKeyAuthentication(pydantic.BaseModel): type: typing.Literal["apiKey"] = "apiKey" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ApiKeyAuthenticationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ApiKeyAuthenticationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ApiKeyAuthenticationDict(typing_extensions.TypedDict): - """ - The API key used to authenticate to the external system. - This can be configured as a header or query parameter. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - location: RestRequestApiKeyLocationDict - """The location of the API key in the request.""" - - apiKey: EncryptedPropertyDict - """The value of the API key.""" - - type: typing.Literal["apiKey"] + return self.model_dump(by_alias=True, exclude_none=True) class AsPlaintextValue(pydantic.BaseModel): @@ -73,18 +54,9 @@ class AsPlaintextValue(pydantic.BaseModel): type: typing.Literal["asPlaintextValue"] = "asPlaintextValue" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AsPlaintextValueDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AsPlaintextValueDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AsPlaintextValueDict(typing_extensions.TypedDict): - """AsPlaintextValue""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: PlaintextValue - type: typing.Literal["asPlaintextValue"] + return self.model_dump(by_alias=True, exclude_none=True) class AsSecretName(pydantic.BaseModel): @@ -94,18 +66,9 @@ class AsSecretName(pydantic.BaseModel): type: typing.Literal["asSecretName"] = "asSecretName" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AsSecretNameDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AsSecretNameDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AsSecretNameDict(typing_extensions.TypedDict): - """AsSecretName""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: SecretName - type: typing.Literal["asSecretName"] + return self.model_dump(by_alias=True, exclude_none=True) class AwsAccessKey(pydantic.BaseModel): @@ -122,25 +85,9 @@ class AwsAccessKey(pydantic.BaseModel): type: typing.Literal["awsAccessKey"] = "awsAccessKey" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AwsAccessKeyDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AwsAccessKeyDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AwsAccessKeyDict(typing_extensions.TypedDict): - """ - [Access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) are long-term - credentials for an IAM user or the AWS account root user. - Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) and a secret access - key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). You must use both the access key ID and - secret access key together to authenticate your requests. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - accessKeyId: str - secretAccessKey: EncryptedPropertyDict - type: typing.Literal["awsAccessKey"] + return self.model_dump(by_alias=True, exclude_none=True) class AwsOidcAuthentication(pydantic.BaseModel): @@ -161,31 +108,9 @@ class AwsOidcAuthentication(pydantic.BaseModel): type: typing.Literal["oidc"] = "oidc" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AwsOidcAuthenticationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AwsOidcAuthenticationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AwsOidcAuthenticationDict(typing_extensions.TypedDict): - """ - [OpenID Connect (OIDC)](/docs/foundry/data-connection/oidc/) is an open authentication protocol that allows - you to authenticate to external system resources without the use of static credentials. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - audience: str - """The configured audience that identifies the external system.""" - - issuerUrl: str - """The URL that identifies Foundry as an OIDC identity provider.""" - - subject: ConnectionRid - """The RID of the Connection that is connecting to the external system.""" - - type: typing.Literal["oidc"] + return self.model_dump(by_alias=True, exclude_none=True) class BasicCredentials(pydantic.BaseModel): @@ -196,19 +121,9 @@ class BasicCredentials(pydantic.BaseModel): type: typing.Literal["basic"] = "basic" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BasicCredentialsDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(BasicCredentialsDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class BasicCredentialsDict(typing_extensions.TypedDict): - """BasicCredentials""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - username: str - password: EncryptedPropertyDict - type: typing.Literal["basic"] + return self.model_dump(by_alias=True, exclude_none=True) class BearerToken(pydantic.BaseModel): @@ -218,18 +133,9 @@ class BearerToken(pydantic.BaseModel): type: typing.Literal["bearerToken"] = "bearerToken" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BearerTokenDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(BearerTokenDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class BearerTokenDict(typing_extensions.TypedDict): - """The bearer token used to authenticate to the external system.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - bearerToken: EncryptedPropertyDict - type: typing.Literal["bearerToken"] + return self.model_dump(by_alias=True, exclude_none=True) class CloudIdentity(pydantic.BaseModel): @@ -242,21 +148,9 @@ class CloudIdentity(pydantic.BaseModel): type: typing.Literal["cloudIdentity"] = "cloudIdentity" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CloudIdentityDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(CloudIdentityDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class CloudIdentityDict(typing_extensions.TypedDict): - """ - [Cloud identities](/docs/foundry/administration/configure-cloud-identities/) allow you to authenticate to - cloud provider resources without the use of static credentials. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - cloudIdentityRid: CloudIdentityRid - type: typing.Literal["cloudIdentity"] + return self.model_dump(by_alias=True, exclude_none=True) CloudIdentityRid = core.RID @@ -274,9 +168,9 @@ class Connection(pydantic.BaseModel): configuration: ConnectionConfiguration model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ConnectionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ConnectionDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) ConnectionConfiguration = typing_extensions.Annotated[ @@ -288,30 +182,6 @@ def to_dict(self) -> "ConnectionDict": """ConnectionConfiguration""" -ConnectionConfigurationDict = typing_extensions.Annotated[ - typing.Union[ - "S3ConnectionConfigurationDict", - "RestConnectionConfigurationDict", - "JdbcConnectionConfigurationDict", - ], - pydantic.Field(discriminator="type"), -] -"""ConnectionConfiguration""" - - -class ConnectionDict(typing_extensions.TypedDict): - """Connection""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ConnectionRid - parentFolderRid: filesystem_models.FolderRid - displayName: ConnectionDisplayName - """The display name of the Connection. The display name must not be blank.""" - - configuration: ConnectionConfigurationDict - - ConnectionDisplayName = str """The display name of the Connection. The display name must not be blank.""" @@ -331,17 +201,6 @@ class ConnectionDict(typing_extensions.TypedDict): """CreateConnectionRequestConnectionConfiguration""" -CreateConnectionRequestConnectionConfigurationDict = typing_extensions.Annotated[ - typing.Union[ - "CreateConnectionRequestS3ConnectionConfigurationDict", - "CreateConnectionRequestRestConnectionConfigurationDict", - "CreateConnectionRequestJdbcConnectionConfigurationDict", - ], - pydantic.Field(discriminator="type"), -] -"""CreateConnectionRequestConnectionConfiguration""" - - class CreateConnectionRequestJdbcConnectionConfiguration(pydantic.BaseModel): """CreateConnectionRequestJdbcConnectionConfiguration""" @@ -362,34 +221,9 @@ class CreateConnectionRequestJdbcConnectionConfiguration(pydantic.BaseModel): type: typing.Literal["jdbc"] = "jdbc" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateConnectionRequestJdbcConnectionConfigurationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateConnectionRequestJdbcConnectionConfigurationDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class CreateConnectionRequestJdbcConnectionConfigurationDict(typing_extensions.TypedDict): - """CreateConnectionRequestJdbcConnectionConfiguration""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - credentials: typing_extensions.NotRequired[BasicCredentialsDict] - driverClass: str - """The fully-qualified driver class name that is used to connect to the database.""" - - jdbcProperties: typing.Dict[str, str] - """ - The list of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed - to the JDBC driver to configure behavior. Refer to the documentation of your specific connection for additional - available JDBC properties to add to your connection configuration. - """ - - url: str - """The URL that the JDBC driver uses to connect to a database.""" - - type: typing.Literal["jdbc"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateConnectionRequestRestConnectionConfiguration(pydantic.BaseModel): @@ -417,39 +251,9 @@ class CreateConnectionRequestRestConnectionConfiguration(pydantic.BaseModel): type: typing.Literal["rest"] = "rest" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateConnectionRequestRestConnectionConfigurationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateConnectionRequestRestConnectionConfigurationDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class CreateConnectionRequestRestConnectionConfigurationDict(typing_extensions.TypedDict): - """CreateConnectionRequestRestConnectionConfiguration""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - additionalSecrets: typing_extensions.NotRequired[RestConnectionAdditionalSecretsDict] - """ - Additional secrets that can be referenced in code and webhook configurations. - If not provided, no additional secrets will be created. - """ - - oauth2ClientRid: typing_extensions.NotRequired[core.RID] - """ - The RID of the [Outbound application](/docs/foundry/administration/configure-outbound-applications) that is used to authenticate to the external system via OAuth2. - Currently, a connection may use only one outbound application for OAuth 2.0 authentication. - Selecting a different outbound application will update the configuration for all domains with OAuth 2.0 as the selected authorization. - """ - - domains: typing.List[DomainDict] - """ - The domains that the connection is allowed to access. - At least one domain must be specified. - """ - - type: typing.Literal["rest"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateConnectionRequestS3ConnectionConfiguration(pydantic.BaseModel): @@ -537,99 +341,9 @@ class CreateConnectionRequestS3ConnectionConfiguration(pydantic.BaseModel): type: typing.Literal["s3"] = "s3" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateConnectionRequestS3ConnectionConfigurationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateConnectionRequestS3ConnectionConfigurationDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class CreateConnectionRequestS3ConnectionConfigurationDict(typing_extensions.TypedDict): - """CreateConnectionRequestS3ConnectionConfiguration""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - connectionTimeoutMillis: typing_extensions.NotRequired[core.Long] - """ - The amount of time (in milliseconds) to wait when initially establishing a connection before giving up and timing out. - If not specified, defaults to 10000 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_CONNECTION_TIMEOUT). - """ - - maxErrorRetry: typing_extensions.NotRequired[int] - """ - The maximum number of retry attempts for failed requests to the S3 service. - If not specified, defaults to 3 as defined by the [AWS SDK default](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/retry-strategy.html#retry-strategies). - """ - - bucketUrl: str - """The URL of the S3 bucket. The URL should contain a trailing slash.""" - - clientKmsConfiguration: typing_extensions.NotRequired[S3KmsConfigurationDict] - """ - The client-side KMS key to use for encryption and decryption of data in the S3 bucket. - If not specified, the default KMS key for the bucket is used. - """ - - matchSubfolderExactly: typing_extensions.NotRequired[bool] - """ - If true, only files in the subfolder specified in the bucket URL will be synced. - If false, all files in the bucket will be synced. - If not specified, defaults to false. - """ - - stsRoleConfiguration: typing_extensions.NotRequired[StsRoleConfigurationDict] - """The configuration needed to assume a role to connect to the S3 external system.""" - - s3Endpoint: typing_extensions.NotRequired[str] - """ - The endpoint of the S3 service. This is used to connect to a custom S3 service that is not AWS S3. - If not specified, defaults to the [AWS S3 endpoint](https://docs.aws.amazon.com/general/latest/gr/s3.html). - Warning: Specifying a region and a custom endpoint containing a region can lead to unexpected behavior. - """ - - socketTimeoutMillis: typing_extensions.NotRequired[core.Long] - """ - The amount of time (in milliseconds) to wait for data to be transferred over an established, open connection. - If not specified, defaults to 50000 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_SOCKET_TIMEOUT). - """ - - enableRequesterPays: typing_extensions.NotRequired[bool] - """ - Defaults to false, unless set and overwritten. - If true, includes the [requester pays header](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html) - in requests, allowing reads from requester pays buckets. - """ - - s3EndpointSigningRegion: typing_extensions.NotRequired[Region] - """ - The region used when constructing the S3 client using a custom endpoint. - This is often not required and would only be needed if you are using the S3 connector with an S3-compliant third-party API, - and are also setting a custom endpoint that requires a non-default region. - """ - - region: typing_extensions.NotRequired[Region] - """ - The region representing the location of the S3 bucket. - Warning: Specifying a region and a custom endpoint containing a region can lead to unexpected behavior. - """ - - authenticationMode: typing_extensions.NotRequired[S3AuthenticationModeDict] - """ - The authentication mode to use to connect to the S3 external system. No authentication mode is required - to connect to publicly accessible AWS S3 buckets. - """ - - proxyConfiguration: typing_extensions.NotRequired[S3ProxyConfigurationDict] - """The configuration needed to connect to the S3 external system through a proxy.""" - - maxConnections: typing_extensions.NotRequired[int] - """ - The maximum number of HTTP connections to the S3 service per sync. - If not specified, defaults to 50 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_MAX_CONNECTIONS). - """ - - type: typing.Literal["s3"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateTableImportRequestJdbcImportConfig(pydantic.BaseModel): @@ -645,27 +359,9 @@ class CreateTableImportRequestJdbcImportConfig(pydantic.BaseModel): type: typing.Literal["jdbcImportConfig"] = "jdbcImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateTableImportRequestJdbcImportConfigDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateTableImportRequestJdbcImportConfigDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class CreateTableImportRequestJdbcImportConfigDict(typing_extensions.TypedDict): - """CreateTableImportRequestJdbcImportConfig""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - query: str - """ - A single SQL query can be executed per sync, which should output a data table - and avoid operations like invoking stored procedures. - The query results are saved to the output dataset in Foundry. - """ - - type: typing.Literal["jdbcImportConfig"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateTableImportRequestMicrosoftAccessImportConfig(pydantic.BaseModel): @@ -681,27 +377,9 @@ class CreateTableImportRequestMicrosoftAccessImportConfig(pydantic.BaseModel): type: typing.Literal["microsoftAccessImportConfig"] = "microsoftAccessImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateTableImportRequestMicrosoftAccessImportConfigDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateTableImportRequestMicrosoftAccessImportConfigDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class CreateTableImportRequestMicrosoftAccessImportConfigDict(typing_extensions.TypedDict): - """CreateTableImportRequestMicrosoftAccessImportConfig""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - query: str - """ - A single SQL query can be executed per sync, which should output a data table - and avoid operations like invoking stored procedures. - The query results are saved to the output dataset in Foundry. - """ - - type: typing.Literal["microsoftAccessImportConfig"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateTableImportRequestMicrosoftSqlServerImportConfig(pydantic.BaseModel): @@ -717,27 +395,9 @@ class CreateTableImportRequestMicrosoftSqlServerImportConfig(pydantic.BaseModel) type: typing.Literal["microsoftSqlServerImportConfig"] = "microsoftSqlServerImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateTableImportRequestMicrosoftSqlServerImportConfigDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateTableImportRequestMicrosoftSqlServerImportConfigDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class CreateTableImportRequestMicrosoftSqlServerImportConfigDict(typing_extensions.TypedDict): - """CreateTableImportRequestMicrosoftSqlServerImportConfig""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - query: str - """ - A single SQL query can be executed per sync, which should output a data table - and avoid operations like invoking stored procedures. - The query results are saved to the output dataset in Foundry. - """ - - type: typing.Literal["microsoftSqlServerImportConfig"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateTableImportRequestOracleImportConfig(pydantic.BaseModel): @@ -753,27 +413,9 @@ class CreateTableImportRequestOracleImportConfig(pydantic.BaseModel): type: typing.Literal["oracleImportConfig"] = "oracleImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateTableImportRequestOracleImportConfigDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateTableImportRequestOracleImportConfigDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class CreateTableImportRequestOracleImportConfigDict(typing_extensions.TypedDict): - """CreateTableImportRequestOracleImportConfig""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - query: str - """ - A single SQL query can be executed per sync, which should output a data table - and avoid operations like invoking stored procedures. - The query results are saved to the output dataset in Foundry. - """ - - type: typing.Literal["oracleImportConfig"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateTableImportRequestPostgreSqlImportConfig(pydantic.BaseModel): @@ -789,27 +431,9 @@ class CreateTableImportRequestPostgreSqlImportConfig(pydantic.BaseModel): type: typing.Literal["postgreSqlImportConfig"] = "postgreSqlImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateTableImportRequestPostgreSqlImportConfigDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateTableImportRequestPostgreSqlImportConfigDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class CreateTableImportRequestPostgreSqlImportConfigDict(typing_extensions.TypedDict): - """CreateTableImportRequestPostgreSqlImportConfig""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - query: str - """ - A single SQL query can be executed per sync, which should output a data table - and avoid operations like invoking stored procedures. - The query results are saved to the output dataset in Foundry. - """ - - type: typing.Literal["postgreSqlImportConfig"] + return self.model_dump(by_alias=True, exclude_none=True) CreateTableImportRequestTableImportConfig = typing_extensions.Annotated[ @@ -825,19 +449,6 @@ class CreateTableImportRequestPostgreSqlImportConfigDict(typing_extensions.Typed """The import configuration for a specific [connector type](/docs/foundry/data-integration/source-type-overview).""" -CreateTableImportRequestTableImportConfigDict = typing_extensions.Annotated[ - typing.Union[ - CreateTableImportRequestJdbcImportConfigDict, - CreateTableImportRequestMicrosoftSqlServerImportConfigDict, - CreateTableImportRequestPostgreSqlImportConfigDict, - CreateTableImportRequestMicrosoftAccessImportConfigDict, - CreateTableImportRequestOracleImportConfigDict, - ], - pydantic.Field(discriminator="type"), -] -"""The import configuration for a specific [connector type](/docs/foundry/data-integration/source-type-overview).""" - - class Domain(pydantic.BaseModel): """The domain that the connection is allowed to access.""" @@ -861,33 +472,9 @@ class Domain(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DomainDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DomainDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DomainDict(typing_extensions.TypedDict): - """The domain that the connection is allowed to access.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - scheme: typing_extensions.NotRequired[UriScheme] - """ - The scheme of the domain that the connection is allowed to access. - If not specified, defaults to HTTPS. - """ - - host: str - """The domain name, IPv4, or IPv6 address.""" - - port: typing_extensions.NotRequired[int] - """The port number of the domain that the connection is allowed to access.""" - - auth: typing_extensions.NotRequired[RestAuthenticationModeDict] - """ - The URI scheme must be HTTPS if using any authentication. - If not specified, no authentication is required. - """ + return self.model_dump(by_alias=True, exclude_none=True) EncryptedProperty = typing_extensions.Annotated[ @@ -902,18 +489,6 @@ class DomainDict(typing_extensions.TypedDict): """ -EncryptedPropertyDict = typing_extensions.Annotated[ - typing.Union[AsSecretNameDict, AsPlaintextValueDict], pydantic.Field(discriminator="type") -] -""" -When reading an encrypted property, the secret name representing the encrypted value will be returned. -When writing to an encrypted property: -- If a plaintext value is passed as an input, the plaintext value will be encrypted and saved to the property. -- If a secret name is passed as an input, the secret name must match the existing secret name of the property - and the property will retain its previously encrypted value. -""" - - class FileAnyPathMatchesFilter(pydantic.BaseModel): """If any file has a relative path matching the regular expression, sync all files in the subfolder that are not otherwise filtered.""" @@ -923,22 +498,9 @@ class FileAnyPathMatchesFilter(pydantic.BaseModel): type: typing.Literal["anyPathMatchesFilter"] = "anyPathMatchesFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FileAnyPathMatchesFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - FileAnyPathMatchesFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class FileAnyPathMatchesFilterDict(typing_extensions.TypedDict): - """If any file has a relative path matching the regular expression, sync all files in the subfolder that are not otherwise filtered.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - regex: str - """The regular expression for the relative path to match against.""" - - type: typing.Literal["anyPathMatchesFilter"] + return self.model_dump(by_alias=True, exclude_none=True) class FileAtLeastCountFilter(pydantic.BaseModel): @@ -953,25 +515,9 @@ class FileAtLeastCountFilter(pydantic.BaseModel): type: typing.Literal["atLeastCountFilter"] = "atLeastCountFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FileAtLeastCountFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - FileAtLeastCountFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class FileAtLeastCountFilterDict(typing_extensions.TypedDict): - """Import all filtered files only if there are at least the specified number of files remaining.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - minFilesCount: int - """ - The minimum number of files remaining expected. - The value specified must be greater than 0. - """ - - type: typing.Literal["atLeastCountFilter"] + return self.model_dump(by_alias=True, exclude_none=True) class FileChangedSinceLastUploadFilter(pydantic.BaseModel): @@ -994,33 +540,9 @@ class FileChangedSinceLastUploadFilter(pydantic.BaseModel): type: typing.Literal["changedSinceLastUploadFilter"] = "changedSinceLastUploadFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FileChangedSinceLastUploadFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - FileChangedSinceLastUploadFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class FileChangedSinceLastUploadFilterDict(typing_extensions.TypedDict): - """ - Only import files that have changed or been added since the last import run. Whether or not a file is considered to be changed is determined by the specified file properties. - This will exclude files uploaded in any previous imports, regardless of the file import mode used. A SNAPSHOT file import mode does not reset the filter. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fileProperties: typing.List[FileProperty] - """ - The criteria on which to determine whether a file has been changed or not since the last import. - If any of the specified criteria have changed, the file is consider changed. The criteria include: - - LAST_MODIFIED: The file's last modified timestamp has changed since the last import. - SIZE: The file's size has changed since the last import. - - If no criteria are specified, only newly added files will be imported. - """ - - type: typing.Literal["changedSinceLastUploadFilter"] + return self.model_dump(by_alias=True, exclude_none=True) class FileImport(pydantic.BaseModel): @@ -1046,9 +568,9 @@ class FileImport(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FileImportDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(FileImportDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) class FileImportCustomFilter(pydantic.BaseModel): @@ -1061,47 +583,9 @@ class FileImportCustomFilter(pydantic.BaseModel): type: typing.Literal["customFilter"] = "customFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FileImportCustomFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - FileImportCustomFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class FileImportCustomFilterDict(typing_extensions.TypedDict): - """ - A custom file import filter. Custom file import filters can be fetched but cannot currently be used - when creating or updating file imports. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - config: typing.Any - type: typing.Literal["customFilter"] - - -class FileImportDict(typing_extensions.TypedDict): - """FileImport""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: FileImportRid - connectionRid: ConnectionRid - """The RID of the Connection (also known as a source) that the File Import uses to import data.""" - - datasetRid: datasets_models.DatasetRid - """The RID of the output dataset.""" - - branchName: typing_extensions.NotRequired[datasets_models.BranchName] - """The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments.""" - - displayName: FileImportDisplayName - fileImportFilters: typing.List[FileImportFilterDict] - """Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs)""" - - importMode: FileImportMode - subfolder: typing_extensions.NotRequired[str] - """A subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system.""" + return self.model_dump(by_alias=True, exclude_none=True) FileImportDisplayName = str @@ -1128,26 +612,6 @@ class FileImportDict(typing_extensions.TypedDict): """ -FileImportFilterDict = typing_extensions.Annotated[ - typing.Union[ - "FilePathNotMatchesFilterDict", - FileAnyPathMatchesFilterDict, - "FilesCountLimitFilterDict", - FileChangedSinceLastUploadFilterDict, - FileImportCustomFilterDict, - "FileLastModifiedAfterFilterDict", - "FilePathMatchesFilterDict", - FileAtLeastCountFilterDict, - "FileSizeFilterDict", - ], - pydantic.Field(discriminator="type"), -] -""" -[Filters](/docs/foundry/data-connection/file-based-syncs/#filters) allow you to filter source files -before they are imported into Foundry. -""" - - FileImportMode = typing.Literal["SNAPSHOT", "APPEND", "UPDATE"] """ Import mode governs how raw files are read from an external system, and written into a Foundry dataset. @@ -1174,25 +638,9 @@ class FileLastModifiedAfterFilter(pydantic.BaseModel): type: typing.Literal["lastModifiedAfterFilter"] = "lastModifiedAfterFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FileLastModifiedAfterFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - FileLastModifiedAfterFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class FileLastModifiedAfterFilterDict(typing_extensions.TypedDict): - """Only import files that have been modified after a specified timestamp""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - afterTimestamp: typing_extensions.NotRequired[datetime] - """ - Timestamp threshold, specified in ISO-8601 format. - If not specified, defaults to the timestamp the filter is added to the file import. - """ - - type: typing.Literal["lastModifiedAfterFilter"] + return self.model_dump(by_alias=True, exclude_none=True) class FilePathMatchesFilter(pydantic.BaseModel): @@ -1215,33 +663,9 @@ class FilePathMatchesFilter(pydantic.BaseModel): type: typing.Literal["pathMatchesFilter"] = "pathMatchesFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FilePathMatchesFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - FilePathMatchesFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class FilePathMatchesFilterDict(typing_extensions.TypedDict): - """ - Only import files whose path (relative to the root of the source) matches the regular expression. - - **Example** - Suppose we are importing files from `relative/subfolder`. - `relative/subfolder` contains: - - `relative/subfolder/include-file.txt` - - `relative/subfolder/exclude-file.txt` - - `relative/subfolder/other-file.txt` - - With the `relative/subfolder/include-.*.txt` regex, only `relative/subfolder/include-file.txt` will be imported. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - regex: str - """Must be written to match the paths relative to the root of the source, even if a subfolder is specified.""" - - type: typing.Literal["pathMatchesFilter"] + return self.model_dump(by_alias=True, exclude_none=True) class FilePathNotMatchesFilter(pydantic.BaseModel): @@ -1265,34 +689,9 @@ class FilePathNotMatchesFilter(pydantic.BaseModel): type: typing.Literal["pathNotMatchesFilter"] = "pathNotMatchesFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FilePathNotMatchesFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - FilePathNotMatchesFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class FilePathNotMatchesFilterDict(typing_extensions.TypedDict): - """ - Only import files whose path (relative to the root of the source) does not match the regular expression. - - **Example** - Suppose we are importing files from `relative/subfolder`. - `relative/subfolder` contains: - - `relative/subfolder/include-file.txt` - - `relative/subfolder/exclude-file.txt` - - `relative/subfolder/other-file.txt` - - With the `relative/subfolder/exclude-.*.txt` regex, both `relative/subfolder/include-file.txt` and `relative/subfolder/other-file.txt` will be imported, - and `relative/subfolder/exclude-file.txt` will be excluded from the import. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - regex: str - """Must be written to match the paths relative to the root of the source, even if a subfolder is specified.""" - - type: typing.Literal["pathNotMatchesFilter"] + return self.model_dump(by_alias=True, exclude_none=True) FileProperty = typing.Literal["LAST_MODIFIED", "SIZE"] @@ -1321,33 +720,9 @@ class FileSizeFilter(pydantic.BaseModel): type: typing.Literal["fileSizeFilter"] = "fileSizeFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FileSizeFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(FileSizeFilterDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class FileSizeFilterDict(typing_extensions.TypedDict): - """ - Only import files whose size is between the specified minimum and maximum values. - At least one of `gt` or `lt` should be present. - If both are present, the value specified for `gt` must be strictly less than `lt - 1`. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - gt: typing_extensions.NotRequired[core_models.SizeBytes] - """ - File size must be greater than this number for it to be imported. - The value specified cannot be a negative number. - """ - - lt: typing_extensions.NotRequired[core_models.SizeBytes] - """ - File size must be less than this number for it to be imported. - The value specified must be at least 1 byte. - """ - - type: typing.Literal["fileSizeFilter"] + return self.model_dump(by_alias=True, exclude_none=True) class FilesCountLimitFilter(pydantic.BaseModel): @@ -1363,26 +738,9 @@ class FilesCountLimitFilter(pydantic.BaseModel): type: typing.Literal["filesCountLimitFilter"] = "filesCountLimitFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FilesCountLimitFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - FilesCountLimitFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class FilesCountLimitFilterDict(typing_extensions.TypedDict): - """ - Only retain `filesCount` number of files in each transaction. - The choice of files to retain is made without any guarantee of order. - This option can increase the reliability of incremental syncs. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - filesCount: int - """The number of files to import in the transaction. The value specified must be positive.""" - - type: typing.Literal["filesCountLimitFilter"] + return self.model_dump(by_alias=True, exclude_none=True) class HeaderApiKey(pydantic.BaseModel): @@ -1394,20 +752,9 @@ class HeaderApiKey(pydantic.BaseModel): type: typing.Literal["header"] = "header" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "HeaderApiKeyDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(HeaderApiKeyDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class HeaderApiKeyDict(typing_extensions.TypedDict): - """HeaderApiKey""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - headerName: str - """The name of the header that the API key is passed in.""" - - type: typing.Literal["header"] + return self.model_dump(by_alias=True, exclude_none=True) class JdbcConnectionConfiguration(pydantic.BaseModel): @@ -1430,33 +777,9 @@ class JdbcConnectionConfiguration(pydantic.BaseModel): type: typing.Literal["jdbc"] = "jdbc" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "JdbcConnectionConfigurationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - JdbcConnectionConfigurationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class JdbcConnectionConfigurationDict(typing_extensions.TypedDict): - """The configuration needed to connect to an external system using the JDBC protocol.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - url: str - """The URL that the JDBC driver uses to connect to a database.""" - - driverClass: str - """The fully-qualified driver class name that is used to connect to the database.""" - - jdbcProperties: typing.Dict[str, str] - """ - The list of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed - to the JDBC driver to configure behavior. Refer to the documentation of your specific connection for additional - available JDBC properties to add to your connection configuration. - """ - - credentials: typing_extensions.NotRequired[BasicCredentialsDict] - type: typing.Literal["jdbc"] + return self.model_dump(by_alias=True, exclude_none=True) class JdbcImportConfig(pydantic.BaseModel): @@ -1472,24 +795,9 @@ class JdbcImportConfig(pydantic.BaseModel): type: typing.Literal["jdbcImportConfig"] = "jdbcImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "JdbcImportConfigDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(JdbcImportConfigDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class JdbcImportConfigDict(typing_extensions.TypedDict): - """The import configuration for a [custom JDBC connection](/docs/foundry/available-connectors/custom-jdbc-sources).""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - query: str - """ - A single SQL query can be executed per sync, which should output a data table - and avoid operations like invoking stored procedures. - The query results are saved to the output dataset in Foundry. - """ - - type: typing.Literal["jdbcImportConfig"] + return self.model_dump(by_alias=True, exclude_none=True) class ListFileImportsResponse(pydantic.BaseModel): @@ -1499,20 +807,9 @@ class ListFileImportsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListFileImportsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListFileImportsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListFileImportsResponseDict(typing_extensions.TypedDict): - """ListFileImportsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[FileImportDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListTableImportsResponse(pydantic.BaseModel): @@ -1522,20 +819,9 @@ class ListTableImportsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListTableImportsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListTableImportsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListTableImportsResponseDict(typing_extensions.TypedDict): - """ListTableImportsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[TableImportDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class MicrosoftAccessImportConfig(pydantic.BaseModel): @@ -1551,26 +837,9 @@ class MicrosoftAccessImportConfig(pydantic.BaseModel): type: typing.Literal["microsoftAccessImportConfig"] = "microsoftAccessImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MicrosoftAccessImportConfigDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - MicrosoftAccessImportConfigDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class MicrosoftAccessImportConfigDict(typing_extensions.TypedDict): - """The import configuration for a [Microsoft Access connection](/docs/foundry/available-connectors/microsoft-access).""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - query: str - """ - A single SQL query can be executed per sync, which should output a data table - and avoid operations like invoking stored procedures. - The query results are saved to the output dataset in Foundry. - """ - - type: typing.Literal["microsoftAccessImportConfig"] + return self.model_dump(by_alias=True, exclude_none=True) class MicrosoftSqlServerImportConfig(pydantic.BaseModel): @@ -1586,69 +855,13 @@ class MicrosoftSqlServerImportConfig(pydantic.BaseModel): type: typing.Literal["microsoftSqlServerImportConfig"] = "microsoftSqlServerImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MicrosoftSqlServerImportConfigDict": - """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - MicrosoftSqlServerImportConfigDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class MicrosoftSqlServerImportConfigDict(typing_extensions.TypedDict): - """The import configuration for a [Microsoft SQL Server connection](/docs/foundry/available-connectors/microsoft-sql-server).""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - query: str - """ - A single SQL query can be executed per sync, which should output a data table - and avoid operations like invoking stored procedures. - The query results are saved to the output dataset in Foundry. - """ - - type: typing.Literal["microsoftSqlServerImportConfig"] - - -class OracleImportConfig(pydantic.BaseModel): - """The import configuration for an Oracle Database 21 connection.""" - - query: str - """ - A single SQL query can be executed per sync, which should output a data table - and avoid operations like invoking stored procedures. - The query results are saved to the output dataset in Foundry. - """ - - type: typing.Literal["oracleImportConfig"] = "oracleImportConfig" - model_config = {"extra": "allow", "populate_by_name": True} - - def to_dict(self) -> "OracleImportConfigDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OracleImportConfigDict, self.model_dump(by_alias=True, exclude_none=True) - ) + return self.model_dump(by_alias=True, exclude_none=True) -class OracleImportConfigDict(typing_extensions.TypedDict): - """The import configuration for an Oracle Database 21 connection.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - query: str - """ - A single SQL query can be executed per sync, which should output a data table - and avoid operations like invoking stored procedures. - The query results are saved to the output dataset in Foundry. - """ - - type: typing.Literal["oracleImportConfig"] - - -PlaintextValue = str -"""PlaintextValue""" - - -class PostgreSqlImportConfig(pydantic.BaseModel): - """The import configuration for a [PostgreSQL connection](/docs/foundry/available-connectors/postgresql).""" +class OracleImportConfig(pydantic.BaseModel): + """The import configuration for an Oracle Database 21 connection.""" query: str """ @@ -1657,20 +870,20 @@ class PostgreSqlImportConfig(pydantic.BaseModel): The query results are saved to the output dataset in Foundry. """ - type: typing.Literal["postgreSqlImportConfig"] = "postgreSqlImportConfig" + type: typing.Literal["oracleImportConfig"] = "oracleImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "PostgreSqlImportConfigDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - PostgreSqlImportConfigDict, self.model_dump(by_alias=True, exclude_none=True) - ) + return self.model_dump(by_alias=True, exclude_none=True) -class PostgreSqlImportConfigDict(typing_extensions.TypedDict): - """The import configuration for a [PostgreSQL connection](/docs/foundry/available-connectors/postgresql).""" +PlaintextValue = str +"""PlaintextValue""" + - __pydantic_config__ = {"extra": "allow"} # type: ignore +class PostgreSqlImportConfig(pydantic.BaseModel): + """The import configuration for a [PostgreSQL connection](/docs/foundry/available-connectors/postgresql).""" query: str """ @@ -1679,7 +892,12 @@ class PostgreSqlImportConfigDict(typing_extensions.TypedDict): The query results are saved to the output dataset in Foundry. """ - type: typing.Literal["postgreSqlImportConfig"] + type: typing.Literal["postgreSqlImportConfig"] = "postgreSqlImportConfig" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) Protocol = typing.Literal["HTTP", "HTTPS"] @@ -1695,22 +913,9 @@ class QueryParameterApiKey(pydantic.BaseModel): type: typing.Literal["queryParameter"] = "queryParameter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryParameterApiKeyDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - QueryParameterApiKeyDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class QueryParameterApiKeyDict(typing_extensions.TypedDict): - """QueryParameterApiKey""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - queryParameterName: str - """The name of the query parameter that the API key is passed in.""" - - type: typing.Literal["queryParameter"] + return self.model_dump(by_alias=True, exclude_none=True) Region = str @@ -1724,15 +929,6 @@ class QueryParameterApiKeyDict(typing_extensions.TypedDict): """The method of authentication for connecting to an external REST system.""" -RestAuthenticationModeDict = typing_extensions.Annotated[ - typing.Union[ - BearerTokenDict, ApiKeyAuthenticationDict, BasicCredentialsDict, "RestConnectionOAuth2Dict" - ], - pydantic.Field(discriminator="type"), -] -"""The method of authentication for connecting to an external REST system.""" - - RestConnectionAdditionalSecrets = typing_extensions.Annotated[ typing.Union["SecretsWithPlaintextValues", "SecretsNames"], pydantic.Field(discriminator="type") ] @@ -1742,16 +938,6 @@ class QueryParameterApiKeyDict(typing_extensions.TypedDict): """ -RestConnectionAdditionalSecretsDict = typing_extensions.Annotated[ - typing.Union["SecretsWithPlaintextValuesDict", "SecretsNamesDict"], - pydantic.Field(discriminator="type"), -] -""" -When creating or updating additional secrets, use SecretsWithPlaintextValues. -When fetching the RestConnectionConfiguration, SecretsNames will be provided. -""" - - class RestConnectionConfiguration(pydantic.BaseModel): """The configuration needed to connect to a [REST external system](/docs/foundry/available-connectors/rest-apis).""" @@ -1777,38 +963,9 @@ class RestConnectionConfiguration(pydantic.BaseModel): type: typing.Literal["rest"] = "rest" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "RestConnectionConfigurationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - RestConnectionConfigurationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class RestConnectionConfigurationDict(typing_extensions.TypedDict): - """The configuration needed to connect to a [REST external system](/docs/foundry/available-connectors/rest-apis).""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - domains: typing.List[DomainDict] - """ - The domains that the connection is allowed to access. - At least one domain must be specified. - """ - - additionalSecrets: typing_extensions.NotRequired[RestConnectionAdditionalSecretsDict] - """ - Additional secrets that can be referenced in code and webhook configurations. - If not provided, no additional secrets will be created. - """ - - oauth2ClientRid: typing_extensions.NotRequired[core.RID] - """ - The RID of the [Outbound application](/docs/foundry/administration/configure-outbound-applications) that is used to authenticate to the external system via OAuth2. - Currently, a connection may use only one outbound application for OAuth 2.0 authentication. - Selecting a different outbound application will update the configuration for all domains with OAuth 2.0 as the selected authorization. - """ - - type: typing.Literal["rest"] + return self.model_dump(by_alias=True, exclude_none=True) class RestConnectionOAuth2(pydantic.BaseModel): @@ -1820,22 +977,9 @@ class RestConnectionOAuth2(pydantic.BaseModel): type: typing.Literal["oauth2"] = "oauth2" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "RestConnectionOAuth2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - RestConnectionOAuth2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class RestConnectionOAuth2Dict(typing_extensions.TypedDict): - """ - In order to use OAuth2 you must have an Outbound application configured in the [Foundry Control Panel Organization settings](/docs/foundry/administration/configure-outbound-applications#create-an-outbound-application). - The RID of the Outbound application must be configured in the RestConnectionConfiguration in the `oauth2ClientRid` field. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["oauth2"] + return self.model_dump(by_alias=True, exclude_none=True) RestRequestApiKeyLocation = typing_extensions.Annotated[ @@ -1844,12 +988,6 @@ class RestConnectionOAuth2Dict(typing_extensions.TypedDict): """The location of the API key in the request.""" -RestRequestApiKeyLocationDict = typing_extensions.Annotated[ - typing.Union[HeaderApiKeyDict, QueryParameterApiKeyDict], pydantic.Field(discriminator="type") -] -"""The location of the API key in the request.""" - - S3AuthenticationMode = typing_extensions.Annotated[ typing.Union[AwsAccessKey, CloudIdentity, AwsOidcAuthentication], pydantic.Field(discriminator="type"), @@ -1857,13 +995,6 @@ class RestConnectionOAuth2Dict(typing_extensions.TypedDict): """S3AuthenticationMode""" -S3AuthenticationModeDict = typing_extensions.Annotated[ - typing.Union[AwsAccessKeyDict, CloudIdentityDict, AwsOidcAuthenticationDict], - pydantic.Field(discriminator="type"), -] -"""S3AuthenticationMode""" - - class S3ConnectionConfiguration(pydantic.BaseModel): """ The configuration needed to connect to an [AWS S3 external system (or any other S3-like external systems that @@ -1952,101 +1083,9 @@ class S3ConnectionConfiguration(pydantic.BaseModel): type: typing.Literal["s3"] = "s3" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "S3ConnectionConfigurationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - S3ConnectionConfigurationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class S3ConnectionConfigurationDict(typing_extensions.TypedDict): - """ - The configuration needed to connect to an [AWS S3 external system (or any other S3-like external systems that - implement the s3a protocol)](/docs/foundry/available-connectors/amazon-s3/#amazon-s3). - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - bucketUrl: str - """The URL of the S3 bucket. The URL should contain a trailing slash.""" - - s3Endpoint: typing_extensions.NotRequired[str] - """ - The endpoint of the S3 service. This is used to connect to a custom S3 service that is not AWS S3. - If not specified, defaults to the [AWS S3 endpoint](https://docs.aws.amazon.com/general/latest/gr/s3.html). - Warning: Specifying a region and a custom endpoint containing a region can lead to unexpected behavior. - """ - - region: typing_extensions.NotRequired[Region] - """ - The region representing the location of the S3 bucket. - Warning: Specifying a region and a custom endpoint containing a region can lead to unexpected behavior. - """ - - authenticationMode: typing_extensions.NotRequired[S3AuthenticationModeDict] - """ - The authentication mode to use to connect to the S3 external system. No authentication mode is required - to connect to publicly accessible AWS S3 buckets. - """ - - s3EndpointSigningRegion: typing_extensions.NotRequired[Region] - """ - The region used when constructing the S3 client using a custom endpoint. - This is often not required and would only be needed if you are using the S3 connector with an S3-compliant third-party API, - and are also setting a custom endpoint that requires a non-default region. - """ - - clientKmsConfiguration: typing_extensions.NotRequired[S3KmsConfigurationDict] - """ - The client-side KMS key to use for encryption and decryption of data in the S3 bucket. - If not specified, the default KMS key for the bucket is used. - """ - - stsRoleConfiguration: typing_extensions.NotRequired[StsRoleConfigurationDict] - """The configuration needed to assume a role to connect to the S3 external system.""" - - proxyConfiguration: typing_extensions.NotRequired[S3ProxyConfigurationDict] - """The configuration needed to connect to the S3 external system through a proxy.""" - - maxConnections: typing_extensions.NotRequired[int] - """ - The maximum number of HTTP connections to the S3 service per sync. - If not specified, defaults to 50 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_MAX_CONNECTIONS). - """ - - connectionTimeoutMillis: typing_extensions.NotRequired[core.Long] - """ - The amount of time (in milliseconds) to wait when initially establishing a connection before giving up and timing out. - If not specified, defaults to 10000 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_CONNECTION_TIMEOUT). - """ - - socketTimeoutMillis: typing_extensions.NotRequired[core.Long] - """ - The amount of time (in milliseconds) to wait for data to be transferred over an established, open connection. - If not specified, defaults to 50000 as defined by the [AWS SDK default](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/ClientConfiguration.html#DEFAULT_SOCKET_TIMEOUT). - """ - - maxErrorRetry: typing_extensions.NotRequired[int] - """ - The maximum number of retry attempts for failed requests to the S3 service. - If not specified, defaults to 3 as defined by the [AWS SDK default](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/retry-strategy.html#retry-strategies). - """ - - matchSubfolderExactly: typing_extensions.NotRequired[bool] - """ - If true, only files in the subfolder specified in the bucket URL will be synced. - If false, all files in the bucket will be synced. - If not specified, defaults to false. - """ - - enableRequesterPays: typing_extensions.NotRequired[bool] - """ - Defaults to false, unless set and overwritten. - If true, includes the [requester pays header](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html) - in requests, allowing reads from requester pays buckets. - """ - - type: typing.Literal["s3"] + return self.model_dump(by_alias=True, exclude_none=True) class S3KmsConfiguration(pydantic.BaseModel): @@ -2066,29 +1105,9 @@ class S3KmsConfiguration(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "S3KmsConfigurationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - S3KmsConfigurationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class S3KmsConfigurationDict(typing_extensions.TypedDict): - """S3KmsConfiguration""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - kmsKey: str - """ - The client-side KMS key to use for encryption and decryption of data in the S3 bucket. - If not specified, the default KMS key for the bucket is used. - """ - - kmsRegion: typing_extensions.NotRequired[Region] - """ - The region of the client-side KMS key to use for encryption and decryption of data in the S3 bucket. - If not specified, the default KMS key region for the bucket is used. - """ + return self.model_dump(by_alias=True, exclude_none=True) class S3ProxyConfiguration(pydantic.BaseModel): @@ -2110,32 +1129,9 @@ class S3ProxyConfiguration(pydantic.BaseModel): credentials: typing.Optional[BasicCredentials] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "S3ProxyConfigurationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - S3ProxyConfigurationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class S3ProxyConfigurationDict(typing_extensions.TypedDict): - """S3ProxyConfiguration""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - host: str - """ - Domain name, IPv4, or IPv6 address. - `protocol` and `port` must be specified separately. - """ - - port: int - nonProxyHosts: typing_extensions.NotRequired[typing.List[str]] - """A list of hosts that can bypass the proxy, such as those used for STS Role. You can also use "*" wildcards.""" - - protocol: typing_extensions.NotRequired[Protocol] - """If defined, must be "HTTP" or "HTTPS". Defaults to "HTTPS".""" - - credentials: typing_extensions.NotRequired[BasicCredentialsDict] + return self.model_dump(by_alias=True, exclude_none=True) SecretName = str @@ -2154,23 +1150,9 @@ class SecretsNames(pydantic.BaseModel): type: typing.Literal["asSecretsNames"] = "asSecretsNames" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SecretsNamesDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(SecretsNamesDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class SecretsNamesDict(typing_extensions.TypedDict): - """ - A list of secret names that can be referenced in code and webhook configurations. - This will be provided to the client when fetching the RestConnectionConfiguration. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - secretNames: typing.List[SecretName] - """The names of the additional secrets that can be referenced in code and webhook configurations.""" - - type: typing.Literal["asSecretsNames"] + return self.model_dump(by_alias=True, exclude_none=True) class SecretsWithPlaintextValues(pydantic.BaseModel): @@ -2185,25 +1167,9 @@ class SecretsWithPlaintextValues(pydantic.BaseModel): type: typing.Literal["asSecretsWithPlaintextValues"] = "asSecretsWithPlaintextValues" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SecretsWithPlaintextValuesDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SecretsWithPlaintextValuesDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SecretsWithPlaintextValuesDict(typing_extensions.TypedDict): - """ - A map representing secret name to plaintext secret value pairs. - This should be used when creating or updating additional secrets for a REST connection. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - secrets: typing.Dict[SecretName, PlaintextValue] - """The additional secrets that can be referenced in code and webhook configurations.""" - - type: typing.Literal["asSecretsWithPlaintextValues"] + return self.model_dump(by_alias=True, exclude_none=True) class StsRoleConfiguration(pydantic.BaseModel): @@ -2243,49 +1209,9 @@ class StsRoleConfiguration(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StsRoleConfigurationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - StsRoleConfigurationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class StsRoleConfigurationDict(typing_extensions.TypedDict): - """StsRoleConfiguration""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - roleArn: str - """ - The Amazon Resource Name (ARN) of the role to assume. - For more information, see the official [AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-arn-format). - """ - - roleSessionName: str - """ - An identifier for the assumed role session. - The value can be any string that you assume will be unique within the AWS account. - For more information, see the official [AWS documentation](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#API_AssumeRole_RequestParameters). - """ - - roleSessionDuration: typing_extensions.NotRequired[core_models.DurationDict] - """ - The duration of the role session. - The value specified can range from 900 seconds (15 minutes) up to the maximum session duration set for the role. - The maximum session duration setting can have a value from 1 hour to 12 hours. For more details see the official [AWS documentation](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#API_AssumeRole_RequestParameters). - """ - - externalId: typing_extensions.NotRequired[str] - """ - A unique identifier that is used by third parties when assuming roles in their customers' accounts. - For more information, see the official [AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html). - """ - - stsEndpoint: typing_extensions.NotRequired[str] - """ - By default, the AWS Security Token Service (AWS STS) is available as a global service, and all AWS STS requests go to a single endpoint at https://sts.amazonaws.com. - AWS recommends using Regional AWS STS endpoints instead of the global endpoint to reduce latency, build in redundancy, and increase session token validity. - """ + return self.model_dump(by_alias=True, exclude_none=True) class TableImport(pydantic.BaseModel): @@ -2309,9 +1235,9 @@ class TableImport(pydantic.BaseModel): config: TableImportConfig model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TableImportDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(TableImportDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) TableImportAllowSchemaChanges = bool @@ -2331,42 +1257,6 @@ def to_dict(self) -> "TableImportDict": """The import configuration for a specific [connector type](/docs/foundry/data-integration/source-type-overview).""" -TableImportConfigDict = typing_extensions.Annotated[ - typing.Union[ - JdbcImportConfigDict, - MicrosoftSqlServerImportConfigDict, - PostgreSqlImportConfigDict, - MicrosoftAccessImportConfigDict, - OracleImportConfigDict, - ], - pydantic.Field(discriminator="type"), -] -"""The import configuration for a specific [connector type](/docs/foundry/data-integration/source-type-overview).""" - - -class TableImportDict(typing_extensions.TypedDict): - """TableImport""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: TableImportRid - connectionRid: ConnectionRid - """The RID of the Connection (also known as a source) that the Table Import uses to import data.""" - - datasetRid: datasets_models.DatasetRid - """The RID of the output dataset.""" - - branchName: typing_extensions.NotRequired[datasets_models.BranchName] - """The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments.""" - - displayName: TableImportDisplayName - importMode: TableImportMode - allowSchemaChanges: TableImportAllowSchemaChanges - """Allow the TableImport to succeed if the schema of imported rows does not match the existing dataset's schema. Defaults to false for new table imports.""" - - config: TableImportConfigDict - - TableImportDisplayName = str """TableImportDisplayName""" @@ -2389,165 +1279,92 @@ class TableImportDict(typing_extensions.TypedDict): core.resolve_forward_references(ConnectionConfiguration, globalns=globals(), localns=locals()) -core.resolve_forward_references(ConnectionConfigurationDict, globalns=globals(), localns=locals()) core.resolve_forward_references( CreateConnectionRequestConnectionConfiguration, globalns=globals(), localns=locals() ) -core.resolve_forward_references( - CreateConnectionRequestConnectionConfigurationDict, globalns=globals(), localns=locals() -) core.resolve_forward_references( CreateTableImportRequestTableImportConfig, globalns=globals(), localns=locals() ) -core.resolve_forward_references( - CreateTableImportRequestTableImportConfigDict, globalns=globals(), localns=locals() -) core.resolve_forward_references(EncryptedProperty, globalns=globals(), localns=locals()) -core.resolve_forward_references(EncryptedPropertyDict, globalns=globals(), localns=locals()) core.resolve_forward_references(FileImportFilter, globalns=globals(), localns=locals()) -core.resolve_forward_references(FileImportFilterDict, globalns=globals(), localns=locals()) core.resolve_forward_references(RestAuthenticationMode, globalns=globals(), localns=locals()) -core.resolve_forward_references(RestAuthenticationModeDict, globalns=globals(), localns=locals()) core.resolve_forward_references( RestConnectionAdditionalSecrets, globalns=globals(), localns=locals() ) -core.resolve_forward_references( - RestConnectionAdditionalSecretsDict, globalns=globals(), localns=locals() -) core.resolve_forward_references(RestRequestApiKeyLocation, globalns=globals(), localns=locals()) -core.resolve_forward_references(RestRequestApiKeyLocationDict, globalns=globals(), localns=locals()) core.resolve_forward_references(S3AuthenticationMode, globalns=globals(), localns=locals()) -core.resolve_forward_references(S3AuthenticationModeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(TableImportConfig, globalns=globals(), localns=locals()) -core.resolve_forward_references(TableImportConfigDict, globalns=globals(), localns=locals()) __all__ = [ "ApiKeyAuthentication", - "ApiKeyAuthenticationDict", "AsPlaintextValue", - "AsPlaintextValueDict", "AsSecretName", - "AsSecretNameDict", "AwsAccessKey", - "AwsAccessKeyDict", "AwsOidcAuthentication", - "AwsOidcAuthenticationDict", "BasicCredentials", - "BasicCredentialsDict", "BearerToken", - "BearerTokenDict", "CloudIdentity", - "CloudIdentityDict", "CloudIdentityRid", "Connection", "ConnectionConfiguration", - "ConnectionConfigurationDict", - "ConnectionDict", "ConnectionDisplayName", "ConnectionRid", "CreateConnectionRequestConnectionConfiguration", - "CreateConnectionRequestConnectionConfigurationDict", "CreateConnectionRequestJdbcConnectionConfiguration", - "CreateConnectionRequestJdbcConnectionConfigurationDict", "CreateConnectionRequestRestConnectionConfiguration", - "CreateConnectionRequestRestConnectionConfigurationDict", "CreateConnectionRequestS3ConnectionConfiguration", - "CreateConnectionRequestS3ConnectionConfigurationDict", "CreateTableImportRequestJdbcImportConfig", - "CreateTableImportRequestJdbcImportConfigDict", "CreateTableImportRequestMicrosoftAccessImportConfig", - "CreateTableImportRequestMicrosoftAccessImportConfigDict", "CreateTableImportRequestMicrosoftSqlServerImportConfig", - "CreateTableImportRequestMicrosoftSqlServerImportConfigDict", "CreateTableImportRequestOracleImportConfig", - "CreateTableImportRequestOracleImportConfigDict", "CreateTableImportRequestPostgreSqlImportConfig", - "CreateTableImportRequestPostgreSqlImportConfigDict", "CreateTableImportRequestTableImportConfig", - "CreateTableImportRequestTableImportConfigDict", "Domain", - "DomainDict", "EncryptedProperty", - "EncryptedPropertyDict", "FileAnyPathMatchesFilter", - "FileAnyPathMatchesFilterDict", "FileAtLeastCountFilter", - "FileAtLeastCountFilterDict", "FileChangedSinceLastUploadFilter", - "FileChangedSinceLastUploadFilterDict", "FileImport", "FileImportCustomFilter", - "FileImportCustomFilterDict", - "FileImportDict", "FileImportDisplayName", "FileImportFilter", - "FileImportFilterDict", "FileImportMode", "FileImportRid", "FileLastModifiedAfterFilter", - "FileLastModifiedAfterFilterDict", "FilePathMatchesFilter", - "FilePathMatchesFilterDict", "FilePathNotMatchesFilter", - "FilePathNotMatchesFilterDict", "FileProperty", "FileSizeFilter", - "FileSizeFilterDict", "FilesCountLimitFilter", - "FilesCountLimitFilterDict", "HeaderApiKey", - "HeaderApiKeyDict", "JdbcConnectionConfiguration", - "JdbcConnectionConfigurationDict", "JdbcImportConfig", - "JdbcImportConfigDict", "ListFileImportsResponse", - "ListFileImportsResponseDict", "ListTableImportsResponse", - "ListTableImportsResponseDict", "MicrosoftAccessImportConfig", - "MicrosoftAccessImportConfigDict", "MicrosoftSqlServerImportConfig", - "MicrosoftSqlServerImportConfigDict", "OracleImportConfig", - "OracleImportConfigDict", "PlaintextValue", "PostgreSqlImportConfig", - "PostgreSqlImportConfigDict", "Protocol", "QueryParameterApiKey", - "QueryParameterApiKeyDict", "Region", "RestAuthenticationMode", - "RestAuthenticationModeDict", "RestConnectionAdditionalSecrets", - "RestConnectionAdditionalSecretsDict", "RestConnectionConfiguration", - "RestConnectionConfigurationDict", "RestConnectionOAuth2", - "RestConnectionOAuth2Dict", "RestRequestApiKeyLocation", - "RestRequestApiKeyLocationDict", "S3AuthenticationMode", - "S3AuthenticationModeDict", "S3ConnectionConfiguration", - "S3ConnectionConfigurationDict", "S3KmsConfiguration", - "S3KmsConfigurationDict", "S3ProxyConfiguration", - "S3ProxyConfigurationDict", "SecretName", "SecretsNames", - "SecretsNamesDict", "SecretsWithPlaintextValues", - "SecretsWithPlaintextValuesDict", "StsRoleConfiguration", - "StsRoleConfigurationDict", "TableImport", "TableImportAllowSchemaChanges", "TableImportConfig", - "TableImportConfigDict", - "TableImportDict", "TableImportDisplayName", "TableImportMode", "TableImportRid", diff --git a/foundry/v2/connectivity/table_import.py b/foundry/v2/connectivity/table_import.py index bb0013d36..a176813d0 100644 --- a/foundry/v2/connectivity/table_import.py +++ b/foundry/v2/connectivity/table_import.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -58,10 +57,7 @@ def create( self, connection_rid: connectivity_models.ConnectionRid, *, - config: typing.Union[ - connectivity_models.CreateTableImportRequestTableImportConfig, - connectivity_models.CreateTableImportRequestTableImportConfigDict, - ], + config: connectivity_models.CreateTableImportRequestTableImportConfig, dataset_rid: datasets_models.DatasetRid, display_name: connectivity_models.TableImportDisplayName, import_mode: connectivity_models.TableImportMode, @@ -78,7 +74,7 @@ def create( :param connection_rid: :type connection_rid: ConnectionRid :param config: - :type config: Union[CreateTableImportRequestTableImportConfig, CreateTableImportRequestTableImportConfigDict] + :type config: CreateTableImportRequestTableImportConfig :param dataset_rid: The RID of the output dataset. :type dataset_rid: DatasetRid :param display_name: @@ -136,10 +132,7 @@ def create( connectivity_models.TableImportAllowSchemaChanges ], "branchName": typing.Optional[datasets_models.BranchName], - "config": typing.Union[ - connectivity_models.CreateTableImportRequestTableImportConfig, - connectivity_models.CreateTableImportRequestTableImportConfigDict, - ], + "config": connectivity_models.CreateTableImportRequestTableImportConfig, }, ), response_type=connectivity_models.TableImport, @@ -379,71 +372,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - connection_rid: connectivity_models.ConnectionRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> connectivity_models.ListTableImportsResponse: - """ - Lists all table imports defined for this connection. - Only table imports that the user has permissions to view will be returned. - - :param connection_rid: - :type connection_rid: ConnectionRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: connectivity_models.ListTableImportsResponse - - :raises ConnectionNotFound: The given Connection could not be found. - """ - - warnings.warn( - "The client.connectivity.TableImport.page(...) method has been deprecated. Please use client.connectivity.TableImport.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/connectivity/connections/{connectionRid}/tableImports", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "connectionRid": connection_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=connectivity_models.ListTableImportsResponse, - request_timeout=request_timeout, - throwable_errors={ - "ConnectionNotFound": connectivity_errors.ConnectionNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _TableImportClientRaw: def __init__(self, client: TableImportClient) -> None: @@ -452,14 +380,12 @@ def delete(_: None): ... def execute(_: core_models.BuildRid): ... def get(_: connectivity_models.TableImport): ... def list(_: connectivity_models.ListTableImportsResponse): ... - def page(_: connectivity_models.ListTableImportsResponse): ... self.create = core.with_raw_response(create, client.create) self.delete = core.with_raw_response(delete, client.delete) self.execute = core.with_raw_response(execute, client.execute) self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) class _TableImportClientStreaming: @@ -468,10 +394,8 @@ def create(_: connectivity_models.TableImport): ... def execute(_: core_models.BuildRid): ... def get(_: connectivity_models.TableImport): ... def list(_: connectivity_models.ListTableImportsResponse): ... - def page(_: connectivity_models.ListTableImportsResponse): ... self.create = core.with_streaming_response(create, client.create) self.execute = core.with_streaming_response(execute, client.execute) self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/core/errors.py b/foundry/v2/core/errors.py index 9fb6c65c8..1c4f596d1 100644 --- a/foundry/v2/core/errors.py +++ b/foundry/v2/core/errors.py @@ -136,7 +136,7 @@ class InvalidFilterValueParameters(typing_extensions.TypedDict): field: str value: typing.Any - expectedType: core_models.FilterTypeDict + expectedType: core_models.FilterType @dataclass diff --git a/foundry/v2/core/models.py b/foundry/v2/core/models.py index 5e50306ec..f0c79a80a 100644 --- a/foundry/v2/core/models.py +++ b/foundry/v2/core/models.py @@ -30,17 +30,9 @@ class AnyType(pydantic.BaseModel): type: typing.Literal["any"] = "any" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AnyTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AnyTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AnyTypeDict(typing_extensions.TypedDict): - """AnyType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["any"] + return self.model_dump(by_alias=True, exclude_none=True) class ArrayFieldType(pydantic.BaseModel): @@ -50,18 +42,9 @@ class ArrayFieldType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ArrayFieldTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ArrayFieldTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ArrayFieldTypeDict(typing_extensions.TypedDict): - """ArrayFieldType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - itemsSchema: FieldSchemaDict - type: typing.Literal["array"] + return self.model_dump(by_alias=True, exclude_none=True) class AttachmentType(pydantic.BaseModel): @@ -70,17 +53,9 @@ class AttachmentType(pydantic.BaseModel): type: typing.Literal["attachment"] = "attachment" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AttachmentTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AttachmentTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AttachmentTypeDict(typing_extensions.TypedDict): - """AttachmentType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["attachment"] + return self.model_dump(by_alias=True, exclude_none=True) class BinaryType(pydantic.BaseModel): @@ -89,17 +64,9 @@ class BinaryType(pydantic.BaseModel): type: typing.Literal["binary"] = "binary" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BinaryTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(BinaryTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class BinaryTypeDict(typing_extensions.TypedDict): - """BinaryType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["binary"] + return self.model_dump(by_alias=True, exclude_none=True) class BooleanType(pydantic.BaseModel): @@ -108,17 +75,9 @@ class BooleanType(pydantic.BaseModel): type: typing.Literal["boolean"] = "boolean" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BooleanTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(BooleanTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class BooleanTypeDict(typing_extensions.TypedDict): - """BooleanType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["boolean"] + return self.model_dump(by_alias=True, exclude_none=True) BuildRid = core.RID @@ -131,17 +90,9 @@ class ByteType(pydantic.BaseModel): type: typing.Literal["byte"] = "byte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ByteTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ByteTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ByteTypeDict(typing_extensions.TypedDict): - """ByteType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["byte"] + return self.model_dump(by_alias=True, exclude_none=True) class CipherTextType(pydantic.BaseModel): @@ -153,20 +104,9 @@ class CipherTextType(pydantic.BaseModel): type: typing.Literal["cipherText"] = "cipherText" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CipherTextTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(CipherTextTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class CipherTextTypeDict(typing_extensions.TypedDict): - """CipherTextType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - defaultCipherChannel: typing_extensions.NotRequired[core.RID] - """An optional Cipher Channel RID which can be used for encryption updates to empty values.""" - - type: typing.Literal["cipherText"] + return self.model_dump(by_alias=True, exclude_none=True) ContentLength = core.Long @@ -191,17 +131,9 @@ class DateType(pydantic.BaseModel): type: typing.Literal["date"] = "date" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DateTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DateTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DateTypeDict(typing_extensions.TypedDict): - """DateType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["date"] + return self.model_dump(by_alias=True, exclude_none=True) class DecimalType(pydantic.BaseModel): @@ -216,23 +148,9 @@ class DecimalType(pydantic.BaseModel): type: typing.Literal["decimal"] = "decimal" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DecimalTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DecimalTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DecimalTypeDict(typing_extensions.TypedDict): - """DecimalType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - precision: typing_extensions.NotRequired[int] - """The total number of digits of the Decimal type. The maximum value is 38.""" - - scale: typing_extensions.NotRequired[int] - """The number of digits to the right of the decimal point. The maximum value is 38.""" - - type: typing.Literal["decimal"] + return self.model_dump(by_alias=True, exclude_none=True) DisplayName = str @@ -246,18 +164,9 @@ class Distance(pydantic.BaseModel): unit: DistanceUnit model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DistanceDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DistanceDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DistanceDict(typing_extensions.TypedDict): - """A measurement of distance.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: float - unit: DistanceUnit + return self.model_dump(by_alias=True, exclude_none=True) DistanceUnit = typing.Literal[ @@ -280,17 +189,9 @@ class DoubleType(pydantic.BaseModel): type: typing.Literal["double"] = "double" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DoubleTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DoubleTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DoubleTypeDict(typing_extensions.TypedDict): - """DoubleType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["double"] + return self.model_dump(by_alias=True, exclude_none=True) class Duration(pydantic.BaseModel): @@ -304,21 +205,9 @@ class Duration(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DurationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DurationDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DurationDict(typing_extensions.TypedDict): - """A measurement of duration.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: int - """The duration value.""" - - unit: TimeUnit - """The unit of duration.""" + return self.model_dump(by_alias=True, exclude_none=True) EmbeddingModel = typing_extensions.Annotated[ @@ -327,13 +216,6 @@ class DurationDict(typing_extensions.TypedDict): """EmbeddingModel""" -EmbeddingModelDict = typing_extensions.Annotated[ - typing.Union["LmsEmbeddingModelDict", "FoundryLiveDeploymentDict"], - pydantic.Field(discriminator="type"), -] -"""EmbeddingModel""" - - EnrollmentRid = core.RID """EnrollmentRid""" @@ -348,9 +230,9 @@ class Field(pydantic.BaseModel): schema_: FieldSchema = pydantic.Field(alias=str("schema")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FieldDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(FieldDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) FieldDataType = typing_extensions.Annotated[ @@ -376,41 +258,6 @@ def to_dict(self) -> "FieldDict": """FieldDataType""" -FieldDataTypeDict = typing_extensions.Annotated[ - typing.Union[ - "StructFieldTypeDict", - DateTypeDict, - "StringTypeDict", - ByteTypeDict, - DoubleTypeDict, - "IntegerTypeDict", - "FloatTypeDict", - "LongTypeDict", - BooleanTypeDict, - ArrayFieldTypeDict, - BinaryTypeDict, - "ShortTypeDict", - DecimalTypeDict, - "MapFieldTypeDict", - "TimestampTypeDict", - ], - pydantic.Field(discriminator="type"), -] -"""FieldDataType""" - - -class FieldDict(typing_extensions.TypedDict): - """ - A field in a Foundry schema. For more information on supported data types, see the - [supported field types](/docs/foundry/data-integration/datasets/#supported-field-types) user documentation. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: FieldName - schema: FieldSchemaDict - - FieldName = str """FieldName""" @@ -423,19 +270,9 @@ class FieldSchema(pydantic.BaseModel): data_type: FieldDataType = pydantic.Field(alias=str("dataType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FieldSchemaDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(FieldSchemaDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class FieldSchemaDict(typing_extensions.TypedDict): - """The specification of the type of a Foundry schema field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nullable: bool - customMetadata: typing_extensions.NotRequired[CustomMetadata] - dataType: FieldDataTypeDict + return self.model_dump(by_alias=True, exclude_none=True) FilePath = str @@ -446,123 +283,159 @@ class FieldSchemaDict(typing_extensions.TypedDict): """The name of a File within Foundry. Examples: `my-file.txt`, `my-file.jpg`, `dataframe.snappy.parquet`.""" -class FilterBinaryTypeDict(typing_extensions.TypedDict): +class FilterBinaryType(pydantic.BaseModel): """FilterBinaryType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + type: typing.Literal["binary"] = "binary" + model_config = {"extra": "allow", "populate_by_name": True} - type: typing.Literal["binary"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -class FilterBooleanTypeDict(typing_extensions.TypedDict): +class FilterBooleanType(pydantic.BaseModel): """FilterBooleanType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + type: typing.Literal["boolean"] = "boolean" + model_config = {"extra": "allow", "populate_by_name": True} - type: typing.Literal["boolean"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -class FilterDateTimeTypeDict(typing_extensions.TypedDict): +class FilterDateTimeType(pydantic.BaseModel): """FilterDateTimeType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + type: typing.Literal["dateTime"] = "dateTime" + model_config = {"extra": "allow", "populate_by_name": True} - type: typing.Literal["dateTime"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -class FilterDateTypeDict(typing_extensions.TypedDict): +class FilterDateType(pydantic.BaseModel): """FilterDateType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + type: typing.Literal["date"] = "date" + model_config = {"extra": "allow", "populate_by_name": True} - type: typing.Literal["date"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -class FilterDoubleTypeDict(typing_extensions.TypedDict): +class FilterDoubleType(pydantic.BaseModel): """FilterDoubleType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + type: typing.Literal["double"] = "double" + model_config = {"extra": "allow", "populate_by_name": True} - type: typing.Literal["double"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -class FilterEnumTypeDict(typing_extensions.TypedDict): +class FilterEnumType(pydantic.BaseModel): """FilterEnumType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore - values: typing.List[str] """The values allowed by the enum type.""" - type: typing.Literal["enum"] + type: typing.Literal["enum"] = "enum" + model_config = {"extra": "allow", "populate_by_name": True} + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -class FilterFloatTypeDict(typing_extensions.TypedDict): + +class FilterFloatType(pydantic.BaseModel): """FilterFloatType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + type: typing.Literal["float"] = "float" + model_config = {"extra": "allow", "populate_by_name": True} - type: typing.Literal["float"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -class FilterIntegerTypeDict(typing_extensions.TypedDict): +class FilterIntegerType(pydantic.BaseModel): """FilterIntegerType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + type: typing.Literal["integer"] = "integer" + model_config = {"extra": "allow", "populate_by_name": True} - type: typing.Literal["integer"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -class FilterLongTypeDict(typing_extensions.TypedDict): +class FilterLongType(pydantic.BaseModel): """FilterLongType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + type: typing.Literal["long"] = "long" + model_config = {"extra": "allow", "populate_by_name": True} - type: typing.Literal["long"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -class FilterRidTypeDict(typing_extensions.TypedDict): +class FilterRidType(pydantic.BaseModel): """FilterRidType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + type: typing.Literal["rid"] = "rid" + model_config = {"extra": "allow", "populate_by_name": True} - type: typing.Literal["rid"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -class FilterStringTypeDict(typing_extensions.TypedDict): +class FilterStringType(pydantic.BaseModel): """FilterStringType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + type: typing.Literal["string"] = "string" + model_config = {"extra": "allow", "populate_by_name": True} - type: typing.Literal["string"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) -FilterTypeDict = typing_extensions.Annotated[ +FilterType = typing_extensions.Annotated[ typing.Union[ - FilterDateTimeTypeDict, - FilterDateTypeDict, - FilterBooleanTypeDict, - FilterStringTypeDict, - FilterDoubleTypeDict, - FilterBinaryTypeDict, - FilterIntegerTypeDict, - FilterFloatTypeDict, - FilterRidTypeDict, - "FilterUuidTypeDict", - FilterEnumTypeDict, - FilterLongTypeDict, + FilterDateTimeType, + FilterDateType, + FilterBooleanType, + FilterStringType, + FilterDoubleType, + FilterBinaryType, + FilterIntegerType, + FilterFloatType, + FilterRidType, + "FilterUuidType", + FilterEnumType, + FilterLongType, ], pydantic.Field(discriminator="type"), ] """FilterType""" -class FilterUuidTypeDict(typing_extensions.TypedDict): +class FilterUuidType(pydantic.BaseModel): """FilterUuidType""" - __pydantic_config__ = {"extra": "allow"} # type: ignore + type: typing.Literal["uuid"] = "uuid" + model_config = {"extra": "allow", "populate_by_name": True} - type: typing.Literal["uuid"] + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) class FloatType(pydantic.BaseModel): @@ -571,17 +444,9 @@ class FloatType(pydantic.BaseModel): type: typing.Literal["float"] = "float" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FloatTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(FloatTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class FloatTypeDict(typing_extensions.TypedDict): - """FloatType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["float"] + return self.model_dump(by_alias=True, exclude_none=True) FolderRid = core.RID @@ -603,28 +468,9 @@ class FoundryLiveDeployment(pydantic.BaseModel): type: typing.Literal["foundryLiveDeployment"] = "foundryLiveDeployment" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FoundryLiveDeploymentDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - FoundryLiveDeploymentDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class FoundryLiveDeploymentDict(typing_extensions.TypedDict): - """FoundryLiveDeployment""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: typing_extensions.NotRequired[core.RID] - """The live deployment identifier. This rid is of the format 'ri.foundry-ml-live.main.live-deployment.'.""" - - inputParamName: typing_extensions.NotRequired[str] - """The name of the input parameter to the model which should contain the query string.""" - - outputParamName: typing_extensions.NotRequired[str] - """The name of the output parameter to the model which should contain the computed embedding.""" - - type: typing.Literal["foundryLiveDeployment"] + return self.model_dump(by_alias=True, exclude_none=True) class FullRowChangeDataCaptureConfiguration(pydantic.BaseModel): @@ -655,42 +501,9 @@ class FullRowChangeDataCaptureConfiguration(pydantic.BaseModel): type: typing.Literal["fullRow"] = "fullRow" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FullRowChangeDataCaptureConfigurationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - FullRowChangeDataCaptureConfigurationDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class FullRowChangeDataCaptureConfigurationDict(typing_extensions.TypedDict): - """ - Configuration for change data capture which resolves the latest state of the dataset based on new full rows - being pushed to the stream. For example, if a value for a row is updated, it is only sufficient to publish - the entire new state of that row to the stream. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - deletionFieldName: FieldName - """The name of a boolean field in the schema that indicates whether or not a row has been deleted.""" - - orderingFieldName: FieldName - """ - The name of an ordering field that determines the newest state for a row in the dataset. - - The ordering field can only be of the following types: - - Byte - - Date - - Decimal - - Integer - - Long - - Short - - String - - Timestamp - """ - - type: typing.Literal["fullRow"] + return self.model_dump(by_alias=True, exclude_none=True) class GeoPointType(pydantic.BaseModel): @@ -699,17 +512,9 @@ class GeoPointType(pydantic.BaseModel): type: typing.Literal["geopoint"] = "geopoint" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GeoPointTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(GeoPointTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class GeoPointTypeDict(typing_extensions.TypedDict): - """GeoPointType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["geopoint"] + return self.model_dump(by_alias=True, exclude_none=True) class GeoShapeType(pydantic.BaseModel): @@ -718,17 +523,9 @@ class GeoShapeType(pydantic.BaseModel): type: typing.Literal["geoshape"] = "geoshape" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GeoShapeTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(GeoShapeTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class GeoShapeTypeDict(typing_extensions.TypedDict): - """GeoShapeType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["geoshape"] + return self.model_dump(by_alias=True, exclude_none=True) class GeotimeSeriesReferenceType(pydantic.BaseModel): @@ -737,19 +534,9 @@ class GeotimeSeriesReferenceType(pydantic.BaseModel): type: typing.Literal["geotimeSeriesReference"] = "geotimeSeriesReference" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GeotimeSeriesReferenceTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GeotimeSeriesReferenceTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GeotimeSeriesReferenceTypeDict(typing_extensions.TypedDict): - """GeotimeSeriesReferenceType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["geotimeSeriesReference"] + return self.model_dump(by_alias=True, exclude_none=True) GroupName = str @@ -766,17 +553,9 @@ class IntegerType(pydantic.BaseModel): type: typing.Literal["integer"] = "integer" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "IntegerTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(IntegerTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class IntegerTypeDict(typing_extensions.TypedDict): - """IntegerType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["integer"] + return self.model_dump(by_alias=True, exclude_none=True) JobRid = core.RID @@ -790,18 +569,9 @@ class LmsEmbeddingModel(pydantic.BaseModel): type: typing.Literal["lms"] = "lms" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LmsEmbeddingModelDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(LmsEmbeddingModelDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class LmsEmbeddingModelDict(typing_extensions.TypedDict): - """A model provided by Language Model Service.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: LmsEmbeddingModelValue - type: typing.Literal["lms"] + return self.model_dump(by_alias=True, exclude_none=True) LmsEmbeddingModelValue = typing.Literal[ @@ -820,17 +590,9 @@ class LongType(pydantic.BaseModel): type: typing.Literal["long"] = "long" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LongTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(LongTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class LongTypeDict(typing_extensions.TypedDict): - """LongType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["long"] + return self.model_dump(by_alias=True, exclude_none=True) class MapFieldType(pydantic.BaseModel): @@ -841,19 +603,9 @@ class MapFieldType(pydantic.BaseModel): type: typing.Literal["map"] = "map" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MapFieldTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MapFieldTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MapFieldTypeDict(typing_extensions.TypedDict): - """MapFieldType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keySchema: FieldSchemaDict - valueSchema: FieldSchemaDict - type: typing.Literal["map"] + return self.model_dump(by_alias=True, exclude_none=True) MarkingId = core.UUID @@ -866,17 +618,9 @@ class MarkingType(pydantic.BaseModel): type: typing.Literal["marking"] = "marking" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MarkingTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MarkingTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MarkingTypeDict(typing_extensions.TypedDict): - """MarkingType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["marking"] + return self.model_dump(by_alias=True, exclude_none=True) MediaItemPath = str @@ -903,18 +647,9 @@ class MediaReference(pydantic.BaseModel): reference: Reference model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MediaReferenceDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MediaReferenceDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MediaReferenceDict(typing_extensions.TypedDict): - """The representation of a media reference.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - mimeType: MediaType - reference: ReferenceDict + return self.model_dump(by_alias=True, exclude_none=True) class MediaReferenceType(pydantic.BaseModel): @@ -923,19 +658,9 @@ class MediaReferenceType(pydantic.BaseModel): type: typing.Literal["mediaReference"] = "mediaReference" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MediaReferenceTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - MediaReferenceTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class MediaReferenceTypeDict(typing_extensions.TypedDict): - """MediaReferenceType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["mediaReference"] + return self.model_dump(by_alias=True, exclude_none=True) MediaSetRid = core.RID @@ -951,20 +676,9 @@ class MediaSetViewItem(pydantic.BaseModel): token: typing.Optional[MediaItemReadToken] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MediaSetViewItemDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MediaSetViewItemDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MediaSetViewItemDict(typing_extensions.TypedDict): - """MediaSetViewItem""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - mediaSetRid: MediaSetRid - mediaSetViewRid: MediaSetViewRid - mediaItemRid: MediaItemRid - token: typing_extensions.NotRequired[MediaItemReadToken] + return self.model_dump(by_alias=True, exclude_none=True) class MediaSetViewItemWrapper(pydantic.BaseModel): @@ -974,20 +688,9 @@ class MediaSetViewItemWrapper(pydantic.BaseModel): type: typing.Literal["mediaSetViewItem"] = "mediaSetViewItem" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MediaSetViewItemWrapperDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - MediaSetViewItemWrapperDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class MediaSetViewItemWrapperDict(typing_extensions.TypedDict): - """MediaSetViewItemWrapper""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - mediaSetViewItem: MediaSetViewItemDict - type: typing.Literal["mediaSetViewItem"] + return self.model_dump(by_alias=True, exclude_none=True) MediaSetViewRid = core.RID @@ -1007,17 +710,9 @@ class NullType(pydantic.BaseModel): type: typing.Literal["null"] = "null" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "NullTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(NullTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class NullTypeDict(typing_extensions.TypedDict): - """NullType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["null"] + return self.model_dump(by_alias=True, exclude_none=True) OperationScope = str @@ -1081,17 +776,9 @@ class ShortType(pydantic.BaseModel): type: typing.Literal["short"] = "short" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ShortTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ShortTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ShortTypeDict(typing_extensions.TypedDict): - """ShortType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["short"] + return self.model_dump(by_alias=True, exclude_none=True) SizeBytes = core.Long @@ -1127,40 +814,9 @@ class StreamSchema(pydantic.BaseModel): change_data_capture: typing.Optional[ChangeDataCaptureConfiguration] = pydantic.Field(alias=str("changeDataCapture"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StreamSchemaDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(StreamSchemaDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class StreamSchemaDict(typing_extensions.TypedDict): - """The schema for a Foundry stream. Records pushed to this stream must match this schema.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: typing.List[FieldDict] - keyFieldNames: typing_extensions.NotRequired[typing.List[FieldName]] - """ - The names of the fields to be used as keys for partitioning records. These key fields are used to group - all records with the same key into the same partition, to guarantee processing order of grouped records. These - keys are not meant to uniquely identify records, and do not by themselves deduplicate records. To deduplicate - records, provide a change data capture configuration for the schema. - - Key fields can only be of the following types: - - Boolean - - Byte - - Date - - Decimal - - Integer - - Long - - Short - - String - - Timestamp - - For additional information on keys for Foundry streams, see the - [streaming keys](/docs/foundry/building-pipelines/streaming-keys/) user documentation. - """ - - changeDataCapture: typing_extensions.NotRequired[ChangeDataCaptureConfigurationDict] + return self.model_dump(by_alias=True, exclude_none=True) class StringType(pydantic.BaseModel): @@ -1169,17 +825,9 @@ class StringType(pydantic.BaseModel): type: typing.Literal["string"] = "string" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StringTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(StringTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class StringTypeDict(typing_extensions.TypedDict): - """StringType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["string"] + return self.model_dump(by_alias=True, exclude_none=True) StructFieldName = str @@ -1193,18 +841,9 @@ class StructFieldType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StructFieldTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(StructFieldTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class StructFieldTypeDict(typing_extensions.TypedDict): - """StructFieldType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subFields: typing.List[FieldDict] - type: typing.Literal["struct"] + return self.model_dump(by_alias=True, exclude_none=True) TimeSeriesItemType = typing_extensions.Annotated[ @@ -1213,12 +852,6 @@ class StructFieldTypeDict(typing_extensions.TypedDict): """A union of the types supported by time series properties.""" -TimeSeriesItemTypeDict = typing_extensions.Annotated[ - typing.Union[StringTypeDict, DoubleTypeDict], pydantic.Field(discriminator="type") -] -"""A union of the types supported by time series properties.""" - - TimeUnit = typing.Literal[ "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS" ] @@ -1232,18 +865,9 @@ class TimeseriesType(pydantic.BaseModel): type: typing.Literal["timeseries"] = "timeseries" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TimeseriesTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(TimeseriesTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class TimeseriesTypeDict(typing_extensions.TypedDict): - """TimeseriesType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - itemType: typing_extensions.NotRequired[TimeSeriesItemTypeDict] - type: typing.Literal["timeseries"] + return self.model_dump(by_alias=True, exclude_none=True) class TimestampType(pydantic.BaseModel): @@ -1252,17 +876,9 @@ class TimestampType(pydantic.BaseModel): type: typing.Literal["timestamp"] = "timestamp" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TimestampTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(TimestampTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class TimestampTypeDict(typing_extensions.TypedDict): - """TimestampType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["timestamp"] + return self.model_dump(by_alias=True, exclude_none=True) TotalCount = core.Long @@ -1276,18 +892,9 @@ class UnsupportedType(pydantic.BaseModel): type: typing.Literal["unsupported"] = "unsupported" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "UnsupportedTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(UnsupportedTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class UnsupportedTypeDict(typing_extensions.TypedDict): - """UnsupportedType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - unsupportedType: str - type: typing.Literal["unsupported"] + return self.model_dump(by_alias=True, exclude_none=True) UpdatedTime = datetime @@ -1307,22 +914,9 @@ class VectorSimilarityFunction(pydantic.BaseModel): value: typing.Optional[VectorSimilarityFunctionValue] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "VectorSimilarityFunctionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - VectorSimilarityFunctionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class VectorSimilarityFunctionDict(typing_extensions.TypedDict): - """ - The vector similarity function to support approximate nearest neighbors search. Will result in an index - specific for the function. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: typing_extensions.NotRequired[VectorSimilarityFunctionValue] + return self.model_dump(by_alias=True, exclude_none=True) VectorSimilarityFunctionValue = typing.Literal[ @@ -1342,22 +936,9 @@ class VectorType(pydantic.BaseModel): type: typing.Literal["vector"] = "vector" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "VectorTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(VectorTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class VectorTypeDict(typing_extensions.TypedDict): - """Represents a fixed size vector of floats. These can be used for vector similarity searches.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - dimension: int - """The dimension of the vector.""" - - supportsSearchWith: typing.List[VectorSimilarityFunctionDict] - embeddingModel: typing_extensions.NotRequired[EmbeddingModelDict] - type: typing.Literal["vector"] + return self.model_dump(by_alias=True, exclude_none=True) ZoneId = str @@ -1374,16 +955,6 @@ class VectorTypeDict(typing_extensions.TypedDict): """ -ChangeDataCaptureConfigurationDict = FullRowChangeDataCaptureConfigurationDict -""" -Configuration for utilizing the stream as a change data capture (CDC) dataset. To configure CDC on a stream, at -least one key needs to be provided. - -For more information on CDC in -Foundry, see the [Change Data Capture](/docs/foundry/data-integration/change-data-capture/) user documentation. -""" - - CreatedBy = PrincipalId """The Foundry user who created this resource""" @@ -1392,127 +963,87 @@ class VectorTypeDict(typing_extensions.TypedDict): """A union of the types supported by media reference properties.""" -ReferenceDict = MediaSetViewItemWrapperDict -"""A union of the types supported by media reference properties.""" - - UpdatedBy = UserId """The Foundry user who last updated this resource""" core.resolve_forward_references(CustomMetadata, globalns=globals(), localns=locals()) core.resolve_forward_references(EmbeddingModel, globalns=globals(), localns=locals()) -core.resolve_forward_references(EmbeddingModelDict, globalns=globals(), localns=locals()) core.resolve_forward_references(FieldDataType, globalns=globals(), localns=locals()) -core.resolve_forward_references(FieldDataTypeDict, globalns=globals(), localns=locals()) -core.resolve_forward_references(FilterTypeDict, globalns=globals(), localns=locals()) +core.resolve_forward_references(FilterType, globalns=globals(), localns=locals()) core.resolve_forward_references(TimeSeriesItemType, globalns=globals(), localns=locals()) -core.resolve_forward_references(TimeSeriesItemTypeDict, globalns=globals(), localns=locals()) __all__ = [ "AnyType", - "AnyTypeDict", "ArrayFieldType", - "ArrayFieldTypeDict", "AttachmentType", - "AttachmentTypeDict", "BinaryType", - "BinaryTypeDict", "BooleanType", - "BooleanTypeDict", "BuildRid", "ByteType", - "ByteTypeDict", "ChangeDataCaptureConfiguration", - "ChangeDataCaptureConfigurationDict", "CipherTextType", - "CipherTextTypeDict", "ContentLength", "ContentType", "CreatedBy", "CreatedTime", "CustomMetadata", "DateType", - "DateTypeDict", "DecimalType", - "DecimalTypeDict", "DisplayName", "Distance", - "DistanceDict", "DistanceUnit", "DoubleType", - "DoubleTypeDict", "Duration", - "DurationDict", "EmbeddingModel", - "EmbeddingModelDict", "EnrollmentRid", "Field", "FieldDataType", - "FieldDataTypeDict", - "FieldDict", "FieldName", "FieldSchema", - "FieldSchemaDict", "FilePath", "Filename", - "FilterBinaryTypeDict", - "FilterBooleanTypeDict", - "FilterDateTimeTypeDict", - "FilterDateTypeDict", - "FilterDoubleTypeDict", - "FilterEnumTypeDict", - "FilterFloatTypeDict", - "FilterIntegerTypeDict", - "FilterLongTypeDict", - "FilterRidTypeDict", - "FilterStringTypeDict", - "FilterTypeDict", - "FilterUuidTypeDict", + "FilterBinaryType", + "FilterBooleanType", + "FilterDateTimeType", + "FilterDateType", + "FilterDoubleType", + "FilterEnumType", + "FilterFloatType", + "FilterIntegerType", + "FilterLongType", + "FilterRidType", + "FilterStringType", + "FilterType", + "FilterUuidType", "FloatType", - "FloatTypeDict", "FolderRid", "FoundryLiveDeployment", - "FoundryLiveDeploymentDict", "FullRowChangeDataCaptureConfiguration", - "FullRowChangeDataCaptureConfigurationDict", "GeoPointType", - "GeoPointTypeDict", "GeoShapeType", - "GeoShapeTypeDict", "GeotimeSeriesReferenceType", - "GeotimeSeriesReferenceTypeDict", "GroupName", "GroupRid", "IntegerType", - "IntegerTypeDict", "JobRid", "LmsEmbeddingModel", - "LmsEmbeddingModelDict", "LmsEmbeddingModelValue", "LongType", - "LongTypeDict", "MapFieldType", - "MapFieldTypeDict", "MarkingId", "MarkingType", - "MarkingTypeDict", "MediaItemPath", "MediaItemReadToken", "MediaItemRid", "MediaReference", - "MediaReferenceDict", "MediaReferenceType", - "MediaReferenceTypeDict", "MediaSetRid", "MediaSetViewItem", - "MediaSetViewItemDict", "MediaSetViewItemWrapper", - "MediaSetViewItemWrapperDict", "MediaSetViewRid", "MediaType", "NullType", - "NullTypeDict", "OperationScope", "OrderByDirection", "OrganizationRid", @@ -1523,36 +1054,25 @@ class VectorTypeDict(typing_extensions.TypedDict): "PrincipalType", "Realm", "Reference", - "ReferenceDict", "ReleaseStatus", "RoleId", "ShortType", - "ShortTypeDict", "SizeBytes", "StreamSchema", - "StreamSchemaDict", "StringType", - "StringTypeDict", "StructFieldName", "StructFieldType", - "StructFieldTypeDict", "TimeSeriesItemType", - "TimeSeriesItemTypeDict", "TimeUnit", "TimeseriesType", - "TimeseriesTypeDict", "TimestampType", - "TimestampTypeDict", "TotalCount", "UnsupportedType", - "UnsupportedTypeDict", "UpdatedBy", "UpdatedTime", "UserId", "VectorSimilarityFunction", - "VectorSimilarityFunctionDict", "VectorSimilarityFunctionValue", "VectorType", - "VectorTypeDict", "ZoneId", ] diff --git a/foundry/v2/datasets/branch.py b/foundry/v2/datasets/branch.py index b1ba13b5a..eb79b339d 100644 --- a/foundry/v2/datasets/branch.py +++ b/foundry/v2/datasets/branch.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -272,68 +271,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - dataset_rid: datasets_models.DatasetRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> datasets_models.ListBranchesResponse: - """ - Lists the Branches of a Dataset. - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: datasets_models.ListBranchesResponse - - :raises BranchNotFound: The requested branch could not be found, or the client token does not have access to it. - :raises DatasetNotFound: The requested dataset could not be found, or the client token does not have access to it. - """ - - warnings.warn( - "The client.datasets.Branch.page(...) method has been deprecated. Please use client.datasets.Branch.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/datasets/{datasetRid}/branches", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - }, - path_params={ - "datasetRid": dataset_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=datasets_models.ListBranchesResponse, - request_timeout=request_timeout, - throwable_errors={ - "BranchNotFound": datasets_errors.BranchNotFound, - "DatasetNotFound": datasets_errors.DatasetNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _BranchClientRaw: def __init__(self, client: BranchClient) -> None: @@ -341,13 +278,11 @@ def create(_: datasets_models.Branch): ... def delete(_: None): ... def get(_: datasets_models.Branch): ... def list(_: datasets_models.ListBranchesResponse): ... - def page(_: datasets_models.ListBranchesResponse): ... self.create = core.with_raw_response(create, client.create) self.delete = core.with_raw_response(delete, client.delete) self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) class _BranchClientStreaming: @@ -355,9 +290,7 @@ def __init__(self, client: BranchClient) -> None: def create(_: datasets_models.Branch): ... def get(_: datasets_models.Branch): ... def list(_: datasets_models.ListBranchesResponse): ... - def page(_: datasets_models.ListBranchesResponse): ... self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/datasets/client.py b/foundry/v2/datasets/client.py deleted file mode 100644 index 3bef47542..000000000 --- a/foundry/v2/datasets/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v2.datasets._client import DatasetsClient - -__all__ = [ - "DatasetsClient", -] diff --git a/foundry/v2/datasets/file.py b/foundry/v2/datasets/file.py index 2f118f1ea..fe289e616 100644 --- a/foundry/v2/datasets/file.py +++ b/foundry/v2/datasets/file.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -372,97 +371,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - dataset_rid: datasets_models.DatasetRid, - *, - branch_name: typing.Optional[datasets_models.BranchName] = None, - end_transaction_rid: typing.Optional[datasets_models.TransactionRid] = None, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - start_transaction_rid: typing.Optional[datasets_models.TransactionRid] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> datasets_models.ListFilesResponse: - """ - Lists Files contained in a Dataset. By default files are listed on the latest view of the default - branch - `master` for most enrollments. - #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most - recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the - branch if there are no snapshot transactions. - To **list files on the resolved view of a transaction** specify the Transaction's resource identifier - as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot - transaction, or the earliest ancestor transaction if there are no snapshot transactions. - To **list files on the resolved view of a range of transactions** specify the the start transaction's resource - identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This - will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. - Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when - the start and end transactions do not belong to the same root-to-leaf path. - To **list files on a specific transaction** specify the Transaction's resource identifier as both the - `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that - Transaction. - - :param dataset_rid: - :type dataset_rid: DatasetRid - :param branch_name: The name of the Branch on which to list Files. Defaults to `master` for most enrollments. - :type branch_name: Optional[BranchName] - :param end_transaction_rid: The Resource Identifier (RID) of the end Transaction. - :type end_transaction_rid: Optional[TransactionRid] - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :param start_transaction_rid: The Resource Identifier (RID) of the start Transaction. - :type start_transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: datasets_models.ListFilesResponse - - :raises BranchNotFound: The requested branch could not be found, or the client token does not have access to it. - :raises DatasetNotFound: The requested dataset could not be found, or the client token does not have access to it. - """ - - warnings.warn( - "The client.datasets.File.page(...) method has been deprecated. Please use client.datasets.File.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/datasets/{datasetRid}/files", - query_params={ - "branchName": branch_name, - "endTransactionRid": end_transaction_rid, - "pageSize": page_size, - "pageToken": page_token, - "startTransactionRid": start_transaction_rid, - }, - path_params={ - "datasetRid": dataset_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=datasets_models.ListFilesResponse, - request_timeout=request_timeout, - throwable_errors={ - "BranchNotFound": datasets_errors.BranchNotFound, - "DatasetNotFound": datasets_errors.DatasetNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -556,14 +464,12 @@ def content(_: bytes): ... def delete(_: None): ... def get(_: datasets_models.File): ... def list(_: datasets_models.ListFilesResponse): ... - def page(_: datasets_models.ListFilesResponse): ... def upload(_: datasets_models.File): ... self.content = core.with_raw_response(content, client.content) self.delete = core.with_raw_response(delete, client.delete) self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) self.upload = core.with_raw_response(upload, client.upload) @@ -572,11 +478,9 @@ def __init__(self, client: FileClient) -> None: def content(_: bytes): ... def get(_: datasets_models.File): ... def list(_: datasets_models.ListFilesResponse): ... - def page(_: datasets_models.ListFilesResponse): ... def upload(_: datasets_models.File): ... self.content = core.with_streaming_response(content, client.content) self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) self.upload = core.with_streaming_response(upload, client.upload) diff --git a/foundry/v2/datasets/models.py b/foundry/v2/datasets/models.py index fc0a03795..fe844dcd0 100644 --- a/foundry/v2/datasets/models.py +++ b/foundry/v2/datasets/models.py @@ -19,7 +19,6 @@ from datetime import datetime import pydantic -import typing_extensions from foundry import _core as core from foundry.v2.core import models as core_models @@ -35,19 +34,9 @@ class Branch(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BranchDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(BranchDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class BranchDict(typing_extensions.TypedDict): - """Branch""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: BranchName - transactionRid: typing_extensions.NotRequired[TransactionRid] - """The most recent OPEN or COMMITTED transaction on the branch. This will never be an ABORTED transaction.""" + return self.model_dump(by_alias=True, exclude_none=True) BranchName = str @@ -62,19 +51,9 @@ class Dataset(pydantic.BaseModel): parent_folder_rid: filesystem_models.FolderRid = pydantic.Field(alias=str("parentFolderRid")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DatasetDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DatasetDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DatasetDict(typing_extensions.TypedDict): - """Dataset""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: DatasetRid - name: DatasetName - parentFolderRid: filesystem_models.FolderRid + return self.model_dump(by_alias=True, exclude_none=True) DatasetName = str @@ -94,20 +73,9 @@ class File(pydantic.BaseModel): updated_time: FileUpdatedTime = pydantic.Field(alias=str("updatedTime")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FileDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(FileDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class FileDict(typing_extensions.TypedDict): - """File""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - path: core_models.FilePath - transactionRid: TransactionRid - sizeBytes: typing_extensions.NotRequired[core.Long] - updatedTime: FileUpdatedTime + return self.model_dump(by_alias=True, exclude_none=True) FileUpdatedTime = datetime @@ -121,20 +89,9 @@ class ListBranchesResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListBranchesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListBranchesResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListBranchesResponseDict(typing_extensions.TypedDict): - """ListBranchesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[BranchDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListFilesResponse(pydantic.BaseModel): @@ -144,18 +101,9 @@ class ListFilesResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListFilesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ListFilesResponseDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ListFilesResponseDict(typing_extensions.TypedDict): - """ListFilesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[FileDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) TableExportFormat = typing.Literal["ARROW", "CSV"] @@ -176,30 +124,15 @@ class Transaction(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TransactionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(TransactionDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) TransactionCreatedTime = datetime """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" -class TransactionDict(typing_extensions.TypedDict): - """Transaction""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: TransactionRid - transactionType: TransactionType - status: TransactionStatus - createdTime: TransactionCreatedTime - """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" - - closedTime: typing_extensions.NotRequired[datetime] - """The timestamp when the transaction was closed, in ISO 8601 timestamp format.""" - - TransactionRid = core.RID """The Resource Identifier (RID) of a Transaction.""" @@ -214,23 +147,17 @@ class TransactionDict(typing_extensions.TypedDict): __all__ = [ "Branch", - "BranchDict", "BranchName", "Dataset", - "DatasetDict", "DatasetName", "DatasetRid", "File", - "FileDict", "FileUpdatedTime", "ListBranchesResponse", - "ListBranchesResponseDict", "ListFilesResponse", - "ListFilesResponseDict", "TableExportFormat", "Transaction", "TransactionCreatedTime", - "TransactionDict", "TransactionRid", "TransactionStatus", "TransactionType", diff --git a/foundry/v2/filesystem/client.py b/foundry/v2/filesystem/client.py deleted file mode 100644 index bb1f17843..000000000 --- a/foundry/v2/filesystem/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v2.filesystem._client import FilesystemClient - -__all__ = [ - "FilesystemClient", -] diff --git a/foundry/v2/filesystem/folder.py b/foundry/v2/filesystem/folder.py index 498062d62..1c11d4d2a 100644 --- a/foundry/v2/filesystem/folder.py +++ b/foundry/v2/filesystem/folder.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -106,69 +105,6 @@ def children( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def children_page( - self, - folder_rid: filesystem_models.FolderRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> filesystem_models.ListChildrenOfFolderResponse: - """ - List all child Resources of the Folder. - - This is a paged endpoint. The page size will be limited to 2,000 results per page. If no page size is - provided, this page size will also be used as the default. - - :param folder_rid: - :type folder_rid: FolderRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: filesystem_models.ListChildrenOfFolderResponse - """ - - warnings.warn( - "The client.filesystem.Folder.children_page(...) method has been deprecated. Please use client.filesystem.Folder.children(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/filesystem/folders/{folderRid}/children", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "folderRid": folder_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=filesystem_models.ListChildrenOfFolderResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -284,12 +220,10 @@ def get( class _FolderClientRaw: def __init__(self, client: FolderClient) -> None: def children(_: filesystem_models.ListChildrenOfFolderResponse): ... - def children_page(_: filesystem_models.ListChildrenOfFolderResponse): ... def create(_: filesystem_models.Folder): ... def get(_: filesystem_models.Folder): ... self.children = core.with_raw_response(children, client.children) - self.children_page = core.with_raw_response(children_page, client.children_page) self.create = core.with_raw_response(create, client.create) self.get = core.with_raw_response(get, client.get) @@ -297,11 +231,9 @@ def get(_: filesystem_models.Folder): ... class _FolderClientStreaming: def __init__(self, client: FolderClient) -> None: def children(_: filesystem_models.ListChildrenOfFolderResponse): ... - def children_page(_: filesystem_models.ListChildrenOfFolderResponse): ... def create(_: filesystem_models.Folder): ... def get(_: filesystem_models.Folder): ... self.children = core.with_streaming_response(children, client.children) - self.children_page = core.with_streaming_response(children_page, client.children_page) self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) diff --git a/foundry/v2/filesystem/models.py b/foundry/v2/filesystem/models.py index 854c42ed8..a42cf17b8 100644 --- a/foundry/v2/filesystem/models.py +++ b/foundry/v2/filesystem/models.py @@ -34,23 +34,9 @@ class AccessRequirements(pydantic.BaseModel): markings: typing.List[Marking] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AccessRequirementsDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AccessRequirementsDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AccessRequirementsDict(typing_extensions.TypedDict): - """ - Access requirements for a resource are composed of Markings and Organizations. Organizations are disjunctive, - while Markings are conjunctive. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - organizations: typing.List[OrganizationDict] - markings: typing.List[MarkingDict] + return self.model_dump(by_alias=True, exclude_none=True) class Everyone(pydantic.BaseModel): @@ -59,17 +45,9 @@ class Everyone(pydantic.BaseModel): type: typing.Literal["everyone"] = "everyone" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "EveryoneDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(EveryoneDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class EveryoneDict(typing_extensions.TypedDict): - """A principal representing all users of the platform.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["everyone"] + return self.model_dump(by_alias=True, exclude_none=True) FileSystemId = str @@ -119,53 +97,9 @@ class Folder(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FolderDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(FolderDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class FolderDict(typing_extensions.TypedDict): - """Folder""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: FolderRid - displayName: ResourceDisplayName - description: typing_extensions.NotRequired[str] - """The description associated with the Folder.""" - - documentation: typing_extensions.NotRequired[str] - """The documentation associated with the Folder.""" - - path: ResourcePath - type: FolderType - createdBy: core_models.CreatedBy - updatedBy: core_models.UpdatedBy - createdTime: core_models.CreatedTime - updatedTime: core_models.UpdatedTime - trashStatus: TrashStatus - """ - The trash status of the Folder. If trashed, this could either be because the Folder itself has been - trashed or because one of its ancestors has been trashed. - """ - - parentFolderRid: FolderRid - """ - The parent folder Resource Identifier (RID). For Projects, this will be the Space RID and for Spaces, - this value will be the root folder (`ri.compass.main.folder.0`). - """ - - projectRid: typing_extensions.NotRequired[ProjectRid] - """ - The Project Resource Identifier (RID) that the Folder lives in. If the Folder is a Space, this value will - not be defined. - """ - - spaceRid: SpaceRid - """ - The Space Resource Identifier (RID) that the Folder lives in. If the Folder is a Space, this value will - be the same as the Folder RID. - """ + return self.model_dump(by_alias=True, exclude_none=True) FolderRid = core.RID @@ -194,20 +128,9 @@ class ListChildrenOfFolderResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListChildrenOfFolderResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListChildrenOfFolderResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListChildrenOfFolderResponseDict(typing_extensions.TypedDict): - """ListChildrenOfFolderResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[ResourceDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListMarkingsOfResourceResponse(pydantic.BaseModel): @@ -217,20 +140,9 @@ class ListMarkingsOfResourceResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListMarkingsOfResourceResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListMarkingsOfResourceResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListMarkingsOfResourceResponseDict(typing_extensions.TypedDict): - """ListMarkingsOfResourceResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[core_models.MarkingId] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListOrganizationsOfProjectResponse(pydantic.BaseModel): @@ -240,21 +152,9 @@ class ListOrganizationsOfProjectResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListOrganizationsOfProjectResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListOrganizationsOfProjectResponseDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class ListOrganizationsOfProjectResponseDict(typing_extensions.TypedDict): - """ListOrganizationsOfProjectResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[core_models.OrganizationRid] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListResourceRolesResponse(pydantic.BaseModel): @@ -264,20 +164,9 @@ class ListResourceRolesResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListResourceRolesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListResourceRolesResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListResourceRolesResponseDict(typing_extensions.TypedDict): - """ListResourceRolesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[ResourceRoleDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListSpacesResponse(pydantic.BaseModel): @@ -287,20 +176,9 @@ class ListSpacesResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListSpacesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListSpacesResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListSpacesResponseDict(typing_extensions.TypedDict): - """ListSpacesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[SpaceDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class Marking(pydantic.BaseModel): @@ -315,23 +193,9 @@ class Marking(pydantic.BaseModel): is_directly_applied: IsDirectlyApplied = pydantic.Field(alias=str("isDirectlyApplied")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MarkingDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MarkingDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MarkingDict(typing_extensions.TypedDict): - """ - [Markings](/docs/foundry/security/markings/) provide an additional level of access control for files, - folders, and Projects within Foundry. Markings define eligibility criteria that restrict visibility - and actions to users who meet those criteria. To access a resource, a user must be a member of all - Markings applied to a resource to access it. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - markingId: core_models.MarkingId - isDirectlyApplied: IsDirectlyApplied + return self.model_dump(by_alias=True, exclude_none=True) class Organization(pydantic.BaseModel): @@ -348,25 +212,9 @@ class Organization(pydantic.BaseModel): is_directly_applied: IsDirectlyApplied = pydantic.Field(alias=str("isDirectlyApplied")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OrganizationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OrganizationDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OrganizationDict(typing_extensions.TypedDict): - """ - [Organizations](/docs/foundry/security/orgs-and-spaces/#organizations) are access requirements applied to - Projects that enforce strict silos between groups of users and resources. Every user is a member of only - one Organization, but can be a guest member of multiple Organizations. In order to meet access requirements, - users must be a member or guest member of at least one Organization applied to a Project. - Organizations are inherited via the file hierarchy and direct dependencies. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - markingId: core_models.MarkingId - organizationRid: core_models.OrganizationRid - isDirectlyApplied: IsDirectlyApplied + return self.model_dump(by_alias=True, exclude_none=True) class PrincipalWithId(pydantic.BaseModel): @@ -377,19 +225,9 @@ class PrincipalWithId(pydantic.BaseModel): type: typing.Literal["principalWithId"] = "principalWithId" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "PrincipalWithIdDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(PrincipalWithIdDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class PrincipalWithIdDict(typing_extensions.TypedDict): - """Represents a user principal or group principal with an ID.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - principalId: core_models.PrincipalId - principalType: core_models.PrincipalType - type: typing.Literal["principalWithId"] + return self.model_dump(by_alias=True, exclude_none=True) class Project(pydantic.BaseModel): @@ -418,36 +256,9 @@ class Project(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ProjectDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ProjectDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ProjectDict(typing_extensions.TypedDict): - """Project""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ProjectRid - displayName: ResourceDisplayName - """The display name of the Project. Must be unique and cannot contain a /""" - - description: typing_extensions.NotRequired[str] - """The description associated with the Project.""" - - documentation: typing_extensions.NotRequired[str] - """The documentation associated with the Project.""" - - path: ResourcePath - createdBy: core_models.CreatedBy - updatedBy: core_models.UpdatedBy - createdTime: core_models.CreatedTime - updatedTime: core_models.UpdatedTime - trashStatus: TrashStatus - """The trash status of the Project.""" - - spaceRid: SpaceRid - """The Space Resource Identifier (RID) that the Project lives in.""" + return self.model_dump(by_alias=True, exclude_none=True) ProjectRid = core.RID @@ -520,64 +331,9 @@ class Resource(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ResourceDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ResourceDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ResourceDict(typing_extensions.TypedDict): - """Resource""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ResourceRid - displayName: ResourceDisplayName - """The display name of the Resource""" - - description: typing_extensions.NotRequired[str] - """The description of the Resource""" - - documentation: typing_extensions.NotRequired[str] - """The documentation associated with the Resource""" - - path: ResourcePath - """The full path to the resource, including the resource name itself""" - - type: ResourceType - """The type of the Resource derived from the Resource Identifier (RID).""" - - createdBy: core_models.CreatedBy - """The user that created the Resource.""" - - updatedBy: core_models.UpdatedBy - """The user that last updated the Resource.""" - - createdTime: core_models.CreatedTime - """The timestamp that the Resource was last created.""" - - updatedTime: core_models.UpdatedTime - """ - The timestamp that the Resource was last modified. For folders, this includes any of its descendants. For - top level folders (spaces and projects), this is not updated by child updates for performance reasons. - """ - - trashStatus: TrashStatus - """ - The trash status of the Resource. If trashed, this could either be because the Resource itself has been - trashed or because one of its ancestors has been trashed. - """ - - parentFolderRid: FolderRid - """The parent folder Resource Identifier (RID). For projects, this will be the Space RID.""" - - projectRid: ProjectRid - """ - The Project Resource Identifier (RID) that the Resource lives in. If the Resource itself is a - Project, this value will still be populated with the Project RID. - """ - - spaceRid: SpaceRid - """The Space Resource Identifier (RID) that the Resource lives in.""" + return self.model_dump(by_alias=True, exclude_none=True) ResourceDisplayName = str @@ -599,18 +355,9 @@ class ResourceRole(pydantic.BaseModel): role_id: core_models.RoleId = pydantic.Field(alias=str("roleId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ResourceRoleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ResourceRoleDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ResourceRoleDict(typing_extensions.TypedDict): - """ResourceRole""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - resourceRolePrincipal: ResourceRolePrincipalDict - roleId: core_models.RoleId + return self.model_dump(by_alias=True, exclude_none=True) ResourceRolePrincipal = typing_extensions.Annotated[ @@ -619,12 +366,6 @@ class ResourceRoleDict(typing_extensions.TypedDict): """ResourceRolePrincipal""" -ResourceRolePrincipalDict = typing_extensions.Annotated[ - typing.Union[PrincipalWithIdDict, EveryoneDict], pydantic.Field(discriminator="type") -] -"""ResourceRolePrincipal""" - - ResourceType = typing.Literal[ "AIP_PROFILE", "AIP_ASSIST_WALKTHROUGH", @@ -718,25 +459,9 @@ class Space(pydantic.BaseModel): organizations: typing.List[core_models.OrganizationRid] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SpaceDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(SpaceDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class SpaceDict(typing_extensions.TypedDict): - """Space""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: SpaceRid - displayName: ResourceDisplayName - description: typing_extensions.NotRequired[str] - """The description of the Space.""" - - path: ResourcePath - fileSystemId: typing_extensions.NotRequired[FileSystemId] - usageAccountRid: typing_extensions.NotRequired[UsageAccountRid] - organizations: typing.List[core_models.OrganizationRid] + return self.model_dump(by_alias=True, exclude_none=True) SpaceRid = core.RID @@ -752,53 +477,36 @@ class SpaceDict(typing_extensions.TypedDict): core.resolve_forward_references(ResourceRolePrincipal, globalns=globals(), localns=locals()) -core.resolve_forward_references(ResourceRolePrincipalDict, globalns=globals(), localns=locals()) __all__ = [ "AccessRequirements", - "AccessRequirementsDict", "Everyone", - "EveryoneDict", "FileSystemId", "Folder", - "FolderDict", "FolderRid", "FolderType", "IsDirectlyApplied", "ListChildrenOfFolderResponse", - "ListChildrenOfFolderResponseDict", "ListMarkingsOfResourceResponse", - "ListMarkingsOfResourceResponseDict", "ListOrganizationsOfProjectResponse", - "ListOrganizationsOfProjectResponseDict", "ListResourceRolesResponse", - "ListResourceRolesResponseDict", "ListSpacesResponse", - "ListSpacesResponseDict", "Marking", - "MarkingDict", "Organization", - "OrganizationDict", "PrincipalWithId", - "PrincipalWithIdDict", "Project", - "ProjectDict", "ProjectRid", "ProjectTemplateRid", "ProjectTemplateVariableId", "ProjectTemplateVariableValue", "Resource", - "ResourceDict", "ResourceDisplayName", "ResourcePath", "ResourceRid", "ResourceRole", - "ResourceRoleDict", "ResourceRolePrincipal", - "ResourceRolePrincipalDict", "ResourceType", "Space", - "SpaceDict", "SpaceRid", "TrashStatus", "UsageAccountRid", diff --git a/foundry/v2/filesystem/project.py b/foundry/v2/filesystem/project.py index 9dcddd672..4e079faea 100644 --- a/foundry/v2/filesystem/project.py +++ b/foundry/v2/filesystem/project.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -118,12 +117,7 @@ def create( display_name: filesystem_models.ResourceDisplayName, organization_rids: typing.List[core_models.OrganizationRid], role_grants: typing.Dict[ - core_models.RoleId, - typing.List[ - typing.Union[ - filesystem_models.PrincipalWithId, filesystem_models.PrincipalWithIdDict - ] - ], + core_models.RoleId, typing.List[filesystem_models.PrincipalWithId] ], space_rid: filesystem_models.SpaceRid, description: typing.Optional[str] = None, @@ -145,7 +139,7 @@ def create( :param organization_rids: :type organization_rids: List[OrganizationRid] :param role_grants: - :type role_grants: Dict[RoleId, List[Union[PrincipalWithId, PrincipalWithIdDict]]] + :type role_grants: Dict[RoleId, List[PrincipalWithId]] :param space_rid: :type space_rid: SpaceRid :param description: @@ -194,13 +188,7 @@ def create( "description": typing.Optional[str], "spaceRid": filesystem_models.SpaceRid, "roleGrants": typing.Dict[ - core_models.RoleId, - typing.List[ - typing.Union[ - filesystem_models.PrincipalWithId, - filesystem_models.PrincipalWithIdDict, - ] - ], + core_models.RoleId, typing.List[filesystem_models.PrincipalWithId] ], "defaultRoles": typing.List[core_models.RoleId], "organizationRids": typing.List[core_models.OrganizationRid], @@ -439,67 +427,6 @@ def organizations( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def organizations_page( - self, - project_rid: filesystem_models.ProjectRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> filesystem_models.ListOrganizationsOfProjectResponse: - """ - List of Organizations directly applied to a Project. The number of Organizations on a Project is - typically small so the `pageSize` and `pageToken` parameters are not required. - - :param project_rid: - :type project_rid: ProjectRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: filesystem_models.ListOrganizationsOfProjectResponse - """ - - warnings.warn( - "The client.filesystem.Project.organizations_page(...) method has been deprecated. Please use client.filesystem.Project.organizations(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/filesystem/projects/{projectRid}/organizations", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "projectRid": project_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=filesystem_models.ListOrganizationsOfProjectResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -567,7 +494,6 @@ def create(_: filesystem_models.Project): ... def create_from_template(_: filesystem_models.Project): ... def get(_: filesystem_models.Project): ... def organizations(_: filesystem_models.ListOrganizationsOfProjectResponse): ... - def organizations_page(_: filesystem_models.ListOrganizationsOfProjectResponse): ... def remove_organizations(_: None): ... self.add_organizations = core.with_raw_response(add_organizations, client.add_organizations) @@ -577,9 +503,6 @@ def remove_organizations(_: None): ... ) self.get = core.with_raw_response(get, client.get) self.organizations = core.with_raw_response(organizations, client.organizations) - self.organizations_page = core.with_raw_response( - organizations_page, client.organizations_page - ) self.remove_organizations = core.with_raw_response( remove_organizations, client.remove_organizations ) @@ -591,7 +514,6 @@ def create(_: filesystem_models.Project): ... def create_from_template(_: filesystem_models.Project): ... def get(_: filesystem_models.Project): ... def organizations(_: filesystem_models.ListOrganizationsOfProjectResponse): ... - def organizations_page(_: filesystem_models.ListOrganizationsOfProjectResponse): ... self.create = core.with_streaming_response(create, client.create) self.create_from_template = core.with_streaming_response( @@ -599,6 +521,3 @@ def organizations_page(_: filesystem_models.ListOrganizationsOfProjectResponse): ) self.get = core.with_streaming_response(get, client.get) self.organizations = core.with_streaming_response(organizations, client.organizations) - self.organizations_page = core.with_streaming_response( - organizations_page, client.organizations_page - ) diff --git a/foundry/v2/filesystem/resource.py b/foundry/v2/filesystem/resource.py index cab0a55b4..56a48480a 100644 --- a/foundry/v2/filesystem/resource.py +++ b/foundry/v2/filesystem/resource.py @@ -14,7 +14,6 @@ import typing -import warnings from functools import cached_property import pydantic @@ -371,67 +370,6 @@ def markings( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def markings_page( - self, - resource_rid: filesystem_models.ResourceRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> filesystem_models.ListMarkingsOfResourceResponse: - """ - List of Markings directly applied to a resource. The number of Markings on a resource is typically small - so the `pageSize` and `pageToken` parameters are not required. - - :param resource_rid: - :type resource_rid: ResourceRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: filesystem_models.ListMarkingsOfResourceResponse - """ - - warnings.warn( - "The client.filesystem.Resource.markings_page(...) method has been deprecated. Please use client.filesystem.Resource.markings(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/filesystem/resources/{resourceRid}/markings", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "resourceRid": resource_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=filesystem_models.ListMarkingsOfResourceResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -598,7 +536,6 @@ def get(_: filesystem_models.Resource): ... def get_access_requirements(_: filesystem_models.AccessRequirements): ... def get_by_path(_: filesystem_models.Resource): ... def markings(_: filesystem_models.ListMarkingsOfResourceResponse): ... - def markings_page(_: filesystem_models.ListMarkingsOfResourceResponse): ... def permanently_delete(_: None): ... def remove_markings(_: None): ... def restore(_: None): ... @@ -611,7 +548,6 @@ def restore(_: None): ... ) self.get_by_path = core.with_raw_response(get_by_path, client.get_by_path) self.markings = core.with_raw_response(markings, client.markings) - self.markings_page = core.with_raw_response(markings_page, client.markings_page) self.permanently_delete = core.with_raw_response( permanently_delete, client.permanently_delete ) @@ -625,7 +561,6 @@ def get(_: filesystem_models.Resource): ... def get_access_requirements(_: filesystem_models.AccessRequirements): ... def get_by_path(_: filesystem_models.Resource): ... def markings(_: filesystem_models.ListMarkingsOfResourceResponse): ... - def markings_page(_: filesystem_models.ListMarkingsOfResourceResponse): ... self.get = core.with_streaming_response(get, client.get) self.get_access_requirements = core.with_streaming_response( @@ -633,4 +568,3 @@ def markings_page(_: filesystem_models.ListMarkingsOfResourceResponse): ... ) self.get_by_path = core.with_streaming_response(get_by_path, client.get_by_path) self.markings = core.with_streaming_response(markings, client.markings) - self.markings_page = core.with_streaming_response(markings_page, client.markings_page) diff --git a/foundry/v2/filesystem/resource_role.py b/foundry/v2/filesystem/resource_role.py index 288525cc7..794bfa660 100644 --- a/foundry/v2/filesystem/resource_role.py +++ b/foundry/v2/filesystem/resource_role.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -56,9 +55,7 @@ def add( self, resource_rid: filesystem_models.ResourceRid, *, - roles: typing.List[ - typing.Union[filesystem_models.ResourceRole, filesystem_models.ResourceRoleDict] - ], + roles: typing.List[filesystem_models.ResourceRole], preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -68,7 +65,7 @@ def add( :param resource_rid: :type resource_rid: ResourceRid :param roles: - :type roles: List[Union[ResourceRole, ResourceRoleDict]] + :type roles: List[ResourceRole] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -98,11 +95,7 @@ def add( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "roles": typing.List[ - typing.Union[ - filesystem_models.ResourceRole, filesystem_models.ResourceRoleDict - ] - ], + "roles": typing.List[filesystem_models.ResourceRole], }, ), response_type=None, @@ -172,70 +165,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - resource_rid: filesystem_models.ResourceRid, - *, - include_inherited: typing.Optional[bool] = None, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> filesystem_models.ListResourceRolesResponse: - """ - List the roles on a resource. - - :param resource_rid: - :type resource_rid: ResourceRid - :param include_inherited: Whether to include inherited roles on the resource. - :type include_inherited: Optional[bool] - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: filesystem_models.ListResourceRolesResponse - """ - - warnings.warn( - "The client.filesystem.Role.page(...) method has been deprecated. Please use client.filesystem.Role.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/filesystem/resources/{resourceRid}/roles", - query_params={ - "includeInherited": include_inherited, - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "resourceRid": resource_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=filesystem_models.ListResourceRolesResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -243,9 +172,7 @@ def remove( self, resource_rid: filesystem_models.ResourceRid, *, - roles: typing.List[ - typing.Union[filesystem_models.ResourceRole, filesystem_models.ResourceRoleDict] - ], + roles: typing.List[filesystem_models.ResourceRole], preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -255,7 +182,7 @@ def remove( :param resource_rid: :type resource_rid: ResourceRid :param roles: - :type roles: List[Union[ResourceRole, ResourceRoleDict]] + :type roles: List[ResourceRole] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -285,11 +212,7 @@ def remove( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "roles": typing.List[ - typing.Union[ - filesystem_models.ResourceRole, filesystem_models.ResourceRoleDict - ] - ], + "roles": typing.List[filesystem_models.ResourceRole], }, ), response_type=None, @@ -306,19 +229,15 @@ class _ResourceRoleClientRaw: def __init__(self, client: ResourceRoleClient) -> None: def add(_: None): ... def list(_: filesystem_models.ListResourceRolesResponse): ... - def page(_: filesystem_models.ListResourceRolesResponse): ... def remove(_: None): ... self.add = core.with_raw_response(add, client.add) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) self.remove = core.with_raw_response(remove, client.remove) class _ResourceRoleClientStreaming: def __init__(self, client: ResourceRoleClient) -> None: def list(_: filesystem_models.ListResourceRolesResponse): ... - def page(_: filesystem_models.ListResourceRolesResponse): ... self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/filesystem/space.py b/foundry/v2/filesystem/space.py index e97e1a53f..4aa84ef7c 100644 --- a/foundry/v2/filesystem/space.py +++ b/foundry/v2/filesystem/space.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -98,76 +97,16 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> filesystem_models.ListSpacesResponse: - """ - Lists all Spaces. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: filesystem_models.ListSpacesResponse - """ - - warnings.warn( - "The client.filesystem.Space.page(...) method has been deprecated. Please use client.filesystem.Space.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/filesystem/spaces", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=filesystem_models.ListSpacesResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _SpaceClientRaw: def __init__(self, client: SpaceClient) -> None: def list(_: filesystem_models.ListSpacesResponse): ... - def page(_: filesystem_models.ListSpacesResponse): ... self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) class _SpaceClientStreaming: def __init__(self, client: SpaceClient) -> None: def list(_: filesystem_models.ListSpacesResponse): ... - def page(_: filesystem_models.ListSpacesResponse): ... self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/functions/client.py b/foundry/v2/functions/client.py deleted file mode 100644 index 92c828262..000000000 --- a/foundry/v2/functions/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v2.functions._client import FunctionsClient - -__all__ = [ - "FunctionsClient", -] diff --git a/foundry/v2/functions/errors.py b/foundry/v2/functions/errors.py index 27114bfe6..dc28c21da 100644 --- a/foundry/v2/functions/errors.py +++ b/foundry/v2/functions/errors.py @@ -58,7 +58,7 @@ class InvalidQueryParameterValueParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - parameterDataType: functions_models.QueryDataTypeDict + parameterDataType: functions_models.QueryDataType parameterId: functions_models.ParameterId parameterValue: typing_extensions.NotRequired[functions_models.DataValue] diff --git a/foundry/v2/functions/models.py b/foundry/v2/functions/models.py index 793fc6b27..04c2b7b69 100644 --- a/foundry/v2/functions/models.py +++ b/foundry/v2/functions/models.py @@ -56,19 +56,9 @@ class ExecuteQueryResponse(pydantic.BaseModel): value: DataValue model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ExecuteQueryResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ExecuteQueryResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ExecuteQueryResponseDict(typing_extensions.TypedDict): - """ExecuteQueryResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: DataValue + return self.model_dump(by_alias=True, exclude_none=True) FunctionRid = core.RID @@ -89,18 +79,9 @@ class Parameter(pydantic.BaseModel): data_type: QueryDataType = pydantic.Field(alias=str("dataType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ParameterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ParameterDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ParameterDict(typing_extensions.TypedDict): - """Details about a parameter of a query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: typing_extensions.NotRequired[str] - dataType: QueryDataTypeDict + return self.model_dump(by_alias=True, exclude_none=True) ParameterId = str @@ -122,9 +103,9 @@ class Query(pydantic.BaseModel): version: FunctionVersion model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QueryDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) QueryAggregationKeyType = typing_extensions.Annotated[ @@ -142,21 +123,6 @@ def to_dict(self) -> "QueryDict": """A union of all the types supported by query aggregation keys.""" -QueryAggregationKeyTypeDict = typing_extensions.Annotated[ - typing.Union[ - core_models.DateTypeDict, - core_models.BooleanTypeDict, - core_models.StringTypeDict, - core_models.DoubleTypeDict, - "QueryAggregationRangeTypeDict", - core_models.IntegerTypeDict, - core_models.TimestampTypeDict, - ], - pydantic.Field(discriminator="type"), -] -"""A union of all the types supported by query aggregation keys.""" - - QueryAggregationRangeSubType = typing_extensions.Annotated[ typing.Union[ core_models.DateType, @@ -169,18 +135,6 @@ def to_dict(self) -> "QueryDict": """A union of all the types supported by query aggregation ranges.""" -QueryAggregationRangeSubTypeDict = typing_extensions.Annotated[ - typing.Union[ - core_models.DateTypeDict, - core_models.DoubleTypeDict, - core_models.IntegerTypeDict, - core_models.TimestampTypeDict, - ], - pydantic.Field(discriminator="type"), -] -"""A union of all the types supported by query aggregation ranges.""" - - class QueryAggregationRangeType(pydantic.BaseModel): """QueryAggregationRangeType""" @@ -188,20 +142,9 @@ class QueryAggregationRangeType(pydantic.BaseModel): type: typing.Literal["range"] = "range" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryAggregationRangeTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - QueryAggregationRangeTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class QueryAggregationRangeTypeDict(typing_extensions.TypedDict): - """QueryAggregationRangeType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: QueryAggregationRangeSubTypeDict - type: typing.Literal["range"] + return self.model_dump(by_alias=True, exclude_none=True) QueryAggregationValueType = typing_extensions.Annotated[ @@ -211,15 +154,6 @@ class QueryAggregationRangeTypeDict(typing_extensions.TypedDict): """A union of all the types supported by query aggregation keys.""" -QueryAggregationValueTypeDict = typing_extensions.Annotated[ - typing.Union[ - core_models.DateTypeDict, core_models.DoubleTypeDict, core_models.TimestampTypeDict - ], - pydantic.Field(discriminator="type"), -] -"""A union of all the types supported by query aggregation keys.""" - - QueryApiName = str """The name of the Query in the API.""" @@ -231,18 +165,9 @@ class QueryArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryArrayTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QueryArrayTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class QueryArrayTypeDict(typing_extensions.TypedDict): - """QueryArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: QueryDataTypeDict - type: typing.Literal["array"] + return self.model_dump(by_alias=True, exclude_none=True) QueryDataType = typing_extensions.Annotated[ @@ -271,46 +196,6 @@ class QueryArrayTypeDict(typing_extensions.TypedDict): """A union of all the types supported by Query parameters or outputs.""" -QueryDataTypeDict = typing_extensions.Annotated[ - typing.Union[ - core_models.DateTypeDict, - "QueryStructTypeDict", - "QuerySetTypeDict", - core_models.StringTypeDict, - core_models.DoubleTypeDict, - core_models.IntegerTypeDict, - "ThreeDimensionalAggregationDict", - "QueryUnionTypeDict", - core_models.FloatTypeDict, - core_models.LongTypeDict, - core_models.BooleanTypeDict, - core_models.UnsupportedTypeDict, - core_models.AttachmentTypeDict, - core_models.NullTypeDict, - QueryArrayTypeDict, - "TwoDimensionalAggregationDict", - "ValueTypeReferenceDict", - core_models.TimestampTypeDict, - ], - pydantic.Field(discriminator="type"), -] -"""A union of all the types supported by Query parameters or outputs.""" - - -class QueryDict(typing_extensions.TypedDict): - """Query""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: QueryApiName - description: typing_extensions.NotRequired[str] - displayName: typing_extensions.NotRequired[core_models.DisplayName] - parameters: typing.Dict[ParameterId, ParameterDict] - output: QueryDataTypeDict - rid: FunctionRid - version: FunctionVersion - - QueryRuntimeErrorParameter = str """QueryRuntimeErrorParameter""" @@ -322,18 +207,9 @@ class QuerySetType(pydantic.BaseModel): type: typing.Literal["set"] = "set" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QuerySetTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QuerySetTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class QuerySetTypeDict(typing_extensions.TypedDict): - """QuerySetType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: QueryDataTypeDict - type: typing.Literal["set"] + return self.model_dump(by_alias=True, exclude_none=True) class QueryStructField(pydantic.BaseModel): @@ -343,18 +219,9 @@ class QueryStructField(pydantic.BaseModel): field_type: QueryDataType = pydantic.Field(alias=str("fieldType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryStructFieldDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QueryStructFieldDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class QueryStructFieldDict(typing_extensions.TypedDict): - """QueryStructField""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: StructFieldName - fieldType: QueryDataTypeDict + return self.model_dump(by_alias=True, exclude_none=True) class QueryStructType(pydantic.BaseModel): @@ -364,18 +231,9 @@ class QueryStructType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryStructTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QueryStructTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class QueryStructTypeDict(typing_extensions.TypedDict): - """QueryStructType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: typing.List[QueryStructFieldDict] - type: typing.Literal["struct"] + return self.model_dump(by_alias=True, exclude_none=True) class QueryUnionType(pydantic.BaseModel): @@ -385,18 +243,9 @@ class QueryUnionType(pydantic.BaseModel): type: typing.Literal["union"] = "union" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryUnionTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QueryUnionTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class QueryUnionTypeDict(typing_extensions.TypedDict): - """QueryUnionType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - unionTypes: typing.List[QueryDataTypeDict] - type: typing.Literal["union"] + return self.model_dump(by_alias=True, exclude_none=True) StructFieldName = str @@ -411,21 +260,9 @@ class ThreeDimensionalAggregation(pydantic.BaseModel): type: typing.Literal["threeDimensionalAggregation"] = "threeDimensionalAggregation" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ThreeDimensionalAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ThreeDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ThreeDimensionalAggregationDict(typing_extensions.TypedDict): - """ThreeDimensionalAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: QueryAggregationKeyTypeDict - valueType: TwoDimensionalAggregationDict - type: typing.Literal["threeDimensionalAggregation"] + return self.model_dump(by_alias=True, exclude_none=True) class TwoDimensionalAggregation(pydantic.BaseModel): @@ -436,21 +273,9 @@ class TwoDimensionalAggregation(pydantic.BaseModel): type: typing.Literal["twoDimensionalAggregation"] = "twoDimensionalAggregation" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TwoDimensionalAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - TwoDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class TwoDimensionalAggregationDict(typing_extensions.TypedDict): - """TwoDimensionalAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: QueryAggregationKeyTypeDict - valueType: QueryAggregationValueTypeDict - type: typing.Literal["twoDimensionalAggregation"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueType(pydantic.BaseModel): @@ -465,9 +290,9 @@ class ValueType(pydantic.BaseModel): base_type: typing.Optional[ValueTypeDataType] = pydantic.Field(alias=str("baseType"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ValueTypeDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) ValueTypeApiName = str @@ -507,20 +332,9 @@ class ValueTypeDataTypeArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeArrayTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeArrayTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeArrayTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: ValueTypeDataTypeDict - type: typing.Literal["array"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeBinaryType(pydantic.BaseModel): @@ -529,19 +343,9 @@ class ValueTypeDataTypeBinaryType(pydantic.BaseModel): type: typing.Literal["binary"] = "binary" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeBinaryTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeBinaryTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeBinaryTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeBinaryType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["binary"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeBooleanType(pydantic.BaseModel): @@ -550,19 +354,9 @@ class ValueTypeDataTypeBooleanType(pydantic.BaseModel): type: typing.Literal["boolean"] = "boolean" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeBooleanTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeBooleanTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeBooleanTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeBooleanType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["boolean"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeByteType(pydantic.BaseModel): @@ -571,19 +365,9 @@ class ValueTypeDataTypeByteType(pydantic.BaseModel): type: typing.Literal["byte"] = "byte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeByteTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeByteTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeByteTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeByteType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["byte"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeDateType(pydantic.BaseModel): @@ -592,19 +376,9 @@ class ValueTypeDataTypeDateType(pydantic.BaseModel): type: typing.Literal["date"] = "date" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeDateTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeDateTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeDateTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeDateType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["date"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeDecimalType(pydantic.BaseModel): @@ -613,45 +387,9 @@ class ValueTypeDataTypeDecimalType(pydantic.BaseModel): type: typing.Literal["decimal"] = "decimal" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeDecimalTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeDecimalTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeDecimalTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeDecimalType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["decimal"] - - -ValueTypeDataTypeDict = typing_extensions.Annotated[ - typing.Union[ - ValueTypeDataTypeDateTypeDict, - "ValueTypeDataTypeStructTypeDict", - "ValueTypeDataTypeStringTypeDict", - ValueTypeDataTypeByteTypeDict, - "ValueTypeDataTypeDoubleTypeDict", - "ValueTypeDataTypeOptionalTypeDict", - "ValueTypeDataTypeIntegerTypeDict", - "ValueTypeDataTypeUnionTypeDict", - "ValueTypeDataTypeFloatTypeDict", - "ValueTypeDataTypeLongTypeDict", - ValueTypeDataTypeBooleanTypeDict, - ValueTypeDataTypeArrayTypeDict, - ValueTypeDataTypeBinaryTypeDict, - "ValueTypeDataTypeValueTypeReferenceDict", - "ValueTypeDataTypeShortTypeDict", - ValueTypeDataTypeDecimalTypeDict, - "ValueTypeDataTypeMapTypeDict", - "ValueTypeDataTypeTimestampTypeDict", - ], - pydantic.Field(discriminator="type"), -] -"""The underlying base type of a value type.""" + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeDoubleType(pydantic.BaseModel): @@ -660,19 +398,9 @@ class ValueTypeDataTypeDoubleType(pydantic.BaseModel): type: typing.Literal["double"] = "double" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeDoubleTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeDoubleTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeDoubleTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeDoubleType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["double"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeFloatType(pydantic.BaseModel): @@ -681,19 +409,9 @@ class ValueTypeDataTypeFloatType(pydantic.BaseModel): type: typing.Literal["float"] = "float" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeFloatTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeFloatTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeFloatTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeFloatType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["float"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeIntegerType(pydantic.BaseModel): @@ -702,19 +420,9 @@ class ValueTypeDataTypeIntegerType(pydantic.BaseModel): type: typing.Literal["integer"] = "integer" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeIntegerTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeIntegerTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeIntegerTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeIntegerType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["integer"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeLongType(pydantic.BaseModel): @@ -723,19 +431,9 @@ class ValueTypeDataTypeLongType(pydantic.BaseModel): type: typing.Literal["long"] = "long" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeLongTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeLongTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeLongTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeLongType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["long"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeMapType(pydantic.BaseModel): @@ -746,21 +444,9 @@ class ValueTypeDataTypeMapType(pydantic.BaseModel): type: typing.Literal["map"] = "map" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeMapTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeMapTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeMapTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeMapType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: ValueTypeDataTypeDict - valueType: ValueTypeDataTypeDict - type: typing.Literal["map"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeOptionalType(pydantic.BaseModel): @@ -770,20 +456,9 @@ class ValueTypeDataTypeOptionalType(pydantic.BaseModel): type: typing.Literal["optional"] = "optional" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeOptionalTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeOptionalTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeOptionalTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeOptionalType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - wrappedType: ValueTypeDataTypeDict - type: typing.Literal["optional"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeShortType(pydantic.BaseModel): @@ -792,19 +467,9 @@ class ValueTypeDataTypeShortType(pydantic.BaseModel): type: typing.Literal["short"] = "short" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeShortTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeShortTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeShortTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeShortType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["short"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeStringType(pydantic.BaseModel): @@ -813,19 +478,9 @@ class ValueTypeDataTypeStringType(pydantic.BaseModel): type: typing.Literal["string"] = "string" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeStringTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeStringTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeStringTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeStringType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["string"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeStructElement(pydantic.BaseModel): @@ -835,20 +490,9 @@ class ValueTypeDataTypeStructElement(pydantic.BaseModel): field_type: ValueTypeDataType = pydantic.Field(alias=str("fieldType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeStructElementDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeStructElementDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeStructElementDict(typing_extensions.TypedDict): - """ValueTypeDataTypeStructElement""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: ValueTypeDataTypeStructFieldIdentifier - fieldType: ValueTypeDataTypeDict + return self.model_dump(by_alias=True, exclude_none=True) ValueTypeDataTypeStructFieldIdentifier = str @@ -862,20 +506,9 @@ class ValueTypeDataTypeStructType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeStructTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeStructTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeStructTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeStructType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: typing.List[ValueTypeDataTypeStructElementDict] - type: typing.Literal["struct"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeTimestampType(pydantic.BaseModel): @@ -884,19 +517,9 @@ class ValueTypeDataTypeTimestampType(pydantic.BaseModel): type: typing.Literal["timestamp"] = "timestamp" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeTimestampTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeTimestampTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeTimestampTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeTimestampType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["timestamp"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeUnionType(pydantic.BaseModel): @@ -906,20 +529,9 @@ class ValueTypeDataTypeUnionType(pydantic.BaseModel): type: typing.Literal["union"] = "union" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeUnionTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeUnionTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeDataTypeUnionTypeDict(typing_extensions.TypedDict): - """ValueTypeDataTypeUnionType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - memberTypes: typing.List[ValueTypeDataTypeDict] - type: typing.Literal["union"] + return self.model_dump(by_alias=True, exclude_none=True) class ValueTypeDataTypeValueTypeReference(pydantic.BaseModel): @@ -930,42 +542,15 @@ class ValueTypeDataTypeValueTypeReference(pydantic.BaseModel): type: typing.Literal["valueTypeReference"] = "valueTypeReference" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeDataTypeValueTypeReferenceDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeDataTypeValueTypeReferenceDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class ValueTypeDataTypeValueTypeReferenceDict(typing_extensions.TypedDict): - """ValueTypeDataTypeValueTypeReference""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ValueTypeRid - versionId: ValueTypeVersionId - type: typing.Literal["valueTypeReference"] + return self.model_dump(by_alias=True, exclude_none=True) ValueTypeDescription = str """A description of the value type.""" -class ValueTypeDict(typing_extensions.TypedDict): - """ValueType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ValueTypeRid - version: ValueTypeVersion - versionId: ValueTypeVersionId - apiName: ValueTypeApiName - displayName: core_models.DisplayName - description: typing_extensions.NotRequired[ValueTypeDescription] - baseType: typing_extensions.NotRequired[ValueTypeDataTypeDict] - - class ValueTypeReference(pydantic.BaseModel): """A reference to a value type that has been registered in the Ontology.""" @@ -974,21 +559,9 @@ class ValueTypeReference(pydantic.BaseModel): type: typing.Literal["valueTypeReference"] = "valueTypeReference" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValueTypeReferenceDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValueTypeReferenceDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValueTypeReferenceDict(typing_extensions.TypedDict): - """A reference to a value type that has been registered in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ValueTypeRid - versionId: ValueTypeVersionId - type: typing.Literal["valueTypeReference"] + return self.model_dump(by_alias=True, exclude_none=True) ValueTypeRid = core.RID @@ -1015,126 +588,67 @@ class VersionId(pydantic.BaseModel): base_type: typing.Optional[ValueTypeDataType] = pydantic.Field(alias=str("baseType"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "VersionIdDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(VersionIdDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class VersionIdDict(typing_extensions.TypedDict): - """VersionId""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ValueTypeRid - version: ValueTypeVersion - versionId: ValueTypeVersionId - apiName: ValueTypeApiName - displayName: core_models.DisplayName - description: typing_extensions.NotRequired[ValueTypeDescription] - baseType: typing_extensions.NotRequired[ValueTypeDataTypeDict] + return self.model_dump(by_alias=True, exclude_none=True) core.resolve_forward_references(QueryAggregationKeyType, globalns=globals(), localns=locals()) -core.resolve_forward_references(QueryAggregationKeyTypeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(QueryAggregationRangeSubType, globalns=globals(), localns=locals()) -core.resolve_forward_references( - QueryAggregationRangeSubTypeDict, globalns=globals(), localns=locals() -) core.resolve_forward_references(QueryAggregationValueType, globalns=globals(), localns=locals()) -core.resolve_forward_references(QueryAggregationValueTypeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(QueryDataType, globalns=globals(), localns=locals()) -core.resolve_forward_references(QueryDataTypeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(ValueTypeDataType, globalns=globals(), localns=locals()) -core.resolve_forward_references(ValueTypeDataTypeDict, globalns=globals(), localns=locals()) __all__ = [ "DataValue", "ExecuteQueryResponse", - "ExecuteQueryResponseDict", "FunctionRid", "FunctionVersion", "Parameter", - "ParameterDict", "ParameterId", "Query", "QueryAggregationKeyType", - "QueryAggregationKeyTypeDict", "QueryAggregationRangeSubType", - "QueryAggregationRangeSubTypeDict", "QueryAggregationRangeType", - "QueryAggregationRangeTypeDict", "QueryAggregationValueType", - "QueryAggregationValueTypeDict", "QueryApiName", "QueryArrayType", - "QueryArrayTypeDict", "QueryDataType", - "QueryDataTypeDict", - "QueryDict", "QueryRuntimeErrorParameter", "QuerySetType", - "QuerySetTypeDict", "QueryStructField", - "QueryStructFieldDict", "QueryStructType", - "QueryStructTypeDict", "QueryUnionType", - "QueryUnionTypeDict", "StructFieldName", "ThreeDimensionalAggregation", - "ThreeDimensionalAggregationDict", "TwoDimensionalAggregation", - "TwoDimensionalAggregationDict", "ValueType", "ValueTypeApiName", "ValueTypeDataType", "ValueTypeDataTypeArrayType", - "ValueTypeDataTypeArrayTypeDict", "ValueTypeDataTypeBinaryType", - "ValueTypeDataTypeBinaryTypeDict", "ValueTypeDataTypeBooleanType", - "ValueTypeDataTypeBooleanTypeDict", "ValueTypeDataTypeByteType", - "ValueTypeDataTypeByteTypeDict", "ValueTypeDataTypeDateType", - "ValueTypeDataTypeDateTypeDict", "ValueTypeDataTypeDecimalType", - "ValueTypeDataTypeDecimalTypeDict", - "ValueTypeDataTypeDict", "ValueTypeDataTypeDoubleType", - "ValueTypeDataTypeDoubleTypeDict", "ValueTypeDataTypeFloatType", - "ValueTypeDataTypeFloatTypeDict", "ValueTypeDataTypeIntegerType", - "ValueTypeDataTypeIntegerTypeDict", "ValueTypeDataTypeLongType", - "ValueTypeDataTypeLongTypeDict", "ValueTypeDataTypeMapType", - "ValueTypeDataTypeMapTypeDict", "ValueTypeDataTypeOptionalType", - "ValueTypeDataTypeOptionalTypeDict", "ValueTypeDataTypeShortType", - "ValueTypeDataTypeShortTypeDict", "ValueTypeDataTypeStringType", - "ValueTypeDataTypeStringTypeDict", "ValueTypeDataTypeStructElement", - "ValueTypeDataTypeStructElementDict", "ValueTypeDataTypeStructFieldIdentifier", "ValueTypeDataTypeStructType", - "ValueTypeDataTypeStructTypeDict", "ValueTypeDataTypeTimestampType", - "ValueTypeDataTypeTimestampTypeDict", "ValueTypeDataTypeUnionType", - "ValueTypeDataTypeUnionTypeDict", "ValueTypeDataTypeValueTypeReference", - "ValueTypeDataTypeValueTypeReferenceDict", "ValueTypeDescription", - "ValueTypeDict", "ValueTypeReference", - "ValueTypeReferenceDict", "ValueTypeRid", "ValueTypeVersion", "ValueTypeVersionId", "VersionId", - "VersionIdDict", ] diff --git a/foundry/v2/geo/models.py b/foundry/v2/geo/models.py index 4df00df32..248b47eb6 100644 --- a/foundry/v2/geo/models.py +++ b/foundry/v2/geo/models.py @@ -62,9 +62,9 @@ class Feature(pydantic.BaseModel): type: typing.Literal["Feature"] = "Feature" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FeatureDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(FeatureDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) class FeatureCollection(pydantic.BaseModel): @@ -75,44 +75,9 @@ class FeatureCollection(pydantic.BaseModel): type: typing.Literal["FeatureCollection"] = "FeatureCollection" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FeatureCollectionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(FeatureCollectionDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class FeatureCollectionDict(typing_extensions.TypedDict): - """GeoJSon 'FeatureCollection' object""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - features: typing.List[FeatureCollectionTypesDict] - bbox: typing_extensions.NotRequired[BBox] - type: typing.Literal["FeatureCollection"] - - -class FeatureDict(typing_extensions.TypedDict): - """GeoJSon 'Feature' object""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - geometry: typing_extensions.NotRequired[GeometryDict] - properties: typing.Dict[FeaturePropertyKey, typing.Any] - """ - A `Feature` object has a member with the name "properties". The - value of the properties member is an object (any JSON object or a - JSON null value). - """ - - id: typing_extensions.NotRequired[typing.Any] - """ - If a `Feature` has a commonly used identifier, that identifier - SHOULD be included as a member of the Feature object with the name - "id", and the value of this member is either a JSON string or - number. - """ - - bbox: typing_extensions.NotRequired[BBox] - type: typing.Literal["Feature"] + return self.model_dump(by_alias=True, exclude_none=True) FeaturePropertyKey = str @@ -127,19 +92,9 @@ class GeoPoint(pydantic.BaseModel): type: typing.Literal["Point"] = "Point" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GeoPointDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(GeoPointDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class GeoPointDict(typing_extensions.TypedDict): - """GeoPoint""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: Position - bbox: typing_extensions.NotRequired[BBox] - type: typing.Literal["Point"] + return self.model_dump(by_alias=True, exclude_none=True) Geometry = typing_extensions.Annotated[ @@ -172,43 +127,9 @@ class GeometryCollection(pydantic.BaseModel): type: typing.Literal["GeometryCollection"] = "GeometryCollection" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GeometryCollectionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GeometryCollectionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GeometryCollectionDict(typing_extensions.TypedDict): - """ - GeoJSon geometry collection - - GeometryCollections composed of a single part or a number of parts of a - single type SHOULD be avoided when that single part or a single object - of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could - be used instead. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - geometries: typing.List[GeometryDict] - bbox: typing_extensions.NotRequired[BBox] - type: typing.Literal["GeometryCollection"] - - -GeometryDict = typing_extensions.Annotated[ - typing.Union[ - "MultiPointDict", - GeometryCollectionDict, - "MultiLineStringDict", - "LineStringDict", - "MultiPolygonDict", - GeoPointDict, - "PolygonDict", - ], - pydantic.Field(discriminator="type"), -] -"""Abstract type for all GeoJSon object except Feature and FeatureCollection""" + return self.model_dump(by_alias=True, exclude_none=True) class LineString(pydantic.BaseModel): @@ -219,9 +140,9 @@ class LineString(pydantic.BaseModel): type: typing.Literal["LineString"] = "LineString" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LineStringDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(LineStringDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) LineStringCoordinates = typing_extensions.Annotated[ @@ -230,16 +151,6 @@ def to_dict(self) -> "LineStringDict": """GeoJSon fundamental geometry construct, array of two or more positions.""" -class LineStringDict(typing_extensions.TypedDict): - """LineString""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: typing_extensions.NotRequired[LineStringCoordinates] - bbox: typing_extensions.NotRequired[BBox] - type: typing.Literal["LineString"] - - LinearRing = typing_extensions.Annotated[typing.List["Position"], annotated_types.Len(min_length=4)] """ A linear ring is a closed LineString with four or more positions. @@ -264,19 +175,9 @@ class MultiLineString(pydantic.BaseModel): type: typing.Literal["MultiLineString"] = "MultiLineString" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MultiLineStringDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MultiLineStringDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MultiLineStringDict(typing_extensions.TypedDict): - """MultiLineString""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: typing.List[LineStringCoordinates] - bbox: typing_extensions.NotRequired[BBox] - type: typing.Literal["MultiLineString"] + return self.model_dump(by_alias=True, exclude_none=True) class MultiPoint(pydantic.BaseModel): @@ -287,19 +188,9 @@ class MultiPoint(pydantic.BaseModel): type: typing.Literal["MultiPoint"] = "MultiPoint" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MultiPointDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MultiPointDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MultiPointDict(typing_extensions.TypedDict): - """MultiPoint""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: typing.List[Position] - bbox: typing_extensions.NotRequired[BBox] - type: typing.Literal["MultiPoint"] + return self.model_dump(by_alias=True, exclude_none=True) class MultiPolygon(pydantic.BaseModel): @@ -310,19 +201,9 @@ class MultiPolygon(pydantic.BaseModel): type: typing.Literal["MultiPolygon"] = "MultiPolygon" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MultiPolygonDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MultiPolygonDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MultiPolygonDict(typing_extensions.TypedDict): - """MultiPolygon""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: typing.List[typing.List[LinearRing]] - bbox: typing_extensions.NotRequired[BBox] - type: typing.Literal["MultiPolygon"] + return self.model_dump(by_alias=True, exclude_none=True) class Polygon(pydantic.BaseModel): @@ -333,19 +214,9 @@ class Polygon(pydantic.BaseModel): type: typing.Literal["Polygon"] = "Polygon" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "PolygonDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(PolygonDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class PolygonDict(typing_extensions.TypedDict): - """Polygon""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: typing.List[LinearRing] - bbox: typing_extensions.NotRequired[BBox] - type: typing.Literal["Polygon"] + return self.model_dump(by_alias=True, exclude_none=True) Position = typing_extensions.Annotated[ @@ -373,13 +244,8 @@ class PolygonDict(typing_extensions.TypedDict): """FeatureCollectionTypes""" -FeatureCollectionTypesDict = FeatureDict -"""FeatureCollectionTypes""" - - core.resolve_forward_references(BBox, globalns=globals(), localns=locals()) core.resolve_forward_references(Geometry, globalns=globals(), localns=locals()) -core.resolve_forward_references(GeometryDict, globalns=globals(), localns=locals()) core.resolve_forward_references(LineStringCoordinates, globalns=globals(), localns=locals()) core.resolve_forward_references(LinearRing, globalns=globals(), localns=locals()) core.resolve_forward_references(Position, globalns=globals(), localns=locals()) @@ -389,28 +255,17 @@ class PolygonDict(typing_extensions.TypedDict): "Coordinate", "Feature", "FeatureCollection", - "FeatureCollectionDict", "FeatureCollectionTypes", - "FeatureCollectionTypesDict", - "FeatureDict", "FeaturePropertyKey", "GeoPoint", - "GeoPointDict", "Geometry", "GeometryCollection", - "GeometryCollectionDict", - "GeometryDict", "LineString", "LineStringCoordinates", - "LineStringDict", "LinearRing", "MultiLineString", - "MultiLineStringDict", "MultiPoint", - "MultiPointDict", "MultiPolygon", - "MultiPolygonDict", "Polygon", - "PolygonDict", "Position", ] diff --git a/foundry/v2/media_sets/client.py b/foundry/v2/media_sets/client.py deleted file mode 100644 index b85f2d9a7..000000000 --- a/foundry/v2/media_sets/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v2.media_sets._client import MediaSetsClient - -__all__ = [ - "MediaSetsClient", -] diff --git a/foundry/v2/media_sets/models.py b/foundry/v2/media_sets/models.py index d329cf1f3..b81f24d1a 100644 --- a/foundry/v2/media_sets/models.py +++ b/foundry/v2/media_sets/models.py @@ -19,7 +19,6 @@ from datetime import datetime import pydantic -import typing_extensions from foundry import _core as core from foundry.v2.core import models as core_models @@ -44,22 +43,9 @@ class GetMediaItemInfoResponse(pydantic.BaseModel): attribution: typing.Optional[MediaAttribution] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GetMediaItemInfoResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GetMediaItemInfoResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GetMediaItemInfoResponseDict(typing_extensions.TypedDict): - """GetMediaItemInfoResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - viewRid: core_models.MediaSetViewRid - path: typing_extensions.NotRequired[core_models.MediaItemPath] - logicalTimestamp: LogicalTimestamp - attribution: typing_extensions.NotRequired[MediaAttributionDict] + return self.model_dump(by_alias=True, exclude_none=True) LogicalTimestamp = core.Long @@ -81,19 +67,9 @@ class MediaAttribution(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MediaAttributionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MediaAttributionDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MediaAttributionDict(typing_extensions.TypedDict): - """MediaAttribution""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - creatorId: core_models.UserId - creationTimestamp: datetime - """The timestamp when the media item was created, in ISO 8601 timestamp format.""" + return self.model_dump(by_alias=True, exclude_none=True) class PutMediaItemResponse(pydantic.BaseModel): @@ -102,19 +78,9 @@ class PutMediaItemResponse(pydantic.BaseModel): media_item_rid: core_models.MediaItemRid = pydantic.Field(alias=str("mediaItemRid")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "PutMediaItemResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - PutMediaItemResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class PutMediaItemResponseDict(typing_extensions.TypedDict): - """PutMediaItemResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - mediaItemRid: core_models.MediaItemRid + return self.model_dump(by_alias=True, exclude_none=True) TransactionId = core.UUID @@ -125,11 +91,8 @@ class PutMediaItemResponseDict(typing_extensions.TypedDict): "BranchName", "BranchRid", "GetMediaItemInfoResponse", - "GetMediaItemInfoResponseDict", "LogicalTimestamp", "MediaAttribution", - "MediaAttributionDict", "PutMediaItemResponse", - "PutMediaItemResponseDict", "TransactionId", ] diff --git a/foundry/v2/ontologies/action.py b/foundry/v2/ontologies/action.py index b7ac9cf6e..055d2430a 100644 --- a/foundry/v2/ontologies/action.py +++ b/foundry/v2/ontologies/action.py @@ -58,12 +58,7 @@ def apply( ontologies_models.ParameterId, typing.Optional[ontologies_models.DataValue] ], artifact_repository: typing.Optional[ontologies_models.ArtifactRepositoryRid] = None, - options: typing.Optional[ - typing.Union[ - ontologies_models.ApplyActionRequestOptions, - ontologies_models.ApplyActionRequestOptionsDict, - ] - ] = None, + options: typing.Optional[ontologies_models.ApplyActionRequestOptions] = None, package_name: typing.Optional[ontologies_models.SdkPackageName] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -88,7 +83,7 @@ def apply( :param artifact_repository: The repository associated with a marketplace installation. :type artifact_repository: Optional[ArtifactRepositoryRid] :param options: - :type options: Optional[Union[ApplyActionRequestOptions, ApplyActionRequestOptionsDict]] + :type options: Optional[ApplyActionRequestOptions] :param package_name: The package name of the generated SDK. :type package_name: Optional[SdkPackageName] :param request_timeout: timeout setting for this request in seconds. @@ -120,12 +115,7 @@ def apply( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "options": typing.Optional[ - typing.Union[ - ontologies_models.ApplyActionRequestOptions, - ontologies_models.ApplyActionRequestOptionsDict, - ] - ], + "options": typing.Optional[ontologies_models.ApplyActionRequestOptions], "parameters": typing.Dict[ ontologies_models.ParameterId, typing.Optional[ontologies_models.DataValue], @@ -147,19 +137,9 @@ def apply_batch( ontology: ontologies_models.OntologyIdentifier, action: ontologies_models.ActionTypeApiName, *, - requests: typing.List[ - typing.Union[ - ontologies_models.BatchApplyActionRequestItem, - ontologies_models.BatchApplyActionRequestItemDict, - ] - ], + requests: typing.List[ontologies_models.BatchApplyActionRequestItem], artifact_repository: typing.Optional[ontologies_models.ArtifactRepositoryRid] = None, - options: typing.Optional[ - typing.Union[ - ontologies_models.BatchApplyActionRequestOptions, - ontologies_models.BatchApplyActionRequestOptionsDict, - ] - ] = None, + options: typing.Optional[ontologies_models.BatchApplyActionRequestOptions] = None, package_name: typing.Optional[ontologies_models.SdkPackageName] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -181,11 +161,11 @@ def apply_batch( :param action: The API name of the action to apply. To find the API name for your action, use the **List action types** endpoint or check the **Ontology Manager**. :type action: ActionTypeApiName :param requests: - :type requests: List[Union[BatchApplyActionRequestItem, BatchApplyActionRequestItemDict]] + :type requests: List[BatchApplyActionRequestItem] :param artifact_repository: The repository associated with a marketplace installation. :type artifact_repository: Optional[ArtifactRepositoryRid] :param options: - :type options: Optional[Union[BatchApplyActionRequestOptions, BatchApplyActionRequestOptionsDict]] + :type options: Optional[BatchApplyActionRequestOptions] :param package_name: The package name of the generated SDK. :type package_name: Optional[SdkPackageName] :param request_timeout: timeout setting for this request in seconds. @@ -218,17 +198,9 @@ def apply_batch( "Body", { # type: ignore "options": typing.Optional[ - typing.Union[ - ontologies_models.BatchApplyActionRequestOptions, - ontologies_models.BatchApplyActionRequestOptionsDict, - ] - ], - "requests": typing.List[ - typing.Union[ - ontologies_models.BatchApplyActionRequestItem, - ontologies_models.BatchApplyActionRequestItemDict, - ] + ontologies_models.BatchApplyActionRequestOptions ], + "requests": typing.List[ontologies_models.BatchApplyActionRequestItem], }, ), response_type=ontologies_models.BatchApplyActionResponseV2, diff --git a/foundry/v2/ontologies/action_type.py b/foundry/v2/ontologies/action_type.py index b2dff2f44..3d1e622f6 100644 --- a/foundry/v2/ontologies/action_type.py +++ b/foundry/v2/ontologies/action_type.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -197,79 +196,16 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - ontology: ontologies_models.OntologyIdentifier, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.ListActionTypesResponseV2: - """ - Lists the action types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. - :type ontology: OntologyIdentifier - :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.ListActionTypesResponseV2 - """ - - warnings.warn( - "The client.ontologies.ActionType.page(...) method has been deprecated. Please use client.ontologies.ActionType.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/actionTypes", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - }, - path_params={ - "ontology": ontology, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=ontologies_models.ListActionTypesResponseV2, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _ActionTypeClientRaw: def __init__(self, client: ActionTypeClient) -> None: def get(_: ontologies_models.ActionTypeV2): ... def get_by_rid(_: ontologies_models.ActionTypeV2): ... def list(_: ontologies_models.ListActionTypesResponseV2): ... - def page(_: ontologies_models.ListActionTypesResponseV2): ... self.get = core.with_raw_response(get, client.get) self.get_by_rid = core.with_raw_response(get_by_rid, client.get_by_rid) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) class _ActionTypeClientStreaming: @@ -277,9 +213,7 @@ def __init__(self, client: ActionTypeClient) -> None: def get(_: ontologies_models.ActionTypeV2): ... def get_by_rid(_: ontologies_models.ActionTypeV2): ... def list(_: ontologies_models.ListActionTypesResponseV2): ... - def page(_: ontologies_models.ListActionTypesResponseV2): ... self.get = core.with_streaming_response(get, client.get) self.get_by_rid = core.with_streaming_response(get_by_rid, client.get_by_rid) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/ontologies/client.py b/foundry/v2/ontologies/client.py deleted file mode 100644 index f38034bd2..000000000 --- a/foundry/v2/ontologies/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v2.ontologies._client import OntologiesClient - -__all__ = [ - "OntologiesClient", -] diff --git a/foundry/v2/ontologies/errors.py b/foundry/v2/ontologies/errors.py index ba3883a41..74aa277e6 100644 --- a/foundry/v2/ontologies/errors.py +++ b/foundry/v2/ontologies/errors.py @@ -753,7 +753,7 @@ class InvalidQueryParameterValueParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - parameterDataType: ontologies_models.QueryDataTypeDict + parameterDataType: ontologies_models.QueryDataType parameterId: ontologies_models.ParameterId parameterValue: typing_extensions.NotRequired[ontologies_models.DataValue] diff --git a/foundry/v2/ontologies/linked_object.py b/foundry/v2/ontologies/linked_object.py index 7d839f2c5..d4f7bfc44 100644 --- a/foundry/v2/ontologies/linked_object.py +++ b/foundry/v2/ontologies/linked_object.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -222,129 +221,22 @@ def list_linked_objects( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page_linked_objects( - self, - ontology: ontologies_models.OntologyIdentifier, - object_type: ontologies_models.ObjectTypeApiName, - primary_key: ontologies_models.PropertyValueEscapedString, - link_type: ontologies_models.LinkTypeApiName, - *, - artifact_repository: typing.Optional[ontologies_models.ArtifactRepositoryRid] = None, - exclude_rid: typing.Optional[bool] = None, - order_by: typing.Optional[ontologies_models.OrderBy] = None, - package_name: typing.Optional[ontologies_models.SdkPackageName] = None, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - select: typing.Optional[typing.List[ontologies_models.SelectedPropertyApiName]] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.ListLinkedObjectsResponseV2: - """ - Lists the linked objects for a specific object and the given link type. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. - :type ontology: OntologyIdentifier - :param object_type: The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. - :type object_type: ObjectTypeApiName - :param primary_key: The primary key of the object from which the links originate. To look up the expected primary key for your object type, use the `Get object type` endpoint or the **Ontology Manager**. - :type primary_key: PropertyValueEscapedString - :param link_type: The API name of the link that exists between the object and the requested objects. To find the API name for your link type, check the **Ontology Manager**. - :type link_type: LinkTypeApiName - :param artifact_repository: The repository associated with a marketplace installation. - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param exclude_rid: A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. - :type exclude_rid: Optional[bool] - :param order_by: - :type order_by: Optional[OrderBy] - :param package_name: The package name of the generated SDK. - :type package_name: Optional[SdkPackageName] - :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param select: The properties of the object type that should be included in the response. Omit this parameter to get all the properties. - :type select: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.ListLinkedObjectsResponseV2 - """ - - warnings.warn( - "The client.ontologies.LinkedObject.page_linked_objects(...) method has been deprecated. Please use client.ontologies.LinkedObject.list_linked_objects(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}", - query_params={ - "artifactRepository": artifact_repository, - "excludeRid": exclude_rid, - "orderBy": order_by, - "packageName": package_name, - "pageSize": page_size, - "pageToken": page_token, - "select": select, - }, - path_params={ - "ontology": ontology, - "objectType": object_type, - "primaryKey": primary_key, - "linkType": link_type, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=ontologies_models.ListLinkedObjectsResponseV2, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _LinkedObjectClientRaw: def __init__(self, client: LinkedObjectClient) -> None: def get_linked_object(_: ontologies_models.OntologyObjectV2): ... def list_linked_objects(_: ontologies_models.ListLinkedObjectsResponseV2): ... - def page_linked_objects(_: ontologies_models.ListLinkedObjectsResponseV2): ... self.get_linked_object = core.with_raw_response(get_linked_object, client.get_linked_object) self.list_linked_objects = core.with_raw_response( list_linked_objects, client.list_linked_objects ) - self.page_linked_objects = core.with_raw_response( - page_linked_objects, client.page_linked_objects - ) class _LinkedObjectClientStreaming: def __init__(self, client: LinkedObjectClient) -> None: def get_linked_object(_: ontologies_models.OntologyObjectV2): ... def list_linked_objects(_: ontologies_models.ListLinkedObjectsResponseV2): ... - def page_linked_objects(_: ontologies_models.ListLinkedObjectsResponseV2): ... self.get_linked_object = core.with_streaming_response( get_linked_object, client.get_linked_object @@ -352,6 +244,3 @@ def page_linked_objects(_: ontologies_models.ListLinkedObjectsResponseV2): ... self.list_linked_objects = core.with_streaming_response( list_linked_objects, client.list_linked_objects ) - self.page_linked_objects = core.with_streaming_response( - page_linked_objects, client.page_linked_objects - ) diff --git a/foundry/v2/ontologies/models.py b/foundry/v2/ontologies/models.py index 0a3d68358..713aea62f 100644 --- a/foundry/v2/ontologies/models.py +++ b/foundry/v2/ontologies/models.py @@ -34,19 +34,9 @@ class AbsoluteTimeRange(pydantic.BaseModel): type: typing.Literal["absolute"] = "absolute" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AbsoluteTimeRangeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AbsoluteTimeRangeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AbsoluteTimeRangeDict(typing_extensions.TypedDict): - """ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - startTime: typing_extensions.NotRequired[datetime] - endTime: typing_extensions.NotRequired[datetime] - type: typing.Literal["absolute"] + return self.model_dump(by_alias=True, exclude_none=True) class AbsoluteValuePropertyExpression(pydantic.BaseModel): @@ -56,20 +46,9 @@ class AbsoluteValuePropertyExpression(pydantic.BaseModel): type: typing.Literal["absoluteValue"] = "absoluteValue" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AbsoluteValuePropertyExpressionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AbsoluteValuePropertyExpressionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AbsoluteValuePropertyExpressionDict(typing_extensions.TypedDict): - """Calculates absolute value of a numeric value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - property: DerivedPropertyDefinitionDict - type: typing.Literal["absoluteValue"] + return self.model_dump(by_alias=True, exclude_none=True) class ActionParameterArrayType(pydantic.BaseModel): @@ -79,20 +58,9 @@ class ActionParameterArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ActionParameterArrayTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ActionParameterArrayTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ActionParameterArrayTypeDict(typing_extensions.TypedDict): - """ActionParameterArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: ActionParameterTypeDict - type: typing.Literal["array"] + return self.model_dump(by_alias=True, exclude_none=True) ActionParameterType = typing_extensions.Annotated[ @@ -119,30 +87,6 @@ class ActionParameterArrayTypeDict(typing_extensions.TypedDict): """A union of all the types supported by Ontology Action parameters.""" -ActionParameterTypeDict = typing_extensions.Annotated[ - typing.Union[ - core_models.DateTypeDict, - "OntologyInterfaceObjectTypeDict", - "OntologyStructTypeDict", - core_models.StringTypeDict, - core_models.DoubleTypeDict, - core_models.IntegerTypeDict, - core_models.LongTypeDict, - "OntologyObjectTypeReferenceTypeDict", - core_models.BooleanTypeDict, - core_models.MarkingTypeDict, - core_models.AttachmentTypeDict, - core_models.MediaReferenceTypeDict, - ActionParameterArrayTypeDict, - "OntologyObjectSetTypeDict", - "OntologyObjectTypeDict", - core_models.TimestampTypeDict, - ], - pydantic.Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Action parameters.""" - - class ActionParameterV2(pydantic.BaseModel): """Details about a parameter of an action.""" @@ -152,20 +96,9 @@ class ActionParameterV2(pydantic.BaseModel): required: bool model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ActionParameterV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ActionParameterV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ActionParameterV2Dict(typing_extensions.TypedDict): - """Details about a parameter of an action.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - displayName: core_models.DisplayName - description: typing_extensions.NotRequired[str] - dataType: ActionParameterTypeDict - required: bool + return self.model_dump(by_alias=True, exclude_none=True) ActionResults = typing_extensions.Annotated[ @@ -174,12 +107,6 @@ class ActionParameterV2Dict(typing_extensions.TypedDict): """ActionResults""" -ActionResultsDict = typing_extensions.Annotated[ - typing.Union["ObjectEditsDict", "ObjectTypeEditsDict"], pydantic.Field(discriminator="type") -] -"""ActionResults""" - - ActionRid = core.RID """The unique resource identifier for an action.""" @@ -207,23 +134,9 @@ class ActionTypeV2(pydantic.BaseModel): operations: typing.List[LogicRule] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ActionTypeV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ActionTypeV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ActionTypeV2Dict(typing_extensions.TypedDict): - """Represents an action type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ActionTypeApiName - description: typing_extensions.NotRequired[str] - displayName: typing_extensions.NotRequired[core_models.DisplayName] - status: core_models.ReleaseStatus - parameters: typing.Dict[ParameterId, ActionParameterV2Dict] - rid: ActionTypeRid - operations: typing.List[LogicRuleDict] + return self.model_dump(by_alias=True, exclude_none=True) class ActivePropertyTypeStatus(pydantic.BaseModel): @@ -235,22 +148,9 @@ class ActivePropertyTypeStatus(pydantic.BaseModel): type: typing.Literal["active"] = "active" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ActivePropertyTypeStatusDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ActivePropertyTypeStatusDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ActivePropertyTypeStatusDict(typing_extensions.TypedDict): - """ - This status indicates that the PropertyType will not change on short notice and should thus be safe to use in - user facing workflows. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["active"] + return self.model_dump(by_alias=True, exclude_none=True) class AddLink(pydantic.BaseModel): @@ -263,21 +163,9 @@ class AddLink(pydantic.BaseModel): type: typing.Literal["addLink"] = "addLink" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AddLinkDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AddLinkDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AddLinkDict(typing_extensions.TypedDict): - """AddLink""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - linkTypeApiNameAtoB: LinkTypeApiName - linkTypeApiNameBtoA: LinkTypeApiName - aSideObject: LinkSideObjectDict - bSideObject: LinkSideObjectDict - type: typing.Literal["addLink"] + return self.model_dump(by_alias=True, exclude_none=True) class AddObject(pydantic.BaseModel): @@ -288,19 +176,9 @@ class AddObject(pydantic.BaseModel): type: typing.Literal["addObject"] = "addObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AddObjectDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AddObjectDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AddObjectDict(typing_extensions.TypedDict): - """AddObject""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - primaryKey: PropertyValue - objectType: ObjectTypeApiName - type: typing.Literal["addObject"] + return self.model_dump(by_alias=True, exclude_none=True) class AddPropertyExpression(pydantic.BaseModel): @@ -310,20 +188,9 @@ class AddPropertyExpression(pydantic.BaseModel): type: typing.Literal["add"] = "add" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AddPropertyExpressionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AddPropertyExpressionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AddPropertyExpressionDict(typing_extensions.TypedDict): - """Adds two or more numeric values.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - properties: typing.List[DerivedPropertyDefinitionDict] - type: typing.Literal["add"] + return self.model_dump(by_alias=True, exclude_none=True) class AggregateObjectsResponseItemV2(pydantic.BaseModel): @@ -333,20 +200,9 @@ class AggregateObjectsResponseItemV2(pydantic.BaseModel): metrics: typing.List[AggregationMetricResultV2] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregateObjectsResponseItemV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregateObjectsResponseItemV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregateObjectsResponseItemV2Dict(typing_extensions.TypedDict): - """AggregateObjectsResponseItemV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - group: typing.Dict[AggregationGroupKeyV2, AggregationGroupValueV2] - metrics: typing.List[AggregationMetricResultV2Dict] + return self.model_dump(by_alias=True, exclude_none=True) class AggregateObjectsResponseV2(pydantic.BaseModel): @@ -357,21 +213,9 @@ class AggregateObjectsResponseV2(pydantic.BaseModel): data: typing.List[AggregateObjectsResponseItemV2] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregateObjectsResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregateObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregateObjectsResponseV2Dict(typing_extensions.TypedDict): - """AggregateObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - excludedItems: typing_extensions.NotRequired[int] - accuracy: AggregationAccuracy - data: typing.List[AggregateObjectsResponseItemV2Dict] + return self.model_dump(by_alias=True, exclude_none=True) class AggregateTimeSeries(pydantic.BaseModel): @@ -381,20 +225,9 @@ class AggregateTimeSeries(pydantic.BaseModel): strategy: TimeSeriesAggregationStrategy model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregateTimeSeriesDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregateTimeSeriesDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregateTimeSeriesDict(typing_extensions.TypedDict): - """AggregateTimeSeries""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - method: TimeSeriesAggregationMethod - strategy: TimeSeriesAggregationStrategyDict + return self.model_dump(by_alias=True, exclude_none=True) AggregationAccuracy = typing.Literal["ACCURATE", "APPROXIMATE"] @@ -417,25 +250,9 @@ class AggregationDurationGroupingV2(pydantic.BaseModel): type: typing.Literal["duration"] = "duration" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregationDurationGroupingV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregationDurationGroupingV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregationDurationGroupingV2Dict(typing_extensions.TypedDict): - """ - Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. - When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - value: int - unit: TimeUnit - type: typing.Literal["duration"] + return self.model_dump(by_alias=True, exclude_none=True) class AggregationExactGroupingV2(pydantic.BaseModel): @@ -447,22 +264,9 @@ class AggregationExactGroupingV2(pydantic.BaseModel): type: typing.Literal["exact"] = "exact" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregationExactGroupingV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregationExactGroupingV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregationExactGroupingV2Dict(typing_extensions.TypedDict): - """Divides objects into groups according to an exact value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - maxGroupCount: typing_extensions.NotRequired[int] - defaultValue: typing_extensions.NotRequired[str] - type: typing.Literal["exact"] + return self.model_dump(by_alias=True, exclude_none=True) class AggregationFixedWidthGroupingV2(pydantic.BaseModel): @@ -473,21 +277,9 @@ class AggregationFixedWidthGroupingV2(pydantic.BaseModel): type: typing.Literal["fixedWidth"] = "fixedWidth" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregationFixedWidthGroupingV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregationFixedWidthGroupingV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregationFixedWidthGroupingV2Dict(typing_extensions.TypedDict): - """Divides objects into groups with the specified width.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - fixedWidth: int - type: typing.Literal["fixedWidth"] + return self.model_dump(by_alias=True, exclude_none=True) AggregationGroupByV2 = typing_extensions.Annotated[ @@ -502,18 +294,6 @@ class AggregationFixedWidthGroupingV2Dict(typing_extensions.TypedDict): """Specifies a grouping for aggregation results.""" -AggregationGroupByV2Dict = typing_extensions.Annotated[ - typing.Union[ - AggregationDurationGroupingV2Dict, - AggregationFixedWidthGroupingV2Dict, - "AggregationRangesGroupingV2Dict", - AggregationExactGroupingV2Dict, - ], - pydantic.Field(discriminator="type"), -] -"""Specifies a grouping for aggregation results.""" - - AggregationGroupKeyV2 = str """AggregationGroupKeyV2""" @@ -538,24 +318,9 @@ class AggregationMetricResultV2(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregationMetricResultV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregationMetricResultV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregationMetricResultV2Dict(typing_extensions.TypedDict): - """AggregationMetricResultV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: str - value: typing_extensions.NotRequired[typing.Any] - """ - The value of the metric. This will be a double in the case of - a numeric metric, or a date string in the case of a date metric. - """ + return self.model_dump(by_alias=True, exclude_none=True) class AggregationRangeV2(pydantic.BaseModel): @@ -569,23 +334,9 @@ class AggregationRangeV2(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregationRangeV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregationRangeV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregationRangeV2Dict(typing_extensions.TypedDict): - """Specifies a range from an inclusive start value to an exclusive end value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - startValue: typing.Any - """Inclusive start.""" - - endValue: typing.Any - """Exclusive end.""" + return self.model_dump(by_alias=True, exclude_none=True) class AggregationRangesGroupingV2(pydantic.BaseModel): @@ -596,21 +347,9 @@ class AggregationRangesGroupingV2(pydantic.BaseModel): type: typing.Literal["ranges"] = "ranges" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AggregationRangesGroupingV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - AggregationRangesGroupingV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class AggregationRangesGroupingV2Dict(typing_extensions.TypedDict): - """Divides objects into groups according to specified ranges.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - ranges: typing.List[AggregationRangeV2Dict] - type: typing.Literal["ranges"] + return self.model_dump(by_alias=True, exclude_none=True) AggregationV2 = typing_extensions.Annotated[ @@ -629,22 +368,6 @@ class AggregationRangesGroupingV2Dict(typing_extensions.TypedDict): """Specifies an aggregation function.""" -AggregationV2Dict = typing_extensions.Annotated[ - typing.Union[ - "ApproximateDistinctAggregationV2Dict", - "MinAggregationV2Dict", - "AvgAggregationV2Dict", - "MaxAggregationV2Dict", - "ApproximatePercentileAggregationV2Dict", - "CountAggregationV2Dict", - "SumAggregationV2Dict", - "ExactDistinctAggregationV2Dict", - ], - pydantic.Field(discriminator="type"), -] -"""Specifies an aggregation function.""" - - class AndQueryV2(pydantic.BaseModel): """Returns objects where every query is satisfied.""" @@ -652,18 +375,9 @@ class AndQueryV2(pydantic.BaseModel): type: typing.Literal["and"] = "and" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AndQueryV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AndQueryV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AndQueryV2Dict(typing_extensions.TypedDict): - """Returns objects where every query is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: typing.List[SearchJsonQueryV2Dict] - type: typing.Literal["and"] + return self.model_dump(by_alias=True, exclude_none=True) ApplyActionMode = typing.Literal["VALIDATE_ONLY", "VALIDATE_AND_EXECUTE"] @@ -677,20 +391,9 @@ class ApplyActionRequestOptions(pydantic.BaseModel): return_edits: typing.Optional[ReturnEditsMode] = pydantic.Field(alias=str("returnEdits"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ApplyActionRequestOptionsDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ApplyActionRequestOptionsDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ApplyActionRequestOptionsDict(typing_extensions.TypedDict): - """ApplyActionRequestOptions""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - mode: typing_extensions.NotRequired[ApplyActionMode] - returnEdits: typing_extensions.NotRequired[ReturnEditsMode] + return self.model_dump(by_alias=True, exclude_none=True) class ApproximateDistinctAggregationV2(pydantic.BaseModel): @@ -702,22 +405,9 @@ class ApproximateDistinctAggregationV2(pydantic.BaseModel): type: typing.Literal["approximateDistinct"] = "approximateDistinct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ApproximateDistinctAggregationV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ApproximateDistinctAggregationV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ApproximateDistinctAggregationV2Dict(typing_extensions.TypedDict): - """Computes an approximate number of distinct values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - name: typing_extensions.NotRequired[AggregationMetricName] - direction: typing_extensions.NotRequired[OrderByDirection] - type: typing.Literal["approximateDistinct"] + return self.model_dump(by_alias=True, exclude_none=True) class ApproximatePercentileAggregationV2(pydantic.BaseModel): @@ -730,24 +420,9 @@ class ApproximatePercentileAggregationV2(pydantic.BaseModel): type: typing.Literal["approximatePercentile"] = "approximatePercentile" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ApproximatePercentileAggregationV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ApproximatePercentileAggregationV2Dict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class ApproximatePercentileAggregationV2Dict(typing_extensions.TypedDict): - """Computes the approximate percentile value for the provided field. Requires Object Storage V2.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - name: typing_extensions.NotRequired[AggregationMetricName] - approximatePercentile: float - direction: typing_extensions.NotRequired[OrderByDirection] - type: typing.Literal["approximatePercentile"] + return self.model_dump(by_alias=True, exclude_none=True) class ArraySizeConstraint(pydantic.BaseModel): @@ -768,31 +443,9 @@ class ArraySizeConstraint(pydantic.BaseModel): type: typing.Literal["arraySize"] = "arraySize" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ArraySizeConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ArraySizeConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ArraySizeConstraintDict(typing_extensions.TypedDict): - """The parameter expects an array of values and the size of the array must fall within the defined range.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - lt: typing_extensions.NotRequired[typing.Any] - """Less than""" - - lte: typing_extensions.NotRequired[typing.Any] - """Less than or equal""" - - gt: typing_extensions.NotRequired[typing.Any] - """Greater than""" - - gte: typing_extensions.NotRequired[typing.Any] - """Greater than or equal""" - - type: typing.Literal["arraySize"] + return self.model_dump(by_alias=True, exclude_none=True) ArtifactRepositoryRid = core.RID @@ -805,13 +458,6 @@ class ArraySizeConstraintDict(typing_extensions.TypedDict): """The attachment metadata response""" -AttachmentMetadataResponseDict = typing_extensions.Annotated[ - typing.Union["AttachmentV2Dict", "ListAttachmentsResponseV2Dict"], - pydantic.Field(discriminator="type"), -] -"""The attachment metadata response""" - - AttachmentRid = core.RID """The unique resource identifier of an attachment.""" @@ -826,21 +472,9 @@ class AttachmentV2(pydantic.BaseModel): type: typing.Literal["single"] = "single" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AttachmentV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AttachmentV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AttachmentV2Dict(typing_extensions.TypedDict): - """The representation of an attachment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: AttachmentRid - filename: core_models.Filename - sizeBytes: core_models.SizeBytes - mediaType: core_models.MediaType - type: typing.Literal["single"] + return self.model_dump(by_alias=True, exclude_none=True) class AvgAggregationV2(pydantic.BaseModel): @@ -852,20 +486,9 @@ class AvgAggregationV2(pydantic.BaseModel): type: typing.Literal["avg"] = "avg" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AvgAggregationV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AvgAggregationV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AvgAggregationV2Dict(typing_extensions.TypedDict): - """Computes the average value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - name: typing_extensions.NotRequired[AggregationMetricName] - direction: typing_extensions.NotRequired[OrderByDirection] - type: typing.Literal["avg"] + return self.model_dump(by_alias=True, exclude_none=True) BatchActionObjectEdit = typing_extensions.Annotated[ @@ -874,13 +497,6 @@ class AvgAggregationV2Dict(typing_extensions.TypedDict): """BatchActionObjectEdit""" -BatchActionObjectEditDict = typing_extensions.Annotated[ - typing.Union["ModifyObjectDict", AddObjectDict, AddLinkDict], - pydantic.Field(discriminator="type"), -] -"""BatchActionObjectEdit""" - - class BatchActionObjectEdits(pydantic.BaseModel): """BatchActionObjectEdits""" @@ -893,25 +509,9 @@ class BatchActionObjectEdits(pydantic.BaseModel): type: typing.Literal["edits"] = "edits" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BatchActionObjectEditsDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - BatchActionObjectEditsDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class BatchActionObjectEditsDict(typing_extensions.TypedDict): - """BatchActionObjectEdits""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - edits: typing.List[BatchActionObjectEditDict] - addedObjectCount: int - modifiedObjectsCount: int - deletedObjectsCount: int - addedLinksCount: int - deletedLinksCount: int - type: typing.Literal["edits"] + return self.model_dump(by_alias=True, exclude_none=True) BatchActionResults = typing_extensions.Annotated[ @@ -920,32 +520,15 @@ class BatchActionObjectEditsDict(typing_extensions.TypedDict): """BatchActionResults""" -BatchActionResultsDict = typing_extensions.Annotated[ - typing.Union[BatchActionObjectEditsDict, "ObjectTypeEditsDict"], - pydantic.Field(discriminator="type"), -] -"""BatchActionResults""" - - class BatchApplyActionRequestItem(pydantic.BaseModel): """BatchApplyActionRequestItem""" parameters: typing.Dict[ParameterId, typing.Optional[DataValue]] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BatchApplyActionRequestItemDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - BatchApplyActionRequestItemDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class BatchApplyActionRequestItemDict(typing_extensions.TypedDict): - """BatchApplyActionRequestItem""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: typing.Dict[ParameterId, typing.Optional[DataValue]] + return self.model_dump(by_alias=True, exclude_none=True) class BatchApplyActionRequestOptions(pydantic.BaseModel): @@ -954,19 +537,9 @@ class BatchApplyActionRequestOptions(pydantic.BaseModel): return_edits: typing.Optional[BatchReturnEditsMode] = pydantic.Field(alias=str("returnEdits"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BatchApplyActionRequestOptionsDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - BatchApplyActionRequestOptionsDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class BatchApplyActionRequestOptionsDict(typing_extensions.TypedDict): - """BatchApplyActionRequestOptions""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - returnEdits: typing_extensions.NotRequired[BatchReturnEditsMode] + return self.model_dump(by_alias=True, exclude_none=True) class BatchApplyActionResponseV2(pydantic.BaseModel): @@ -975,19 +548,9 @@ class BatchApplyActionResponseV2(pydantic.BaseModel): edits: typing.Optional[BatchActionResults] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BatchApplyActionResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - BatchApplyActionResponseV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class BatchApplyActionResponseV2Dict(typing_extensions.TypedDict): - """BatchApplyActionResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - edits: typing_extensions.NotRequired[BatchActionResultsDict] + return self.model_dump(by_alias=True, exclude_none=True) BatchReturnEditsMode = typing.Literal["ALL", "NONE"] @@ -1009,26 +572,9 @@ class BlueprintIcon(pydantic.BaseModel): type: typing.Literal["blueprint"] = "blueprint" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BlueprintIconDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(BlueprintIconDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class BlueprintIconDict(typing_extensions.TypedDict): - """BlueprintIcon""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - color: str - """A hexadecimal color code.""" - - name: str - """ - The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. - Used to specify the Blueprint icon to represent the object type in a React app. - """ - - type: typing.Literal["blueprint"] + return self.model_dump(by_alias=True, exclude_none=True) class BoundingBoxValue(pydantic.BaseModel): @@ -1038,18 +584,9 @@ class BoundingBoxValue(pydantic.BaseModel): bottom_right: WithinBoundingBoxPoint = pydantic.Field(alias=str("bottomRight")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BoundingBoxValueDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(BoundingBoxValueDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class BoundingBoxValueDict(typing_extensions.TypedDict): - """The top left and bottom right coordinate points that make up the bounding box.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - topLeft: WithinBoundingBoxPointDict - bottomRight: WithinBoundingBoxPointDict + return self.model_dump(by_alias=True, exclude_none=True) class CenterPoint(pydantic.BaseModel): @@ -1059,18 +596,9 @@ class CenterPoint(pydantic.BaseModel): distance: core_models.Distance model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CenterPointDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(CenterPointDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class CenterPointDict(typing_extensions.TypedDict): - """The coordinate point to use as the center of the distance query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - center: CenterPointTypesDict - distance: core_models.DistanceDict + return self.model_dump(by_alias=True, exclude_none=True) class ContainsAllTermsInOrderPrefixLastTerm(pydantic.BaseModel): @@ -1089,35 +617,16 @@ class ContainsAllTermsInOrderPrefixLastTerm(pydantic.BaseModel): ) model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ContainsAllTermsInOrderPrefixLastTermDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ContainsAllTermsInOrderPrefixLastTermDict, - self.model_dump(by_alias=True, exclude_none=True), - ) + return self.model_dump(by_alias=True, exclude_none=True) -class ContainsAllTermsInOrderPrefixLastTermDict(typing_extensions.TypedDict): +class ContainsAllTermsInOrderQuery(pydantic.BaseModel): """ Returns objects where the specified field contains all of the terms in the order provided, - but they do have to be adjacent to each other. - The last term can be a partial prefix match. Allows you to specify a property to query on - by a variety of means. Either `field` or `propertyIdentifier` can be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: str - type: typing.Literal["containsAllTermsInOrderPrefixLastTerm"] - - -class ContainsAllTermsInOrderQuery(pydantic.BaseModel): - """ - Returns objects where the specified field contains all of the terms in the order provided, - but they do have to be adjacent to each other. Allows you to specify a property to query on - by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. + but they do have to be adjacent to each other. Allows you to specify a property to query on + by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. """ field: typing.Optional[PropertyApiName] = None @@ -1126,26 +635,9 @@ class ContainsAllTermsInOrderQuery(pydantic.BaseModel): type: typing.Literal["containsAllTermsInOrder"] = "containsAllTermsInOrder" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ContainsAllTermsInOrderQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ContainsAllTermsInOrderQueryDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ContainsAllTermsInOrderQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field contains all of the terms in the order provided, - but they do have to be adjacent to each other. Allows you to specify a property to query on - by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: str - type: typing.Literal["containsAllTermsInOrder"] + return self.model_dump(by_alias=True, exclude_none=True) class ContainsAllTermsQuery(pydantic.BaseModel): @@ -1162,27 +654,9 @@ class ContainsAllTermsQuery(pydantic.BaseModel): type: typing.Literal["containsAllTerms"] = "containsAllTerms" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ContainsAllTermsQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ContainsAllTermsQueryDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ContainsAllTermsQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on - by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: str - fuzzy: typing_extensions.NotRequired[FuzzyV2] - type: typing.Literal["containsAllTerms"] + return self.model_dump(by_alias=True, exclude_none=True) class ContainsAnyTermQuery(pydantic.BaseModel): @@ -1199,27 +673,9 @@ class ContainsAnyTermQuery(pydantic.BaseModel): type: typing.Literal["containsAnyTerm"] = "containsAnyTerm" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ContainsAnyTermQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ContainsAnyTermQueryDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ContainsAnyTermQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field contains any of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on - by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: str - fuzzy: typing_extensions.NotRequired[FuzzyV2] - type: typing.Literal["containsAnyTerm"] + return self.model_dump(by_alias=True, exclude_none=True) class ContainsQueryV2(pydantic.BaseModel): @@ -1234,23 +690,9 @@ class ContainsQueryV2(pydantic.BaseModel): type: typing.Literal["contains"] = "contains" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ContainsQueryV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ContainsQueryV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ContainsQueryV2Dict(typing_extensions.TypedDict): - """ - Returns objects where the specified array contains a value. Allows you to specify a property to query on by a - variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: PropertyValue - type: typing.Literal["contains"] + return self.model_dump(by_alias=True, exclude_none=True) class CountAggregationV2(pydantic.BaseModel): @@ -1261,21 +703,9 @@ class CountAggregationV2(pydantic.BaseModel): type: typing.Literal["count"] = "count" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CountAggregationV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CountAggregationV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class CountAggregationV2Dict(typing_extensions.TypedDict): - """Computes the total count of objects.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: typing_extensions.NotRequired[AggregationMetricName] - direction: typing_extensions.NotRequired[OrderByDirection] - type: typing.Literal["count"] + return self.model_dump(by_alias=True, exclude_none=True) class CountObjectsResponseV2(pydantic.BaseModel): @@ -1284,19 +714,9 @@ class CountObjectsResponseV2(pydantic.BaseModel): count: typing.Optional[int] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CountObjectsResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CountObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class CountObjectsResponseV2Dict(typing_extensions.TypedDict): - """CountObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - count: typing_extensions.NotRequired[int] + return self.model_dump(by_alias=True, exclude_none=True) class CreateInterfaceObjectRule(pydantic.BaseModel): @@ -1306,20 +726,9 @@ class CreateInterfaceObjectRule(pydantic.BaseModel): type: typing.Literal["createInterfaceObject"] = "createInterfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateInterfaceObjectRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateInterfaceObjectRuleDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class CreateInterfaceObjectRuleDict(typing_extensions.TypedDict): - """CreateInterfaceObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - interfaceTypeApiName: InterfaceTypeApiName - type: typing.Literal["createInterfaceObject"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateLinkRule(pydantic.BaseModel): @@ -1332,21 +741,9 @@ class CreateLinkRule(pydantic.BaseModel): type: typing.Literal["createLink"] = "createLink" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateLinkRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(CreateLinkRuleDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class CreateLinkRuleDict(typing_extensions.TypedDict): - """CreateLinkRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - linkTypeApiNameAtoB: LinkTypeApiName - linkTypeApiNameBtoA: LinkTypeApiName - aSideObjectTypeApiName: ObjectTypeApiName - bSideObjectTypeApiName: ObjectTypeApiName - type: typing.Literal["createLink"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateObjectRule(pydantic.BaseModel): @@ -1356,18 +753,9 @@ class CreateObjectRule(pydantic.BaseModel): type: typing.Literal["createObject"] = "createObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateObjectRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(CreateObjectRuleDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class CreateObjectRuleDict(typing_extensions.TypedDict): - """CreateObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeApiName: ObjectTypeApiName - type: typing.Literal["createObject"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateTemporaryObjectSetResponseV2(pydantic.BaseModel): @@ -1376,20 +764,9 @@ class CreateTemporaryObjectSetResponseV2(pydantic.BaseModel): object_set_rid: ObjectSetRid = pydantic.Field(alias=str("objectSetRid")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateTemporaryObjectSetResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateTemporaryObjectSetResponseV2Dict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class CreateTemporaryObjectSetResponseV2Dict(typing_extensions.TypedDict): - """CreateTemporaryObjectSetResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSetRid: ObjectSetRid + return self.model_dump(by_alias=True, exclude_none=True) DataValue = typing.Any @@ -1432,20 +809,9 @@ class DeleteInterfaceObjectRule(pydantic.BaseModel): type: typing.Literal["deleteInterfaceObject"] = "deleteInterfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DeleteInterfaceObjectRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - DeleteInterfaceObjectRuleDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class DeleteInterfaceObjectRuleDict(typing_extensions.TypedDict): - """DeleteInterfaceObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - interfaceTypeApiName: InterfaceTypeApiName - type: typing.Literal["deleteInterfaceObject"] + return self.model_dump(by_alias=True, exclude_none=True) class DeleteLink(pydantic.BaseModel): @@ -1458,21 +824,9 @@ class DeleteLink(pydantic.BaseModel): type: typing.Literal["deleteLink"] = "deleteLink" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DeleteLinkDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DeleteLinkDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DeleteLinkDict(typing_extensions.TypedDict): - """DeleteLink""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - linkTypeApiNameAtoB: LinkTypeApiName - linkTypeApiNameBtoA: LinkTypeApiName - aSideObject: LinkSideObjectDict - bSideObject: LinkSideObjectDict - type: typing.Literal["deleteLink"] + return self.model_dump(by_alias=True, exclude_none=True) class DeleteLinkRule(pydantic.BaseModel): @@ -1485,21 +839,9 @@ class DeleteLinkRule(pydantic.BaseModel): type: typing.Literal["deleteLink"] = "deleteLink" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DeleteLinkRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DeleteLinkRuleDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DeleteLinkRuleDict(typing_extensions.TypedDict): - """DeleteLinkRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - linkTypeApiNameAtoB: LinkTypeApiName - linkTypeApiNameBtoA: LinkTypeApiName - aSideObjectTypeApiName: ObjectTypeApiName - bSideObjectTypeApiName: ObjectTypeApiName - type: typing.Literal["deleteLink"] + return self.model_dump(by_alias=True, exclude_none=True) class DeleteObject(pydantic.BaseModel): @@ -1510,19 +852,9 @@ class DeleteObject(pydantic.BaseModel): type: typing.Literal["deleteObject"] = "deleteObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DeleteObjectDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DeleteObjectDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DeleteObjectDict(typing_extensions.TypedDict): - """DeleteObject""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - primaryKey: PropertyValue - objectType: ObjectTypeApiName - type: typing.Literal["deleteObject"] + return self.model_dump(by_alias=True, exclude_none=True) class DeleteObjectRule(pydantic.BaseModel): @@ -1532,18 +864,9 @@ class DeleteObjectRule(pydantic.BaseModel): type: typing.Literal["deleteObject"] = "deleteObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DeleteObjectRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DeleteObjectRuleDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DeleteObjectRuleDict(typing_extensions.TypedDict): - """DeleteObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeApiName: ObjectTypeApiName - type: typing.Literal["deleteObject"] + return self.model_dump(by_alias=True, exclude_none=True) class DeprecatedPropertyTypeStatus(pydantic.BaseModel): @@ -1558,25 +881,9 @@ class DeprecatedPropertyTypeStatus(pydantic.BaseModel): type: typing.Literal["deprecated"] = "deprecated" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DeprecatedPropertyTypeStatusDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - DeprecatedPropertyTypeStatusDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class DeprecatedPropertyTypeStatusDict(typing_extensions.TypedDict): - """ - This status indicates that the PropertyType is reaching the end of its life and will be removed as per the - deadline specified. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - message: str - deadline: datetime - replacedBy: typing_extensions.NotRequired[PropertyTypeRid] - type: typing.Literal["deprecated"] + return self.model_dump(by_alias=True, exclude_none=True) DerivedPropertyApiName = str @@ -1602,25 +909,6 @@ class DeprecatedPropertyTypeStatusDict(typing_extensions.TypedDict): """Definition of a derived property.""" -DerivedPropertyDefinitionDict = typing_extensions.Annotated[ - typing.Union[ - AddPropertyExpressionDict, - AbsoluteValuePropertyExpressionDict, - "ExtractPropertyExpressionDict", - "SelectedPropertyExpressionDict", - "NegatePropertyExpressionDict", - "SubtractPropertyExpressionDict", - "PropertyApiNameSelectorDict", - "LeastPropertyExpressionDict", - "DividePropertyExpressionDict", - "MultiplyPropertyExpressionDict", - "GreatestPropertyExpressionDict", - ], - pydantic.Field(discriminator="type"), -] -"""Definition of a derived property.""" - - class DividePropertyExpression(pydantic.BaseModel): """Divides the left numeric value by the right numeric value.""" @@ -1629,21 +917,9 @@ class DividePropertyExpression(pydantic.BaseModel): type: typing.Literal["divide"] = "divide" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DividePropertyExpressionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - DividePropertyExpressionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class DividePropertyExpressionDict(typing_extensions.TypedDict): - """Divides the left numeric value by the right numeric value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - left: DerivedPropertyDefinitionDict - right: DerivedPropertyDefinitionDict - type: typing.Literal["divide"] + return self.model_dump(by_alias=True, exclude_none=True) class DoesNotIntersectBoundingBoxQuery(pydantic.BaseModel): @@ -1659,26 +935,9 @@ class DoesNotIntersectBoundingBoxQuery(pydantic.BaseModel): type: typing.Literal["doesNotIntersectBoundingBox"] = "doesNotIntersectBoundingBox" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DoesNotIntersectBoundingBoxQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - DoesNotIntersectBoundingBoxQueryDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class DoesNotIntersectBoundingBoxQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field does not intersect the bounding box provided. Allows you to specify a - property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not - both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: BoundingBoxValueDict - type: typing.Literal["doesNotIntersectBoundingBox"] + return self.model_dump(by_alias=True, exclude_none=True) class DoesNotIntersectPolygonQuery(pydantic.BaseModel): @@ -1694,26 +953,9 @@ class DoesNotIntersectPolygonQuery(pydantic.BaseModel): type: typing.Literal["doesNotIntersectPolygon"] = "doesNotIntersectPolygon" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DoesNotIntersectPolygonQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - DoesNotIntersectPolygonQueryDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class DoesNotIntersectPolygonQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field does not intersect the polygon provided. Allows you to specify a - property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not - both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: PolygonValueDict - type: typing.Literal["doesNotIntersectPolygon"] + return self.model_dump(by_alias=True, exclude_none=True) class DoubleVector(pydantic.BaseModel): @@ -1726,21 +968,9 @@ class DoubleVector(pydantic.BaseModel): type: typing.Literal["vector"] = "vector" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DoubleVectorDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DoubleVectorDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DoubleVectorDict(typing_extensions.TypedDict): - """ - The vector to search with. The vector must be of the same dimension as the vectors stored in the provided - propertyIdentifier. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: typing.List[float] - type: typing.Literal["vector"] + return self.model_dump(by_alias=True, exclude_none=True) class EntrySetType(pydantic.BaseModel): @@ -1751,19 +981,9 @@ class EntrySetType(pydantic.BaseModel): type: typing.Literal["entrySet"] = "entrySet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "EntrySetTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(EntrySetTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class EntrySetTypeDict(typing_extensions.TypedDict): - """EntrySetType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: QueryDataTypeDict - valueType: QueryDataTypeDict - type: typing.Literal["entrySet"] + return self.model_dump(by_alias=True, exclude_none=True) class EqualsQueryV2(pydantic.BaseModel): @@ -1778,23 +998,9 @@ class EqualsQueryV2(pydantic.BaseModel): type: typing.Literal["eq"] = "eq" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "EqualsQueryV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(EqualsQueryV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class EqualsQueryV2Dict(typing_extensions.TypedDict): - """ - Returns objects where the specified field is equal to a value. Allows you to specify a property to query on - by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: PropertyValue - type: typing.Literal["eq"] + return self.model_dump(by_alias=True, exclude_none=True) class ExactDistinctAggregationV2(pydantic.BaseModel): @@ -1806,22 +1012,9 @@ class ExactDistinctAggregationV2(pydantic.BaseModel): type: typing.Literal["exactDistinct"] = "exactDistinct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ExactDistinctAggregationV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ExactDistinctAggregationV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ExactDistinctAggregationV2Dict(typing_extensions.TypedDict): - """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - name: typing_extensions.NotRequired[AggregationMetricName] - direction: typing_extensions.NotRequired[OrderByDirection] - type: typing.Literal["exactDistinct"] + return self.model_dump(by_alias=True, exclude_none=True) class ExamplePropertyTypeStatus(pydantic.BaseModel): @@ -1833,22 +1026,9 @@ class ExamplePropertyTypeStatus(pydantic.BaseModel): type: typing.Literal["example"] = "example" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ExamplePropertyTypeStatusDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ExamplePropertyTypeStatusDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ExamplePropertyTypeStatusDict(typing_extensions.TypedDict): - """ - This status indicates that the PropertyType is an example. It is backed by notional data that should not be - used for actual workflows, but can be used to test those workflows. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["example"] + return self.model_dump(by_alias=True, exclude_none=True) class ExecuteQueryResponse(pydantic.BaseModel): @@ -1857,19 +1037,9 @@ class ExecuteQueryResponse(pydantic.BaseModel): value: DataValue model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ExecuteQueryResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ExecuteQueryResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ExecuteQueryResponseDict(typing_extensions.TypedDict): - """ExecuteQueryResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: DataValue + return self.model_dump(by_alias=True, exclude_none=True) class ExperimentalPropertyTypeStatus(pydantic.BaseModel): @@ -1878,19 +1048,9 @@ class ExperimentalPropertyTypeStatus(pydantic.BaseModel): type: typing.Literal["experimental"] = "experimental" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ExperimentalPropertyTypeStatusDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ExperimentalPropertyTypeStatusDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ExperimentalPropertyTypeStatusDict(typing_extensions.TypedDict): - """This status indicates that the PropertyType is in development.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["experimental"] + return self.model_dump(by_alias=True, exclude_none=True) ExtractDatePart = typing.Literal["DAYS", "MONTHS", "QUARTERS", "YEARS"] @@ -1905,21 +1065,9 @@ class ExtractPropertyExpression(pydantic.BaseModel): type: typing.Literal["extract"] = "extract" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ExtractPropertyExpressionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ExtractPropertyExpressionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ExtractPropertyExpressionDict(typing_extensions.TypedDict): - """Extracts the specified date part from a date or timestamp.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - property: DerivedPropertyDefinitionDict - part: ExtractDatePart - type: typing.Literal["extract"] + return self.model_dump(by_alias=True, exclude_none=True) FilterValue = str @@ -1956,25 +1104,9 @@ class GetSelectedPropertyOperation(pydantic.BaseModel): type: typing.Literal["get"] = "get" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GetSelectedPropertyOperationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GetSelectedPropertyOperationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GetSelectedPropertyOperationDict(typing_extensions.TypedDict): - """ - Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could - explode the cardinality. - - Use collectList or collectSet which will return a list of values in that case. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - selectedPropertyApiName: PropertyApiName - type: typing.Literal["get"] + return self.model_dump(by_alias=True, exclude_none=True) class GreatestPropertyExpression(pydantic.BaseModel): @@ -1984,20 +1116,9 @@ class GreatestPropertyExpression(pydantic.BaseModel): type: typing.Literal["greatest"] = "greatest" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GreatestPropertyExpressionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GreatestPropertyExpressionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GreatestPropertyExpressionDict(typing_extensions.TypedDict): - """Finds greatest of two or more numeric, date or timestamp values.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - properties: typing.List[DerivedPropertyDefinitionDict] - type: typing.Literal["greatest"] + return self.model_dump(by_alias=True, exclude_none=True) class GroupMemberConstraint(pydantic.BaseModel): @@ -2006,19 +1127,9 @@ class GroupMemberConstraint(pydantic.BaseModel): type: typing.Literal["groupMember"] = "groupMember" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GroupMemberConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GroupMemberConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GroupMemberConstraintDict(typing_extensions.TypedDict): - """The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["groupMember"] + return self.model_dump(by_alias=True, exclude_none=True) class GtQueryV2(pydantic.BaseModel): @@ -2033,23 +1144,9 @@ class GtQueryV2(pydantic.BaseModel): type: typing.Literal["gt"] = "gt" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GtQueryV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(GtQueryV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class GtQueryV2Dict(typing_extensions.TypedDict): - """ - Returns objects where the specified field is greater than a value. Allows you to specify a property to query on - by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: PropertyValue - type: typing.Literal["gt"] + return self.model_dump(by_alias=True, exclude_none=True) class GteQueryV2(pydantic.BaseModel): @@ -2064,23 +1161,9 @@ class GteQueryV2(pydantic.BaseModel): type: typing.Literal["gte"] = "gte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GteQueryV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(GteQueryV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class GteQueryV2Dict(typing_extensions.TypedDict): - """ - Returns objects where the specified field is greater than or equal to a value. Allows you to specify a property - to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: PropertyValue - type: typing.Literal["gte"] + return self.model_dump(by_alias=True, exclude_none=True) class InQuery(pydantic.BaseModel): @@ -2096,24 +1179,9 @@ class InQuery(pydantic.BaseModel): type: typing.Literal["in"] = "in" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "InQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(InQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class InQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field equals any of the provided values. Allows you to - specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, - but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: typing.List[PropertyValue] - type: typing.Literal["in"] + return self.model_dump(by_alias=True, exclude_none=True) class InterfaceLinkType(pydantic.BaseModel): @@ -2135,9 +1203,9 @@ class InterfaceLinkType(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "InterfaceLinkTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(InterfaceLinkTypeDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) InterfaceLinkTypeApiName = str @@ -2151,38 +1219,11 @@ def to_dict(self) -> "InterfaceLinkTypeDict": """ -class InterfaceLinkTypeDict(typing_extensions.TypedDict): - """ - A link type constraint defined at the interface level where the implementation of the links is provided - by the implementing object types. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: InterfaceLinkTypeRid - apiName: InterfaceLinkTypeApiName - displayName: core_models.DisplayName - description: typing_extensions.NotRequired[str] - """The description of the interface link type.""" - - linkedEntityApiName: InterfaceLinkTypeLinkedEntityApiNameDict - cardinality: InterfaceLinkTypeCardinality - required: bool - """Whether each implementing object type must declare at least one implementation of this link.""" - - -InterfaceLinkTypeLinkedEntityApiName = typing_extensions.Annotated[ - typing.Union["LinkedObjectTypeApiName", "LinkedInterfaceTypeApiName"], - pydantic.Field(discriminator="type"), -] -"""A reference to the linked entity. This can either be an object or an interface type.""" - - -InterfaceLinkTypeLinkedEntityApiNameDict = typing_extensions.Annotated[ - typing.Union["LinkedObjectTypeApiNameDict", "LinkedInterfaceTypeApiNameDict"], - pydantic.Field(discriminator="type"), -] -"""A reference to the linked entity. This can either be an object or an interface type.""" +InterfaceLinkTypeLinkedEntityApiName = typing_extensions.Annotated[ + typing.Union["LinkedObjectTypeApiName", "LinkedInterfaceTypeApiName"], + pydantic.Field(discriminator="type"), +] +"""A reference to the linked entity. This can either be an object or an interface type.""" InterfaceLinkTypeRid = core.RID @@ -2207,30 +1248,9 @@ class InterfaceSharedPropertyType(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "InterfaceSharedPropertyTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - InterfaceSharedPropertyTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class InterfaceSharedPropertyTypeDict(typing_extensions.TypedDict): - """ - A shared property type with an additional field to indicate whether the property must be included on every - object type that implements the interface, or whether it is optional. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: SharedPropertyTypeRid - apiName: SharedPropertyTypeApiName - displayName: core_models.DisplayName - description: typing_extensions.NotRequired[str] - """A short text that describes the SharedPropertyType.""" - - dataType: ObjectPropertyTypeDict - required: bool - """Whether each implementing object type must declare an implementation for this property.""" + return self.model_dump(by_alias=True, exclude_none=True) InterfaceToObjectTypeMapping = typing.Dict["SharedPropertyTypeApiName", "PropertyApiName"] @@ -2289,9 +1309,9 @@ class InterfaceType(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "InterfaceTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(InterfaceTypeDict, self.model_dump(by_alias=True, exclude_none=True)) + return self.model_dump(by_alias=True, exclude_none=True) InterfaceTypeApiName = str @@ -2301,55 +1321,6 @@ def to_dict(self) -> "InterfaceTypeDict": """ -class InterfaceTypeDict(typing_extensions.TypedDict): - """Represents an interface type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: InterfaceTypeRid - apiName: InterfaceTypeApiName - displayName: core_models.DisplayName - description: typing_extensions.NotRequired[str] - """The description of the interface.""" - - properties: typing.Dict[SharedPropertyTypeApiName, InterfaceSharedPropertyTypeDict] - """ - A map from a shared property type API name to the corresponding shared property type. The map describes the - set of properties the interface has. A shared property type must be unique across all of the properties. - """ - - allProperties: typing.Dict[SharedPropertyTypeApiName, InterfaceSharedPropertyTypeDict] - """ - A map from a shared property type API name to the corresponding shared property type. The map describes the - set of properties the interface has, including properties from all directly and indirectly extended - interfaces. - """ - - extendsInterfaces: typing.List[InterfaceTypeApiName] - """ - A list of interface API names that this interface extends. An interface can extend other interfaces to - inherit their properties. - """ - - allExtendsInterfaces: typing.List[InterfaceTypeApiName] - """A list of interface API names that this interface extends, both directly and indirectly.""" - - implementedByObjectTypes: typing.List[ObjectTypeApiName] - """A list of object API names that implement this interface.""" - - links: typing.Dict[InterfaceLinkTypeApiName, InterfaceLinkTypeDict] - """ - A map from an interface link type API name to the corresponding interface link type. The map describes the - set of link types the interface has. - """ - - allLinks: typing.Dict[InterfaceLinkTypeApiName, InterfaceLinkTypeDict] - """ - A map from an interface link type API name to the corresponding interface link type. The map describes the - set of link types the interface has, including links from all directly and indirectly extended interfaces. - """ - - InterfaceTypeRid = core.RID """The unique resource identifier of an interface, useful for interacting with other Foundry APIs.""" @@ -2366,25 +1337,9 @@ class IntersectsBoundingBoxQuery(pydantic.BaseModel): type: typing.Literal["intersectsBoundingBox"] = "intersectsBoundingBox" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "IntersectsBoundingBoxQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - IntersectsBoundingBoxQueryDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class IntersectsBoundingBoxQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field intersects the bounding box provided. Allows you to specify a property - to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: BoundingBoxValueDict - type: typing.Literal["intersectsBoundingBox"] + return self.model_dump(by_alias=True, exclude_none=True) class IntersectsPolygonQuery(pydantic.BaseModel): @@ -2399,25 +1354,9 @@ class IntersectsPolygonQuery(pydantic.BaseModel): type: typing.Literal["intersectsPolygon"] = "intersectsPolygon" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "IntersectsPolygonQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - IntersectsPolygonQueryDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class IntersectsPolygonQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field intersects the polygon provided. Allows you to specify a property to - query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: PolygonValueDict - type: typing.Literal["intersectsPolygon"] + return self.model_dump(by_alias=True, exclude_none=True) class IsNullQueryV2(pydantic.BaseModel): @@ -2432,23 +1371,9 @@ class IsNullQueryV2(pydantic.BaseModel): type: typing.Literal["isNull"] = "isNull" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "IsNullQueryV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(IsNullQueryV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class IsNullQueryV2Dict(typing_extensions.TypedDict): - """ - Returns objects based on the existence of the specified field. Allows you to specify a property to query on - by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: bool - type: typing.Literal["isNull"] + return self.model_dump(by_alias=True, exclude_none=True) class LeastPropertyExpression(pydantic.BaseModel): @@ -2458,20 +1383,9 @@ class LeastPropertyExpression(pydantic.BaseModel): type: typing.Literal["least"] = "least" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LeastPropertyExpressionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - LeastPropertyExpressionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class LeastPropertyExpressionDict(typing_extensions.TypedDict): - """Finds least of two or more numeric, date or timestamp values.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - properties: typing.List[DerivedPropertyDefinitionDict] - type: typing.Literal["least"] + return self.model_dump(by_alias=True, exclude_none=True) class LinkSideObject(pydantic.BaseModel): @@ -2481,18 +1395,9 @@ class LinkSideObject(pydantic.BaseModel): object_type: ObjectTypeApiName = pydantic.Field(alias=str("objectType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LinkSideObjectDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(LinkSideObjectDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class LinkSideObjectDict(typing_extensions.TypedDict): - """LinkSideObject""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - primaryKey: PropertyValue - objectType: ObjectTypeApiName + return self.model_dump(by_alias=True, exclude_none=True) LinkTypeApiName = str @@ -2522,23 +1427,9 @@ class LinkTypeSideV2(pydantic.BaseModel): link_type_rid: LinkTypeRid = pydantic.Field(alias=str("linkTypeRid")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LinkTypeSideV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(LinkTypeSideV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class LinkTypeSideV2Dict(typing_extensions.TypedDict): - """LinkTypeSideV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: LinkTypeApiName - displayName: core_models.DisplayName - status: core_models.ReleaseStatus - objectTypeApiName: ObjectTypeApiName - cardinality: LinkTypeSideCardinality - foreignKeyPropertyApiName: typing_extensions.NotRequired[PropertyApiName] - linkTypeRid: LinkTypeRid + return self.model_dump(by_alias=True, exclude_none=True) class LinkedInterfaceTypeApiName(pydantic.BaseModel): @@ -2548,20 +1439,9 @@ class LinkedInterfaceTypeApiName(pydantic.BaseModel): type: typing.Literal["interfaceTypeApiName"] = "interfaceTypeApiName" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LinkedInterfaceTypeApiNameDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - LinkedInterfaceTypeApiNameDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class LinkedInterfaceTypeApiNameDict(typing_extensions.TypedDict): - """A reference to the linked interface type.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: InterfaceTypeApiName - type: typing.Literal["interfaceTypeApiName"] + return self.model_dump(by_alias=True, exclude_none=True) class LinkedObjectTypeApiName(pydantic.BaseModel): @@ -2571,20 +1451,9 @@ class LinkedObjectTypeApiName(pydantic.BaseModel): type: typing.Literal["objectTypeApiName"] = "objectTypeApiName" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LinkedObjectTypeApiNameDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - LinkedObjectTypeApiNameDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class LinkedObjectTypeApiNameDict(typing_extensions.TypedDict): - """A reference to the linked object type.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ObjectTypeApiName - type: typing.Literal["objectTypeApiName"] + return self.model_dump(by_alias=True, exclude_none=True) class ListActionTypesResponseV2(pydantic.BaseModel): @@ -2594,20 +1463,9 @@ class ListActionTypesResponseV2(pydantic.BaseModel): data: typing.List[ActionTypeV2] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListActionTypesResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListActionTypesResponseV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListActionTypesResponseV2Dict(typing_extensions.TypedDict): - """ListActionTypesResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[ActionTypeV2Dict] + return self.model_dump(by_alias=True, exclude_none=True) class ListAttachmentsResponseV2(pydantic.BaseModel): @@ -2618,21 +1476,9 @@ class ListAttachmentsResponseV2(pydantic.BaseModel): type: typing.Literal["multiple"] = "multiple" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListAttachmentsResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListAttachmentsResponseV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListAttachmentsResponseV2Dict(typing_extensions.TypedDict): - """ListAttachmentsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[AttachmentV2Dict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - type: typing.Literal["multiple"] + return self.model_dump(by_alias=True, exclude_none=True) class ListInterfaceTypesResponse(pydantic.BaseModel): @@ -2642,20 +1488,9 @@ class ListInterfaceTypesResponse(pydantic.BaseModel): data: typing.List[InterfaceType] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListInterfaceTypesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListInterfaceTypesResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListInterfaceTypesResponseDict(typing_extensions.TypedDict): - """ListInterfaceTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[InterfaceTypeDict] + return self.model_dump(by_alias=True, exclude_none=True) class ListLinkedObjectsResponseV2(pydantic.BaseModel): @@ -2665,20 +1500,9 @@ class ListLinkedObjectsResponseV2(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListLinkedObjectsResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListLinkedObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListLinkedObjectsResponseV2Dict(typing_extensions.TypedDict): - """ListLinkedObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[OntologyObjectV2] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListObjectTypesV2Response(pydantic.BaseModel): @@ -2690,21 +1514,9 @@ class ListObjectTypesV2Response(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListObjectTypesV2ResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListObjectTypesV2ResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListObjectTypesV2ResponseDict(typing_extensions.TypedDict): - """ListObjectTypesV2Response""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[ObjectTypeV2Dict] - """The list of object types in the current page.""" + return self.model_dump(by_alias=True, exclude_none=True) class ListObjectsResponseV2(pydantic.BaseModel): @@ -2717,23 +1529,9 @@ class ListObjectsResponseV2(pydantic.BaseModel): total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListObjectsResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListObjectsResponseV2Dict(typing_extensions.TypedDict): - """ListObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[OntologyObjectV2] - """The list of objects in the current page.""" - - totalCount: core_models.TotalCount + return self.model_dump(by_alias=True, exclude_none=True) class ListOntologiesV2Response(pydantic.BaseModel): @@ -2744,20 +1542,9 @@ class ListOntologiesV2Response(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListOntologiesV2ResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListOntologiesV2ResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListOntologiesV2ResponseDict(typing_extensions.TypedDict): - """ListOntologiesV2Response""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[OntologyV2Dict] - """The list of Ontologies the user has access to.""" + return self.model_dump(by_alias=True, exclude_none=True) class ListOutgoingLinkTypesResponseV2(pydantic.BaseModel): @@ -2769,21 +1556,9 @@ class ListOutgoingLinkTypesResponseV2(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListOutgoingLinkTypesResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListOutgoingLinkTypesResponseV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListOutgoingLinkTypesResponseV2Dict(typing_extensions.TypedDict): - """ListOutgoingLinkTypesResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[LinkTypeSideV2Dict] - """The list of link type sides in the current page.""" + return self.model_dump(by_alias=True, exclude_none=True) class ListQueryTypesResponseV2(pydantic.BaseModel): @@ -2793,20 +1568,9 @@ class ListQueryTypesResponseV2(pydantic.BaseModel): data: typing.List[QueryTypeV2] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListQueryTypesResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListQueryTypesResponseV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListQueryTypesResponseV2Dict(typing_extensions.TypedDict): - """ListQueryTypesResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - data: typing.List[QueryTypeV2Dict] + return self.model_dump(by_alias=True, exclude_none=True) class LoadObjectSetResponseV2(pydantic.BaseModel): @@ -2819,23 +1583,9 @@ class LoadObjectSetResponseV2(pydantic.BaseModel): total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LoadObjectSetResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - LoadObjectSetResponseV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class LoadObjectSetResponseV2Dict(typing_extensions.TypedDict): - """Represents the API response when loading an `ObjectSet`.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[OntologyObjectV2] - """The list of objects in the current Page.""" - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - totalCount: core_models.TotalCount + return self.model_dump(by_alias=True, exclude_none=True) class LoadObjectSetV2MultipleObjectTypesResponse(pydantic.BaseModel): @@ -2858,34 +1608,9 @@ class LoadObjectSetV2MultipleObjectTypesResponse(pydantic.BaseModel): interface_to_object_type_mappings: typing.Dict[InterfaceTypeApiName, InterfaceToObjectTypeMappings] = pydantic.Field(alias=str("interfaceToObjectTypeMappings")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LoadObjectSetV2MultipleObjectTypesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - LoadObjectSetV2MultipleObjectTypesResponseDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class LoadObjectSetV2MultipleObjectTypesResponseDict(typing_extensions.TypedDict): - """ - Represents the API response when loading an `ObjectSet`. An `interfaceToObjectTypeMappings` field is - optionally returned if the type scope of the returned object set includes any interfaces. The "type scope" - of an object set refers to whether objects contain all their properties (object-type type scope) or just the - properties that implement interface properties (interface type scope). There can be multiple type scopes in a - single object set- some objects may have all their properties and some may only have interface properties. - - The `interfaceToObjectTypeMappings` field contains mappings from `SharedPropertyTypeApiName`s on the interface(s) to - `PropertyApiName` for properties on the object(s). - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[OntologyObjectV2] - """The list of objects in the current page.""" - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - totalCount: core_models.TotalCount - interfaceToObjectTypeMappings: typing.Dict[InterfaceTypeApiName, InterfaceToObjectTypeMappings] + return self.model_dump(by_alias=True, exclude_none=True) class LoadObjectSetV2ObjectsOrInterfacesResponse(pydantic.BaseModel): @@ -2901,27 +1626,9 @@ class LoadObjectSetV2ObjectsOrInterfacesResponse(pydantic.BaseModel): total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LoadObjectSetV2ObjectsOrInterfacesResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - LoadObjectSetV2ObjectsOrInterfacesResponseDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class LoadObjectSetV2ObjectsOrInterfacesResponseDict(typing_extensions.TypedDict): - """ - Represents the API response when loading an `ObjectSet`. Objects in the returned set can either have properties - defined by an interface that the objects belong to or properties defined by the object type of the object. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[OntologyObjectV2] - """The list of objects in the current page.""" - - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - totalCount: core_models.TotalCount + return self.model_dump(by_alias=True, exclude_none=True) LogicRule = typing_extensions.Annotated[ @@ -2940,22 +1647,6 @@ class LoadObjectSetV2ObjectsOrInterfacesResponseDict(typing_extensions.TypedDict """LogicRule""" -LogicRuleDict = typing_extensions.Annotated[ - typing.Union[ - DeleteInterfaceObjectRuleDict, - "ModifyInterfaceObjectRuleDict", - "ModifyObjectRuleDict", - DeleteObjectRuleDict, - CreateInterfaceObjectRuleDict, - DeleteLinkRuleDict, - CreateObjectRuleDict, - CreateLinkRuleDict, - ], - pydantic.Field(discriminator="type"), -] -"""LogicRule""" - - class LtQueryV2(pydantic.BaseModel): """ Returns objects where the specified field is less than a value. Allows you to specify a property to query on @@ -2968,23 +1659,9 @@ class LtQueryV2(pydantic.BaseModel): type: typing.Literal["lt"] = "lt" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LtQueryV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(LtQueryV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class LtQueryV2Dict(typing_extensions.TypedDict): - """ - Returns objects where the specified field is less than a value. Allows you to specify a property to query on - by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: PropertyValue - type: typing.Literal["lt"] + return self.model_dump(by_alias=True, exclude_none=True) class LteQueryV2(pydantic.BaseModel): @@ -2999,23 +1676,9 @@ class LteQueryV2(pydantic.BaseModel): type: typing.Literal["lte"] = "lte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "LteQueryV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(LteQueryV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class LteQueryV2Dict(typing_extensions.TypedDict): - """ - Returns objects where the specified field is less than or equal to a value. Allows you to specify a property to - query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: PropertyValue - type: typing.Literal["lte"] + return self.model_dump(by_alias=True, exclude_none=True) class MaxAggregationV2(pydantic.BaseModel): @@ -3027,20 +1690,9 @@ class MaxAggregationV2(pydantic.BaseModel): type: typing.Literal["max"] = "max" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MaxAggregationV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MaxAggregationV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MaxAggregationV2Dict(typing_extensions.TypedDict): - """Computes the maximum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - name: typing_extensions.NotRequired[AggregationMetricName] - direction: typing_extensions.NotRequired[OrderByDirection] - type: typing.Literal["max"] + return self.model_dump(by_alias=True, exclude_none=True) class MediaMetadata(pydantic.BaseModel): @@ -3051,19 +1703,9 @@ class MediaMetadata(pydantic.BaseModel): media_type: core_models.MediaType = pydantic.Field(alias=str("mediaType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MediaMetadataDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MediaMetadataDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MediaMetadataDict(typing_extensions.TypedDict): - """MediaMetadata""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - path: typing_extensions.NotRequired[core_models.MediaItemPath] - sizeBytes: core_models.SizeBytes - mediaType: core_models.MediaType + return self.model_dump(by_alias=True, exclude_none=True) class MinAggregationV2(pydantic.BaseModel): @@ -3075,20 +1717,9 @@ class MinAggregationV2(pydantic.BaseModel): type: typing.Literal["min"] = "min" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MinAggregationV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(MinAggregationV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class MinAggregationV2Dict(typing_extensions.TypedDict): - """Computes the minimum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - name: typing_extensions.NotRequired[AggregationMetricName] - direction: typing_extensions.NotRequired[OrderByDirection] - type: typing.Literal["min"] + return self.model_dump(by_alias=True, exclude_none=True) class ModifyInterfaceObjectRule(pydantic.BaseModel): @@ -3098,20 +1729,9 @@ class ModifyInterfaceObjectRule(pydantic.BaseModel): type: typing.Literal["modifyInterfaceObject"] = "modifyInterfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ModifyInterfaceObjectRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ModifyInterfaceObjectRuleDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ModifyInterfaceObjectRuleDict(typing_extensions.TypedDict): - """ModifyInterfaceObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - interfaceTypeApiName: InterfaceTypeApiName - type: typing.Literal["modifyInterfaceObject"] + return self.model_dump(by_alias=True, exclude_none=True) class ModifyObject(pydantic.BaseModel): @@ -3122,19 +1742,9 @@ class ModifyObject(pydantic.BaseModel): type: typing.Literal["modifyObject"] = "modifyObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ModifyObjectDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ModifyObjectDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ModifyObjectDict(typing_extensions.TypedDict): - """ModifyObject""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - primaryKey: PropertyValue - objectType: ObjectTypeApiName - type: typing.Literal["modifyObject"] + return self.model_dump(by_alias=True, exclude_none=True) class ModifyObjectRule(pydantic.BaseModel): @@ -3144,18 +1754,9 @@ class ModifyObjectRule(pydantic.BaseModel): type: typing.Literal["modifyObject"] = "modifyObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ModifyObjectRuleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ModifyObjectRuleDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ModifyObjectRuleDict(typing_extensions.TypedDict): - """ModifyObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeApiName: ObjectTypeApiName - type: typing.Literal["modifyObject"] + return self.model_dump(by_alias=True, exclude_none=True) class MultiplyPropertyExpression(pydantic.BaseModel): @@ -3165,20 +1766,9 @@ class MultiplyPropertyExpression(pydantic.BaseModel): type: typing.Literal["multiply"] = "multiply" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MultiplyPropertyExpressionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - MultiplyPropertyExpressionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class MultiplyPropertyExpressionDict(typing_extensions.TypedDict): - """Multiplies two or more numeric values.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - properties: typing.List[DerivedPropertyDefinitionDict] - type: typing.Literal["multiply"] + return self.model_dump(by_alias=True, exclude_none=True) NearestNeighborsQuery = typing_extensions.Annotated[ @@ -3190,16 +1780,6 @@ class MultiplyPropertyExpressionDict(typing_extensions.TypedDict): """ -NearestNeighborsQueryDict = typing_extensions.Annotated[ - typing.Union[DoubleVectorDict, "NearestNeighborsQueryTextDict"], - pydantic.Field(discriminator="type"), -] -""" -Queries support either a vector matching the embedding model defined on the property, or text that is -automatically embedded. -""" - - class NearestNeighborsQueryText(pydantic.BaseModel): """Automatically embed the text in a vector using the embedding model configured for the given propertyIdentifier.""" @@ -3207,20 +1787,9 @@ class NearestNeighborsQueryText(pydantic.BaseModel): type: typing.Literal["text"] = "text" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "NearestNeighborsQueryTextDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - NearestNeighborsQueryTextDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class NearestNeighborsQueryTextDict(typing_extensions.TypedDict): - """Automatically embed the text in a vector using the embedding model configured for the given propertyIdentifier.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: str - type: typing.Literal["text"] + return self.model_dump(by_alias=True, exclude_none=True) class NegatePropertyExpression(pydantic.BaseModel): @@ -3230,20 +1799,9 @@ class NegatePropertyExpression(pydantic.BaseModel): type: typing.Literal["negate"] = "negate" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "NegatePropertyExpressionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - NegatePropertyExpressionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class NegatePropertyExpressionDict(typing_extensions.TypedDict): - """Negates a numeric value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - property: DerivedPropertyDefinitionDict - type: typing.Literal["negate"] + return self.model_dump(by_alias=True, exclude_none=True) class NotQueryV2(pydantic.BaseModel): @@ -3253,18 +1811,9 @@ class NotQueryV2(pydantic.BaseModel): type: typing.Literal["not"] = "not" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "NotQueryV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(NotQueryV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class NotQueryV2Dict(typing_extensions.TypedDict): - """Returns objects where the query is not satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: SearchJsonQueryV2Dict - type: typing.Literal["not"] + return self.model_dump(by_alias=True, exclude_none=True) ObjectEdit = typing_extensions.Annotated[ @@ -3274,13 +1823,6 @@ class NotQueryV2Dict(typing_extensions.TypedDict): """ObjectEdit""" -ObjectEditDict = typing_extensions.Annotated[ - typing.Union[ModifyObjectDict, DeleteObjectDict, AddObjectDict, DeleteLinkDict, AddLinkDict], - pydantic.Field(discriminator="type"), -] -"""ObjectEdit""" - - class ObjectEdits(pydantic.BaseModel): """ObjectEdits""" @@ -3293,23 +1835,9 @@ class ObjectEdits(pydantic.BaseModel): type: typing.Literal["edits"] = "edits" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectEditsDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ObjectEditsDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ObjectEditsDict(typing_extensions.TypedDict): - """ObjectEdits""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - edits: typing.List[ObjectEditDict] - addedObjectCount: int - modifiedObjectsCount: int - deletedObjectsCount: int - addedLinksCount: int - deletedLinksCount: int - type: typing.Literal["edits"] + return self.model_dump(by_alias=True, exclude_none=True) ObjectPropertyType = typing_extensions.Annotated[ @@ -3342,55 +1870,15 @@ class ObjectEditsDict(typing_extensions.TypedDict): """A union of all the types supported by Ontology Object properties.""" -ObjectPropertyTypeDict = typing_extensions.Annotated[ - typing.Union[ - core_models.DateTypeDict, - "StructTypeDict", - core_models.StringTypeDict, - core_models.ByteTypeDict, - core_models.DoubleTypeDict, - core_models.GeoPointTypeDict, - core_models.GeotimeSeriesReferenceTypeDict, - core_models.IntegerTypeDict, - core_models.FloatTypeDict, - core_models.GeoShapeTypeDict, - core_models.LongTypeDict, - core_models.BooleanTypeDict, - core_models.CipherTextTypeDict, - core_models.MarkingTypeDict, - core_models.AttachmentTypeDict, - core_models.MediaReferenceTypeDict, - core_models.TimeseriesTypeDict, - "OntologyObjectArrayTypeDict", - core_models.ShortTypeDict, - core_models.VectorTypeDict, - core_models.DecimalTypeDict, - core_models.TimestampTypeDict, - ], - pydantic.Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Object properties.""" - - class ObjectPropertyValueConstraint(pydantic.BaseModel): """The parameter value must be a property value of an object found within an object set.""" type: typing.Literal["objectPropertyValue"] = "objectPropertyValue" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectPropertyValueConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectPropertyValueConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectPropertyValueConstraintDict(typing_extensions.TypedDict): - """The parameter value must be a property value of an object found within an object set.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["objectPropertyValue"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectQueryResultConstraint(pydantic.BaseModel): @@ -3399,19 +1887,9 @@ class ObjectQueryResultConstraint(pydantic.BaseModel): type: typing.Literal["objectQueryResult"] = "objectQueryResult" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectQueryResultConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectQueryResultConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectQueryResultConstraintDict(typing_extensions.TypedDict): - """The parameter value must be the primary key of an object found within an object set.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["objectQueryResult"] + return self.model_dump(by_alias=True, exclude_none=True) ObjectRid = core.RID @@ -3451,24 +1929,9 @@ class ObjectSetAsBaseObjectTypesType(pydantic.BaseModel): type: typing.Literal["asBaseObjectTypes"] = "asBaseObjectTypes" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetAsBaseObjectTypesTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetAsBaseObjectTypesTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetAsBaseObjectTypesTypeDict(typing_extensions.TypedDict): - """ - Casts the objects in the object set to their base type and thus ensures objects are returned with all of their - properties in the resulting object set, not just the properties that implement interface properties. This is - currently unsupported and an exception will be thrown if used. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict - type: typing.Literal["asBaseObjectTypes"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetAsTypeType(pydantic.BaseModel): @@ -3485,27 +1948,9 @@ class ObjectSetAsTypeType(pydantic.BaseModel): type: typing.Literal["asType"] = "asType" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetAsTypeTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetAsTypeTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetAsTypeTypeDict(typing_extensions.TypedDict): - """ - Casts an object set to a specified object type or interface type API name. Any object whose object type does - not match the object type provided or implement the interface type provided will be dropped from the resulting - object set. This is currently unsupported and an exception will be thrown if used. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - entityType: str - """An object type or interface type API name.""" - - objectSet: ObjectSetDict - type: typing.Literal["asType"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetBaseType(pydantic.BaseModel): @@ -3514,45 +1959,12 @@ class ObjectSetBaseType(pydantic.BaseModel): object_type: str = pydantic.Field(alias=str("objectType")) # type: ignore[literal-required] """The API name of the object type.""" - type: typing.Literal["base"] = "base" - model_config = {"extra": "allow", "populate_by_name": True} - - def to_dict(self) -> "ObjectSetBaseTypeDict": - """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ObjectSetBaseTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ObjectSetBaseTypeDict(typing_extensions.TypedDict): - """ObjectSetBaseType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectType: str - """The API name of the object type.""" - - type: typing.Literal["base"] - - -ObjectSetDict = typing_extensions.Annotated[ - typing.Union[ - "ObjectSetSearchAroundTypeDict", - "ObjectSetStaticTypeDict", - "ObjectSetIntersectionTypeDict", - "ObjectSetWithPropertiesTypeDict", - "ObjectSetSubtractTypeDict", - "ObjectSetNearestNeighborsTypeDict", - "ObjectSetUnionTypeDict", - ObjectSetAsTypeTypeDict, - "ObjectSetMethodInputTypeDict", - "ObjectSetReferenceTypeDict", - "ObjectSetFilterTypeDict", - "ObjectSetInterfaceBaseTypeDict", - ObjectSetAsBaseObjectTypesTypeDict, - ObjectSetBaseTypeDict, - ], - pydantic.Field(discriminator="type"), -] -"""Represents the definition of an `ObjectSet` in the `Ontology`.""" + type: typing.Literal["base"] = "base" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetFilterType(pydantic.BaseModel): @@ -3563,21 +1975,9 @@ class ObjectSetFilterType(pydantic.BaseModel): type: typing.Literal["filter"] = "filter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetFilterTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetFilterTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetFilterTypeDict(typing_extensions.TypedDict): - """ObjectSetFilterType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict - where: SearchJsonQueryV2Dict - type: typing.Literal["filter"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetInterfaceBaseType(pydantic.BaseModel): @@ -3598,31 +1998,9 @@ class ObjectSetInterfaceBaseType(pydantic.BaseModel): type: typing.Literal["interfaceBase"] = "interfaceBase" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetInterfaceBaseTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetInterfaceBaseTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetInterfaceBaseTypeDict(typing_extensions.TypedDict): - """ObjectSetInterfaceBaseType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - interfaceType: str - """ - An object set with objects that implement the interface with the given interface API name. The objects in - the object set will only have properties that implement properties of the given interface, unless you set the includeAllBaseObjectProperties flag. - """ - - includeAllBaseObjectProperties: typing_extensions.NotRequired[bool] - """ - A flag that will return all of the underlying object properties for the objects that implement the interface. - This includes properties that don't explicitly implement an SPT on the interface. - """ - - type: typing.Literal["interfaceBase"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetIntersectionType(pydantic.BaseModel): @@ -3632,20 +2010,9 @@ class ObjectSetIntersectionType(pydantic.BaseModel): type: typing.Literal["intersect"] = "intersect" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetIntersectionTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetIntersectionTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetIntersectionTypeDict(typing_extensions.TypedDict): - """ObjectSetIntersectionType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSets: typing.List[ObjectSetDict] - type: typing.Literal["intersect"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetMethodInputType(pydantic.BaseModel): @@ -3658,23 +2025,9 @@ class ObjectSetMethodInputType(pydantic.BaseModel): type: typing.Literal["methodInput"] = "methodInput" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetMethodInputTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetMethodInputTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetMethodInputTypeDict(typing_extensions.TypedDict): - """ - ObjectSet which is the root of a MethodObjectSet definition. - - This feature is experimental and not yet generally available. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["methodInput"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetNearestNeighborsType(pydantic.BaseModel): @@ -3702,38 +2055,9 @@ class ObjectSetNearestNeighborsType(pydantic.BaseModel): type: typing.Literal["nearestNeighbors"] = "nearestNeighbors" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetNearestNeighborsTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetNearestNeighborsTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetNearestNeighborsTypeDict(typing_extensions.TypedDict): - """ - ObjectSet containing the top `numNeighbors` objects with `propertyIdentifier` nearest to the input vector or - text. This can only be performed on a property with type vector that has been configured to be searched with - approximate nearest neighbors using a similarity function configured in the Ontology. - - A non-zero score for each resulting object is returned when the `orderType` in the `orderBy` field is set to - `relevance`. Note that: - - Scores will not be returned if a nearestNeighbors object set is composed through union, subtraction - or intersection with non-nearestNeighbors object sets. - - If results have scores, the order of the scores will be decreasing (duplicate scores are possible). - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict - propertyIdentifier: PropertyIdentifierDict - numNeighbors: int - """ - The number of objects to return. If the number of documents in the objectType is less than the provided - value, all objects will be returned. This value is limited to 1 <= numNeighbors <= 500. - """ - - query: NearestNeighborsQueryDict - type: typing.Literal["nearestNeighbors"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetReferenceType(pydantic.BaseModel): @@ -3743,20 +2067,9 @@ class ObjectSetReferenceType(pydantic.BaseModel): type: typing.Literal["reference"] = "reference" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetReferenceTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetReferenceTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetReferenceTypeDict(typing_extensions.TypedDict): - """ObjectSetReferenceType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - reference: ObjectSetRid - type: typing.Literal["reference"] + return self.model_dump(by_alias=True, exclude_none=True) ObjectSetRid = core.RID @@ -3771,21 +2084,9 @@ class ObjectSetSearchAroundType(pydantic.BaseModel): type: typing.Literal["searchAround"] = "searchAround" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetSearchAroundTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetSearchAroundTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetSearchAroundTypeDict(typing_extensions.TypedDict): - """ObjectSetSearchAroundType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict - link: LinkTypeApiName - type: typing.Literal["searchAround"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetStaticType(pydantic.BaseModel): @@ -3795,20 +2096,9 @@ class ObjectSetStaticType(pydantic.BaseModel): type: typing.Literal["static"] = "static" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetStaticTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetStaticTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetStaticTypeDict(typing_extensions.TypedDict): - """ObjectSetStaticType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objects: typing.List[ObjectRid] - type: typing.Literal["static"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetSubtractType(pydantic.BaseModel): @@ -3818,20 +2108,9 @@ class ObjectSetSubtractType(pydantic.BaseModel): type: typing.Literal["subtract"] = "subtract" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetSubtractTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetSubtractTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetSubtractTypeDict(typing_extensions.TypedDict): - """ObjectSetSubtractType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSets: typing.List[ObjectSetDict] - type: typing.Literal["subtract"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetUnionType(pydantic.BaseModel): @@ -3841,20 +2120,9 @@ class ObjectSetUnionType(pydantic.BaseModel): type: typing.Literal["union"] = "union" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetUnionTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetUnionTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetUnionTypeDict(typing_extensions.TypedDict): - """ObjectSetUnionType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSets: typing.List[ObjectSetDict] - type: typing.Literal["union"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectSetWithPropertiesType(pydantic.BaseModel): @@ -3871,27 +2139,9 @@ class ObjectSetWithPropertiesType(pydantic.BaseModel): type: typing.Literal["withProperties"] = "withProperties" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectSetWithPropertiesTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectSetWithPropertiesTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectSetWithPropertiesTypeDict(typing_extensions.TypedDict): - """ - ObjectSet which returns objects with additional derived properties. - - This feature is experimental and not yet generally available. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict - derivedProperties: typing.Dict[DerivedPropertyApiName, DerivedPropertyDefinitionDict] - """Map of the name of the derived property to return and its definition""" - - type: typing.Literal["withProperties"] + return self.model_dump(by_alias=True, exclude_none=True) ObjectTypeApiName = str @@ -3908,18 +2158,9 @@ class ObjectTypeEdits(pydantic.BaseModel): type: typing.Literal["largeScaleEdits"] = "largeScaleEdits" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectTypeEditsDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ObjectTypeEditsDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ObjectTypeEditsDict(typing_extensions.TypedDict): - """ObjectTypeEdits""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - editedObjectTypes: typing.List[ObjectTypeApiName] - type: typing.Literal["largeScaleEdits"] + return self.model_dump(by_alias=True, exclude_none=True) class ObjectTypeFullMetadata(pydantic.BaseModel): @@ -3941,31 +2182,9 @@ class ObjectTypeFullMetadata(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectTypeFullMetadataDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectTypeFullMetadataDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectTypeFullMetadataDict(typing_extensions.TypedDict): - """ObjectTypeFullMetadata""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectType: ObjectTypeV2Dict - linkTypes: typing.List[LinkTypeSideV2Dict] - implementsInterfaces: typing.List[InterfaceTypeApiName] - """A list of interfaces that this object type implements.""" - - implementsInterfaces2: typing.Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementationDict] - """A list of interfaces that this object type implements and how it implements them.""" - - sharedPropertyTypeMapping: typing.Dict[SharedPropertyTypeApiName, PropertyApiName] - """ - A map from shared property type API name to backing local property API name for the shared property types - present on this object type. - """ + return self.model_dump(by_alias=True, exclude_none=True) ObjectTypeId = str @@ -3978,19 +2197,9 @@ class ObjectTypeInterfaceImplementation(pydantic.BaseModel): properties: typing.Dict[SharedPropertyTypeApiName, PropertyApiName] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectTypeInterfaceImplementationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ObjectTypeInterfaceImplementationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ObjectTypeInterfaceImplementationDict(typing_extensions.TypedDict): - """ObjectTypeInterfaceImplementation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - properties: typing.Dict[SharedPropertyTypeApiName, PropertyApiName] + return self.model_dump(by_alias=True, exclude_none=True) ObjectTypeRid = core.RID @@ -4019,33 +2228,9 @@ class ObjectTypeV2(pydantic.BaseModel): visibility: typing.Optional[ObjectTypeVisibility] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ObjectTypeV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ObjectTypeV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ObjectTypeV2Dict(typing_extensions.TypedDict): - """Represents an object type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ObjectTypeApiName - displayName: core_models.DisplayName - status: core_models.ReleaseStatus - description: typing_extensions.NotRequired[str] - """The description of the object type.""" - - pluralDisplayName: str - """The plural display name of the object type.""" - - icon: IconDict - primaryKey: PropertyApiName - properties: typing.Dict[PropertyApiName, PropertyV2Dict] - """A map of the properties of the object type.""" - - rid: ObjectTypeRid - titleProperty: PropertyApiName - visibility: typing_extensions.NotRequired[ObjectTypeVisibility] + return self.model_dump(by_alias=True, exclude_none=True) ObjectTypeVisibility = typing.Literal["NORMAL", "PROMINENT", "HIDDEN"] @@ -4062,21 +2247,9 @@ class OneOfConstraint(pydantic.BaseModel): type: typing.Literal["oneOf"] = "oneOf" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OneOfConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OneOfConstraintDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OneOfConstraintDict(typing_extensions.TypedDict): - """The parameter has a manually predefined set of options.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - options: typing.List[ParameterOptionDict] - otherValuesAllowed: bool - """A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**.""" - - type: typing.Literal["oneOf"] + return self.model_dump(by_alias=True, exclude_none=True) OntologyApiName = str @@ -4090,18 +2263,9 @@ class OntologyArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyArrayTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OntologyArrayTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OntologyArrayTypeDict(typing_extensions.TypedDict): - """OntologyArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - itemType: OntologyDataTypeDict - type: typing.Literal["array"] + return self.model_dump(by_alias=True, exclude_none=True) OntologyDataType = typing_extensions.Annotated[ @@ -4134,36 +2298,6 @@ class OntologyArrayTypeDict(typing_extensions.TypedDict): """A union of all the primitive types used by Palantir's Ontology-based products.""" -OntologyDataTypeDict = typing_extensions.Annotated[ - typing.Union[ - core_models.DateTypeDict, - "OntologyStructTypeDict", - "OntologySetTypeDict", - core_models.StringTypeDict, - core_models.ByteTypeDict, - core_models.DoubleTypeDict, - core_models.IntegerTypeDict, - core_models.FloatTypeDict, - core_models.AnyTypeDict, - core_models.LongTypeDict, - core_models.BooleanTypeDict, - core_models.CipherTextTypeDict, - core_models.MarkingTypeDict, - core_models.UnsupportedTypeDict, - OntologyArrayTypeDict, - "OntologyObjectSetTypeDict", - core_models.BinaryTypeDict, - core_models.ShortTypeDict, - core_models.DecimalTypeDict, - "OntologyMapTypeDict", - core_models.TimestampTypeDict, - "OntologyObjectTypeDict", - ], - pydantic.Field(discriminator="type"), -] -"""A union of all the primitive types used by Palantir's Ontology-based products.""" - - class OntologyFullMetadata(pydantic.BaseModel): """OntologyFullMetadata""" @@ -4175,24 +2309,9 @@ class OntologyFullMetadata(pydantic.BaseModel): shared_property_types: typing.Dict[SharedPropertyTypeApiName, SharedPropertyType] = pydantic.Field(alias=str("sharedPropertyTypes")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyFullMetadataDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OntologyFullMetadataDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class OntologyFullMetadataDict(typing_extensions.TypedDict): - """OntologyFullMetadata""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - ontology: OntologyV2Dict - objectTypes: typing.Dict[ObjectTypeApiName, ObjectTypeFullMetadataDict] - actionTypes: typing.Dict[ActionTypeApiName, ActionTypeV2Dict] - queryTypes: typing.Dict[QueryApiName, QueryTypeV2Dict] - interfaceTypes: typing.Dict[InterfaceTypeApiName, InterfaceTypeDict] - sharedPropertyTypes: typing.Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] + return self.model_dump(by_alias=True, exclude_none=True) OntologyIdentifier = str @@ -4206,20 +2325,9 @@ class OntologyInterfaceObjectType(pydantic.BaseModel): type: typing.Literal["interfaceObject"] = "interfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyInterfaceObjectTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OntologyInterfaceObjectTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class OntologyInterfaceObjectTypeDict(typing_extensions.TypedDict): - """OntologyInterfaceObjectType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - interfaceTypeApiName: InterfaceTypeApiName - type: typing.Literal["interfaceObject"] + return self.model_dump(by_alias=True, exclude_none=True) class OntologyMapType(pydantic.BaseModel): @@ -4230,19 +2338,9 @@ class OntologyMapType(pydantic.BaseModel): type: typing.Literal["map"] = "map" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyMapTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OntologyMapTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OntologyMapTypeDict(typing_extensions.TypedDict): - """OntologyMapType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: OntologyDataTypeDict - valueType: OntologyDataTypeDict - type: typing.Literal["map"] + return self.model_dump(by_alias=True, exclude_none=True) class OntologyObjectArrayType(pydantic.BaseModel): @@ -4252,20 +2350,9 @@ class OntologyObjectArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyObjectArrayTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OntologyObjectArrayTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class OntologyObjectArrayTypeDict(typing_extensions.TypedDict): - """OntologyObjectArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: ObjectPropertyTypeDict - type: typing.Literal["array"] + return self.model_dump(by_alias=True, exclude_none=True) class OntologyObjectSetType(pydantic.BaseModel): @@ -4276,21 +2363,9 @@ class OntologyObjectSetType(pydantic.BaseModel): type: typing.Literal["objectSet"] = "objectSet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyObjectSetTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OntologyObjectSetTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class OntologyObjectSetTypeDict(typing_extensions.TypedDict): - """OntologyObjectSetType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectApiName: typing_extensions.NotRequired[ObjectTypeApiName] - objectTypeApiName: typing_extensions.NotRequired[ObjectTypeApiName] - type: typing.Literal["objectSet"] + return self.model_dump(by_alias=True, exclude_none=True) class OntologyObjectType(pydantic.BaseModel): @@ -4301,21 +2376,9 @@ class OntologyObjectType(pydantic.BaseModel): type: typing.Literal["object"] = "object" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyObjectTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OntologyObjectTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class OntologyObjectTypeDict(typing_extensions.TypedDict): - """OntologyObjectType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectApiName: ObjectTypeApiName - objectTypeApiName: ObjectTypeApiName - type: typing.Literal["object"] + return self.model_dump(by_alias=True, exclude_none=True) class OntologyObjectTypeReferenceType(pydantic.BaseModel): @@ -4324,19 +2387,9 @@ class OntologyObjectTypeReferenceType(pydantic.BaseModel): type: typing.Literal["objectType"] = "objectType" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyObjectTypeReferenceTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OntologyObjectTypeReferenceTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class OntologyObjectTypeReferenceTypeDict(typing_extensions.TypedDict): - """OntologyObjectTypeReferenceType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["objectType"] + return self.model_dump(by_alias=True, exclude_none=True) OntologyObjectV2 = typing.Dict["PropertyApiName", "PropertyValue"] @@ -4357,18 +2410,9 @@ class OntologySetType(pydantic.BaseModel): type: typing.Literal["set"] = "set" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologySetTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OntologySetTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OntologySetTypeDict(typing_extensions.TypedDict): - """OntologySetType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - itemType: OntologyDataTypeDict - type: typing.Literal["set"] + return self.model_dump(by_alias=True, exclude_none=True) class OntologyStructField(pydantic.BaseModel): @@ -4379,21 +2423,9 @@ class OntologyStructField(pydantic.BaseModel): required: bool model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyStructFieldDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OntologyStructFieldDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class OntologyStructFieldDict(typing_extensions.TypedDict): - """OntologyStructField""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: core_models.StructFieldName - fieldType: OntologyDataTypeDict - required: bool + return self.model_dump(by_alias=True, exclude_none=True) class OntologyStructType(pydantic.BaseModel): @@ -4403,20 +2435,9 @@ class OntologyStructType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyStructTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - OntologyStructTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class OntologyStructTypeDict(typing_extensions.TypedDict): - """OntologyStructType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: typing.List[OntologyStructFieldDict] - type: typing.Literal["struct"] + return self.model_dump(by_alias=True, exclude_none=True) class OntologyV2(pydantic.BaseModel): @@ -4428,20 +2449,9 @@ class OntologyV2(pydantic.BaseModel): rid: OntologyRid model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OntologyV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OntologyV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OntologyV2Dict(typing_extensions.TypedDict): - """Metadata about an Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: OntologyApiName - displayName: core_models.DisplayName - description: str - rid: OntologyRid + return self.model_dump(by_alias=True, exclude_none=True) class OrQueryV2(pydantic.BaseModel): @@ -4451,18 +2461,9 @@ class OrQueryV2(pydantic.BaseModel): type: typing.Literal["or"] = "or" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OrQueryV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OrQueryV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OrQueryV2Dict(typing_extensions.TypedDict): - """Returns objects where at least 1 query is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: typing.List[SearchJsonQueryV2Dict] - type: typing.Literal["or"] + return self.model_dump(by_alias=True, exclude_none=True) OrderBy = str @@ -4519,41 +2520,6 @@ class OrQueryV2Dict(typing_extensions.TypedDict): """ -ParameterEvaluatedConstraintDict = typing_extensions.Annotated[ - typing.Union[ - OneOfConstraintDict, - GroupMemberConstraintDict, - ObjectPropertyValueConstraintDict, - "RangeConstraintDict", - ArraySizeConstraintDict, - ObjectQueryResultConstraintDict, - "StringLengthConstraintDict", - "StringRegexMatchConstraintDict", - "UnevaluableConstraintDict", - ], - pydantic.Field(discriminator="type"), -] -""" -A constraint that an action parameter value must satisfy in order to be considered valid. -Constraints can be configured on action parameters in the **Ontology Manager**. -Applicable constraints are determined dynamically based on parameter inputs. -Parameter values are evaluated against the final set of constraints. - -The type of the constraint. -| Type | Description | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | -| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | -| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | -| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | -| `oneOf` | The parameter has a manually predefined set of options. | -| `range` | The parameter value must be within the defined range. | -| `stringLength` | The parameter value must have a length within the defined range. | -| `stringRegexMatch` | The parameter value must match a predefined regular expression. | -| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | -""" - - class ParameterEvaluationResult(pydantic.BaseModel): """Represents the validity of a parameter against the configured constraints.""" @@ -4564,22 +2530,9 @@ class ParameterEvaluationResult(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ParameterEvaluationResultDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ParameterEvaluationResultDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ParameterEvaluationResultDict(typing_extensions.TypedDict): - """Represents the validity of a parameter against the configured constraints.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - result: ValidationResult - evaluatedConstraints: typing.List[ParameterEvaluatedConstraintDict] - required: bool - """Represents whether the parameter is a required input to the action.""" + return self.model_dump(by_alias=True, exclude_none=True) ParameterId = str @@ -4598,19 +2551,9 @@ class ParameterOption(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ParameterOptionDict": - """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ParameterOptionDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ParameterOptionDict(typing_extensions.TypedDict): - """A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - displayName: typing_extensions.NotRequired[core_models.DisplayName] - value: typing_extensions.NotRequired[typing.Any] - """An allowed configured value for a parameter within an action.""" + def to_dict(self) -> dict: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) class PreciseDuration(pydantic.BaseModel): @@ -4623,21 +2566,9 @@ class PreciseDuration(pydantic.BaseModel): type: typing.Literal["duration"] = "duration" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "PreciseDurationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(PreciseDurationDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class PreciseDurationDict(typing_extensions.TypedDict): - """A measurement of duration.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: int - """The duration value.""" - - unit: PreciseTimeUnit - type: typing.Literal["duration"] + return self.model_dump(by_alias=True, exclude_none=True) PreciseTimeUnit = typing.Literal["NANOSECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS", "WEEKS"] @@ -4662,20 +2593,9 @@ class PropertyApiNameSelector(pydantic.BaseModel): type: typing.Literal["property"] = "property" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "PropertyApiNameSelectorDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - PropertyApiNameSelectorDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class PropertyApiNameSelectorDict(typing_extensions.TypedDict): - """A property api name that references properties to query on.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: PropertyApiName - type: typing.Literal["property"] + return self.model_dump(by_alias=True, exclude_none=True) PropertyFilter = str @@ -4722,13 +2642,6 @@ class PropertyApiNameSelectorDict(typing_extensions.TypedDict): """An identifier used to select properties or struct fields.""" -PropertyIdentifierDict = typing_extensions.Annotated[ - typing.Union[PropertyApiNameSelectorDict, "StructFieldSelectorDict"], - pydantic.Field(discriminator="type"), -] -"""An identifier used to select properties or struct fields.""" - - PropertyTypeRid = core.RID """PropertyTypeRid""" @@ -4745,18 +2658,6 @@ class PropertyApiNameSelectorDict(typing_extensions.TypedDict): """The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example.""" -PropertyTypeStatusDict = typing_extensions.Annotated[ - typing.Union[ - DeprecatedPropertyTypeStatusDict, - ActivePropertyTypeStatusDict, - ExperimentalPropertyTypeStatusDict, - ExamplePropertyTypeStatusDict, - ], - pydantic.Field(discriminator="type"), -] -"""The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example.""" - - PropertyTypeVisibility = typing.Literal["NORMAL", "PROMINENT", "HIDDEN"] """PropertyTypeVisibility""" @@ -4772,22 +2673,9 @@ class PropertyV2(pydantic.BaseModel): visibility: typing.Optional[PropertyTypeVisibility] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "PropertyV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(PropertyV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class PropertyV2Dict(typing_extensions.TypedDict): - """Details about some property of an object.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: typing_extensions.NotRequired[str] - displayName: typing_extensions.NotRequired[core_models.DisplayName] - dataType: ObjectPropertyTypeDict - rid: PropertyTypeRid - status: typing_extensions.NotRequired[PropertyTypeStatusDict] - visibility: typing_extensions.NotRequired[PropertyTypeVisibility] + return self.model_dump(by_alias=True, exclude_none=True) PropertyValue = typing.Any @@ -4839,21 +2727,6 @@ class PropertyV2Dict(typing_extensions.TypedDict): """A union of all the types supported by query aggregation keys.""" -QueryAggregationKeyTypeDict = typing_extensions.Annotated[ - typing.Union[ - core_models.DateTypeDict, - core_models.BooleanTypeDict, - core_models.StringTypeDict, - core_models.DoubleTypeDict, - "QueryAggregationRangeTypeDict", - core_models.IntegerTypeDict, - core_models.TimestampTypeDict, - ], - pydantic.Field(discriminator="type"), -] -"""A union of all the types supported by query aggregation keys.""" - - QueryAggregationRangeSubType = typing_extensions.Annotated[ typing.Union[ core_models.DateType, @@ -4866,18 +2739,6 @@ class PropertyV2Dict(typing_extensions.TypedDict): """A union of all the types supported by query aggregation ranges.""" -QueryAggregationRangeSubTypeDict = typing_extensions.Annotated[ - typing.Union[ - core_models.DateTypeDict, - core_models.DoubleTypeDict, - core_models.IntegerTypeDict, - core_models.TimestampTypeDict, - ], - pydantic.Field(discriminator="type"), -] -"""A union of all the types supported by query aggregation ranges.""" - - class QueryAggregationRangeType(pydantic.BaseModel): """QueryAggregationRangeType""" @@ -4885,20 +2746,9 @@ class QueryAggregationRangeType(pydantic.BaseModel): type: typing.Literal["range"] = "range" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryAggregationRangeTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - QueryAggregationRangeTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class QueryAggregationRangeTypeDict(typing_extensions.TypedDict): - """QueryAggregationRangeType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: QueryAggregationRangeSubTypeDict - type: typing.Literal["range"] + return self.model_dump(by_alias=True, exclude_none=True) QueryAggregationValueType = typing_extensions.Annotated[ @@ -4908,15 +2758,6 @@ class QueryAggregationRangeTypeDict(typing_extensions.TypedDict): """A union of all the types supported by query aggregation keys.""" -QueryAggregationValueTypeDict = typing_extensions.Annotated[ - typing.Union[ - core_models.DateTypeDict, core_models.DoubleTypeDict, core_models.TimestampTypeDict - ], - pydantic.Field(discriminator="type"), -] -"""A union of all the types supported by query aggregation keys.""" - - QueryApiName = str """The name of the Query in the API.""" @@ -4928,18 +2769,9 @@ class QueryArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryArrayTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QueryArrayTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class QueryArrayTypeDict(typing_extensions.TypedDict): - """QueryArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: QueryDataTypeDict - type: typing.Literal["array"] + return self.model_dump(by_alias=True, exclude_none=True) QueryDataType = typing_extensions.Annotated[ @@ -4970,34 +2802,6 @@ class QueryArrayTypeDict(typing_extensions.TypedDict): """A union of all the types supported by Ontology Query parameters or outputs.""" -QueryDataTypeDict = typing_extensions.Annotated[ - typing.Union[ - core_models.DateTypeDict, - "QueryStructTypeDict", - "QuerySetTypeDict", - core_models.StringTypeDict, - EntrySetTypeDict, - core_models.DoubleTypeDict, - core_models.IntegerTypeDict, - "ThreeDimensionalAggregationDict", - "QueryUnionTypeDict", - core_models.FloatTypeDict, - core_models.LongTypeDict, - core_models.BooleanTypeDict, - core_models.UnsupportedTypeDict, - core_models.AttachmentTypeDict, - core_models.NullTypeDict, - QueryArrayTypeDict, - OntologyObjectSetTypeDict, - "TwoDimensionalAggregationDict", - OntologyObjectTypeDict, - core_models.TimestampTypeDict, - ], - pydantic.Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Query parameters or outputs.""" - - class QueryParameterV2(pydantic.BaseModel): """Details about a parameter of a query.""" @@ -5005,18 +2809,9 @@ class QueryParameterV2(pydantic.BaseModel): data_type: QueryDataType = pydantic.Field(alias=str("dataType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryParameterV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QueryParameterV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class QueryParameterV2Dict(typing_extensions.TypedDict): - """Details about a parameter of a query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: typing_extensions.NotRequired[str] - dataType: QueryDataTypeDict + return self.model_dump(by_alias=True, exclude_none=True) QueryRuntimeErrorParameter = str @@ -5030,18 +2825,9 @@ class QuerySetType(pydantic.BaseModel): type: typing.Literal["set"] = "set" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QuerySetTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QuerySetTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class QuerySetTypeDict(typing_extensions.TypedDict): - """QuerySetType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: QueryDataTypeDict - type: typing.Literal["set"] + return self.model_dump(by_alias=True, exclude_none=True) class QueryStructField(pydantic.BaseModel): @@ -5051,18 +2837,9 @@ class QueryStructField(pydantic.BaseModel): field_type: QueryDataType = pydantic.Field(alias=str("fieldType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryStructFieldDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QueryStructFieldDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class QueryStructFieldDict(typing_extensions.TypedDict): - """QueryStructField""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: core_models.StructFieldName - fieldType: QueryDataTypeDict + return self.model_dump(by_alias=True, exclude_none=True) class QueryStructType(pydantic.BaseModel): @@ -5072,18 +2849,9 @@ class QueryStructType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryStructTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QueryStructTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class QueryStructTypeDict(typing_extensions.TypedDict): - """QueryStructType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: typing.List[QueryStructFieldDict] - type: typing.Literal["struct"] + return self.model_dump(by_alias=True, exclude_none=True) class QueryTypeV2(pydantic.BaseModel): @@ -5098,23 +2866,9 @@ class QueryTypeV2(pydantic.BaseModel): version: FunctionVersion model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryTypeV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QueryTypeV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class QueryTypeV2Dict(typing_extensions.TypedDict): - """Represents a query type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: QueryApiName - description: typing_extensions.NotRequired[str] - displayName: typing_extensions.NotRequired[core_models.DisplayName] - parameters: typing.Dict[ParameterId, QueryParameterV2Dict] - output: QueryDataTypeDict - rid: FunctionRid - version: FunctionVersion + return self.model_dump(by_alias=True, exclude_none=True) class QueryUnionType(pydantic.BaseModel): @@ -5124,18 +2878,9 @@ class QueryUnionType(pydantic.BaseModel): type: typing.Literal["union"] = "union" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "QueryUnionTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(QueryUnionTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class QueryUnionTypeDict(typing_extensions.TypedDict): - """QueryUnionType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - unionTypes: typing.List[QueryDataTypeDict] - type: typing.Literal["union"] + return self.model_dump(by_alias=True, exclude_none=True) class RangeConstraint(pydantic.BaseModel): @@ -5156,29 +2901,9 @@ class RangeConstraint(pydantic.BaseModel): type: typing.Literal["range"] = "range" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "RangeConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(RangeConstraintDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class RangeConstraintDict(typing_extensions.TypedDict): - """The parameter value must be within the defined range.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - lt: typing_extensions.NotRequired[typing.Any] - """Less than""" - - lte: typing_extensions.NotRequired[typing.Any] - """Less than or equal""" - - gt: typing_extensions.NotRequired[typing.Any] - """Greater than""" - - gte: typing_extensions.NotRequired[typing.Any] - """Greater than or equal""" - - type: typing.Literal["range"] + return self.model_dump(by_alias=True, exclude_none=True) class RelativeTime(pydantic.BaseModel): @@ -5189,19 +2914,9 @@ class RelativeTime(pydantic.BaseModel): unit: RelativeTimeSeriesTimeUnit model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "RelativeTimeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(RelativeTimeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class RelativeTimeDict(typing_extensions.TypedDict): - """A relative time, such as "3 days before" or "2 hours after" the current moment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - when: RelativeTimeRelation - value: int - unit: RelativeTimeSeriesTimeUnit + return self.model_dump(by_alias=True, exclude_none=True) class RelativeTimeRange(pydantic.BaseModel): @@ -5212,19 +2927,9 @@ class RelativeTimeRange(pydantic.BaseModel): type: typing.Literal["relative"] = "relative" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "RelativeTimeRangeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(RelativeTimeRangeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class RelativeTimeRangeDict(typing_extensions.TypedDict): - """A relative time range for a time series query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - startTime: typing_extensions.NotRequired[RelativeTimeDict] - endTime: typing_extensions.NotRequired[RelativeTimeDict] - type: typing.Literal["relative"] + return self.model_dump(by_alias=True, exclude_none=True) RelativeTimeRelation = typing.Literal["BEFORE", "AFTER"] @@ -5248,20 +2953,9 @@ class RollingAggregateWindowPoints(pydantic.BaseModel): type: typing.Literal["pointsCount"] = "pointsCount" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "RollingAggregateWindowPointsDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - RollingAggregateWindowPointsDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class RollingAggregateWindowPointsDict(typing_extensions.TypedDict): - """Number of points in each window.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - count: int - type: typing.Literal["pointsCount"] + return self.model_dump(by_alias=True, exclude_none=True) SdkPackageName = str @@ -5299,37 +2993,6 @@ class RollingAggregateWindowPointsDict(typing_extensions.TypedDict): """SearchJsonQueryV2""" -SearchJsonQueryV2Dict = typing_extensions.Annotated[ - typing.Union[ - OrQueryV2Dict, - InQueryDict, - DoesNotIntersectPolygonQueryDict, - LtQueryV2Dict, - DoesNotIntersectBoundingBoxQueryDict, - EqualsQueryV2Dict, - ContainsAllTermsQueryDict, - GtQueryV2Dict, - "WithinDistanceOfQueryDict", - "WithinBoundingBoxQueryDict", - ContainsQueryV2Dict, - NotQueryV2Dict, - IntersectsBoundingBoxQueryDict, - AndQueryV2Dict, - IsNullQueryV2Dict, - ContainsAllTermsInOrderPrefixLastTermDict, - ContainsAnyTermQueryDict, - GteQueryV2Dict, - ContainsAllTermsInOrderQueryDict, - "WithinPolygonQueryDict", - IntersectsPolygonQueryDict, - LteQueryV2Dict, - "StartsWithQueryDict", - ], - pydantic.Field(discriminator="type"), -] -"""SearchJsonQueryV2""" - - class SearchObjectsResponseV2(pydantic.BaseModel): """SearchObjectsResponseV2""" @@ -5338,21 +3001,9 @@ class SearchObjectsResponseV2(pydantic.BaseModel): total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchObjectsResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SearchObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SearchObjectsResponseV2Dict(typing_extensions.TypedDict): - """SearchObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[OntologyObjectV2] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] - totalCount: core_models.TotalCount + return self.model_dump(by_alias=True, exclude_none=True) SearchOrderByType = typing.Literal["fields", "relevance"] @@ -5366,18 +3017,9 @@ class SearchOrderByV2(pydantic.BaseModel): fields: typing.List[SearchOrderingV2] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchOrderByV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(SearchOrderByV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class SearchOrderByV2Dict(typing_extensions.TypedDict): - """Specifies the ordering of search results by a field and an ordering direction or by relevance if scores are required in a nearestNeighbors query. By default `orderType` is set to `fields`.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - orderType: typing_extensions.NotRequired[SearchOrderByType] - fields: typing.List[SearchOrderingV2Dict] + return self.model_dump(by_alias=True, exclude_none=True) class SearchOrderingV2(pydantic.BaseModel): @@ -5389,19 +3031,9 @@ class SearchOrderingV2(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchOrderingV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(SearchOrderingV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class SearchOrderingV2Dict(typing_extensions.TypedDict): - """SearchOrderingV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - direction: typing_extensions.NotRequired[str] - """Specifies the ordering direction (can be either `asc` or `desc`)""" + return self.model_dump(by_alias=True, exclude_none=True) SelectedPropertyApiName = str @@ -5431,21 +3063,9 @@ class SelectedPropertyApproximateDistinctAggregation(pydantic.BaseModel): type: typing.Literal["approximateDistinct"] = "approximateDistinct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SelectedPropertyApproximateDistinctAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SelectedPropertyApproximateDistinctAggregationDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class SelectedPropertyApproximateDistinctAggregationDict(typing_extensions.TypedDict): - """Computes an approximate number of distinct values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - selectedPropertyApiName: PropertyApiName - type: typing.Literal["approximateDistinct"] + return self.model_dump(by_alias=True, exclude_none=True) class SelectedPropertyApproximatePercentileAggregation(pydantic.BaseModel): @@ -5456,22 +3076,9 @@ class SelectedPropertyApproximatePercentileAggregation(pydantic.BaseModel): type: typing.Literal["approximatePercentile"] = "approximatePercentile" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SelectedPropertyApproximatePercentileAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SelectedPropertyApproximatePercentileAggregationDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class SelectedPropertyApproximatePercentileAggregationDict(typing_extensions.TypedDict): - """Computes the approximate percentile value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - selectedPropertyApiName: PropertyApiName - approximatePercentile: float - type: typing.Literal["approximatePercentile"] + return self.model_dump(by_alias=True, exclude_none=True) class SelectedPropertyAvgAggregation(pydantic.BaseModel): @@ -5481,20 +3088,9 @@ class SelectedPropertyAvgAggregation(pydantic.BaseModel): type: typing.Literal["avg"] = "avg" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SelectedPropertyAvgAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SelectedPropertyAvgAggregationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SelectedPropertyAvgAggregationDict(typing_extensions.TypedDict): - """Computes the average value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - selectedPropertyApiName: PropertyApiName - type: typing.Literal["avg"] + return self.model_dump(by_alias=True, exclude_none=True) class SelectedPropertyCollectListAggregation(pydantic.BaseModel): @@ -5515,32 +3111,9 @@ class SelectedPropertyCollectListAggregation(pydantic.BaseModel): type: typing.Literal["collectList"] = "collectList" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SelectedPropertyCollectListAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SelectedPropertyCollectListAggregationDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class SelectedPropertyCollectListAggregationDict(typing_extensions.TypedDict): - """ - Lists all values of a property up to the specified limit. The maximum supported limit is 100, by default. - - NOTE: A separate count aggregation should be used to determine the total count of values, to account for - a possible truncation of the returned list. - - Ignores objects for which a property is absent, so the returned list will contain non-null values only. - Returns an empty list when none of the objects have values for a provided property. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - selectedPropertyApiName: PropertyApiName - limit: int - """Maximum number of values to collect. The maximum supported limit is 100.""" - - type: typing.Literal["collectList"] + return self.model_dump(by_alias=True, exclude_none=True) class SelectedPropertyCollectSetAggregation(pydantic.BaseModel): @@ -5561,32 +3134,9 @@ class SelectedPropertyCollectSetAggregation(pydantic.BaseModel): type: typing.Literal["collectSet"] = "collectSet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SelectedPropertyCollectSetAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SelectedPropertyCollectSetAggregationDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class SelectedPropertyCollectSetAggregationDict(typing_extensions.TypedDict): - """ - Lists all distinct values of a property up to the specified limit. The maximum supported limit is 100. - - NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of - values, to account for a possible truncation of the returned set. - - Ignores objects for which a property is absent, so the returned list will contain non-null values only. - Returns an empty list when none of the objects have values for a provided property. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - selectedPropertyApiName: PropertyApiName - limit: int - """Maximum number of values to collect. The maximum supported limit is 100.""" - - type: typing.Literal["collectSet"] + return self.model_dump(by_alias=True, exclude_none=True) class SelectedPropertyCountAggregation(pydantic.BaseModel): @@ -5595,19 +3145,9 @@ class SelectedPropertyCountAggregation(pydantic.BaseModel): type: typing.Literal["count"] = "count" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SelectedPropertyCountAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SelectedPropertyCountAggregationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SelectedPropertyCountAggregationDict(typing_extensions.TypedDict): - """Computes the total count of objects.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["count"] + return self.model_dump(by_alias=True, exclude_none=True) class SelectedPropertyExactDistinctAggregation(pydantic.BaseModel): @@ -5617,21 +3157,9 @@ class SelectedPropertyExactDistinctAggregation(pydantic.BaseModel): type: typing.Literal["exactDistinct"] = "exactDistinct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SelectedPropertyExactDistinctAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SelectedPropertyExactDistinctAggregationDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class SelectedPropertyExactDistinctAggregationDict(typing_extensions.TypedDict): - """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - selectedPropertyApiName: PropertyApiName - type: typing.Literal["exactDistinct"] + return self.model_dump(by_alias=True, exclude_none=True) class SelectedPropertyExpression(pydantic.BaseModel): @@ -5642,21 +3170,9 @@ class SelectedPropertyExpression(pydantic.BaseModel): type: typing.Literal["selection"] = "selection" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SelectedPropertyExpressionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SelectedPropertyExpressionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SelectedPropertyExpressionDict(typing_extensions.TypedDict): - """Definition for a selected property over a MethodObjectSet.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: MethodObjectSetDict - operation: SelectedPropertyOperationDict - type: typing.Literal["selection"] + return self.model_dump(by_alias=True, exclude_none=True) class SelectedPropertyMaxAggregation(pydantic.BaseModel): @@ -5666,20 +3182,9 @@ class SelectedPropertyMaxAggregation(pydantic.BaseModel): type: typing.Literal["max"] = "max" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SelectedPropertyMaxAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SelectedPropertyMaxAggregationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SelectedPropertyMaxAggregationDict(typing_extensions.TypedDict): - """Computes the maximum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - selectedPropertyApiName: PropertyApiName - type: typing.Literal["max"] + return self.model_dump(by_alias=True, exclude_none=True) class SelectedPropertyMinAggregation(pydantic.BaseModel): @@ -5689,20 +3194,9 @@ class SelectedPropertyMinAggregation(pydantic.BaseModel): type: typing.Literal["min"] = "min" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SelectedPropertyMinAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SelectedPropertyMinAggregationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SelectedPropertyMinAggregationDict(typing_extensions.TypedDict): - """Computes the minimum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - selectedPropertyApiName: PropertyApiName - type: typing.Literal["min"] + return self.model_dump(by_alias=True, exclude_none=True) SelectedPropertyOperation = typing_extensions.Annotated[ @@ -5724,25 +3218,6 @@ class SelectedPropertyMinAggregationDict(typing_extensions.TypedDict): """Operation on a selected property, can be an aggregation function or retrieval of a single selected property""" -SelectedPropertyOperationDict = typing_extensions.Annotated[ - typing.Union[ - SelectedPropertyApproximateDistinctAggregationDict, - SelectedPropertyMinAggregationDict, - SelectedPropertyAvgAggregationDict, - SelectedPropertyMaxAggregationDict, - SelectedPropertyApproximatePercentileAggregationDict, - GetSelectedPropertyOperationDict, - SelectedPropertyCountAggregationDict, - "SelectedPropertySumAggregationDict", - SelectedPropertyCollectListAggregationDict, - SelectedPropertyExactDistinctAggregationDict, - SelectedPropertyCollectSetAggregationDict, - ], - pydantic.Field(discriminator="type"), -] -"""Operation on a selected property, can be an aggregation function or retrieval of a single selected property""" - - class SelectedPropertySumAggregation(pydantic.BaseModel): """Computes the sum of values for the provided field.""" @@ -5750,20 +3225,9 @@ class SelectedPropertySumAggregation(pydantic.BaseModel): type: typing.Literal["sum"] = "sum" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SelectedPropertySumAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SelectedPropertySumAggregationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SelectedPropertySumAggregationDict(typing_extensions.TypedDict): - """Computes the sum of values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - selectedPropertyApiName: PropertyApiName - type: typing.Literal["sum"] + return self.model_dump(by_alias=True, exclude_none=True) class SharedPropertyType(pydantic.BaseModel): @@ -5778,32 +3242,16 @@ class SharedPropertyType(pydantic.BaseModel): data_type: ObjectPropertyType = pydantic.Field(alias=str("dataType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SharedPropertyTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SharedPropertyTypeDict, self.model_dump(by_alias=True, exclude_none=True) - ) + return self.model_dump(by_alias=True, exclude_none=True) SharedPropertyTypeApiName = str """ The name of the shared property type in the API in lowerCamelCase format. To find the API name for your -shared property type, use the `List shared property types` endpoint or check the **Ontology Manager**. -""" - - -class SharedPropertyTypeDict(typing_extensions.TypedDict): - """A property type that can be shared across object types.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: SharedPropertyTypeRid - apiName: SharedPropertyTypeApiName - displayName: core_models.DisplayName - description: typing_extensions.NotRequired[str] - """A short text that describes the SharedPropertyType.""" - - dataType: ObjectPropertyTypeDict +shared property type, use the `List shared property types` endpoint or check the **Ontology Manager**. +""" SharedPropertyTypeRid = core.RID @@ -5822,23 +3270,9 @@ class StartsWithQuery(pydantic.BaseModel): type: typing.Literal["startsWith"] = "startsWith" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StartsWithQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(StartsWithQueryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class StartsWithQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field starts with the provided value. Allows you to specify a property to - query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: str - type: typing.Literal["startsWith"] + return self.model_dump(by_alias=True, exclude_none=True) StreamingOutputFormat = typing.Literal["JSON", "ARROW"] @@ -5869,34 +3303,9 @@ class StringLengthConstraint(pydantic.BaseModel): type: typing.Literal["stringLength"] = "stringLength" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StringLengthConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - StringLengthConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class StringLengthConstraintDict(typing_extensions.TypedDict): - """ - The parameter value must have a length within the defined range. - *This range is always inclusive.* - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - lt: typing_extensions.NotRequired[typing.Any] - """Less than""" - - lte: typing_extensions.NotRequired[typing.Any] - """Less than or equal""" - - gt: typing_extensions.NotRequired[typing.Any] - """Greater than""" - - gte: typing_extensions.NotRequired[typing.Any] - """Greater than or equal""" - - type: typing.Literal["stringLength"] + return self.model_dump(by_alias=True, exclude_none=True) class StringRegexMatchConstraint(pydantic.BaseModel): @@ -5914,28 +3323,9 @@ class StringRegexMatchConstraint(pydantic.BaseModel): type: typing.Literal["stringRegexMatch"] = "stringRegexMatch" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StringRegexMatchConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - StringRegexMatchConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class StringRegexMatchConstraintDict(typing_extensions.TypedDict): - """The parameter value must match a predefined regular expression.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - regex: str - """The regular expression configured in the **Ontology Manager**.""" - - configuredFailureMessage: typing_extensions.NotRequired[str] - """ - The message indicating that the regular expression was not matched. - This is configured per parameter in the **Ontology Manager**. - """ - - type: typing.Literal["stringRegexMatch"] + return self.model_dump(by_alias=True, exclude_none=True) StructFieldApiName = str @@ -5955,26 +3345,9 @@ class StructFieldSelector(pydantic.BaseModel): type: typing.Literal["structField"] = "structField" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StructFieldSelectorDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - StructFieldSelectorDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class StructFieldSelectorDict(typing_extensions.TypedDict): - """ - A combination of a property API name and a struct field API name used to select struct fields. Note that you can - still select struct properties with only a 'PropertyApiNameSelector'; the queries will then become 'OR' queries - across the fields of the struct property, and derived property expressions will operate on the whole struct - where applicable. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - propertyApiName: PropertyApiName - structFieldApiName: StructFieldApiName - type: typing.Literal["structField"] + return self.model_dump(by_alias=True, exclude_none=True) class StructFieldType(pydantic.BaseModel): @@ -5984,18 +3357,9 @@ class StructFieldType(pydantic.BaseModel): data_type: ObjectPropertyType = pydantic.Field(alias=str("dataType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StructFieldTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(StructFieldTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class StructFieldTypeDict(typing_extensions.TypedDict): - """StructFieldType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: StructFieldApiName - dataType: ObjectPropertyTypeDict + return self.model_dump(by_alias=True, exclude_none=True) class StructType(pydantic.BaseModel): @@ -6005,18 +3369,9 @@ class StructType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StructTypeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(StructTypeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class StructTypeDict(typing_extensions.TypedDict): - """StructType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - structFieldTypes: typing.List[StructFieldTypeDict] - type: typing.Literal["struct"] + return self.model_dump(by_alias=True, exclude_none=True) class SubmissionCriteriaEvaluation(pydantic.BaseModel): @@ -6035,29 +3390,9 @@ class SubmissionCriteriaEvaluation(pydantic.BaseModel): result: ValidationResult model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SubmissionCriteriaEvaluationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SubmissionCriteriaEvaluationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SubmissionCriteriaEvaluationDict(typing_extensions.TypedDict): - """ - Contains the status of the **submission criteria**. - **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. - These are configured in the **Ontology Manager**. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - configuredFailureMessage: typing_extensions.NotRequired[str] - """ - The message indicating one of the **submission criteria** was not satisfied. - This is configured per **submission criteria** in the **Ontology Manager**. - """ - - result: ValidationResult + return self.model_dump(by_alias=True, exclude_none=True) class SubtractPropertyExpression(pydantic.BaseModel): @@ -6068,21 +3403,9 @@ class SubtractPropertyExpression(pydantic.BaseModel): type: typing.Literal["subtract"] = "subtract" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SubtractPropertyExpressionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SubtractPropertyExpressionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SubtractPropertyExpressionDict(typing_extensions.TypedDict): - """Subtracts the right numeric value from the left numeric value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - left: DerivedPropertyDefinitionDict - right: DerivedPropertyDefinitionDict - type: typing.Literal["subtract"] + return self.model_dump(by_alias=True, exclude_none=True) class SumAggregationV2(pydantic.BaseModel): @@ -6094,20 +3417,9 @@ class SumAggregationV2(pydantic.BaseModel): type: typing.Literal["sum"] = "sum" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SumAggregationV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(SumAggregationV2Dict, self.model_dump(by_alias=True, exclude_none=True)) - - -class SumAggregationV2Dict(typing_extensions.TypedDict): - """Computes the sum of values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - name: typing_extensions.NotRequired[AggregationMetricName] - direction: typing_extensions.NotRequired[OrderByDirection] - type: typing.Literal["sum"] + return self.model_dump(by_alias=True, exclude_none=True) class SyncApplyActionResponseV2(pydantic.BaseModel): @@ -6117,20 +3429,9 @@ class SyncApplyActionResponseV2(pydantic.BaseModel): edits: typing.Optional[ActionResults] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SyncApplyActionResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SyncApplyActionResponseV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SyncApplyActionResponseV2Dict(typing_extensions.TypedDict): - """SyncApplyActionResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - validation: typing_extensions.NotRequired[ValidateActionResponseV2Dict] - edits: typing_extensions.NotRequired[ActionResultsDict] + return self.model_dump(by_alias=True, exclude_none=True) class ThreeDimensionalAggregation(pydantic.BaseModel): @@ -6141,21 +3442,9 @@ class ThreeDimensionalAggregation(pydantic.BaseModel): type: typing.Literal["threeDimensionalAggregation"] = "threeDimensionalAggregation" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ThreeDimensionalAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ThreeDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ThreeDimensionalAggregationDict(typing_extensions.TypedDict): - """ThreeDimensionalAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: QueryAggregationKeyTypeDict - valueType: TwoDimensionalAggregationDict - type: typing.Literal["threeDimensionalAggregation"] + return self.model_dump(by_alias=True, exclude_none=True) TimeRange = typing_extensions.Annotated[ @@ -6164,12 +3453,6 @@ class ThreeDimensionalAggregationDict(typing_extensions.TypedDict): """An absolute or relative range for a time series query.""" -TimeRangeDict = typing_extensions.Annotated[ - typing.Union[AbsoluteTimeRangeDict, RelativeTimeRangeDict], pydantic.Field(discriminator="type") -] -"""An absolute or relative range for a time series query.""" - - TimeSeriesAggregationMethod = typing.Literal[ "SUM", "MEAN", @@ -6200,22 +3483,6 @@ class ThreeDimensionalAggregationDict(typing_extensions.TypedDict): """ -TimeSeriesAggregationStrategyDict = typing_extensions.Annotated[ - typing.Union[ - "TimeSeriesRollingAggregateDict", - "TimeSeriesPeriodicAggregateDict", - "TimeSeriesCumulativeAggregateDict", - ], - pydantic.Field(discriminator="type"), -] -""" -CUMULATIVE aggregates all points up to the current point. -ROLLING aggregates all points in a rolling window whose size is either the specified number of points or -time duration. -PERIODIC aggregates all points in specified time windows. -""" - - class TimeSeriesCumulativeAggregate(pydantic.BaseModel): """ The cumulative aggregate is calculated progressively for each point in the input time series, @@ -6225,22 +3492,9 @@ class TimeSeriesCumulativeAggregate(pydantic.BaseModel): type: typing.Literal["cumulative"] = "cumulative" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TimeSeriesCumulativeAggregateDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - TimeSeriesCumulativeAggregateDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class TimeSeriesCumulativeAggregateDict(typing_extensions.TypedDict): - """ - The cumulative aggregate is calculated progressively for each point in the input time series, - considering all preceding points up to and including the current point. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["cumulative"] + return self.model_dump(by_alias=True, exclude_none=True) class TimeSeriesPeriodicAggregate(pydantic.BaseModel): @@ -6273,43 +3527,9 @@ class TimeSeriesPeriodicAggregate(pydantic.BaseModel): type: typing.Literal["periodic"] = "periodic" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TimeSeriesPeriodicAggregateDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - TimeSeriesPeriodicAggregateDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class TimeSeriesPeriodicAggregateDict(typing_extensions.TypedDict): - """ - Aggregates values over discrete, periodic windows for a given time series. - - A periodic window divides the time series into windows of fixed durations. - For each window, an aggregate function is applied to the points within that window. The result is a time series - with values representing the aggregate for each window. Windows with no data points are not included - in the output. - - Periodic aggregation is useful for downsampling a continuous stream of data to larger granularities such as - hourly, daily, monthly. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - windowSize: PreciseDurationDict - alignmentTimestamp: typing_extensions.NotRequired[datetime] - """ - The timestamp used to align the result, such that ticks in the result time series will lie at integer - multiples of the window duration from the alignment timestamp. - - Default is the first epoch timestamp (January 1, 1970, 00:00:00 UTC) so that all aggregated points have - timestamps at midnight UTC at the start of each window duration. - - For example, for a weekly aggregate with alignment timestamp 5 January, 8:33PM, - each aggregated timestamp will lie on the 7 day intervals at 8:33PM starting at 5 January. - """ - - windowType: TimeSeriesWindowType - type: typing.Literal["periodic"] + return self.model_dump(by_alias=True, exclude_none=True) class TimeSeriesPoint(pydantic.BaseModel): @@ -6323,21 +3543,9 @@ class TimeSeriesPoint(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TimeSeriesPointDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(TimeSeriesPointDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class TimeSeriesPointDict(typing_extensions.TypedDict): - """A time and value pair.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - time: datetime - """An ISO 8601 timestamp""" - - value: typing.Any - """An object which is either an enum String or a double number.""" + return self.model_dump(by_alias=True, exclude_none=True) class TimeSeriesRollingAggregate(pydantic.BaseModel): @@ -6347,20 +3555,9 @@ class TimeSeriesRollingAggregate(pydantic.BaseModel): type: typing.Literal["rolling"] = "rolling" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TimeSeriesRollingAggregateDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - TimeSeriesRollingAggregateDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class TimeSeriesRollingAggregateDict(typing_extensions.TypedDict): - """TimeSeriesRollingAggregate""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - windowSize: TimeSeriesRollingAggregateWindowDict - type: typing.Literal["rolling"] + return self.model_dump(by_alias=True, exclude_none=True) TimeSeriesRollingAggregateWindow = typing_extensions.Annotated[ @@ -6377,20 +3574,6 @@ class TimeSeriesRollingAggregateDict(typing_extensions.TypedDict): """ -TimeSeriesRollingAggregateWindowDict = typing_extensions.Annotated[ - typing.Union[PreciseDurationDict, RollingAggregateWindowPointsDict], - pydantic.Field(discriminator="type"), -] -""" -A rolling window is a moving subset of data points that ends at the current timestamp (inclusive) -and spans a specified duration (window size). As new data points are added, old points fall out of the -window if they are outside the specified duration. - -Rolling windows are commonly used for smoothing data, detecting trends, and reducing noise -in time series analysis. -""" - - TimeSeriesWindowType = typing.Literal["START", "END"] """TimeSeriesWindowType""" @@ -6412,21 +3595,9 @@ class TimeseriesEntry(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TimeseriesEntryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(TimeseriesEntryDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class TimeseriesEntryDict(typing_extensions.TypedDict): - """A time and value pair.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - time: datetime - """An ISO 8601 timestamp""" - - value: typing.Any - """An object which is either an enum String, double number, or a geopoint.""" + return self.model_dump(by_alias=True, exclude_none=True) class TwoDimensionalAggregation(pydantic.BaseModel): @@ -6437,21 +3608,9 @@ class TwoDimensionalAggregation(pydantic.BaseModel): type: typing.Literal["twoDimensionalAggregation"] = "twoDimensionalAggregation" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TwoDimensionalAggregationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - TwoDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class TwoDimensionalAggregationDict(typing_extensions.TypedDict): - """TwoDimensionalAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: QueryAggregationKeyTypeDict - valueType: QueryAggregationValueTypeDict - type: typing.Literal["twoDimensionalAggregation"] + return self.model_dump(by_alias=True, exclude_none=True) class UnevaluableConstraint(pydantic.BaseModel): @@ -6463,22 +3622,9 @@ class UnevaluableConstraint(pydantic.BaseModel): type: typing.Literal["unevaluable"] = "unevaluable" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "UnevaluableConstraintDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - UnevaluableConstraintDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class UnevaluableConstraintDict(typing_extensions.TypedDict): - """ - The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. - This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["unevaluable"] + return self.model_dump(by_alias=True, exclude_none=True) class ValidateActionResponseV2(pydantic.BaseModel): @@ -6489,21 +3635,9 @@ class ValidateActionResponseV2(pydantic.BaseModel): parameters: typing.Dict[ParameterId, ParameterEvaluationResult] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ValidateActionResponseV2Dict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ValidateActionResponseV2Dict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ValidateActionResponseV2Dict(typing_extensions.TypedDict): - """ValidateActionResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - result: ValidationResult - submissionCriteria: typing.List[SubmissionCriteriaEvaluationDict] - parameters: typing.Dict[ParameterId, ParameterEvaluationResultDict] + return self.model_dump(by_alias=True, exclude_none=True) ValidationResult = typing.Literal["VALID", "INVALID"] @@ -6551,26 +3685,9 @@ class WithinBoundingBoxQuery(pydantic.BaseModel): type: typing.Literal["withinBoundingBox"] = "withinBoundingBox" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "WithinBoundingBoxQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - WithinBoundingBoxQueryDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class WithinBoundingBoxQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field contains a point within the bounding box provided. Allows you to - specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, - but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: BoundingBoxValueDict - type: typing.Literal["withinBoundingBox"] + return self.model_dump(by_alias=True, exclude_none=True) class WithinDistanceOfQuery(pydantic.BaseModel): @@ -6586,26 +3703,9 @@ class WithinDistanceOfQuery(pydantic.BaseModel): type: typing.Literal["withinDistanceOf"] = "withinDistanceOf" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "WithinDistanceOfQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - WithinDistanceOfQueryDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class WithinDistanceOfQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field contains a point within the distance provided of the center point. - Allows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` - must be supplied, but not both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: CenterPointDict - type: typing.Literal["withinDistanceOf"] + return self.model_dump(by_alias=True, exclude_none=True) class WithinPolygonQuery(pydantic.BaseModel): @@ -6621,653 +3721,355 @@ class WithinPolygonQuery(pydantic.BaseModel): type: typing.Literal["withinPolygon"] = "withinPolygon" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "WithinPolygonQueryDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - WithinPolygonQueryDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class WithinPolygonQueryDict(typing_extensions.TypedDict): - """ - Returns objects where the specified field contains a point within the polygon provided. Allows you to specify a - property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not - both. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: typing_extensions.NotRequired[PropertyApiName] - propertyIdentifier: typing_extensions.NotRequired[PropertyIdentifierDict] - value: PolygonValueDict - type: typing.Literal["withinPolygon"] + return self.model_dump(by_alias=True, exclude_none=True) CenterPointTypes = geo_models.GeoPoint """CenterPointTypes""" -CenterPointTypesDict = geo_models.GeoPointDict -"""CenterPointTypes""" - - Icon = BlueprintIcon """A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).""" -IconDict = BlueprintIconDict -"""A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).""" - - MethodObjectSet = ObjectSet """MethodObjectSet""" -MethodObjectSetDict = ObjectSetDict -"""MethodObjectSet""" - - PolygonValue = geo_models.Polygon """PolygonValue""" -PolygonValueDict = geo_models.PolygonDict -"""PolygonValue""" - - WithinBoundingBoxPoint = geo_models.GeoPoint """WithinBoundingBoxPoint""" -WithinBoundingBoxPointDict = geo_models.GeoPointDict -"""WithinBoundingBoxPoint""" - - core.resolve_forward_references(ActionParameterType, globalns=globals(), localns=locals()) -core.resolve_forward_references(ActionParameterTypeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(ActionResults, globalns=globals(), localns=locals()) -core.resolve_forward_references(ActionResultsDict, globalns=globals(), localns=locals()) core.resolve_forward_references(AggregationGroupByV2, globalns=globals(), localns=locals()) -core.resolve_forward_references(AggregationGroupByV2Dict, globalns=globals(), localns=locals()) core.resolve_forward_references(AggregationV2, globalns=globals(), localns=locals()) -core.resolve_forward_references(AggregationV2Dict, globalns=globals(), localns=locals()) core.resolve_forward_references(AttachmentMetadataResponse, globalns=globals(), localns=locals()) -core.resolve_forward_references( - AttachmentMetadataResponseDict, globalns=globals(), localns=locals() -) core.resolve_forward_references(BatchActionObjectEdit, globalns=globals(), localns=locals()) -core.resolve_forward_references(BatchActionObjectEditDict, globalns=globals(), localns=locals()) core.resolve_forward_references(BatchActionResults, globalns=globals(), localns=locals()) -core.resolve_forward_references(BatchActionResultsDict, globalns=globals(), localns=locals()) core.resolve_forward_references(DerivedPropertyDefinition, globalns=globals(), localns=locals()) -core.resolve_forward_references(DerivedPropertyDefinitionDict, globalns=globals(), localns=locals()) core.resolve_forward_references( InterfaceLinkTypeLinkedEntityApiName, globalns=globals(), localns=locals() ) -core.resolve_forward_references( - InterfaceLinkTypeLinkedEntityApiNameDict, globalns=globals(), localns=locals() -) core.resolve_forward_references(InterfaceToObjectTypeMapping, globalns=globals(), localns=locals()) core.resolve_forward_references(InterfaceToObjectTypeMappings, globalns=globals(), localns=locals()) core.resolve_forward_references(LogicRule, globalns=globals(), localns=locals()) -core.resolve_forward_references(LogicRuleDict, globalns=globals(), localns=locals()) core.resolve_forward_references(NearestNeighborsQuery, globalns=globals(), localns=locals()) -core.resolve_forward_references(NearestNeighborsQueryDict, globalns=globals(), localns=locals()) core.resolve_forward_references(ObjectEdit, globalns=globals(), localns=locals()) -core.resolve_forward_references(ObjectEditDict, globalns=globals(), localns=locals()) core.resolve_forward_references(ObjectPropertyType, globalns=globals(), localns=locals()) -core.resolve_forward_references(ObjectPropertyTypeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(ObjectSet, globalns=globals(), localns=locals()) -core.resolve_forward_references(ObjectSetDict, globalns=globals(), localns=locals()) core.resolve_forward_references(OntologyDataType, globalns=globals(), localns=locals()) -core.resolve_forward_references(OntologyDataTypeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(OntologyObjectV2, globalns=globals(), localns=locals()) core.resolve_forward_references(ParameterEvaluatedConstraint, globalns=globals(), localns=locals()) -core.resolve_forward_references( - ParameterEvaluatedConstraintDict, globalns=globals(), localns=locals() -) core.resolve_forward_references(PropertyIdentifier, globalns=globals(), localns=locals()) -core.resolve_forward_references(PropertyIdentifierDict, globalns=globals(), localns=locals()) core.resolve_forward_references(PropertyTypeStatus, globalns=globals(), localns=locals()) -core.resolve_forward_references(PropertyTypeStatusDict, globalns=globals(), localns=locals()) core.resolve_forward_references(QueryAggregationKeyType, globalns=globals(), localns=locals()) -core.resolve_forward_references(QueryAggregationKeyTypeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(QueryAggregationRangeSubType, globalns=globals(), localns=locals()) -core.resolve_forward_references( - QueryAggregationRangeSubTypeDict, globalns=globals(), localns=locals() -) core.resolve_forward_references(QueryAggregationValueType, globalns=globals(), localns=locals()) -core.resolve_forward_references(QueryAggregationValueTypeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(QueryDataType, globalns=globals(), localns=locals()) -core.resolve_forward_references(QueryDataTypeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(SearchJsonQueryV2, globalns=globals(), localns=locals()) -core.resolve_forward_references(SearchJsonQueryV2Dict, globalns=globals(), localns=locals()) core.resolve_forward_references(SelectedPropertyOperation, globalns=globals(), localns=locals()) -core.resolve_forward_references(SelectedPropertyOperationDict, globalns=globals(), localns=locals()) core.resolve_forward_references(TimeRange, globalns=globals(), localns=locals()) -core.resolve_forward_references(TimeRangeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(TimeSeriesAggregationStrategy, globalns=globals(), localns=locals()) -core.resolve_forward_references( - TimeSeriesAggregationStrategyDict, globalns=globals(), localns=locals() -) core.resolve_forward_references( TimeSeriesRollingAggregateWindow, globalns=globals(), localns=locals() ) -core.resolve_forward_references( - TimeSeriesRollingAggregateWindowDict, globalns=globals(), localns=locals() -) __all__ = [ "AbsoluteTimeRange", - "AbsoluteTimeRangeDict", "AbsoluteValuePropertyExpression", - "AbsoluteValuePropertyExpressionDict", "ActionParameterArrayType", - "ActionParameterArrayTypeDict", "ActionParameterType", - "ActionParameterTypeDict", "ActionParameterV2", - "ActionParameterV2Dict", "ActionResults", - "ActionResultsDict", "ActionRid", "ActionTypeApiName", "ActionTypeRid", "ActionTypeV2", - "ActionTypeV2Dict", "ActivePropertyTypeStatus", - "ActivePropertyTypeStatusDict", "AddLink", - "AddLinkDict", "AddObject", - "AddObjectDict", "AddPropertyExpression", - "AddPropertyExpressionDict", "AggregateObjectsResponseItemV2", - "AggregateObjectsResponseItemV2Dict", "AggregateObjectsResponseV2", - "AggregateObjectsResponseV2Dict", "AggregateTimeSeries", - "AggregateTimeSeriesDict", "AggregationAccuracy", "AggregationAccuracyRequest", "AggregationDurationGroupingV2", - "AggregationDurationGroupingV2Dict", "AggregationExactGroupingV2", - "AggregationExactGroupingV2Dict", "AggregationFixedWidthGroupingV2", - "AggregationFixedWidthGroupingV2Dict", "AggregationGroupByV2", - "AggregationGroupByV2Dict", "AggregationGroupKeyV2", "AggregationGroupValueV2", "AggregationMetricName", "AggregationMetricResultV2", - "AggregationMetricResultV2Dict", "AggregationRangeV2", - "AggregationRangeV2Dict", "AggregationRangesGroupingV2", - "AggregationRangesGroupingV2Dict", "AggregationV2", - "AggregationV2Dict", "AndQueryV2", - "AndQueryV2Dict", "ApplyActionMode", "ApplyActionRequestOptions", - "ApplyActionRequestOptionsDict", "ApproximateDistinctAggregationV2", - "ApproximateDistinctAggregationV2Dict", "ApproximatePercentileAggregationV2", - "ApproximatePercentileAggregationV2Dict", "ArraySizeConstraint", - "ArraySizeConstraintDict", "ArtifactRepositoryRid", "AttachmentMetadataResponse", - "AttachmentMetadataResponseDict", "AttachmentRid", "AttachmentV2", - "AttachmentV2Dict", "AvgAggregationV2", - "AvgAggregationV2Dict", "BatchActionObjectEdit", - "BatchActionObjectEditDict", "BatchActionObjectEdits", - "BatchActionObjectEditsDict", "BatchActionResults", - "BatchActionResultsDict", "BatchApplyActionRequestItem", - "BatchApplyActionRequestItemDict", "BatchApplyActionRequestOptions", - "BatchApplyActionRequestOptionsDict", "BatchApplyActionResponseV2", - "BatchApplyActionResponseV2Dict", "BatchReturnEditsMode", "BlueprintIcon", - "BlueprintIconDict", "BoundingBoxValue", - "BoundingBoxValueDict", "CenterPoint", - "CenterPointDict", "CenterPointTypes", - "CenterPointTypesDict", "ContainsAllTermsInOrderPrefixLastTerm", - "ContainsAllTermsInOrderPrefixLastTermDict", "ContainsAllTermsInOrderQuery", - "ContainsAllTermsInOrderQueryDict", "ContainsAllTermsQuery", - "ContainsAllTermsQueryDict", "ContainsAnyTermQuery", - "ContainsAnyTermQueryDict", "ContainsQueryV2", - "ContainsQueryV2Dict", "CountAggregationV2", - "CountAggregationV2Dict", "CountObjectsResponseV2", - "CountObjectsResponseV2Dict", "CreateInterfaceObjectRule", - "CreateInterfaceObjectRuleDict", "CreateLinkRule", - "CreateLinkRuleDict", "CreateObjectRule", - "CreateObjectRuleDict", "CreateTemporaryObjectSetResponseV2", - "CreateTemporaryObjectSetResponseV2Dict", "DataValue", "DeleteInterfaceObjectRule", - "DeleteInterfaceObjectRuleDict", "DeleteLink", - "DeleteLinkDict", "DeleteLinkRule", - "DeleteLinkRuleDict", "DeleteObject", - "DeleteObjectDict", "DeleteObjectRule", - "DeleteObjectRuleDict", "DeprecatedPropertyTypeStatus", - "DeprecatedPropertyTypeStatusDict", "DerivedPropertyApiName", "DerivedPropertyDefinition", - "DerivedPropertyDefinitionDict", "DividePropertyExpression", - "DividePropertyExpressionDict", "DoesNotIntersectBoundingBoxQuery", - "DoesNotIntersectBoundingBoxQueryDict", "DoesNotIntersectPolygonQuery", - "DoesNotIntersectPolygonQueryDict", "DoubleVector", - "DoubleVectorDict", "EntrySetType", - "EntrySetTypeDict", "EqualsQueryV2", - "EqualsQueryV2Dict", "ExactDistinctAggregationV2", - "ExactDistinctAggregationV2Dict", "ExamplePropertyTypeStatus", - "ExamplePropertyTypeStatusDict", "ExecuteQueryResponse", - "ExecuteQueryResponseDict", "ExperimentalPropertyTypeStatus", - "ExperimentalPropertyTypeStatusDict", "ExtractDatePart", "ExtractPropertyExpression", - "ExtractPropertyExpressionDict", "FilterValue", "FunctionRid", "FunctionVersion", "FuzzyV2", "GetSelectedPropertyOperation", - "GetSelectedPropertyOperationDict", "GreatestPropertyExpression", - "GreatestPropertyExpressionDict", "GroupMemberConstraint", - "GroupMemberConstraintDict", "GtQueryV2", - "GtQueryV2Dict", "GteQueryV2", - "GteQueryV2Dict", "Icon", - "IconDict", "InQuery", - "InQueryDict", "InterfaceLinkType", "InterfaceLinkTypeApiName", "InterfaceLinkTypeCardinality", - "InterfaceLinkTypeDict", "InterfaceLinkTypeLinkedEntityApiName", - "InterfaceLinkTypeLinkedEntityApiNameDict", "InterfaceLinkTypeRid", "InterfaceSharedPropertyType", - "InterfaceSharedPropertyTypeDict", "InterfaceToObjectTypeMapping", "InterfaceToObjectTypeMappings", "InterfaceType", "InterfaceTypeApiName", - "InterfaceTypeDict", "InterfaceTypeRid", "IntersectsBoundingBoxQuery", - "IntersectsBoundingBoxQueryDict", "IntersectsPolygonQuery", - "IntersectsPolygonQueryDict", "IsNullQueryV2", - "IsNullQueryV2Dict", "LeastPropertyExpression", - "LeastPropertyExpressionDict", "LinkSideObject", - "LinkSideObjectDict", "LinkTypeApiName", "LinkTypeRid", "LinkTypeSideCardinality", "LinkTypeSideV2", - "LinkTypeSideV2Dict", "LinkedInterfaceTypeApiName", - "LinkedInterfaceTypeApiNameDict", "LinkedObjectTypeApiName", - "LinkedObjectTypeApiNameDict", "ListActionTypesResponseV2", - "ListActionTypesResponseV2Dict", "ListAttachmentsResponseV2", - "ListAttachmentsResponseV2Dict", "ListInterfaceTypesResponse", - "ListInterfaceTypesResponseDict", "ListLinkedObjectsResponseV2", - "ListLinkedObjectsResponseV2Dict", "ListObjectTypesV2Response", - "ListObjectTypesV2ResponseDict", "ListObjectsResponseV2", - "ListObjectsResponseV2Dict", "ListOntologiesV2Response", - "ListOntologiesV2ResponseDict", "ListOutgoingLinkTypesResponseV2", - "ListOutgoingLinkTypesResponseV2Dict", "ListQueryTypesResponseV2", - "ListQueryTypesResponseV2Dict", "LoadObjectSetResponseV2", - "LoadObjectSetResponseV2Dict", "LoadObjectSetV2MultipleObjectTypesResponse", - "LoadObjectSetV2MultipleObjectTypesResponseDict", "LoadObjectSetV2ObjectsOrInterfacesResponse", - "LoadObjectSetV2ObjectsOrInterfacesResponseDict", "LogicRule", - "LogicRuleDict", "LtQueryV2", - "LtQueryV2Dict", "LteQueryV2", - "LteQueryV2Dict", "MaxAggregationV2", - "MaxAggregationV2Dict", "MediaMetadata", - "MediaMetadataDict", "MethodObjectSet", - "MethodObjectSetDict", "MinAggregationV2", - "MinAggregationV2Dict", "ModifyInterfaceObjectRule", - "ModifyInterfaceObjectRuleDict", "ModifyObject", - "ModifyObjectDict", "ModifyObjectRule", - "ModifyObjectRuleDict", "MultiplyPropertyExpression", - "MultiplyPropertyExpressionDict", "NearestNeighborsQuery", - "NearestNeighborsQueryDict", "NearestNeighborsQueryText", - "NearestNeighborsQueryTextDict", "NegatePropertyExpression", - "NegatePropertyExpressionDict", "NotQueryV2", - "NotQueryV2Dict", "ObjectEdit", - "ObjectEditDict", "ObjectEdits", - "ObjectEditsDict", "ObjectPropertyType", - "ObjectPropertyTypeDict", "ObjectPropertyValueConstraint", - "ObjectPropertyValueConstraintDict", "ObjectQueryResultConstraint", - "ObjectQueryResultConstraintDict", "ObjectRid", "ObjectSet", "ObjectSetAsBaseObjectTypesType", - "ObjectSetAsBaseObjectTypesTypeDict", "ObjectSetAsTypeType", - "ObjectSetAsTypeTypeDict", "ObjectSetBaseType", - "ObjectSetBaseTypeDict", - "ObjectSetDict", "ObjectSetFilterType", - "ObjectSetFilterTypeDict", "ObjectSetInterfaceBaseType", - "ObjectSetInterfaceBaseTypeDict", "ObjectSetIntersectionType", - "ObjectSetIntersectionTypeDict", "ObjectSetMethodInputType", - "ObjectSetMethodInputTypeDict", "ObjectSetNearestNeighborsType", - "ObjectSetNearestNeighborsTypeDict", "ObjectSetReferenceType", - "ObjectSetReferenceTypeDict", "ObjectSetRid", "ObjectSetSearchAroundType", - "ObjectSetSearchAroundTypeDict", "ObjectSetStaticType", - "ObjectSetStaticTypeDict", "ObjectSetSubtractType", - "ObjectSetSubtractTypeDict", "ObjectSetUnionType", - "ObjectSetUnionTypeDict", "ObjectSetWithPropertiesType", - "ObjectSetWithPropertiesTypeDict", "ObjectTypeApiName", "ObjectTypeEdits", - "ObjectTypeEditsDict", "ObjectTypeFullMetadata", - "ObjectTypeFullMetadataDict", "ObjectTypeId", "ObjectTypeInterfaceImplementation", - "ObjectTypeInterfaceImplementationDict", "ObjectTypeRid", "ObjectTypeV2", - "ObjectTypeV2Dict", "ObjectTypeVisibility", "OneOfConstraint", - "OneOfConstraintDict", "OntologyApiName", "OntologyArrayType", - "OntologyArrayTypeDict", "OntologyDataType", - "OntologyDataTypeDict", "OntologyFullMetadata", - "OntologyFullMetadataDict", "OntologyIdentifier", "OntologyInterfaceObjectType", - "OntologyInterfaceObjectTypeDict", "OntologyMapType", - "OntologyMapTypeDict", "OntologyObjectArrayType", - "OntologyObjectArrayTypeDict", "OntologyObjectSetType", - "OntologyObjectSetTypeDict", "OntologyObjectType", - "OntologyObjectTypeDict", "OntologyObjectTypeReferenceType", - "OntologyObjectTypeReferenceTypeDict", "OntologyObjectV2", "OntologyRid", "OntologySetType", - "OntologySetTypeDict", "OntologyStructField", - "OntologyStructFieldDict", "OntologyStructType", - "OntologyStructTypeDict", "OntologyV2", - "OntologyV2Dict", "OrQueryV2", - "OrQueryV2Dict", "OrderBy", "OrderByDirection", "ParameterEvaluatedConstraint", - "ParameterEvaluatedConstraintDict", "ParameterEvaluationResult", - "ParameterEvaluationResultDict", "ParameterId", "ParameterOption", - "ParameterOptionDict", "PolygonValue", - "PolygonValueDict", "PreciseDuration", - "PreciseDurationDict", "PreciseTimeUnit", "PrimaryKeyValue", "PropertyApiName", "PropertyApiNameSelector", - "PropertyApiNameSelectorDict", "PropertyFilter", "PropertyId", "PropertyIdentifier", - "PropertyIdentifierDict", "PropertyTypeRid", "PropertyTypeStatus", - "PropertyTypeStatusDict", "PropertyTypeVisibility", "PropertyV2", - "PropertyV2Dict", "PropertyValue", "PropertyValueEscapedString", "QueryAggregationKeyType", - "QueryAggregationKeyTypeDict", "QueryAggregationRangeSubType", - "QueryAggregationRangeSubTypeDict", "QueryAggregationRangeType", - "QueryAggregationRangeTypeDict", "QueryAggregationValueType", - "QueryAggregationValueTypeDict", "QueryApiName", "QueryArrayType", - "QueryArrayTypeDict", "QueryDataType", - "QueryDataTypeDict", "QueryParameterV2", - "QueryParameterV2Dict", "QueryRuntimeErrorParameter", "QuerySetType", - "QuerySetTypeDict", "QueryStructField", - "QueryStructFieldDict", "QueryStructType", - "QueryStructTypeDict", "QueryTypeV2", - "QueryTypeV2Dict", "QueryUnionType", - "QueryUnionTypeDict", "RangeConstraint", - "RangeConstraintDict", "RelativeTime", - "RelativeTimeDict", "RelativeTimeRange", - "RelativeTimeRangeDict", "RelativeTimeRelation", "RelativeTimeSeriesTimeUnit", "ReturnEditsMode", "RollingAggregateWindowPoints", - "RollingAggregateWindowPointsDict", "SdkPackageName", "SearchJsonQueryV2", - "SearchJsonQueryV2Dict", "SearchObjectsResponseV2", - "SearchObjectsResponseV2Dict", "SearchOrderByType", "SearchOrderByV2", - "SearchOrderByV2Dict", "SearchOrderingV2", - "SearchOrderingV2Dict", "SelectedPropertyApiName", "SelectedPropertyApproximateDistinctAggregation", - "SelectedPropertyApproximateDistinctAggregationDict", "SelectedPropertyApproximatePercentileAggregation", - "SelectedPropertyApproximatePercentileAggregationDict", "SelectedPropertyAvgAggregation", - "SelectedPropertyAvgAggregationDict", "SelectedPropertyCollectListAggregation", - "SelectedPropertyCollectListAggregationDict", "SelectedPropertyCollectSetAggregation", - "SelectedPropertyCollectSetAggregationDict", "SelectedPropertyCountAggregation", - "SelectedPropertyCountAggregationDict", "SelectedPropertyExactDistinctAggregation", - "SelectedPropertyExactDistinctAggregationDict", "SelectedPropertyExpression", - "SelectedPropertyExpressionDict", "SelectedPropertyMaxAggregation", - "SelectedPropertyMaxAggregationDict", "SelectedPropertyMinAggregation", - "SelectedPropertyMinAggregationDict", "SelectedPropertyOperation", - "SelectedPropertyOperationDict", "SelectedPropertySumAggregation", - "SelectedPropertySumAggregationDict", "SharedPropertyType", "SharedPropertyTypeApiName", - "SharedPropertyTypeDict", "SharedPropertyTypeRid", "StartsWithQuery", - "StartsWithQueryDict", "StreamingOutputFormat", "StringLengthConstraint", - "StringLengthConstraintDict", "StringRegexMatchConstraint", - "StringRegexMatchConstraintDict", "StructFieldApiName", "StructFieldSelector", - "StructFieldSelectorDict", "StructFieldType", - "StructFieldTypeDict", "StructType", - "StructTypeDict", "SubmissionCriteriaEvaluation", - "SubmissionCriteriaEvaluationDict", "SubtractPropertyExpression", - "SubtractPropertyExpressionDict", "SumAggregationV2", - "SumAggregationV2Dict", "SyncApplyActionResponseV2", - "SyncApplyActionResponseV2Dict", "ThreeDimensionalAggregation", - "ThreeDimensionalAggregationDict", "TimeRange", - "TimeRangeDict", "TimeSeriesAggregationMethod", "TimeSeriesAggregationStrategy", - "TimeSeriesAggregationStrategyDict", "TimeSeriesCumulativeAggregate", - "TimeSeriesCumulativeAggregateDict", "TimeSeriesPeriodicAggregate", - "TimeSeriesPeriodicAggregateDict", "TimeSeriesPoint", - "TimeSeriesPointDict", "TimeSeriesRollingAggregate", - "TimeSeriesRollingAggregateDict", "TimeSeriesRollingAggregateWindow", - "TimeSeriesRollingAggregateWindowDict", "TimeSeriesWindowType", "TimeUnit", "TimeseriesEntry", - "TimeseriesEntryDict", "TwoDimensionalAggregation", - "TwoDimensionalAggregationDict", "UnevaluableConstraint", - "UnevaluableConstraintDict", "ValidateActionResponseV2", - "ValidateActionResponseV2Dict", "ValidationResult", "ValueType", "WithinBoundingBoxPoint", - "WithinBoundingBoxPointDict", "WithinBoundingBoxQuery", - "WithinBoundingBoxQueryDict", "WithinDistanceOfQuery", - "WithinDistanceOfQueryDict", "WithinPolygonQuery", - "WithinPolygonQueryDict", ] diff --git a/foundry/v2/ontologies/object_type.py b/foundry/v2/ontologies/object_type.py index 7130d6a4b..5a042b19d 100644 --- a/foundry/v2/ontologies/object_type.py +++ b/foundry/v2/ontologies/object_type.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -312,131 +311,6 @@ def list_outgoing_link_types( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - ontology: ontologies_models.OntologyIdentifier, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.ListObjectTypesV2Response: - """ - Lists the object types for the given Ontology. - - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. - :type ontology: OntologyIdentifier - :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.ListObjectTypesV2Response - """ - - warnings.warn( - "The client.ontologies.ObjectType.page(...) method has been deprecated. Please use client.ontologies.ObjectType.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objectTypes", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - }, - path_params={ - "ontology": ontology, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=ontologies_models.ListObjectTypesV2Response, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page_outgoing_link_types( - self, - ontology: ontologies_models.OntologyIdentifier, - object_type: ontologies_models.ObjectTypeApiName, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.ListOutgoingLinkTypesResponseV2: - """ - List the outgoing links for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. - :type ontology: OntologyIdentifier - :param object_type: The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager** application. - :type object_type: ObjectTypeApiName - :param page_size: The desired size of the page to be returned. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.ListOutgoingLinkTypesResponseV2 - """ - - warnings.warn( - "The client.ontologies.ObjectType.page_outgoing_link_types(...) method has been deprecated. Please use client.ontologies.ObjectType.list_outgoing_link_types(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - }, - path_params={ - "ontology": ontology, - "objectType": object_type, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=ontologies_models.ListOutgoingLinkTypesResponseV2, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _ObjectTypeClientRaw: def __init__(self, client: ObjectTypeClient) -> None: @@ -445,8 +319,6 @@ def get_full_metadata(_: ontologies_models.ObjectTypeFullMetadata): ... def get_outgoing_link_type(_: ontologies_models.LinkTypeSideV2): ... def list(_: ontologies_models.ListObjectTypesV2Response): ... def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV2): ... - def page(_: ontologies_models.ListObjectTypesV2Response): ... - def page_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV2): ... self.get = core.with_raw_response(get, client.get) self.get_full_metadata = core.with_raw_response(get_full_metadata, client.get_full_metadata) @@ -457,10 +329,6 @@ def page_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV self.list_outgoing_link_types = core.with_raw_response( list_outgoing_link_types, client.list_outgoing_link_types ) - self.page = core.with_raw_response(page, client.page) - self.page_outgoing_link_types = core.with_raw_response( - page_outgoing_link_types, client.page_outgoing_link_types - ) class _ObjectTypeClientStreaming: @@ -470,8 +338,6 @@ def get_full_metadata(_: ontologies_models.ObjectTypeFullMetadata): ... def get_outgoing_link_type(_: ontologies_models.LinkTypeSideV2): ... def list(_: ontologies_models.ListObjectTypesV2Response): ... def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV2): ... - def page(_: ontologies_models.ListObjectTypesV2Response): ... - def page_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV2): ... self.get = core.with_streaming_response(get, client.get) self.get_full_metadata = core.with_streaming_response( @@ -484,7 +350,3 @@ def page_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV self.list_outgoing_link_types = core.with_streaming_response( list_outgoing_link_types, client.list_outgoing_link_types ) - self.page = core.with_streaming_response(page, client.page) - self.page_outgoing_link_types = core.with_streaming_response( - page_outgoing_link_types, client.page_outgoing_link_types - ) diff --git a/foundry/v2/ontologies/ontology_interface.py b/foundry/v2/ontologies/ontology_interface.py index d9b8f8c04..10e006e75 100644 --- a/foundry/v2/ontologies/ontology_interface.py +++ b/foundry/v2/ontologies/ontology_interface.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -56,21 +55,11 @@ def aggregate( ontology: ontologies_models.OntologyIdentifier, interface_type: ontologies_models.InterfaceTypeApiName, *, - aggregation: typing.List[ - typing.Union[ontologies_models.AggregationV2, ontologies_models.AggregationV2Dict] - ], - group_by: typing.List[ - typing.Union[ - ontologies_models.AggregationGroupByV2, ontologies_models.AggregationGroupByV2Dict - ] - ], + aggregation: typing.List[ontologies_models.AggregationV2], + group_by: typing.List[ontologies_models.AggregationGroupByV2], accuracy: typing.Optional[ontologies_models.AggregationAccuracyRequest] = None, preview: typing.Optional[core_models.PreviewMode] = None, - where: typing.Optional[ - typing.Union[ - ontologies_models.SearchJsonQueryV2, ontologies_models.SearchJsonQueryV2Dict - ] - ] = None, + where: typing.Optional[ontologies_models.SearchJsonQueryV2] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> ontologies_models.AggregateObjectsResponseV2: @@ -94,15 +83,15 @@ def aggregate( :param interface_type: The API name of the interface type. To find the API name, use the **List interface types** endpoint or check the **Ontology Manager**. :type interface_type: InterfaceTypeApiName :param aggregation: - :type aggregation: List[Union[AggregationV2, AggregationV2Dict]] + :type aggregation: List[AggregationV2] :param group_by: - :type group_by: List[Union[AggregationGroupByV2, AggregationGroupByV2Dict]] + :type group_by: List[AggregationGroupByV2] :param accuracy: :type accuracy: Optional[AggregationAccuracyRequest] :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. :type preview: Optional[PreviewMode] :param where: - :type where: Optional[Union[SearchJsonQueryV2, SearchJsonQueryV2Dict]] + :type where: Optional[SearchJsonQueryV2] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -133,23 +122,9 @@ def aggregate( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "aggregation": typing.List[ - typing.Union[ - ontologies_models.AggregationV2, ontologies_models.AggregationV2Dict - ] - ], - "where": typing.Optional[ - typing.Union[ - ontologies_models.SearchJsonQueryV2, - ontologies_models.SearchJsonQueryV2Dict, - ] - ], - "groupBy": typing.List[ - typing.Union[ - ontologies_models.AggregationGroupByV2, - ontologies_models.AggregationGroupByV2Dict, - ] - ], + "aggregation": typing.List[ontologies_models.AggregationV2], + "where": typing.Optional[ontologies_models.SearchJsonQueryV2], + "groupBy": typing.List[ontologies_models.AggregationGroupByV2], "accuracy": typing.Optional[ontologies_models.AggregationAccuracyRequest], }, ), @@ -281,76 +256,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - ontology: ontologies_models.OntologyIdentifier, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.ListInterfaceTypesResponse: - """ - :::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. - ::: - - Lists the interface types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. - :type ontology: OntologyIdentifier - :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. - :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: ontologies_models.ListInterfaceTypesResponse - """ - - warnings.warn( - "The client.ontologies.OntologyInterface.page(...) method has been deprecated. Please use client.ontologies.OntologyInterface.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/interfaceTypes", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "ontology": ontology, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=ontologies_models.ListInterfaceTypesResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -369,17 +274,11 @@ def search( other_interface_types: typing.List[ontologies_models.InterfaceTypeApiName], selected_object_types: typing.List[ontologies_models.ObjectTypeApiName], selected_shared_property_types: typing.List[ontologies_models.SharedPropertyTypeApiName], - order_by: typing.Optional[ - typing.Union[ontologies_models.SearchOrderByV2, ontologies_models.SearchOrderByV2Dict] - ] = None, + order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, preview: typing.Optional[core_models.PreviewMode] = None, - where: typing.Optional[ - typing.Union[ - ontologies_models.SearchJsonQueryV2, ontologies_models.SearchJsonQueryV2Dict - ] - ] = None, + where: typing.Optional[ontologies_models.SearchJsonQueryV2] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> ontologies_models.SearchObjectsResponseV2: @@ -436,7 +335,7 @@ def search( :param selected_shared_property_types: A list of shared property type API names of the interface type that should be included in the response. Omit this parameter to include all properties of the interface type in the response. :type selected_shared_property_types: List[SharedPropertyTypeApiName] :param order_by: - :type order_by: Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] + :type order_by: Optional[SearchOrderByV2] :param page_size: :type page_size: Optional[PageSize] :param page_token: @@ -444,7 +343,7 @@ def search( :param preview: A boolean flag that, when set to true, enables the use of beta features in preview mode. :type preview: Optional[PreviewMode] :param where: - :type where: Optional[Union[SearchJsonQueryV2, SearchJsonQueryV2Dict]] + :type where: Optional[SearchJsonQueryV2] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -480,18 +379,8 @@ def search( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "where": typing.Optional[ - typing.Union[ - ontologies_models.SearchJsonQueryV2, - ontologies_models.SearchJsonQueryV2Dict, - ] - ], - "orderBy": typing.Optional[ - typing.Union[ - ontologies_models.SearchOrderByV2, - ontologies_models.SearchOrderByV2Dict, - ] - ], + "where": typing.Optional[ontologies_models.SearchJsonQueryV2], + "orderBy": typing.Optional[ontologies_models.SearchOrderByV2], "augmentedProperties": typing.Dict[ ontologies_models.ObjectTypeApiName, typing.List[ontologies_models.PropertyApiName], @@ -522,13 +411,11 @@ def __init__(self, client: OntologyInterfaceClient) -> None: def aggregate(_: ontologies_models.AggregateObjectsResponseV2): ... def get(_: ontologies_models.InterfaceType): ... def list(_: ontologies_models.ListInterfaceTypesResponse): ... - def page(_: ontologies_models.ListInterfaceTypesResponse): ... def search(_: ontologies_models.SearchObjectsResponseV2): ... self.aggregate = core.with_raw_response(aggregate, client.aggregate) self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) self.search = core.with_raw_response(search, client.search) @@ -537,11 +424,9 @@ def __init__(self, client: OntologyInterfaceClient) -> None: def aggregate(_: ontologies_models.AggregateObjectsResponseV2): ... def get(_: ontologies_models.InterfaceType): ... def list(_: ontologies_models.ListInterfaceTypesResponse): ... - def page(_: ontologies_models.ListInterfaceTypesResponse): ... def search(_: ontologies_models.SearchObjectsResponseV2): ... self.aggregate = core.with_streaming_response(aggregate, client.aggregate) self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) self.search = core.with_streaming_response(search, client.search) diff --git a/foundry/v2/ontologies/ontology_object.py b/foundry/v2/ontologies/ontology_object.py index 929248e2c..e9aeb17fa 100644 --- a/foundry/v2/ontologies/ontology_object.py +++ b/foundry/v2/ontologies/ontology_object.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -56,22 +55,12 @@ def aggregate( ontology: ontologies_models.OntologyIdentifier, object_type: ontologies_models.ObjectTypeApiName, *, - aggregation: typing.List[ - typing.Union[ontologies_models.AggregationV2, ontologies_models.AggregationV2Dict] - ], - group_by: typing.List[ - typing.Union[ - ontologies_models.AggregationGroupByV2, ontologies_models.AggregationGroupByV2Dict - ] - ], + aggregation: typing.List[ontologies_models.AggregationV2], + group_by: typing.List[ontologies_models.AggregationGroupByV2], accuracy: typing.Optional[ontologies_models.AggregationAccuracyRequest] = None, artifact_repository: typing.Optional[ontologies_models.ArtifactRepositoryRid] = None, package_name: typing.Optional[ontologies_models.SdkPackageName] = None, - where: typing.Optional[ - typing.Union[ - ontologies_models.SearchJsonQueryV2, ontologies_models.SearchJsonQueryV2Dict - ] - ] = None, + where: typing.Optional[ontologies_models.SearchJsonQueryV2] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> ontologies_models.AggregateObjectsResponseV2: @@ -85,9 +74,9 @@ def aggregate( :param object_type: The type of the object to aggregate on. :type object_type: ObjectTypeApiName :param aggregation: - :type aggregation: List[Union[AggregationV2, AggregationV2Dict]] + :type aggregation: List[AggregationV2] :param group_by: - :type group_by: List[Union[AggregationGroupByV2, AggregationGroupByV2Dict]] + :type group_by: List[AggregationGroupByV2] :param accuracy: :type accuracy: Optional[AggregationAccuracyRequest] :param artifact_repository: The repository associated with a marketplace installation. @@ -95,7 +84,7 @@ def aggregate( :param package_name: The package name of the generated SDK. :type package_name: Optional[SdkPackageName] :param where: - :type where: Optional[Union[SearchJsonQueryV2, SearchJsonQueryV2Dict]] + :type where: Optional[SearchJsonQueryV2] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -127,23 +116,9 @@ def aggregate( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "aggregation": typing.List[ - typing.Union[ - ontologies_models.AggregationV2, ontologies_models.AggregationV2Dict - ] - ], - "where": typing.Optional[ - typing.Union[ - ontologies_models.SearchJsonQueryV2, - ontologies_models.SearchJsonQueryV2Dict, - ] - ], - "groupBy": typing.List[ - typing.Union[ - ontologies_models.AggregationGroupByV2, - ontologies_models.AggregationGroupByV2Dict, - ] - ], + "aggregation": typing.List[ontologies_models.AggregationV2], + "where": typing.Optional[ontologies_models.SearchJsonQueryV2], + "groupBy": typing.List[ontologies_models.AggregationGroupByV2], "accuracy": typing.Optional[ontologies_models.AggregationAccuracyRequest], }, ), @@ -366,100 +341,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - ontology: ontologies_models.OntologyIdentifier, - object_type: ontologies_models.ObjectTypeApiName, - *, - artifact_repository: typing.Optional[ontologies_models.ArtifactRepositoryRid] = None, - exclude_rid: typing.Optional[bool] = None, - order_by: typing.Optional[ontologies_models.OrderBy] = None, - package_name: typing.Optional[ontologies_models.SdkPackageName] = None, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - select: typing.Optional[typing.List[ontologies_models.SelectedPropertyApiName]] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.ListObjectsResponseV2: - """ - Lists the objects for the given Ontology and object type. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. - :type ontology: OntologyIdentifier - :param object_type: The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. - :type object_type: ObjectTypeApiName - :param artifact_repository: The repository associated with a marketplace installation. - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param exclude_rid: A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. - :type exclude_rid: Optional[bool] - :param order_by: - :type order_by: Optional[OrderBy] - :param package_name: The package name of the generated SDK. - :type package_name: Optional[SdkPackageName] - :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param select: The properties of the object type that should be included in the response. Omit this parameter to get all the properties. - :type select: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.ListObjectsResponseV2 - """ - - warnings.warn( - "The client.ontologies.OntologyObject.page(...) method has been deprecated. Please use client.ontologies.OntologyObject.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}", - query_params={ - "artifactRepository": artifact_repository, - "excludeRid": exclude_rid, - "orderBy": order_by, - "packageName": package_name, - "pageSize": page_size, - "pageToken": page_token, - "select": select, - }, - path_params={ - "ontology": ontology, - "objectType": object_type, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=ontologies_models.ListObjectsResponseV2, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -471,17 +352,11 @@ def search( select: typing.List[ontologies_models.PropertyApiName], artifact_repository: typing.Optional[ontologies_models.ArtifactRepositoryRid] = None, exclude_rid: typing.Optional[bool] = None, - order_by: typing.Optional[ - typing.Union[ontologies_models.SearchOrderByV2, ontologies_models.SearchOrderByV2Dict] - ] = None, + order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, package_name: typing.Optional[ontologies_models.SdkPackageName] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, - where: typing.Optional[ - typing.Union[ - ontologies_models.SearchJsonQueryV2, ontologies_models.SearchJsonQueryV2Dict - ] - ] = None, + where: typing.Optional[ontologies_models.SearchJsonQueryV2] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> ontologies_models.SearchObjectsResponseV2: @@ -523,7 +398,7 @@ def search( :param exclude_rid: A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. :type exclude_rid: Optional[bool] :param order_by: - :type order_by: Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] + :type order_by: Optional[SearchOrderByV2] :param package_name: The package name of the generated SDK. :type package_name: Optional[SdkPackageName] :param page_size: @@ -531,7 +406,7 @@ def search( :param page_token: :type page_token: Optional[PageToken] :param where: - :type where: Optional[Union[SearchJsonQueryV2, SearchJsonQueryV2Dict]] + :type where: Optional[SearchJsonQueryV2] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -565,18 +440,8 @@ def search( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "where": typing.Optional[ - typing.Union[ - ontologies_models.SearchJsonQueryV2, - ontologies_models.SearchJsonQueryV2Dict, - ] - ], - "orderBy": typing.Optional[ - typing.Union[ - ontologies_models.SearchOrderByV2, - ontologies_models.SearchOrderByV2Dict, - ] - ], + "where": typing.Optional[ontologies_models.SearchJsonQueryV2], + "orderBy": typing.Optional[ontologies_models.SearchOrderByV2], "pageSize": typing.Optional[core_models.PageSize], "pageToken": typing.Optional[core_models.PageToken], "select": typing.List[ontologies_models.PropertyApiName], @@ -597,14 +462,12 @@ def aggregate(_: ontologies_models.AggregateObjectsResponseV2): ... def count(_: ontologies_models.CountObjectsResponseV2): ... def get(_: ontologies_models.OntologyObjectV2): ... def list(_: ontologies_models.ListObjectsResponseV2): ... - def page(_: ontologies_models.ListObjectsResponseV2): ... def search(_: ontologies_models.SearchObjectsResponseV2): ... self.aggregate = core.with_raw_response(aggregate, client.aggregate) self.count = core.with_raw_response(count, client.count) self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) self.search = core.with_raw_response(search, client.search) @@ -614,12 +477,10 @@ def aggregate(_: ontologies_models.AggregateObjectsResponseV2): ... def count(_: ontologies_models.CountObjectsResponseV2): ... def get(_: ontologies_models.OntologyObjectV2): ... def list(_: ontologies_models.ListObjectsResponseV2): ... - def page(_: ontologies_models.ListObjectsResponseV2): ... def search(_: ontologies_models.SearchObjectsResponseV2): ... self.aggregate = core.with_streaming_response(aggregate, client.aggregate) self.count = core.with_streaming_response(count, client.count) self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) self.search = core.with_streaming_response(search, client.search) diff --git a/foundry/v2/ontologies/ontology_object_set.py b/foundry/v2/ontologies/ontology_object_set.py index def78641b..d8c97ac70 100644 --- a/foundry/v2/ontologies/ontology_object_set.py +++ b/foundry/v2/ontologies/ontology_object_set.py @@ -54,15 +54,9 @@ def aggregate( self, ontology: ontologies_models.OntologyIdentifier, *, - aggregation: typing.List[ - typing.Union[ontologies_models.AggregationV2, ontologies_models.AggregationV2Dict] - ], - group_by: typing.List[ - typing.Union[ - ontologies_models.AggregationGroupByV2, ontologies_models.AggregationGroupByV2Dict - ] - ], - object_set: typing.Union[ontologies_models.ObjectSet, ontologies_models.ObjectSetDict], + aggregation: typing.List[ontologies_models.AggregationV2], + group_by: typing.List[ontologies_models.AggregationGroupByV2], + object_set: ontologies_models.ObjectSet, accuracy: typing.Optional[ontologies_models.AggregationAccuracyRequest] = None, artifact_repository: typing.Optional[ontologies_models.ArtifactRepositoryRid] = None, package_name: typing.Optional[ontologies_models.SdkPackageName] = None, @@ -77,11 +71,11 @@ def aggregate( :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. :type ontology: OntologyIdentifier :param aggregation: - :type aggregation: List[Union[AggregationV2, AggregationV2Dict]] + :type aggregation: List[AggregationV2] :param group_by: - :type group_by: List[Union[AggregationGroupByV2, AggregationGroupByV2Dict]] + :type group_by: List[AggregationGroupByV2] :param object_set: - :type object_set: Union[ObjectSet, ObjectSetDict] + :type object_set: ObjectSet :param accuracy: :type accuracy: Optional[AggregationAccuracyRequest] :param artifact_repository: The repository associated with a marketplace installation. @@ -118,20 +112,9 @@ def aggregate( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "aggregation": typing.List[ - typing.Union[ - ontologies_models.AggregationV2, ontologies_models.AggregationV2Dict - ] - ], - "objectSet": typing.Union[ - ontologies_models.ObjectSet, ontologies_models.ObjectSetDict - ], - "groupBy": typing.List[ - typing.Union[ - ontologies_models.AggregationGroupByV2, - ontologies_models.AggregationGroupByV2Dict, - ] - ], + "aggregation": typing.List[ontologies_models.AggregationV2], + "objectSet": ontologies_models.ObjectSet, + "groupBy": typing.List[ontologies_models.AggregationGroupByV2], "accuracy": typing.Optional[ontologies_models.AggregationAccuracyRequest], }, ), @@ -149,7 +132,7 @@ def create_temporary( self, ontology: ontologies_models.OntologyIdentifier, *, - object_set: typing.Union[ontologies_models.ObjectSet, ontologies_models.ObjectSetDict], + object_set: ontologies_models.ObjectSet, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> ontologies_models.CreateTemporaryObjectSetResponseV2: @@ -162,7 +145,7 @@ def create_temporary( :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. :type ontology: OntologyIdentifier :param object_set: - :type object_set: Union[ObjectSet, ObjectSetDict] + :type object_set: ObjectSet :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -187,9 +170,7 @@ def create_temporary( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "objectSet": typing.Union[ - ontologies_models.ObjectSet, ontologies_models.ObjectSetDict - ], + "objectSet": ontologies_models.ObjectSet, }, ), response_type=ontologies_models.CreateTemporaryObjectSetResponseV2, @@ -253,13 +234,11 @@ def load( self, ontology: ontologies_models.OntologyIdentifier, *, - object_set: typing.Union[ontologies_models.ObjectSet, ontologies_models.ObjectSetDict], + object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], artifact_repository: typing.Optional[ontologies_models.ArtifactRepositoryRid] = None, exclude_rid: typing.Optional[bool] = None, - order_by: typing.Optional[ - typing.Union[ontologies_models.SearchOrderByV2, ontologies_models.SearchOrderByV2Dict] - ] = None, + order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, package_name: typing.Optional[ontologies_models.SdkPackageName] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -279,7 +258,7 @@ def load( :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. :type ontology: OntologyIdentifier :param object_set: - :type object_set: Union[ObjectSet, ObjectSetDict] + :type object_set: ObjectSet :param select: :type select: List[SelectedPropertyApiName] :param artifact_repository: The repository associated with a marketplace installation. @@ -287,7 +266,7 @@ def load( :param exclude_rid: A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. :type exclude_rid: Optional[bool] :param order_by: - :type order_by: Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] + :type order_by: Optional[SearchOrderByV2] :param package_name: The package name of the generated SDK. :type package_name: Optional[SdkPackageName] :param page_size: @@ -326,15 +305,8 @@ def load( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "objectSet": typing.Union[ - ontologies_models.ObjectSet, ontologies_models.ObjectSetDict - ], - "orderBy": typing.Optional[ - typing.Union[ - ontologies_models.SearchOrderByV2, - ontologies_models.SearchOrderByV2Dict, - ] - ], + "objectSet": ontologies_models.ObjectSet, + "orderBy": typing.Optional[ontologies_models.SearchOrderByV2], "select": typing.List[ontologies_models.SelectedPropertyApiName], "pageToken": typing.Optional[core_models.PageToken], "pageSize": typing.Optional[core_models.PageSize], @@ -355,13 +327,11 @@ def load_multiple_object_types( self, ontology: ontologies_models.OntologyIdentifier, *, - object_set: typing.Union[ontologies_models.ObjectSet, ontologies_models.ObjectSetDict], + object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], artifact_repository: typing.Optional[ontologies_models.ArtifactRepositoryRid] = None, exclude_rid: typing.Optional[bool] = None, - order_by: typing.Optional[ - typing.Union[ontologies_models.SearchOrderByV2, ontologies_models.SearchOrderByV2Dict] - ] = None, + order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, package_name: typing.Optional[ontologies_models.SdkPackageName] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -387,7 +357,7 @@ def load_multiple_object_types( :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. :type ontology: OntologyIdentifier :param object_set: - :type object_set: Union[ObjectSet, ObjectSetDict] + :type object_set: ObjectSet :param select: :type select: List[SelectedPropertyApiName] :param artifact_repository: The repository associated with a marketplace installation. @@ -395,7 +365,7 @@ def load_multiple_object_types( :param exclude_rid: A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. :type exclude_rid: Optional[bool] :param order_by: - :type order_by: Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] + :type order_by: Optional[SearchOrderByV2] :param package_name: The package name of the generated SDK. :type package_name: Optional[SdkPackageName] :param page_size: @@ -437,15 +407,8 @@ def load_multiple_object_types( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "objectSet": typing.Union[ - ontologies_models.ObjectSet, ontologies_models.ObjectSetDict - ], - "orderBy": typing.Optional[ - typing.Union[ - ontologies_models.SearchOrderByV2, - ontologies_models.SearchOrderByV2Dict, - ] - ], + "objectSet": ontologies_models.ObjectSet, + "orderBy": typing.Optional[ontologies_models.SearchOrderByV2], "select": typing.List[ontologies_models.SelectedPropertyApiName], "pageToken": typing.Optional[core_models.PageToken], "pageSize": typing.Optional[core_models.PageSize], @@ -466,13 +429,11 @@ def load_objects_or_interfaces( self, ontology: ontologies_models.OntologyIdentifier, *, - object_set: typing.Union[ontologies_models.ObjectSet, ontologies_models.ObjectSetDict], + object_set: ontologies_models.ObjectSet, select: typing.List[ontologies_models.SelectedPropertyApiName], artifact_repository: typing.Optional[ontologies_models.ArtifactRepositoryRid] = None, exclude_rid: typing.Optional[bool] = None, - order_by: typing.Optional[ - typing.Union[ontologies_models.SearchOrderByV2, ontologies_models.SearchOrderByV2Dict] - ] = None, + order_by: typing.Optional[ontologies_models.SearchOrderByV2] = None, package_name: typing.Optional[ontologies_models.SdkPackageName] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -500,7 +461,7 @@ def load_objects_or_interfaces( :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. :type ontology: OntologyIdentifier :param object_set: - :type object_set: Union[ObjectSet, ObjectSetDict] + :type object_set: ObjectSet :param select: :type select: List[SelectedPropertyApiName] :param artifact_repository: The repository associated with a marketplace installation. @@ -508,7 +469,7 @@ def load_objects_or_interfaces( :param exclude_rid: A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. :type exclude_rid: Optional[bool] :param order_by: - :type order_by: Optional[Union[SearchOrderByV2, SearchOrderByV2Dict]] + :type order_by: Optional[SearchOrderByV2] :param package_name: The package name of the generated SDK. :type package_name: Optional[SdkPackageName] :param page_size: @@ -550,15 +511,8 @@ def load_objects_or_interfaces( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "objectSet": typing.Union[ - ontologies_models.ObjectSet, ontologies_models.ObjectSetDict - ], - "orderBy": typing.Optional[ - typing.Union[ - ontologies_models.SearchOrderByV2, - ontologies_models.SearchOrderByV2Dict, - ] - ], + "objectSet": ontologies_models.ObjectSet, + "orderBy": typing.Optional[ontologies_models.SearchOrderByV2], "select": typing.List[ontologies_models.SelectedPropertyApiName], "pageToken": typing.Optional[core_models.PageToken], "pageSize": typing.Optional[core_models.PageSize], diff --git a/foundry/v2/ontologies/query_type.py b/foundry/v2/ontologies/query_type.py index 4891fc98c..5245e70c6 100644 --- a/foundry/v2/ontologies/query_type.py +++ b/foundry/v2/ontologies/query_type.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -150,85 +149,20 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - ontology: ontologies_models.OntologyIdentifier, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> ontologies_models.ListQueryTypesResponseV2: - """ - Lists the query types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. - :type ontology: OntologyIdentifier - :param page_size: The desired size of the page to be returned. Defaults to 100. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - :type page_size: Optional[PageSize] - :param page_token: - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ontologies_models.ListQueryTypesResponseV2 - """ - - warnings.warn( - "The client.ontologies.QueryType.page(...) method has been deprecated. Please use client.ontologies.QueryType.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/queryTypes", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - }, - path_params={ - "ontology": ontology, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=ontologies_models.ListQueryTypesResponseV2, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - class _QueryTypeClientRaw: def __init__(self, client: QueryTypeClient) -> None: def get(_: ontologies_models.QueryTypeV2): ... def list(_: ontologies_models.ListQueryTypesResponseV2): ... - def page(_: ontologies_models.ListQueryTypesResponseV2): ... self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) class _QueryTypeClientStreaming: def __init__(self, client: QueryTypeClient) -> None: def get(_: ontologies_models.QueryTypeV2): ... def list(_: ontologies_models.ListQueryTypesResponseV2): ... - def page(_: ontologies_models.ListQueryTypesResponseV2): ... self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) diff --git a/foundry/v2/ontologies/time_series_property_v2.py b/foundry/v2/ontologies/time_series_property_v2.py index e39376d94..a1c6e72d4 100644 --- a/foundry/v2/ontologies/time_series_property_v2.py +++ b/foundry/v2/ontologies/time_series_property_v2.py @@ -186,17 +186,11 @@ def stream_points( primary_key: ontologies_models.PropertyValueEscapedString, property: ontologies_models.PropertyApiName, *, - aggregate: typing.Optional[ - typing.Union[ - ontologies_models.AggregateTimeSeries, ontologies_models.AggregateTimeSeriesDict - ] - ] = None, + aggregate: typing.Optional[ontologies_models.AggregateTimeSeries] = None, artifact_repository: typing.Optional[ontologies_models.ArtifactRepositoryRid] = None, format: typing.Optional[ontologies_models.StreamingOutputFormat] = None, package_name: typing.Optional[ontologies_models.SdkPackageName] = None, - range: typing.Optional[ - typing.Union[ontologies_models.TimeRange, ontologies_models.TimeRangeDict] - ] = None, + range: typing.Optional[ontologies_models.TimeRange] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> bytes: @@ -215,7 +209,7 @@ def stream_points( :param property: The API name of the time series property. To find the API name for your time series property, check the **Ontology Manager** or use the **Get object type** endpoint. :type property: PropertyApiName :param aggregate: - :type aggregate: Optional[Union[AggregateTimeSeries, AggregateTimeSeriesDict]] + :type aggregate: Optional[AggregateTimeSeries] :param artifact_repository: The repository associated with a marketplace installation. :type artifact_repository: Optional[ArtifactRepositoryRid] :param format: The output format to serialize the output binary stream in. Default is JSON. ARROW is more efficient than JSON at streaming a large sized response. @@ -223,7 +217,7 @@ def stream_points( :param package_name: The package name of the generated SDK. :type package_name: Optional[SdkPackageName] :param range: - :type range: Optional[Union[TimeRange, TimeRangeDict]] + :type range: Optional[TimeRange] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -256,17 +250,8 @@ def stream_points( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "range": typing.Optional[ - typing.Union[ - ontologies_models.TimeRange, ontologies_models.TimeRangeDict - ] - ], - "aggregate": typing.Optional[ - typing.Union[ - ontologies_models.AggregateTimeSeries, - ontologies_models.AggregateTimeSeriesDict, - ] - ], + "range": typing.Optional[ontologies_models.TimeRange], + "aggregate": typing.Optional[ontologies_models.AggregateTimeSeries], }, ), response_type=bytes, diff --git a/foundry/v2/ontologies/time_series_value_bank_property.py b/foundry/v2/ontologies/time_series_value_bank_property.py index 35f07dd87..433cafaa7 100644 --- a/foundry/v2/ontologies/time_series_value_bank_property.py +++ b/foundry/v2/ontologies/time_series_value_bank_property.py @@ -123,9 +123,7 @@ def stream_values( *, artifact_repository: typing.Optional[ontologies_models.ArtifactRepositoryRid] = None, package_name: typing.Optional[ontologies_models.SdkPackageName] = None, - range: typing.Optional[ - typing.Union[ontologies_models.TimeRange, ontologies_models.TimeRangeDict] - ] = None, + range: typing.Optional[ontologies_models.TimeRange] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> bytes: @@ -148,7 +146,7 @@ def stream_values( :param package_name: The package name of the generated SDK. :type package_name: Optional[SdkPackageName] :param range: - :type range: Optional[Union[TimeRange, TimeRangeDict]] + :type range: Optional[TimeRange] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -179,11 +177,7 @@ def stream_values( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "range": typing.Optional[ - typing.Union[ - ontologies_models.TimeRange, ontologies_models.TimeRangeDict - ] - ], + "range": typing.Optional[ontologies_models.TimeRange], }, ), response_type=bytes, diff --git a/foundry/v2/orchestration/build.py b/foundry/v2/orchestration/build.py index 8dd4a884a..493f7ed7d 100644 --- a/foundry/v2/orchestration/build.py +++ b/foundry/v2/orchestration/build.py @@ -14,7 +14,6 @@ import typing -import warnings import annotated_types import pydantic @@ -106,20 +105,13 @@ def create( self, *, fallback_branches: orchestration_models.FallbackBranches, - target: typing.Union[ - orchestration_models.BuildTarget, orchestration_models.BuildTargetDict - ], + target: orchestration_models.BuildTarget, abort_on_failure: typing.Optional[orchestration_models.AbortOnFailure] = None, branch_name: typing.Optional[datasets_models.BranchName] = None, force_build: typing.Optional[orchestration_models.ForceBuild] = None, notifications_enabled: typing.Optional[orchestration_models.NotificationsEnabled] = None, preview: typing.Optional[core_models.PreviewMode] = None, - retry_backoff_duration: typing.Optional[ - typing.Union[ - orchestration_models.RetryBackoffDuration, - orchestration_models.RetryBackoffDurationDict, - ] - ] = None, + retry_backoff_duration: typing.Optional[orchestration_models.RetryBackoffDuration] = None, retry_count: typing.Optional[orchestration_models.RetryCount] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -129,7 +121,7 @@ def create( :param fallback_branches: :type fallback_branches: FallbackBranches :param target: The targets of the schedule. - :type target: Union[BuildTarget, BuildTargetDict] + :type target: BuildTarget :param abort_on_failure: :type abort_on_failure: Optional[AbortOnFailure] :param branch_name: The target branch the build should run on. @@ -141,7 +133,7 @@ def create( :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param retry_backoff_duration: - :type retry_backoff_duration: Optional[Union[RetryBackoffDuration, RetryBackoffDurationDict]] + :type retry_backoff_duration: Optional[RetryBackoffDuration] :param retry_count: The number of retry attempts for failed jobs. :type retry_count: Optional[RetryCount] :param request_timeout: timeout setting for this request in seconds. @@ -177,18 +169,13 @@ def create( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "target": typing.Union[ - orchestration_models.BuildTarget, orchestration_models.BuildTargetDict - ], + "target": orchestration_models.BuildTarget, "branchName": typing.Optional[datasets_models.BranchName], "fallbackBranches": orchestration_models.FallbackBranches, "forceBuild": typing.Optional[orchestration_models.ForceBuild], "retryCount": typing.Optional[orchestration_models.RetryCount], "retryBackoffDuration": typing.Optional[ - typing.Union[ - orchestration_models.RetryBackoffDuration, - orchestration_models.RetryBackoffDurationDict, - ] + orchestration_models.RetryBackoffDuration ], "abortOnFailure": typing.Optional[orchestration_models.AbortOnFailure], "notificationsEnabled": typing.Optional[ @@ -260,12 +247,7 @@ def get( def get_batch( self, body: typing_extensions.Annotated[ - typing.List[ - typing.Union[ - orchestration_models.GetBuildsBatchRequestElement, - orchestration_models.GetBuildsBatchRequestElementDict, - ] - ], + typing.List[orchestration_models.GetBuildsBatchRequestElement], annotated_types.Len(min_length=1, max_length=100), ], *, @@ -278,7 +260,7 @@ def get_batch( The maximum batch size for this endpoint is 100. :param body: Body of the request - :type body: List[Union[GetBuildsBatchRequestElement, GetBuildsBatchRequestElementDict]] + :type body: List[GetBuildsBatchRequestElement] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -301,7 +283,7 @@ def get_batch( }, body=body, body_type=typing_extensions.Annotated[ - typing.List[orchestration_models.GetBuildsBatchRequestElementDict], + typing.List[orchestration_models.GetBuildsBatchRequestElement], annotated_types.Len(min_length=1, max_length=100), ], response_type=orchestration_models.GetBuildsBatchResponse, @@ -364,80 +346,14 @@ def jobs( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def jobs_page( - self, - build_rid: core_models.BuildRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> orchestration_models.ListJobsOfBuildResponse: - """ - Get the Jobs in the Build. - :param build_rid: The RID of a Build. - :type build_rid: BuildRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: orchestration_models.ListJobsOfBuildResponse - """ - - warnings.warn( - "The client.orchestration.Build.jobs_page(...) method has been deprecated. Please use client.orchestration.Build.jobs(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/orchestration/builds/{buildRid}/jobs", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "buildRid": build_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=orchestration_models.ListJobsOfBuildResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected def search( self, *, - where: typing.Union[ - orchestration_models.SearchBuildsFilter, orchestration_models.SearchBuildsFilterDict - ], - order_by: typing.Optional[ - typing.Union[ - orchestration_models.SearchBuildsOrderBy, - orchestration_models.SearchBuildsOrderByDict, - ] - ] = None, + where: orchestration_models.SearchBuildsFilter, + order_by: typing.Optional[orchestration_models.SearchBuildsOrderBy] = None, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, preview: typing.Optional[core_models.PreviewMode] = None, @@ -447,9 +363,9 @@ def search( """ Search for Builds. :param where: - :type where: Union[SearchBuildsFilter, SearchBuildsFilterDict] + :type where: SearchBuildsFilter :param order_by: - :type order_by: Optional[Union[SearchBuildsOrderBy, SearchBuildsOrderByDict]] + :type order_by: Optional[SearchBuildsOrderBy] :param page_size: The page size for the search request. If no value is provided, a default of `100` will be used. :type page_size: Optional[PageSize] :param page_token: @@ -485,16 +401,8 @@ def search( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "where": typing.Union[ - orchestration_models.SearchBuildsFilter, - orchestration_models.SearchBuildsFilterDict, - ], - "orderBy": typing.Optional[ - typing.Union[ - orchestration_models.SearchBuildsOrderBy, - orchestration_models.SearchBuildsOrderByDict, - ] - ], + "where": orchestration_models.SearchBuildsFilter, + "orderBy": typing.Optional[orchestration_models.SearchBuildsOrderBy], "pageToken": typing.Optional[core_models.PageToken], "pageSize": typing.Optional[core_models.PageSize], }, @@ -516,7 +424,6 @@ def create(_: orchestration_models.Build): ... def get(_: orchestration_models.Build): ... def get_batch(_: orchestration_models.GetBuildsBatchResponse): ... def jobs(_: orchestration_models.ListJobsOfBuildResponse): ... - def jobs_page(_: orchestration_models.ListJobsOfBuildResponse): ... def search(_: orchestration_models.SearchBuildsResponse): ... self.cancel = core.with_raw_response(cancel, client.cancel) @@ -524,7 +431,6 @@ def search(_: orchestration_models.SearchBuildsResponse): ... self.get = core.with_raw_response(get, client.get) self.get_batch = core.with_raw_response(get_batch, client.get_batch) self.jobs = core.with_raw_response(jobs, client.jobs) - self.jobs_page = core.with_raw_response(jobs_page, client.jobs_page) self.search = core.with_raw_response(search, client.search) @@ -534,12 +440,10 @@ def create(_: orchestration_models.Build): ... def get(_: orchestration_models.Build): ... def get_batch(_: orchestration_models.GetBuildsBatchResponse): ... def jobs(_: orchestration_models.ListJobsOfBuildResponse): ... - def jobs_page(_: orchestration_models.ListJobsOfBuildResponse): ... def search(_: orchestration_models.SearchBuildsResponse): ... self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) self.get_batch = core.with_streaming_response(get_batch, client.get_batch) self.jobs = core.with_streaming_response(jobs, client.jobs) - self.jobs_page = core.with_streaming_response(jobs_page, client.jobs_page) self.search = core.with_streaming_response(search, client.search) diff --git a/foundry/v2/orchestration/client.py b/foundry/v2/orchestration/client.py deleted file mode 100644 index 7e414a73f..000000000 --- a/foundry/v2/orchestration/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v2.orchestration._client import OrchestrationClient - -__all__ = [ - "OrchestrationClient", -] diff --git a/foundry/v2/orchestration/job.py b/foundry/v2/orchestration/job.py index 26193dc13..6ad16baec 100644 --- a/foundry/v2/orchestration/job.py +++ b/foundry/v2/orchestration/job.py @@ -104,12 +104,7 @@ def get( def get_batch( self, body: typing_extensions.Annotated[ - typing.List[ - typing.Union[ - orchestration_models.GetJobsBatchRequestElement, - orchestration_models.GetJobsBatchRequestElementDict, - ] - ], + typing.List[orchestration_models.GetJobsBatchRequestElement], annotated_types.Len(min_length=1, max_length=500), ], *, @@ -122,7 +117,7 @@ def get_batch( The maximum batch size for this endpoint is 500. :param body: Body of the request - :type body: List[Union[GetJobsBatchRequestElement, GetJobsBatchRequestElementDict]] + :type body: List[GetJobsBatchRequestElement] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -145,7 +140,7 @@ def get_batch( }, body=body, body_type=typing_extensions.Annotated[ - typing.List[orchestration_models.GetJobsBatchRequestElementDict], + typing.List[orchestration_models.GetJobsBatchRequestElement], annotated_types.Len(min_length=1, max_length=500), ], response_type=orchestration_models.GetJobsBatchResponse, diff --git a/foundry/v2/orchestration/models.py b/foundry/v2/orchestration/models.py index e38bf934e..78c42090f 100644 --- a/foundry/v2/orchestration/models.py +++ b/foundry/v2/orchestration/models.py @@ -48,26 +48,9 @@ class Action(pydantic.BaseModel): notifications_enabled: NotificationsEnabled = pydantic.Field(alias=str("notificationsEnabled")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ActionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ActionDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ActionDict(typing_extensions.TypedDict): - """Action""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - target: BuildTargetDict - branchName: datasets_models.BranchName - """The target branch the schedule should run on.""" - - fallbackBranches: FallbackBranches - forceBuild: ForceBuild - retryCount: typing_extensions.NotRequired[RetryCount] - retryBackoffDuration: typing_extensions.NotRequired[RetryBackoffDurationDict] - abortOnFailure: AbortOnFailure - notificationsEnabled: NotificationsEnabled + return self.model_dump(by_alias=True, exclude_none=True) class AndTrigger(pydantic.BaseModel): @@ -77,18 +60,9 @@ class AndTrigger(pydantic.BaseModel): type: typing.Literal["and"] = "and" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "AndTriggerDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(AndTriggerDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class AndTriggerDict(typing_extensions.TypedDict): - """Trigger after all of the given triggers emit an event.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - triggers: typing.List[TriggerDict] - type: typing.Literal["and"] + return self.model_dump(by_alias=True, exclude_none=True) class Build(pydantic.BaseModel): @@ -114,34 +88,9 @@ class Build(pydantic.BaseModel): status: BuildStatus model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "BuildDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(BuildDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class BuildDict(typing_extensions.TypedDict): - """Build""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: core_models.BuildRid - """The RID of a Build.""" - - branchName: datasets_models.BranchName - """The branch that the build is running on.""" - - createdTime: core_models.CreatedTime - """The timestamp that the build was created.""" - - createdBy: core_models.CreatedBy - """The user who created the build.""" - - fallbackBranches: FallbackBranches - jobRids: typing.List[core_models.JobRid] - retryCount: RetryCount - retryBackoffDuration: RetryBackoffDurationDict - abortOnFailure: AbortOnFailure - status: BuildStatus + return self.model_dump(by_alias=True, exclude_none=True) BuildStatus = typing.Literal["RUNNING", "SUCCEEDED", "FAILED", "CANCELED"] @@ -155,13 +104,6 @@ class BuildDict(typing_extensions.TypedDict): """The targets of the build.""" -BuildTargetDict = typing_extensions.Annotated[ - typing.Union["UpstreamTargetDict", "ManualTargetDict", "ConnectingTargetDict"], - pydantic.Field(discriminator="type"), -] -"""The targets of the build.""" - - BuildableRid = core.RID """ The Resource Identifier (RID) of a Resource that can be built. For example, this is a Dataset RID, Media Set @@ -187,29 +129,9 @@ class ConnectingTarget(pydantic.BaseModel): type: typing.Literal["connecting"] = "connecting" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ConnectingTargetDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ConnectingTargetDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ConnectingTargetDict(typing_extensions.TypedDict): - """ - All datasets between the input datasets (exclusive) and the - target datasets (inclusive) except for the datasets to ignore. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - inputRids: typing.List[BuildableRid] - """The upstream input datasets (exclusive).""" - - targetRids: typing.List[BuildableRid] - """The downstream target datasets (inclusive).""" - - ignoredRids: typing.List[BuildableRid] - """The datasets between the input datasets and target datasets to exclude.""" - - type: typing.Literal["connecting"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateScheduleRequestAction(pydantic.BaseModel): @@ -227,28 +149,9 @@ class CreateScheduleRequestAction(pydantic.BaseModel): target: CreateScheduleRequestBuildTarget model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateScheduleRequestActionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateScheduleRequestActionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class CreateScheduleRequestActionDict(typing_extensions.TypedDict): - """CreateScheduleRequestAction""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - abortOnFailure: typing_extensions.NotRequired[AbortOnFailure] - forceBuild: typing_extensions.NotRequired[ForceBuild] - retryBackoffDuration: typing_extensions.NotRequired[RetryBackoffDurationDict] - retryCount: typing_extensions.NotRequired[RetryCount] - fallbackBranches: typing_extensions.NotRequired[FallbackBranches] - branchName: typing_extensions.NotRequired[datasets_models.BranchName] - """The target branch the schedule should run on.""" - - notificationsEnabled: typing_extensions.NotRequired[NotificationsEnabled] - target: CreateScheduleRequestBuildTargetDict + return self.model_dump(by_alias=True, exclude_none=True) CreateScheduleRequestBuildTarget = typing_extensions.Annotated[ @@ -262,17 +165,6 @@ class CreateScheduleRequestActionDict(typing_extensions.TypedDict): """The targets of the build.""" -CreateScheduleRequestBuildTargetDict = typing_extensions.Annotated[ - typing.Union[ - "CreateScheduleRequestUpstreamTargetDict", - "CreateScheduleRequestManualTargetDict", - "CreateScheduleRequestConnectingTargetDict", - ], - pydantic.Field(discriminator="type"), -] -"""The targets of the build.""" - - class CreateScheduleRequestConnectingTarget(pydantic.BaseModel): """CreateScheduleRequestConnectingTarget""" @@ -288,29 +180,9 @@ class CreateScheduleRequestConnectingTarget(pydantic.BaseModel): type: typing.Literal["connecting"] = "connecting" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateScheduleRequestConnectingTargetDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateScheduleRequestConnectingTargetDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class CreateScheduleRequestConnectingTargetDict(typing_extensions.TypedDict): - """CreateScheduleRequestConnectingTarget""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - ignoredRids: typing_extensions.NotRequired[typing.List[BuildableRid]] - """The datasets between the input datasets and target datasets to exclude.""" - - targetRids: typing.List[BuildableRid] - """The downstream target datasets (inclusive).""" - - inputRids: typing.List[BuildableRid] - """The upstream input datasets (exclusive).""" - - type: typing.Literal["connecting"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateScheduleRequestManualTarget(pydantic.BaseModel): @@ -320,20 +192,9 @@ class CreateScheduleRequestManualTarget(pydantic.BaseModel): type: typing.Literal["manual"] = "manual" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateScheduleRequestManualTargetDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateScheduleRequestManualTargetDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class CreateScheduleRequestManualTargetDict(typing_extensions.TypedDict): - """CreateScheduleRequestManualTarget""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - targetRids: typing.List[BuildableRid] - type: typing.Literal["manual"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateScheduleRequestProjectScope(pydantic.BaseModel): @@ -343,20 +204,9 @@ class CreateScheduleRequestProjectScope(pydantic.BaseModel): type: typing.Literal["project"] = "project" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateScheduleRequestProjectScopeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateScheduleRequestProjectScopeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class CreateScheduleRequestProjectScopeDict(typing_extensions.TypedDict): - """CreateScheduleRequestProjectScope""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - projectRids: typing.List[filesystem_models.ProjectRid] - type: typing.Literal["project"] + return self.model_dump(by_alias=True, exclude_none=True) CreateScheduleRequestScopeMode = typing_extensions.Annotated[ @@ -366,13 +216,6 @@ class CreateScheduleRequestProjectScopeDict(typing_extensions.TypedDict): """The boundaries for the schedule build.""" -CreateScheduleRequestScopeModeDict = typing_extensions.Annotated[ - typing.Union[CreateScheduleRequestProjectScopeDict, "CreateScheduleRequestUserScopeDict"], - pydantic.Field(discriminator="type"), -] -"""The boundaries for the schedule build.""" - - class CreateScheduleRequestUpstreamTarget(pydantic.BaseModel): """CreateScheduleRequestUpstreamTarget""" @@ -385,26 +228,9 @@ class CreateScheduleRequestUpstreamTarget(pydantic.BaseModel): type: typing.Literal["upstream"] = "upstream" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateScheduleRequestUpstreamTargetDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateScheduleRequestUpstreamTargetDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class CreateScheduleRequestUpstreamTargetDict(typing_extensions.TypedDict): - """CreateScheduleRequestUpstreamTarget""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - ignoredRids: typing_extensions.NotRequired[typing.List[BuildableRid]] - """The datasets to ignore when calculating the final set of dataset to build.""" - - targetRids: typing.List[BuildableRid] - """The target datasets.""" - - type: typing.Literal["upstream"] + return self.model_dump(by_alias=True, exclude_none=True) class CreateScheduleRequestUserScope(pydantic.BaseModel): @@ -413,19 +239,9 @@ class CreateScheduleRequestUserScope(pydantic.BaseModel): type: typing.Literal["user"] = "user" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateScheduleRequestUserScopeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateScheduleRequestUserScopeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class CreateScheduleRequestUserScopeDict(typing_extensions.TypedDict): - """CreateScheduleRequestUserScope""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["user"] + return self.model_dump(by_alias=True, exclude_none=True) CronExpression = str @@ -443,19 +259,9 @@ class DatasetJobOutput(pydantic.BaseModel): type: typing.Literal["datasetJobOutput"] = "datasetJobOutput" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DatasetJobOutputDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DatasetJobOutputDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DatasetJobOutputDict(typing_extensions.TypedDict): - """DatasetJobOutput""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - datasetRid: datasets_models.DatasetRid - outputTransactionRid: typing_extensions.NotRequired[datasets_models.TransactionRid] - type: typing.Literal["datasetJobOutput"] + return self.model_dump(by_alias=True, exclude_none=True) class DatasetUpdatedTrigger(pydantic.BaseModel): @@ -469,24 +275,9 @@ class DatasetUpdatedTrigger(pydantic.BaseModel): type: typing.Literal["datasetUpdated"] = "datasetUpdated" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DatasetUpdatedTriggerDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - DatasetUpdatedTriggerDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class DatasetUpdatedTriggerDict(typing_extensions.TypedDict): - """ - Trigger whenever a new transaction is committed to the - dataset on the target branch. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - datasetRid: datasets_models.DatasetRid - branchName: datasets_models.BranchName - type: typing.Literal["datasetUpdated"] + return self.model_dump(by_alias=True, exclude_none=True) FallbackBranches = typing.List[datasets_models.BranchName] @@ -508,20 +299,9 @@ class GetBuildsBatchRequestElement(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GetBuildsBatchRequestElementDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GetBuildsBatchRequestElementDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GetBuildsBatchRequestElementDict(typing_extensions.TypedDict): - """GetBuildsBatchRequestElement""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - buildRid: core_models.BuildRid - """The RID of a Build.""" + return self.model_dump(by_alias=True, exclude_none=True) class GetBuildsBatchResponse(pydantic.BaseModel): @@ -530,19 +310,9 @@ class GetBuildsBatchResponse(pydantic.BaseModel): data: typing.Dict[core_models.BuildRid, Build] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GetBuildsBatchResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GetBuildsBatchResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GetBuildsBatchResponseDict(typing_extensions.TypedDict): - """GetBuildsBatchResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.Dict[core_models.BuildRid, BuildDict] + return self.model_dump(by_alias=True, exclude_none=True) class GetJobsBatchRequestElement(pydantic.BaseModel): @@ -553,20 +323,9 @@ class GetJobsBatchRequestElement(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GetJobsBatchRequestElementDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GetJobsBatchRequestElementDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GetJobsBatchRequestElementDict(typing_extensions.TypedDict): - """GetJobsBatchRequestElement""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - jobRid: core_models.JobRid - """The RID of a Job.""" + return self.model_dump(by_alias=True, exclude_none=True) class GetJobsBatchResponse(pydantic.BaseModel): @@ -575,19 +334,9 @@ class GetJobsBatchResponse(pydantic.BaseModel): data: typing.Dict[core_models.JobRid, Job] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "GetJobsBatchResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - GetJobsBatchResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class GetJobsBatchResponseDict(typing_extensions.TypedDict): - """GetJobsBatchResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.Dict[core_models.JobRid, JobDict] + return self.model_dump(by_alias=True, exclude_none=True) class Job(pydantic.BaseModel): @@ -614,34 +363,9 @@ class Job(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "JobDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(JobDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class JobDict(typing_extensions.TypedDict): - """Job""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: core_models.JobRid - """The RID of a Job.""" - - buildRid: core_models.BuildRid - """The RID of the Build that the Job belongs to.""" - - startedTime: JobStartedTime - """The time this job started waiting for the dependencies to be resolved.""" - - finishedTime: typing_extensions.NotRequired[datetime] - """The time this job was finished.""" - - jobStatus: JobStatus - outputs: typing.List[JobOutputDict] - """ - Outputs of the Job. Only outputs with supported types are listed here; unsupported types are omitted. - Currently supported types are Dataset and Media Set outputs. - """ + return self.model_dump(by_alias=True, exclude_none=True) JobOutput = typing_extensions.Annotated[ @@ -651,13 +375,6 @@ class JobDict(typing_extensions.TypedDict): """Other types of Job Outputs exist in Foundry. Currently, only Dataset and Media Set are supported by the API.""" -JobOutputDict = typing_extensions.Annotated[ - typing.Union[DatasetJobOutputDict, "TransactionalMediaSetJobOutputDict"], - pydantic.Field(discriminator="type"), -] -"""Other types of Job Outputs exist in Foundry. Currently, only Dataset and Media Set are supported by the API.""" - - JobStartedTime = datetime """The time this job started waiting for the dependencies to be resolved.""" @@ -677,24 +394,9 @@ class JobSucceededTrigger(pydantic.BaseModel): type: typing.Literal["jobSucceeded"] = "jobSucceeded" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "JobSucceededTriggerDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - JobSucceededTriggerDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class JobSucceededTriggerDict(typing_extensions.TypedDict): - """ - Trigger whenever a job succeeds on the dataset and on the target - branch. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - datasetRid: datasets_models.DatasetRid - branchName: datasets_models.BranchName - type: typing.Literal["jobSucceeded"] + return self.model_dump(by_alias=True, exclude_none=True) class ListJobsOfBuildResponse(pydantic.BaseModel): @@ -704,20 +406,9 @@ class ListJobsOfBuildResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListJobsOfBuildResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListJobsOfBuildResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListJobsOfBuildResponseDict(typing_extensions.TypedDict): - """ListJobsOfBuildResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[JobDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ListRunsOfScheduleResponse(pydantic.BaseModel): @@ -727,20 +418,9 @@ class ListRunsOfScheduleResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListRunsOfScheduleResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListRunsOfScheduleResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListRunsOfScheduleResponseDict(typing_extensions.TypedDict): - """ListRunsOfScheduleResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[ScheduleRunDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class ManualTarget(pydantic.BaseModel): @@ -750,18 +430,9 @@ class ManualTarget(pydantic.BaseModel): type: typing.Literal["manual"] = "manual" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ManualTargetDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ManualTargetDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ManualTargetDict(typing_extensions.TypedDict): - """Manually specify all datasets to build.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - targetRids: typing.List[BuildableRid] - type: typing.Literal["manual"] + return self.model_dump(by_alias=True, exclude_none=True) class MediaSetUpdatedTrigger(pydantic.BaseModel): @@ -777,26 +448,9 @@ class MediaSetUpdatedTrigger(pydantic.BaseModel): type: typing.Literal["mediaSetUpdated"] = "mediaSetUpdated" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "MediaSetUpdatedTriggerDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - MediaSetUpdatedTriggerDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class MediaSetUpdatedTriggerDict(typing_extensions.TypedDict): - """ - Trigger whenever an update is made to a media set on the target - branch. For transactional media sets, this happens when a transaction - is committed. For non-transactional media sets, this event happens - eventually (but not necessary immediately) after an update. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - mediaSetRid: core_models.MediaSetRid - branchName: datasets_models.BranchName - type: typing.Literal["mediaSetUpdated"] + return self.model_dump(by_alias=True, exclude_none=True) class NewLogicTrigger(pydantic.BaseModel): @@ -810,22 +464,9 @@ class NewLogicTrigger(pydantic.BaseModel): type: typing.Literal["newLogic"] = "newLogic" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "NewLogicTriggerDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(NewLogicTriggerDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class NewLogicTriggerDict(typing_extensions.TypedDict): - """ - Trigger whenever a new JobSpec is put on the dataset and on - that branch. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - branchName: datasets_models.BranchName - datasetRid: datasets_models.DatasetRid - type: typing.Literal["newLogic"] + return self.model_dump(by_alias=True, exclude_none=True) NotificationsEnabled = bool @@ -842,18 +483,9 @@ class OrTrigger(pydantic.BaseModel): type: typing.Literal["or"] = "or" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "OrTriggerDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(OrTriggerDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class OrTriggerDict(typing_extensions.TypedDict): - """Trigger whenever any of the given triggers emit an event.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - triggers: typing.List[TriggerDict] - type: typing.Literal["or"] + return self.model_dump(by_alias=True, exclude_none=True) class ProjectScope(pydantic.BaseModel): @@ -863,18 +495,9 @@ class ProjectScope(pydantic.BaseModel): type: typing.Literal["project"] = "project" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ProjectScopeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ProjectScopeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ProjectScopeDict(typing_extensions.TypedDict): - """The schedule will only build resources in the following projects.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - projectRids: typing.List[filesystem_models.ProjectRid] - type: typing.Literal["project"] + return self.model_dump(by_alias=True, exclude_none=True) class ReplaceScheduleRequestAction(pydantic.BaseModel): @@ -892,28 +515,9 @@ class ReplaceScheduleRequestAction(pydantic.BaseModel): target: ReplaceScheduleRequestBuildTarget model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ReplaceScheduleRequestActionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ReplaceScheduleRequestActionDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ReplaceScheduleRequestActionDict(typing_extensions.TypedDict): - """ReplaceScheduleRequestAction""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - abortOnFailure: typing_extensions.NotRequired[AbortOnFailure] - forceBuild: typing_extensions.NotRequired[ForceBuild] - retryBackoffDuration: typing_extensions.NotRequired[RetryBackoffDurationDict] - retryCount: typing_extensions.NotRequired[RetryCount] - fallbackBranches: typing_extensions.NotRequired[FallbackBranches] - branchName: typing_extensions.NotRequired[datasets_models.BranchName] - """The target branch the schedule should run on.""" - - notificationsEnabled: typing_extensions.NotRequired[NotificationsEnabled] - target: ReplaceScheduleRequestBuildTargetDict + return self.model_dump(by_alias=True, exclude_none=True) ReplaceScheduleRequestBuildTarget = typing_extensions.Annotated[ @@ -927,17 +531,6 @@ class ReplaceScheduleRequestActionDict(typing_extensions.TypedDict): """The targets of the build.""" -ReplaceScheduleRequestBuildTargetDict = typing_extensions.Annotated[ - typing.Union[ - "ReplaceScheduleRequestUpstreamTargetDict", - "ReplaceScheduleRequestManualTargetDict", - "ReplaceScheduleRequestConnectingTargetDict", - ], - pydantic.Field(discriminator="type"), -] -"""The targets of the build.""" - - class ReplaceScheduleRequestConnectingTarget(pydantic.BaseModel): """ReplaceScheduleRequestConnectingTarget""" @@ -953,29 +546,9 @@ class ReplaceScheduleRequestConnectingTarget(pydantic.BaseModel): type: typing.Literal["connecting"] = "connecting" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ReplaceScheduleRequestConnectingTargetDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ReplaceScheduleRequestConnectingTargetDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class ReplaceScheduleRequestConnectingTargetDict(typing_extensions.TypedDict): - """ReplaceScheduleRequestConnectingTarget""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - ignoredRids: typing_extensions.NotRequired[typing.List[BuildableRid]] - """The datasets between the input datasets and target datasets to exclude.""" - - targetRids: typing.List[BuildableRid] - """The downstream target datasets (inclusive).""" - - inputRids: typing.List[BuildableRid] - """The upstream input datasets (exclusive).""" - - type: typing.Literal["connecting"] + return self.model_dump(by_alias=True, exclude_none=True) class ReplaceScheduleRequestManualTarget(pydantic.BaseModel): @@ -985,21 +558,9 @@ class ReplaceScheduleRequestManualTarget(pydantic.BaseModel): type: typing.Literal["manual"] = "manual" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ReplaceScheduleRequestManualTargetDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ReplaceScheduleRequestManualTargetDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class ReplaceScheduleRequestManualTargetDict(typing_extensions.TypedDict): - """ReplaceScheduleRequestManualTarget""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - targetRids: typing.List[BuildableRid] - type: typing.Literal["manual"] + return self.model_dump(by_alias=True, exclude_none=True) class ReplaceScheduleRequestProjectScope(pydantic.BaseModel): @@ -1009,21 +570,9 @@ class ReplaceScheduleRequestProjectScope(pydantic.BaseModel): type: typing.Literal["project"] = "project" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ReplaceScheduleRequestProjectScopeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ReplaceScheduleRequestProjectScopeDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class ReplaceScheduleRequestProjectScopeDict(typing_extensions.TypedDict): - """ReplaceScheduleRequestProjectScope""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - projectRids: typing.List[filesystem_models.ProjectRid] - type: typing.Literal["project"] + return self.model_dump(by_alias=True, exclude_none=True) ReplaceScheduleRequestScopeMode = typing_extensions.Annotated[ @@ -1033,13 +582,6 @@ class ReplaceScheduleRequestProjectScopeDict(typing_extensions.TypedDict): """The boundaries for the schedule build.""" -ReplaceScheduleRequestScopeModeDict = typing_extensions.Annotated[ - typing.Union[ReplaceScheduleRequestProjectScopeDict, "ReplaceScheduleRequestUserScopeDict"], - pydantic.Field(discriminator="type"), -] -"""The boundaries for the schedule build.""" - - class ReplaceScheduleRequestUpstreamTarget(pydantic.BaseModel): """ReplaceScheduleRequestUpstreamTarget""" @@ -1052,26 +594,9 @@ class ReplaceScheduleRequestUpstreamTarget(pydantic.BaseModel): type: typing.Literal["upstream"] = "upstream" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ReplaceScheduleRequestUpstreamTargetDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ReplaceScheduleRequestUpstreamTargetDict, - self.model_dump(by_alias=True, exclude_none=True), - ) - - -class ReplaceScheduleRequestUpstreamTargetDict(typing_extensions.TypedDict): - """ReplaceScheduleRequestUpstreamTarget""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - ignoredRids: typing_extensions.NotRequired[typing.List[BuildableRid]] - """The datasets to ignore when calculating the final set of dataset to build.""" - - targetRids: typing.List[BuildableRid] - """The target datasets.""" - - type: typing.Literal["upstream"] + return self.model_dump(by_alias=True, exclude_none=True) class ReplaceScheduleRequestUserScope(pydantic.BaseModel): @@ -1080,19 +605,9 @@ class ReplaceScheduleRequestUserScope(pydantic.BaseModel): type: typing.Literal["user"] = "user" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ReplaceScheduleRequestUserScopeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ReplaceScheduleRequestUserScopeDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ReplaceScheduleRequestUserScopeDict(typing_extensions.TypedDict): - """ReplaceScheduleRequestUserScope""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["user"] + return self.model_dump(by_alias=True, exclude_none=True) RetryCount = int @@ -1127,35 +642,9 @@ class Schedule(pydantic.BaseModel): scope_mode: ScopeMode = pydantic.Field(alias=str("scopeMode")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ScheduleDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ScheduleDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ScheduleDict(typing_extensions.TypedDict): - """Schedule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ScheduleRid - displayName: typing_extensions.NotRequired[str] - description: typing_extensions.NotRequired[str] - currentVersionRid: ScheduleVersionRid - """The RID of the current schedule version""" - - createdTime: core_models.CreatedTime - createdBy: core_models.CreatedBy - updatedTime: core_models.UpdatedTime - updatedBy: core_models.UpdatedBy - paused: SchedulePaused - trigger: typing_extensions.NotRequired[TriggerDict] - """ - The schedule trigger. If the requesting user does not have - permission to see the trigger, this will be empty. - """ - - action: ActionDict - scopeMode: ScopeModeDict + return self.model_dump(by_alias=True, exclude_none=True) SchedulePaused = bool @@ -1191,35 +680,9 @@ class ScheduleRun(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ScheduleRunDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ScheduleRunDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ScheduleRunDict(typing_extensions.TypedDict): - """ScheduleRun""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ScheduleRunRid - """The RID of a schedule run""" - - scheduleRid: ScheduleRid - scheduleVersionRid: ScheduleVersionRid - createdTime: core_models.CreatedTime - """The time at which the schedule run was created.""" - - createdBy: typing_extensions.NotRequired[core_models.CreatedBy] - """ - The Foundry user who manually invoked this schedule run. Automatic trigger runs have this field set to - empty. - """ - - result: typing_extensions.NotRequired[ScheduleRunResultDict] - """ - The result of triggering the schedule. If empty, it means the service - is still working on triggering the schedule. - """ + return self.model_dump(by_alias=True, exclude_none=True) class ScheduleRunError(pydantic.BaseModel): @@ -1230,19 +693,9 @@ class ScheduleRunError(pydantic.BaseModel): type: typing.Literal["error"] = "error" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ScheduleRunErrorDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ScheduleRunErrorDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ScheduleRunErrorDict(typing_extensions.TypedDict): - """An error occurred attempting to run the schedule.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - errorName: ScheduleRunErrorName - description: str - type: typing.Literal["error"] + return self.model_dump(by_alias=True, exclude_none=True) ScheduleRunErrorName = typing.Literal[ @@ -1263,19 +716,9 @@ class ScheduleRunIgnored(pydantic.BaseModel): type: typing.Literal["ignored"] = "ignored" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ScheduleRunIgnoredDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ScheduleRunIgnoredDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ScheduleRunIgnoredDict(typing_extensions.TypedDict): - """The schedule is not running as all targets are up-to-date.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["ignored"] + return self.model_dump(by_alias=True, exclude_none=True) ScheduleRunResult = typing_extensions.Annotated[ @@ -1288,16 +731,6 @@ class ScheduleRunIgnoredDict(typing_extensions.TypedDict): """ -ScheduleRunResultDict = typing_extensions.Annotated[ - typing.Union[ScheduleRunIgnoredDict, "ScheduleRunSubmittedDict", ScheduleRunErrorDict], - pydantic.Field(discriminator="type"), -] -""" -The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, -ignored if all targets are up-to-date or error. -""" - - ScheduleRunRid = core.RID """The RID of a schedule run""" @@ -1309,20 +742,9 @@ class ScheduleRunSubmitted(pydantic.BaseModel): type: typing.Literal["submitted"] = "submitted" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ScheduleRunSubmittedDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ScheduleRunSubmittedDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ScheduleRunSubmittedDict(typing_extensions.TypedDict): - """The schedule has been successfully triggered.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - buildRid: core_models.BuildRid - type: typing.Literal["submitted"] + return self.model_dump(by_alias=True, exclude_none=True) class ScheduleSucceededTrigger(pydantic.BaseModel): @@ -1335,23 +757,9 @@ class ScheduleSucceededTrigger(pydantic.BaseModel): type: typing.Literal["scheduleSucceeded"] = "scheduleSucceeded" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ScheduleSucceededTriggerDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ScheduleSucceededTriggerDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ScheduleSucceededTriggerDict(typing_extensions.TypedDict): - """ - Trigger whenever the specified schedule completes its action - successfully. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - scheduleRid: ScheduleRid - type: typing.Literal["scheduleSucceeded"] + return self.model_dump(by_alias=True, exclude_none=True) class ScheduleVersion(pydantic.BaseModel): @@ -1372,29 +780,9 @@ class ScheduleVersion(pydantic.BaseModel): scope_mode: ScopeMode = pydantic.Field(alias=str("scopeMode")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ScheduleVersionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(ScheduleVersionDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class ScheduleVersionDict(typing_extensions.TypedDict): - """ScheduleVersion""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ScheduleVersionRid - """The RID of a schedule version""" - - scheduleRid: ScheduleRid - createdTime: core_models.CreatedTime - """The time the schedule version was created""" - - createdBy: core_models.CreatedBy - """The Foundry user who created the schedule version""" - - trigger: typing_extensions.NotRequired[TriggerDict] - action: ActionDict - scopeMode: ScopeModeDict + return self.model_dump(by_alias=True, exclude_none=True) ScheduleVersionRid = core.RID @@ -1407,12 +795,6 @@ class ScheduleVersionDict(typing_extensions.TypedDict): """The boundaries for the schedule build.""" -ScopeModeDict = typing_extensions.Annotated[ - typing.Union[ProjectScopeDict, "UserScopeDict"], pydantic.Field(discriminator="type") -] -"""The boundaries for the schedule build.""" - - class SearchBuildsAndFilter(pydantic.BaseModel): """Returns the Builds where every filter is satisfied.""" @@ -1420,20 +802,9 @@ class SearchBuildsAndFilter(pydantic.BaseModel): type: typing.Literal["and"] = "and" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchBuildsAndFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SearchBuildsAndFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SearchBuildsAndFilterDict(typing_extensions.TypedDict): - """Returns the Builds where every filter is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - items: typing.List[SearchBuildsFilterDict] - type: typing.Literal["and"] + return self.model_dump(by_alias=True, exclude_none=True) class SearchBuildsEqualsFilter(pydantic.BaseModel): @@ -1444,21 +815,9 @@ class SearchBuildsEqualsFilter(pydantic.BaseModel): type: typing.Literal["eq"] = "eq" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchBuildsEqualsFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SearchBuildsEqualsFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SearchBuildsEqualsFilterDict(typing_extensions.TypedDict): - """SearchBuildsEqualsFilter""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: SearchBuildsEqualsFilterField - value: typing.Any - type: typing.Literal["eq"] + return self.model_dump(by_alias=True, exclude_none=True) SearchBuildsEqualsFilterField = typing.Literal["CREATED_BY", "BRANCH_NAME", "STATUS", "RID"] @@ -1479,20 +838,6 @@ class SearchBuildsEqualsFilterDict(typing_extensions.TypedDict): """SearchBuildsFilter""" -SearchBuildsFilterDict = typing_extensions.Annotated[ - typing.Union[ - "SearchBuildsNotFilterDict", - "SearchBuildsOrFilterDict", - SearchBuildsAndFilterDict, - "SearchBuildsLtFilterDict", - "SearchBuildsGteFilterDict", - SearchBuildsEqualsFilterDict, - ], - pydantic.Field(discriminator="type"), -] -"""SearchBuildsFilter""" - - class SearchBuildsGteFilter(pydantic.BaseModel): """SearchBuildsGteFilter""" @@ -1501,21 +846,9 @@ class SearchBuildsGteFilter(pydantic.BaseModel): type: typing.Literal["gte"] = "gte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchBuildsGteFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SearchBuildsGteFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SearchBuildsGteFilterDict(typing_extensions.TypedDict): - """SearchBuildsGteFilter""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: SearchBuildsGteFilterField - value: typing.Any - type: typing.Literal["gte"] + return self.model_dump(by_alias=True, exclude_none=True) SearchBuildsGteFilterField = typing.Literal["STARTED_TIME", "FINISHED_TIME"] @@ -1530,21 +863,9 @@ class SearchBuildsLtFilter(pydantic.BaseModel): type: typing.Literal["lt"] = "lt" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchBuildsLtFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SearchBuildsLtFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SearchBuildsLtFilterDict(typing_extensions.TypedDict): - """SearchBuildsLtFilter""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: SearchBuildsLtFilterField - value: typing.Any - type: typing.Literal["lt"] + return self.model_dump(by_alias=True, exclude_none=True) SearchBuildsLtFilterField = typing.Literal["STARTED_TIME", "FINISHED_TIME"] @@ -1558,20 +879,9 @@ class SearchBuildsNotFilter(pydantic.BaseModel): type: typing.Literal["not"] = "not" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchBuildsNotFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SearchBuildsNotFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SearchBuildsNotFilterDict(typing_extensions.TypedDict): - """Returns the Builds where the filter is not satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: SearchBuildsFilterDict - type: typing.Literal["not"] + return self.model_dump(by_alias=True, exclude_none=True) class SearchBuildsOrFilter(pydantic.BaseModel): @@ -1581,20 +891,9 @@ class SearchBuildsOrFilter(pydantic.BaseModel): type: typing.Literal["or"] = "or" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchBuildsOrFilterDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SearchBuildsOrFilterDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SearchBuildsOrFilterDict(typing_extensions.TypedDict): - """Returns the Builds where at least one filter is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - items: typing.List[SearchBuildsFilterDict] - type: typing.Literal["or"] + return self.model_dump(by_alias=True, exclude_none=True) class SearchBuildsOrderBy(pydantic.BaseModel): @@ -1603,19 +902,9 @@ class SearchBuildsOrderBy(pydantic.BaseModel): fields: typing.List[SearchBuildsOrderByItem] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchBuildsOrderByDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SearchBuildsOrderByDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SearchBuildsOrderByDict(typing_extensions.TypedDict): - """SearchBuildsOrderBy""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: typing.List[SearchBuildsOrderByItemDict] + return self.model_dump(by_alias=True, exclude_none=True) SearchBuildsOrderByField = typing.Literal["STARTED_TIME", "FINISHED_TIME"] @@ -1629,20 +918,9 @@ class SearchBuildsOrderByItem(pydantic.BaseModel): direction: core_models.OrderByDirection model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchBuildsOrderByItemDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SearchBuildsOrderByItemDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SearchBuildsOrderByItemDict(typing_extensions.TypedDict): - """SearchBuildsOrderByItem""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: SearchBuildsOrderByField - direction: core_models.OrderByDirection + return self.model_dump(by_alias=True, exclude_none=True) class SearchBuildsResponse(pydantic.BaseModel): @@ -1652,20 +930,9 @@ class SearchBuildsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SearchBuildsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SearchBuildsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SearchBuildsResponseDict(typing_extensions.TypedDict): - """SearchBuildsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[BuildDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) class TimeTrigger(pydantic.BaseModel): @@ -1676,19 +943,9 @@ class TimeTrigger(pydantic.BaseModel): type: typing.Literal["time"] = "time" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TimeTriggerDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(TimeTriggerDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class TimeTriggerDict(typing_extensions.TypedDict): - """Trigger on a time based schedule.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - cronExpression: CronExpression - timeZone: core_models.ZoneId - type: typing.Literal["time"] + return self.model_dump(by_alias=True, exclude_none=True) class TransactionalMediaSetJobOutput(pydantic.BaseModel): @@ -1699,21 +956,9 @@ class TransactionalMediaSetJobOutput(pydantic.BaseModel): type: typing.Literal["transactionalMediaSetJobOutput"] = "transactionalMediaSetJobOutput" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "TransactionalMediaSetJobOutputDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - TransactionalMediaSetJobOutputDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class TransactionalMediaSetJobOutputDict(typing_extensions.TypedDict): - """TransactionalMediaSetJobOutput""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - mediaSetRid: core_models.MediaSetRid - transactionId: typing_extensions.NotRequired[str] - type: typing.Literal["transactionalMediaSetJobOutput"] + return self.model_dump(by_alias=True, exclude_none=True) Trigger = typing_extensions.Annotated[ @@ -1732,22 +977,6 @@ class TransactionalMediaSetJobOutputDict(typing_extensions.TypedDict): """Trigger""" -TriggerDict = typing_extensions.Annotated[ - typing.Union[ - JobSucceededTriggerDict, - OrTriggerDict, - NewLogicTriggerDict, - AndTriggerDict, - DatasetUpdatedTriggerDict, - ScheduleSucceededTriggerDict, - MediaSetUpdatedTriggerDict, - TimeTriggerDict, - ], - pydantic.Field(discriminator="type"), -] -"""Trigger""" - - class UpstreamTarget(pydantic.BaseModel): """Target the specified datasets along with all upstream datasets except the ignored datasets.""" @@ -1760,23 +989,9 @@ class UpstreamTarget(pydantic.BaseModel): type: typing.Literal["upstream"] = "upstream" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "UpstreamTargetDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(UpstreamTargetDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class UpstreamTargetDict(typing_extensions.TypedDict): - """Target the specified datasets along with all upstream datasets except the ignored datasets.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - targetRids: typing.List[BuildableRid] - """The target datasets.""" - - ignoredRids: typing.List[BuildableRid] - """The datasets to ignore when calculating the final set of dataset to build.""" - - type: typing.Literal["upstream"] + return self.model_dump(by_alias=True, exclude_none=True) class UserScope(pydantic.BaseModel): @@ -1788,210 +1003,115 @@ class UserScope(pydantic.BaseModel): type: typing.Literal["user"] = "user" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "UserScopeDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(UserScopeDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class UserScopeDict(typing_extensions.TypedDict): - """ - When triggered, the schedule will build all resources that the - associated user is permitted to build. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["user"] + return self.model_dump(by_alias=True, exclude_none=True) RetryBackoffDuration = core_models.Duration """The duration to wait before retrying after a Job fails.""" -RetryBackoffDurationDict = core_models.DurationDict -"""The duration to wait before retrying after a Job fails.""" - - core.resolve_forward_references(BuildTarget, globalns=globals(), localns=locals()) -core.resolve_forward_references(BuildTargetDict, globalns=globals(), localns=locals()) core.resolve_forward_references( CreateScheduleRequestBuildTarget, globalns=globals(), localns=locals() ) -core.resolve_forward_references( - CreateScheduleRequestBuildTargetDict, globalns=globals(), localns=locals() -) core.resolve_forward_references( CreateScheduleRequestScopeMode, globalns=globals(), localns=locals() ) -core.resolve_forward_references( - CreateScheduleRequestScopeModeDict, globalns=globals(), localns=locals() -) core.resolve_forward_references(FallbackBranches, globalns=globals(), localns=locals()) core.resolve_forward_references(JobOutput, globalns=globals(), localns=locals()) -core.resolve_forward_references(JobOutputDict, globalns=globals(), localns=locals()) core.resolve_forward_references( ReplaceScheduleRequestBuildTarget, globalns=globals(), localns=locals() ) -core.resolve_forward_references( - ReplaceScheduleRequestBuildTargetDict, globalns=globals(), localns=locals() -) core.resolve_forward_references( ReplaceScheduleRequestScopeMode, globalns=globals(), localns=locals() ) -core.resolve_forward_references( - ReplaceScheduleRequestScopeModeDict, globalns=globals(), localns=locals() -) core.resolve_forward_references(ScheduleRunResult, globalns=globals(), localns=locals()) -core.resolve_forward_references(ScheduleRunResultDict, globalns=globals(), localns=locals()) core.resolve_forward_references(ScopeMode, globalns=globals(), localns=locals()) -core.resolve_forward_references(ScopeModeDict, globalns=globals(), localns=locals()) core.resolve_forward_references(SearchBuildsFilter, globalns=globals(), localns=locals()) -core.resolve_forward_references(SearchBuildsFilterDict, globalns=globals(), localns=locals()) core.resolve_forward_references(Trigger, globalns=globals(), localns=locals()) -core.resolve_forward_references(TriggerDict, globalns=globals(), localns=locals()) __all__ = [ "AbortOnFailure", "Action", - "ActionDict", "AndTrigger", - "AndTriggerDict", "Build", - "BuildDict", "BuildStatus", "BuildTarget", - "BuildTargetDict", "BuildableRid", "ConnectingTarget", - "ConnectingTargetDict", "CreateScheduleRequestAction", - "CreateScheduleRequestActionDict", "CreateScheduleRequestBuildTarget", - "CreateScheduleRequestBuildTargetDict", "CreateScheduleRequestConnectingTarget", - "CreateScheduleRequestConnectingTargetDict", "CreateScheduleRequestManualTarget", - "CreateScheduleRequestManualTargetDict", "CreateScheduleRequestProjectScope", - "CreateScheduleRequestProjectScopeDict", "CreateScheduleRequestScopeMode", - "CreateScheduleRequestScopeModeDict", "CreateScheduleRequestUpstreamTarget", - "CreateScheduleRequestUpstreamTargetDict", "CreateScheduleRequestUserScope", - "CreateScheduleRequestUserScopeDict", "CronExpression", "DatasetJobOutput", - "DatasetJobOutputDict", "DatasetUpdatedTrigger", - "DatasetUpdatedTriggerDict", "FallbackBranches", "ForceBuild", "GetBuildsBatchRequestElement", - "GetBuildsBatchRequestElementDict", "GetBuildsBatchResponse", - "GetBuildsBatchResponseDict", "GetJobsBatchRequestElement", - "GetJobsBatchRequestElementDict", "GetJobsBatchResponse", - "GetJobsBatchResponseDict", "Job", - "JobDict", "JobOutput", - "JobOutputDict", "JobStartedTime", "JobStatus", "JobSucceededTrigger", - "JobSucceededTriggerDict", "ListJobsOfBuildResponse", - "ListJobsOfBuildResponseDict", "ListRunsOfScheduleResponse", - "ListRunsOfScheduleResponseDict", "ManualTarget", - "ManualTargetDict", "MediaSetUpdatedTrigger", - "MediaSetUpdatedTriggerDict", "NewLogicTrigger", - "NewLogicTriggerDict", "NotificationsEnabled", "OrTrigger", - "OrTriggerDict", "ProjectScope", - "ProjectScopeDict", "ReplaceScheduleRequestAction", - "ReplaceScheduleRequestActionDict", "ReplaceScheduleRequestBuildTarget", - "ReplaceScheduleRequestBuildTargetDict", "ReplaceScheduleRequestConnectingTarget", - "ReplaceScheduleRequestConnectingTargetDict", "ReplaceScheduleRequestManualTarget", - "ReplaceScheduleRequestManualTargetDict", "ReplaceScheduleRequestProjectScope", - "ReplaceScheduleRequestProjectScopeDict", "ReplaceScheduleRequestScopeMode", - "ReplaceScheduleRequestScopeModeDict", "ReplaceScheduleRequestUpstreamTarget", - "ReplaceScheduleRequestUpstreamTargetDict", "ReplaceScheduleRequestUserScope", - "ReplaceScheduleRequestUserScopeDict", "RetryBackoffDuration", - "RetryBackoffDurationDict", "RetryCount", "Schedule", - "ScheduleDict", "SchedulePaused", "ScheduleRid", "ScheduleRun", - "ScheduleRunDict", "ScheduleRunError", - "ScheduleRunErrorDict", "ScheduleRunErrorName", "ScheduleRunIgnored", - "ScheduleRunIgnoredDict", "ScheduleRunResult", - "ScheduleRunResultDict", "ScheduleRunRid", "ScheduleRunSubmitted", - "ScheduleRunSubmittedDict", "ScheduleSucceededTrigger", - "ScheduleSucceededTriggerDict", "ScheduleVersion", - "ScheduleVersionDict", "ScheduleVersionRid", "ScopeMode", - "ScopeModeDict", "SearchBuildsAndFilter", - "SearchBuildsAndFilterDict", "SearchBuildsEqualsFilter", - "SearchBuildsEqualsFilterDict", "SearchBuildsEqualsFilterField", "SearchBuildsFilter", - "SearchBuildsFilterDict", "SearchBuildsGteFilter", - "SearchBuildsGteFilterDict", "SearchBuildsGteFilterField", "SearchBuildsLtFilter", - "SearchBuildsLtFilterDict", "SearchBuildsLtFilterField", "SearchBuildsNotFilter", - "SearchBuildsNotFilterDict", "SearchBuildsOrFilter", - "SearchBuildsOrFilterDict", "SearchBuildsOrderBy", - "SearchBuildsOrderByDict", "SearchBuildsOrderByField", "SearchBuildsOrderByItem", - "SearchBuildsOrderByItemDict", "SearchBuildsResponse", - "SearchBuildsResponseDict", "TimeTrigger", - "TimeTriggerDict", "TransactionalMediaSetJobOutput", - "TransactionalMediaSetJobOutputDict", "Trigger", - "TriggerDict", "UpstreamTarget", - "UpstreamTargetDict", "UserScope", - "UserScopeDict", ] diff --git a/foundry/v2/orchestration/schedule.py b/foundry/v2/orchestration/schedule.py index 3429386b8..88e8e53da 100644 --- a/foundry/v2/orchestration/schedule.py +++ b/foundry/v2/orchestration/schedule.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -55,29 +54,19 @@ def __init__( def create( self, *, - action: typing.Union[ - orchestration_models.CreateScheduleRequestAction, - orchestration_models.CreateScheduleRequestActionDict, - ], + action: orchestration_models.CreateScheduleRequestAction, description: typing.Optional[str] = None, display_name: typing.Optional[str] = None, preview: typing.Optional[core_models.PreviewMode] = None, - scope_mode: typing.Optional[ - typing.Union[ - orchestration_models.CreateScheduleRequestScopeMode, - orchestration_models.CreateScheduleRequestScopeModeDict, - ] - ] = None, - trigger: typing.Optional[ - typing.Union[orchestration_models.Trigger, orchestration_models.TriggerDict] - ] = None, + scope_mode: typing.Optional[orchestration_models.CreateScheduleRequestScopeMode] = None, + trigger: typing.Optional[orchestration_models.Trigger] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> orchestration_models.Schedule: """ Creates a new Schedule. :param action: - :type action: Union[CreateScheduleRequestAction, CreateScheduleRequestActionDict] + :type action: CreateScheduleRequestAction :param description: :type description: Optional[str] :param display_name: @@ -85,9 +74,9 @@ def create( :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param scope_mode: - :type scope_mode: Optional[Union[CreateScheduleRequestScopeMode, CreateScheduleRequestScopeModeDict]] + :type scope_mode: Optional[CreateScheduleRequestScopeMode] :param trigger: The schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty. - :type trigger: Optional[Union[Trigger, TriggerDict]] + :type trigger: Optional[Trigger] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -120,20 +109,10 @@ def create( { # type: ignore "displayName": typing.Optional[str], "description": typing.Optional[str], - "action": typing.Union[ - orchestration_models.CreateScheduleRequestAction, - orchestration_models.CreateScheduleRequestActionDict, - ], - "trigger": typing.Optional[ - typing.Union[ - orchestration_models.Trigger, orchestration_models.TriggerDict - ] - ], + "action": orchestration_models.CreateScheduleRequestAction, + "trigger": typing.Optional[orchestration_models.Trigger], "scopeMode": typing.Optional[ - typing.Union[ - orchestration_models.CreateScheduleRequestScopeMode, - orchestration_models.CreateScheduleRequestScopeModeDict, - ] + orchestration_models.CreateScheduleRequestScopeMode ], }, ), @@ -296,22 +275,12 @@ def replace( self, schedule_rid: orchestration_models.ScheduleRid, *, - action: typing.Union[ - orchestration_models.ReplaceScheduleRequestAction, - orchestration_models.ReplaceScheduleRequestActionDict, - ], + action: orchestration_models.ReplaceScheduleRequestAction, description: typing.Optional[str] = None, display_name: typing.Optional[str] = None, preview: typing.Optional[core_models.PreviewMode] = None, - scope_mode: typing.Optional[ - typing.Union[ - orchestration_models.ReplaceScheduleRequestScopeMode, - orchestration_models.ReplaceScheduleRequestScopeModeDict, - ] - ] = None, - trigger: typing.Optional[ - typing.Union[orchestration_models.Trigger, orchestration_models.TriggerDict] - ] = None, + scope_mode: typing.Optional[orchestration_models.ReplaceScheduleRequestScopeMode] = None, + trigger: typing.Optional[orchestration_models.Trigger] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> orchestration_models.Schedule: @@ -320,7 +289,7 @@ def replace( :param schedule_rid: :type schedule_rid: ScheduleRid :param action: - :type action: Union[ReplaceScheduleRequestAction, ReplaceScheduleRequestActionDict] + :type action: ReplaceScheduleRequestAction :param description: :type description: Optional[str] :param display_name: @@ -328,9 +297,9 @@ def replace( :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param scope_mode: - :type scope_mode: Optional[Union[ReplaceScheduleRequestScopeMode, ReplaceScheduleRequestScopeModeDict]] + :type scope_mode: Optional[ReplaceScheduleRequestScopeMode] :param trigger: The schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty. - :type trigger: Optional[Union[Trigger, TriggerDict]] + :type trigger: Optional[Trigger] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -365,20 +334,10 @@ def replace( { # type: ignore "displayName": typing.Optional[str], "description": typing.Optional[str], - "action": typing.Union[ - orchestration_models.ReplaceScheduleRequestAction, - orchestration_models.ReplaceScheduleRequestActionDict, - ], - "trigger": typing.Optional[ - typing.Union[ - orchestration_models.Trigger, orchestration_models.TriggerDict - ] - ], + "action": orchestration_models.ReplaceScheduleRequestAction, + "trigger": typing.Optional[orchestration_models.Trigger], "scopeMode": typing.Optional[ - typing.Union[ - orchestration_models.ReplaceScheduleRequestScopeMode, - orchestration_models.ReplaceScheduleRequestScopeModeDict, - ] + orchestration_models.ReplaceScheduleRequestScopeMode ], }, ), @@ -494,66 +453,6 @@ def runs( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def runs_page( - self, - schedule_rid: orchestration_models.ScheduleRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> orchestration_models.ListRunsOfScheduleResponse: - """ - Get the most recent runs of a Schedule. If no page size is provided, a page size of 100 will be used. - - :param schedule_rid: - :type schedule_rid: ScheduleRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :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: orchestration_models.ListRunsOfScheduleResponse - """ - - warnings.warn( - "The client.orchestration.Schedule.runs_page(...) method has been deprecated. Please use client.orchestration.Schedule.runs(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/orchestration/schedules/{scheduleRid}/runs", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - "preview": preview, - }, - path_params={ - "scheduleRid": schedule_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=orchestration_models.ListRunsOfScheduleResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -611,7 +510,6 @@ def pause(_: None): ... def replace(_: orchestration_models.Schedule): ... def run(_: orchestration_models.ScheduleRun): ... def runs(_: orchestration_models.ListRunsOfScheduleResponse): ... - def runs_page(_: orchestration_models.ListRunsOfScheduleResponse): ... def unpause(_: None): ... self.create = core.with_raw_response(create, client.create) @@ -621,7 +519,6 @@ def unpause(_: None): ... self.replace = core.with_raw_response(replace, client.replace) self.run = core.with_raw_response(run, client.run) self.runs = core.with_raw_response(runs, client.runs) - self.runs_page = core.with_raw_response(runs_page, client.runs_page) self.unpause = core.with_raw_response(unpause, client.unpause) @@ -632,11 +529,9 @@ def get(_: orchestration_models.Schedule): ... def replace(_: orchestration_models.Schedule): ... def run(_: orchestration_models.ScheduleRun): ... def runs(_: orchestration_models.ListRunsOfScheduleResponse): ... - def runs_page(_: orchestration_models.ListRunsOfScheduleResponse): ... self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) self.replace = core.with_streaming_response(replace, client.replace) self.run = core.with_streaming_response(run, client.run) self.runs = core.with_streaming_response(runs, client.runs) - self.runs_page = core.with_streaming_response(runs_page, client.runs_page) diff --git a/foundry/v2/sql_queries/client.py b/foundry/v2/sql_queries/client.py deleted file mode 100644 index 18c8b3aba..000000000 --- a/foundry/v2/sql_queries/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v2.sql_queries._client import SqlQueriesClient - -__all__ = [ - "SqlQueriesClient", -] diff --git a/foundry/v2/sql_queries/models.py b/foundry/v2/sql_queries/models.py index c486b109c..142dca380 100644 --- a/foundry/v2/sql_queries/models.py +++ b/foundry/v2/sql_queries/models.py @@ -29,19 +29,9 @@ class CanceledQueryStatus(pydantic.BaseModel): type: typing.Literal["canceled"] = "canceled" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CanceledQueryStatusDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CanceledQueryStatusDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class CanceledQueryStatusDict(typing_extensions.TypedDict): - """CanceledQueryStatus""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: typing.Literal["canceled"] + return self.model_dump(by_alias=True, exclude_none=True) class FailedQueryStatus(pydantic.BaseModel): @@ -53,20 +43,9 @@ class FailedQueryStatus(pydantic.BaseModel): type: typing.Literal["failed"] = "failed" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "FailedQueryStatusDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(FailedQueryStatusDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class FailedQueryStatusDict(typing_extensions.TypedDict): - """FailedQueryStatus""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - errorMessage: str - """An error message describing why the query failed.""" - - type: typing.Literal["failed"] + return self.model_dump(by_alias=True, exclude_none=True) QueryId = str @@ -82,18 +61,6 @@ class FailedQueryStatusDict(typing_extensions.TypedDict): """QueryStatus""" -QueryStatusDict = typing_extensions.Annotated[ - typing.Union[ - "RunningQueryStatusDict", - CanceledQueryStatusDict, - FailedQueryStatusDict, - "SucceededQueryStatusDict", - ], - pydantic.Field(discriminator="type"), -] -"""QueryStatus""" - - class RunningQueryStatus(pydantic.BaseModel): """RunningQueryStatus""" @@ -101,20 +68,9 @@ class RunningQueryStatus(pydantic.BaseModel): type: typing.Literal["running"] = "running" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "RunningQueryStatusDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - RunningQueryStatusDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class RunningQueryStatusDict(typing_extensions.TypedDict): - """RunningQueryStatus""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - queryId: QueryId - type: typing.Literal["running"] + return self.model_dump(by_alias=True, exclude_none=True) class SucceededQueryStatus(pydantic.BaseModel): @@ -124,35 +80,18 @@ class SucceededQueryStatus(pydantic.BaseModel): type: typing.Literal["succeeded"] = "succeeded" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "SucceededQueryStatusDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - SucceededQueryStatusDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class SucceededQueryStatusDict(typing_extensions.TypedDict): - """SucceededQueryStatus""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - queryId: QueryId - type: typing.Literal["succeeded"] + return self.model_dump(by_alias=True, exclude_none=True) core.resolve_forward_references(QueryStatus, globalns=globals(), localns=locals()) -core.resolve_forward_references(QueryStatusDict, globalns=globals(), localns=locals()) __all__ = [ "CanceledQueryStatus", - "CanceledQueryStatusDict", "FailedQueryStatus", - "FailedQueryStatusDict", "QueryId", "QueryStatus", - "QueryStatusDict", "RunningQueryStatus", - "RunningQueryStatusDict", "SucceededQueryStatus", - "SucceededQueryStatusDict", ] diff --git a/foundry/v2/streams/client.py b/foundry/v2/streams/client.py deleted file mode 100644 index 35346cf3c..000000000 --- a/foundry/v2/streams/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v2.streams._client import StreamsClient - -__all__ = [ - "StreamsClient", -] diff --git a/foundry/v2/streams/dataset.py b/foundry/v2/streams/dataset.py index c2a9d150d..61308a018 100644 --- a/foundry/v2/streams/dataset.py +++ b/foundry/v2/streams/dataset.py @@ -70,7 +70,7 @@ def create( *, name: datasets_models.DatasetName, parent_folder_rid: filesystem_models.FolderRid, - schema: typing.Union[core_models.StreamSchema, core_models.StreamSchemaDict], + schema: core_models.StreamSchema, branch_name: typing.Optional[datasets_models.BranchName] = None, compressed: typing.Optional[streams_models.Compressed] = None, partitions_count: typing.Optional[streams_models.PartitionsCount] = None, @@ -89,7 +89,7 @@ def create( :param parent_folder_rid: :type parent_folder_rid: FolderRid :param schema: The Foundry schema to apply to the new stream. - :type schema: Union[StreamSchema, StreamSchemaDict] + :type schema: StreamSchema :param branch_name: The branch to create the initial stream on. If not specified, the default branch will be used ('master' for most enrollments). :type branch_name: Optional[BranchName] :param compressed: Whether or not compression is enabled for the stream. Defaults to false. @@ -135,9 +135,7 @@ def create( { # type: ignore "name": datasets_models.DatasetName, "parentFolderRid": filesystem_models.FolderRid, - "schema": typing.Union[ - core_models.StreamSchema, core_models.StreamSchemaDict - ], + "schema": core_models.StreamSchema, "branchName": typing.Optional[datasets_models.BranchName], "partitionsCount": typing.Optional[streams_models.PartitionsCount], "streamType": typing.Optional[streams_models.StreamType], diff --git a/foundry/v2/streams/models.py b/foundry/v2/streams/models.py index 64b213b6e..5c0461067 100644 --- a/foundry/v2/streams/models.py +++ b/foundry/v2/streams/models.py @@ -18,7 +18,6 @@ import typing import pydantic -import typing_extensions from foundry import _core as core from foundry.v2.core import models as core_models @@ -63,42 +62,9 @@ class CreateStreamRequestStreamSchema(pydantic.BaseModel): change_data_capture: typing.Optional[core_models.ChangeDataCaptureConfiguration] = pydantic.Field(alias=str("changeDataCapture"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "CreateStreamRequestStreamSchemaDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - CreateStreamRequestStreamSchemaDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class CreateStreamRequestStreamSchemaDict(typing_extensions.TypedDict): - """CreateStreamRequestStreamSchema""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyFieldNames: typing_extensions.NotRequired[typing.List[core_models.FieldName]] - """ - The names of the fields to be used as keys for partitioning records. These key fields are used to group - all records with the same key into the same partition, to guarantee processing order of grouped records. These - keys are not meant to uniquely identify records, and do not by themselves deduplicate records. To deduplicate - records, provide a change data capture configuration for the schema. - - Key fields can only be of the following types: - - Boolean - - Byte - - Date - - Decimal - - Integer - - Long - - Short - - String - - Timestamp - - For additional information on keys for Foundry streams, see the - [streaming keys](/docs/foundry/building-pipelines/streaming-keys/) user documentation. - """ - - fields: typing.List[core_models.FieldDict] - changeDataCapture: typing_extensions.NotRequired[core_models.ChangeDataCaptureConfigurationDict] + return self.model_dump(by_alias=True, exclude_none=True) class Dataset(pydantic.BaseModel): @@ -109,19 +75,9 @@ class Dataset(pydantic.BaseModel): parent_folder_rid: filesystem_models.FolderRid = pydantic.Field(alias=str("parentFolderRid")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "DatasetDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(DatasetDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class DatasetDict(typing_extensions.TypedDict): - """Dataset""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: datasets_models.DatasetRid - name: datasets_models.DatasetName - parentFolderRid: filesystem_models.FolderRid + return self.model_dump(by_alias=True, exclude_none=True) PartitionsCount = int @@ -161,39 +117,9 @@ class Stream(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "StreamDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(StreamDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class StreamDict(typing_extensions.TypedDict): - """Stream""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - branchName: datasets_models.BranchName - schema: core_models.StreamSchemaDict - """The Foundry schema for this stream.""" - - viewRid: ViewRid - """The view that this stream corresponds to.""" - - partitionsCount: PartitionsCount - """ - The number of partitions for the Foundry stream. Defaults to 1. - - Generally, each partition can handle about 5 mb/s of data, so for higher volume streams, more partitions - are recommended. - """ - - streamType: StreamType - """ - A conceptual representation of the expected shape of the data for a stream. HIGH_THROUGHPUT and - LOW_LATENCY are not compatible with each other. Defaults to LOW_LATENCY. - """ - - compressed: Compressed - """Whether or not compression is enabled for the stream. Defaults to false.""" + return self.model_dump(by_alias=True, exclude_none=True) StreamType = typing.Literal["LOW_LATENCY", "HIGH_THROUGHPUT"] @@ -221,13 +147,10 @@ class StreamDict(typing_extensions.TypedDict): __all__ = [ "Compressed", "CreateStreamRequestStreamSchema", - "CreateStreamRequestStreamSchemaDict", "Dataset", - "DatasetDict", "PartitionsCount", "Record", "Stream", - "StreamDict", "StreamType", "ViewRid", ] diff --git a/foundry/v2/streams/stream.py b/foundry/v2/streams/stream.py index e60d5beef..829f1696a 100644 --- a/foundry/v2/streams/stream.py +++ b/foundry/v2/streams/stream.py @@ -57,10 +57,7 @@ def create( dataset_rid: datasets_models.DatasetRid, *, branch_name: datasets_models.BranchName, - schema: typing.Union[ - streams_models.CreateStreamRequestStreamSchema, - streams_models.CreateStreamRequestStreamSchemaDict, - ], + schema: streams_models.CreateStreamRequestStreamSchema, compressed: typing.Optional[streams_models.Compressed] = None, partitions_count: typing.Optional[streams_models.PartitionsCount] = None, preview: typing.Optional[core_models.PreviewMode] = None, @@ -76,7 +73,7 @@ def create( :param branch_name: :type branch_name: BranchName :param schema: The Foundry schema for this stream. - :type schema: Union[CreateStreamRequestStreamSchema, CreateStreamRequestStreamSchemaDict] + :type schema: CreateStreamRequestStreamSchema :param compressed: Whether or not compression is enabled for the stream. Defaults to false. :type compressed: Optional[Compressed] :param partitions_count: The number of partitions for the Foundry stream. Defaults to 1. Generally, each partition can handle about 5 mb/s of data, so for higher volume streams, more partitions are recommended. @@ -117,10 +114,7 @@ def create( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "schema": typing.Union[ - streams_models.CreateStreamRequestStreamSchema, - streams_models.CreateStreamRequestStreamSchemaDict, - ], + "schema": streams_models.CreateStreamRequestStreamSchema, "partitionsCount": typing.Optional[streams_models.PartitionsCount], "streamType": typing.Optional[streams_models.StreamType], "branchName": datasets_models.BranchName, @@ -403,9 +397,7 @@ def reset( compressed: typing.Optional[streams_models.Compressed] = None, partitions_count: typing.Optional[streams_models.PartitionsCount] = None, preview: typing.Optional[core_models.PreviewMode] = None, - schema: typing.Optional[ - typing.Union[core_models.StreamSchema, core_models.StreamSchemaDict] - ] = None, + schema: typing.Optional[core_models.StreamSchema] = None, stream_type: typing.Optional[streams_models.StreamType] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, @@ -430,7 +422,7 @@ def reset( :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param schema: The Foundry schema to apply to the new stream. If omitted, the schema of the existing stream on the branch will be used. - :type schema: Optional[Union[StreamSchema, StreamSchemaDict]] + :type schema: Optional[StreamSchema] :param stream_type: A conceptual representation of the expected shape of the data for a stream. HIGH_THROUGHPUT and LOW_LATENCY are not compatible with each other. Defaults to LOW_LATENCY. If omitted, the stream type of the existing stream on the branch will be used. :type stream_type: Optional[StreamType] :param request_timeout: timeout setting for this request in seconds. @@ -465,9 +457,7 @@ def reset( body_type=typing_extensions.TypedDict( "Body", { # type: ignore - "schema": typing.Optional[ - typing.Union[core_models.StreamSchema, core_models.StreamSchemaDict] - ], + "schema": typing.Optional[core_models.StreamSchema], "partitionsCount": typing.Optional[streams_models.PartitionsCount], "streamType": typing.Optional[streams_models.StreamType], "compressed": typing.Optional[streams_models.Compressed], diff --git a/foundry/v2/third_party_applications/client.py b/foundry/v2/third_party_applications/client.py deleted file mode 100644 index 97ab85d07..000000000 --- a/foundry/v2/third_party_applications/client.py +++ /dev/null @@ -1,20 +0,0 @@ -# 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. - - -from foundry.v2.third_party_applications._client import ThirdPartyApplicationsClient - -__all__ = [ - "ThirdPartyApplicationsClient", -] diff --git a/foundry/v2/third_party_applications/models.py b/foundry/v2/third_party_applications/models.py index d80733cf3..715780afb 100644 --- a/foundry/v2/third_party_applications/models.py +++ b/foundry/v2/third_party_applications/models.py @@ -18,7 +18,6 @@ import typing import pydantic -import typing_extensions from foundry import _core as core from foundry.v2.core import models as core_models @@ -31,20 +30,9 @@ class ListVersionsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ListVersionsResponseDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ListVersionsResponseDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ListVersionsResponseDict(typing_extensions.TypedDict): - """ListVersionsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: typing.List[VersionDict] - nextPageToken: typing_extensions.NotRequired[core_models.PageToken] + return self.model_dump(by_alias=True, exclude_none=True) Subdomain = str @@ -59,20 +47,9 @@ class ThirdPartyApplication(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "ThirdPartyApplicationDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast( - ThirdPartyApplicationDict, self.model_dump(by_alias=True, exclude_none=True) - ) - - -class ThirdPartyApplicationDict(typing_extensions.TypedDict): - """ThirdPartyApplication""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ThirdPartyApplicationRid - """An RID identifying a third-party application created in Developer Console.""" + return self.model_dump(by_alias=True, exclude_none=True) ThirdPartyApplicationRid = core.RID @@ -87,18 +64,9 @@ class Version(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "VersionDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(VersionDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class VersionDict(typing_extensions.TypedDict): - """Version""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - version: VersionVersion - """The semantic version of the Website.""" + return self.model_dump(by_alias=True, exclude_none=True) VersionVersion = str @@ -116,33 +84,17 @@ class Website(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> "WebsiteDict": + def to_dict(self) -> dict: """Return the dictionary representation of the model using the field aliases.""" - return typing.cast(WebsiteDict, self.model_dump(by_alias=True, exclude_none=True)) - - -class WebsiteDict(typing_extensions.TypedDict): - """Website""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - deployedVersion: typing_extensions.NotRequired[VersionVersion] - """The version of the Website that is currently deployed.""" - - subdomains: typing.List[Subdomain] - """The subdomains from which the Website is currently served.""" + return self.model_dump(by_alias=True, exclude_none=True) __all__ = [ "ListVersionsResponse", - "ListVersionsResponseDict", "Subdomain", "ThirdPartyApplication", - "ThirdPartyApplicationDict", "ThirdPartyApplicationRid", "Version", - "VersionDict", "VersionVersion", "Website", - "WebsiteDict", ] diff --git a/foundry/v2/third_party_applications/version.py b/foundry/v2/third_party_applications/version.py index b9000ff6d..f9a2687cb 100644 --- a/foundry/v2/third_party_applications/version.py +++ b/foundry/v2/third_party_applications/version.py @@ -14,7 +14,6 @@ import typing -import warnings import pydantic import typing_extensions @@ -194,63 +193,6 @@ def list( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def page( - self, - third_party_application_rid: third_party_applications_models.ThirdPartyApplicationRid, - *, - page_size: typing.Optional[core_models.PageSize] = None, - page_token: typing.Optional[core_models.PageToken] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> third_party_applications_models.ListVersionsResponse: - """ - Lists all Versions. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param third_party_application_rid: An RID identifying a third-party application created in Developer Console. - :type third_party_application_rid: ThirdPartyApplicationRid - :param page_size: The page size to use for the endpoint. - :type page_size: Optional[PageSize] - :param page_token: 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. - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: third_party_applications_models.ListVersionsResponse - """ - - warnings.warn( - "The client.third_party_applications.Version.page(...) method has been deprecated. Please use client.third_party_applications.Version.list(...) instead.", - DeprecationWarning, - stacklevel=2, - ) - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions", - query_params={ - "pageSize": page_size, - "pageToken": page_token, - }, - path_params={ - "thirdPartyApplicationRid": third_party_application_rid, - }, - header_params={ - "Accept": "application/json", - }, - body=None, - body_type=None, - response_type=third_party_applications_models.ListVersionsResponse, - request_timeout=request_timeout, - throwable_errors={}, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -372,14 +314,12 @@ def __init__(self, client: VersionClient) -> None: def delete(_: None): ... def get(_: third_party_applications_models.Version): ... def list(_: third_party_applications_models.ListVersionsResponse): ... - def page(_: third_party_applications_models.ListVersionsResponse): ... def upload(_: third_party_applications_models.Version): ... def upload_snapshot(_: third_party_applications_models.Version): ... self.delete = core.with_raw_response(delete, client.delete) self.get = core.with_raw_response(get, client.get) self.list = core.with_raw_response(list, client.list) - self.page = core.with_raw_response(page, client.page) self.upload = core.with_raw_response(upload, client.upload) self.upload_snapshot = core.with_raw_response(upload_snapshot, client.upload_snapshot) @@ -388,12 +328,10 @@ class _VersionClientStreaming: def __init__(self, client: VersionClient) -> None: def get(_: third_party_applications_models.Version): ... def list(_: third_party_applications_models.ListVersionsResponse): ... - def page(_: third_party_applications_models.ListVersionsResponse): ... def upload(_: third_party_applications_models.Version): ... def upload_snapshot(_: third_party_applications_models.Version): ... self.get = core.with_streaming_response(get, client.get) self.list = core.with_streaming_response(list, client.list) - self.page = core.with_streaming_response(page, client.page) self.upload = core.with_streaming_response(upload, client.upload) self.upload_snapshot = core.with_streaming_response(upload_snapshot, client.upload_snapshot) diff --git a/tests/auth/test_foundry_auth_token_client.py b/tests/auth/test_user_auth_token_client.py similarity index 100% rename from tests/auth/test_foundry_auth_token_client.py rename to tests/auth/test_user_auth_token_client.py diff --git a/tests/utils.py b/tests/utils.py deleted file mode 100644 index c97e36612..000000000 --- a/tests/utils.py +++ /dev/null @@ -1,80 +0,0 @@ -# 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 json -from contextlib import contextmanager -from typing import Any -from typing import Dict -from typing import List -from typing import Literal -from typing import Optional -from typing import cast -from unittest.mock import Mock -from unittest.mock import patch -from urllib.parse import quote - -import pydantic -import pytest -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -import foundry -from foundry.v1 import FoundryClient as FoundryV1Client -from foundry.v2 import FoundryClient as FoundryV2Client - - -class MockResponse(TypedDict): - status: int - content_type: Optional[str] - json: Optional[Any] - - -class MockRequest(TypedDict): - method: Literal["GET", "POST", "DELETE", "PATCH", "PUT"] - url: str - path_params: Dict[str, Any] - response: MockResponse - json: Optional[Any] - - -@pytest.fixture -def client_v1(): - yield FoundryV1Client( - auth=foundry.UserTokenAuth(token=""), - hostname="example.palantirfoundry.com", - ) - - -@pytest.fixture -def client_v2(): - yield FoundryV2Client( - auth=foundry.UserTokenAuth(token=""), - hostname="example.palantirfoundry.com", - ) - - -def serialize_response(response: Any): - """Serialize the response to primitive data structures (lists, dicts, str, int, etc.)""" - if response is None: - return None - elif isinstance(response, list): - return [serialize_response(value) for value in response] - elif isinstance(response, dict): - return {key: serialize_response(value) for key, value in response.items()} - elif isinstance(response, pydantic.BaseModel): - # The to_dict() method will exist on each data model - return cast(Any, response).to_dict() - else: - return response From 7ee6743324100cf32b9ae16d386dfc4c28b9692f Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Tue, 1 Apr 2025 09:23:24 -0300 Subject: [PATCH 02/11] rename --- README.md | 3090 ++++++++--------- config.json | 2 +- docs/v1/Datasets/Branch.md | 32 +- docs/v1/Datasets/Dataset.md | 48 +- docs/v1/Datasets/File.md | 40 +- docs/v1/Datasets/Transaction.md | 32 +- docs/v1/Ontologies/Action.md | 24 +- docs/v1/Ontologies/ActionType.md | 16 +- docs/v1/Ontologies/Attachment.md | 24 +- docs/v1/Ontologies/ObjectType.md | 32 +- docs/v1/Ontologies/Ontology.md | 16 +- docs/v1/Ontologies/OntologyObject.md | 48 +- docs/v1/Ontologies/Query.md | 8 +- docs/v1/Ontologies/QueryType.md | 16 +- docs/v2/Admin/AuthenticationProvider.md | 32 +- docs/v2/Admin/Enrollment.md | 16 +- docs/v2/Admin/Group.md | 48 +- docs/v2/Admin/GroupMember.md | 24 +- docs/v2/Admin/GroupMembership.md | 8 +- docs/v2/Admin/GroupProviderInfo.md | 16 +- docs/v2/Admin/Host.md | 8 +- docs/v2/Admin/Marking.md | 32 +- docs/v2/Admin/MarkingCategory.md | 16 +- docs/v2/Admin/MarkingMember.md | 24 +- docs/v2/Admin/MarkingRoleAssignment.md | 24 +- docs/v2/Admin/Organization.md | 16 +- docs/v2/Admin/User.md | 64 +- docs/v2/Admin/UserProviderInfo.md | 16 +- docs/v2/AipAgents/Agent.md | 16 +- docs/v2/AipAgents/AgentVersion.md | 16 +- docs/v2/AipAgents/Content.md | 8 +- docs/v2/AipAgents/Session.md | 64 +- docs/v2/Connectivity/Connection.md | 32 +- docs/v2/Connectivity/FileImport.md | 48 +- docs/v2/Connectivity/TableImport.md | 40 +- docs/v2/Datasets/Branch.md | 32 +- docs/v2/Datasets/Dataset.md | 24 +- docs/v2/Datasets/File.md | 40 +- docs/v2/Datasets/Transaction.md | 48 +- docs/v2/Filesystem/Folder.md | 24 +- docs/v2/Filesystem/Project.md | 48 +- docs/v2/Filesystem/Resource.md | 72 +- docs/v2/Filesystem/ResourceRole.md | 24 +- docs/v2/Filesystem/Space.md | 8 +- docs/v2/Functions/Query.md | 24 +- docs/v2/Functions/ValueType.md | 8 +- docs/v2/Functions/VersionId.md | 8 +- docs/v2/MediaSets/MediaSet.md | 64 +- docs/v2/Ontologies/Action.md | 16 +- docs/v2/Ontologies/ActionType.md | 24 +- docs/v2/Ontologies/Attachment.md | 24 +- docs/v2/Ontologies/AttachmentProperty.md | 32 +- docs/v2/Ontologies/LinkedObject.md | 16 +- docs/v2/Ontologies/MediaReferenceProperty.md | 24 +- docs/v2/Ontologies/ObjectType.md | 40 +- docs/v2/Ontologies/Ontology.md | 24 +- docs/v2/Ontologies/OntologyInterface.md | 32 +- docs/v2/Ontologies/OntologyObject.md | 40 +- docs/v2/Ontologies/OntologyObjectSet.md | 48 +- docs/v2/Ontologies/Query.md | 8 +- docs/v2/Ontologies/QueryType.md | 16 +- docs/v2/Ontologies/TimeSeriesPropertyV2.md | 24 +- .../Ontologies/TimeSeriesValueBankProperty.md | 16 +- docs/v2/Orchestration/Build.md | 48 +- docs/v2/Orchestration/Job.md | 16 +- docs/v2/Orchestration/Schedule.md | 64 +- docs/v2/Orchestration/ScheduleVersion.md | 16 +- docs/v2/SqlQueries/Query.md | 32 +- docs/v2/Streams/Dataset.md | 8 +- docs/v2/Streams/Stream.md | 48 +- .../ThirdPartyApplication.md | 8 +- docs/v2/ThirdPartyApplications/Version.md | 40 +- docs/v2/ThirdPartyApplications/Website.md | 24 +- foundry/__init__.py | 88 - foundry/_core/__init__.py | 37 - foundry/_errors/__init__.py | 39 - foundry_sdk/__init__.py | 88 + foundry_sdk/_core/__init__.py | 37 + {foundry => foundry_sdk}/_core/api_client.py | 52 +- {foundry => foundry_sdk}/_core/auth_utils.py | 2 +- .../_core/binary_stream.py | 0 .../_core/compute_module_pipeline_auth.py | 8 +- .../_core/confidential_client_auth.py | 12 +- {foundry => foundry_sdk}/_core/config.py | 0 {foundry => foundry_sdk}/_core/http_client.py | 8 +- {foundry => foundry_sdk}/_core/oauth_utils.py | 8 +- .../_core/page_iterator.py | 0 .../_core/public_client_auth.py | 14 +- .../_core/resource_iterator.py | 0 .../_core/user_token_auth_client.py | 8 +- {foundry => foundry_sdk}/_core/utils.py | 0 foundry_sdk/_errors/__init__.py | 39 + .../_errors/api_not_found.py | 2 +- .../_errors/connection_error.py | 2 +- .../_errors/environment_not_configured.py | 2 +- .../_errors/not_authenticated.py | 2 +- .../_errors/palantir_exception.py | 0 .../_errors/palantir_rpc_exception.py | 2 +- .../_errors/sdk_internal_error.py | 6 +- .../_errors/stream_error.py | 2 +- .../_errors/timeout_error.py | 4 +- {foundry => foundry_sdk}/_errors/utils.py | 4 +- {foundry => foundry_sdk}/_versions.py | 0 {foundry => foundry_sdk}/py.typed | 0 {foundry/v2 => foundry_sdk/v1}/__init__.py | 2 +- {foundry => foundry_sdk}/v1/cli.py | 94 +- {foundry => foundry_sdk}/v1/client.py | 6 +- {foundry => foundry_sdk}/v1/core/errors.py | 4 +- {foundry => foundry_sdk}/v1/core/models.py | 2 +- .../v1/datasets/__init__.py | 2 +- .../v1/datasets/_client.py | 4 +- .../v1/datasets/branch.py | 8 +- .../v1/datasets/dataset.py | 14 +- .../v1/datasets/errors.py | 6 +- {foundry => foundry_sdk}/v1/datasets/file.py | 8 +- .../v1/datasets/models.py | 4 +- .../v1/datasets/transaction.py | 6 +- {foundry => foundry_sdk}/v1/geo/errors.py | 0 {foundry => foundry_sdk}/v1/geo/models.py | 2 +- .../v1}/ontologies/__init__.py | 2 +- .../v1/ontologies/_client.py | 12 +- .../v1/ontologies/action.py | 6 +- .../v1/ontologies/action_type.py | 8 +- .../v1/ontologies/attachment.py | 8 +- .../v1}/ontologies/errors.py | 6 +- .../v1/ontologies/models.py | 4 +- .../v1/ontologies/object_type.py | 8 +- .../v1/ontologies/ontology.py | 12 +- .../v1/ontologies/ontology_object.py | 8 +- .../v1/ontologies/query.py | 6 +- .../v1/ontologies/query_type.py | 8 +- {foundry/v1 => foundry_sdk/v2}/__init__.py | 2 +- {foundry => foundry_sdk}/v2/admin/__init__.py | 2 +- {foundry => foundry_sdk}/v2/admin/_client.py | 14 +- .../v2/admin/authentication_provider.py | 10 +- .../v2/admin/enrollment.py | 16 +- {foundry => foundry_sdk}/v2/admin/errors.py | 6 +- {foundry => foundry_sdk}/v2/admin/group.py | 14 +- .../v2/admin/group_member.py | 10 +- .../v2/admin/group_membership.py | 8 +- .../v2/admin/group_provider_info.py | 10 +- {foundry => foundry_sdk}/v2/admin/host.py | 10 +- {foundry => foundry_sdk}/v2/admin/marking.py | 14 +- .../v2/admin/marking_category.py | 10 +- .../v2/admin/marking_member.py | 10 +- .../v2/admin/marking_role_assignment.py | 10 +- {foundry => foundry_sdk}/v2/admin/models.py | 4 +- .../v2/admin/organization.py | 10 +- {foundry => foundry_sdk}/v2/admin/user.py | 14 +- .../v2/admin/user_provider_info.py | 10 +- .../v2/aip_agents/__init__.py | 2 +- .../v2/aip_agents/_client.py | 4 +- .../v2/aip_agents/agent.py | 14 +- .../v2/aip_agents/agent_version.py | 10 +- .../v2/aip_agents/content.py | 10 +- .../v2/aip_agents/errors.py | 8 +- .../v2/aip_agents/models.py | 8 +- .../v2/aip_agents/session.py | 12 +- {foundry => foundry_sdk}/v2/cli.py | 430 +-- {foundry => foundry_sdk}/v2/client.py | 28 +- .../v2/connectivity/__init__.py | 2 +- .../v2/connectivity/_client.py | 4 +- .../v2/connectivity/connection.py | 16 +- .../v2/connectivity/errors.py | 8 +- .../v2/connectivity/file_import.py | 14 +- .../v2/connectivity/models.py | 8 +- .../v2/connectivity/table_import.py | 14 +- {foundry => foundry_sdk}/v2/core/errors.py | 4 +- {foundry => foundry_sdk}/v2/core/models.py | 2 +- .../v2/datasets/__init__.py | 2 +- .../v2/datasets/_client.py | 4 +- .../v2/datasets/branch.py | 10 +- .../v2/datasets/dataset.py | 18 +- .../v2/datasets/errors.py | 8 +- {foundry => foundry_sdk}/v2/datasets/file.py | 10 +- .../v2/datasets/models.py | 6 +- .../v2/datasets/transaction.py | 10 +- .../v2/filesystem/__init__.py | 2 +- .../v2/filesystem/_client.py | 10 +- .../v2/filesystem/errors.py | 6 +- .../v2/filesystem/folder.py | 10 +- .../v2/filesystem/models.py | 4 +- .../v2/filesystem/project.py | 10 +- .../v2/filesystem/resource.py | 12 +- .../v2/filesystem/resource_role.py | 10 +- .../v2/filesystem/space.py | 8 +- .../v2/functions/__init__.py | 2 +- .../v2/functions/_client.py | 6 +- .../v2/functions/errors.py | 4 +- .../v2/functions/models.py | 4 +- .../v2/functions/query.py | 10 +- .../v2/functions/value_type.py | 12 +- .../v2/functions/version_id.py | 10 +- {foundry => foundry_sdk}/v2/geo/errors.py | 0 {foundry => foundry_sdk}/v2/geo/models.py | 2 +- .../v2/media_sets/__init__.py | 2 +- .../v2/media_sets/_client.py | 4 +- .../v2/media_sets/errors.py | 4 +- .../v2/media_sets/media_set.py | 8 +- .../v2/media_sets/models.py | 4 +- .../v2}/ontologies/__init__.py | 2 +- .../v2/ontologies/_client.py | 28 +- .../v2/ontologies/action.py | 6 +- .../v2/ontologies/action_type.py | 8 +- .../v2/ontologies/attachment.py | 8 +- .../v2/ontologies/attachment_property.py | 6 +- .../v2}/ontologies/errors.py | 6 +- .../v2/ontologies/linked_object.py | 8 +- .../v2/ontologies/media_reference_property.py | 8 +- .../v2/ontologies/models.py | 6 +- .../v2/ontologies/object_type.py | 8 +- .../v2/ontologies/ontology.py | 12 +- .../v2/ontologies/ontology_interface.py | 8 +- .../v2/ontologies/ontology_object.py | 8 +- .../v2/ontologies/ontology_object_set.py | 8 +- .../v2/ontologies/query.py | 6 +- .../v2/ontologies/query_type.py | 8 +- .../v2/ontologies/time_series_property_v2.py | 6 +- .../time_series_value_bank_property.py | 6 +- .../v2/orchestration/__init__.py | 2 +- .../v2/orchestration/_client.py | 10 +- .../v2/orchestration/build.py | 12 +- .../v2/orchestration/errors.py | 8 +- .../v2/orchestration/job.py | 10 +- .../v2/orchestration/models.py | 8 +- .../v2/orchestration/schedule.py | 10 +- .../v2/orchestration/schedule_version.py | 10 +- .../v2/sql_queries/__init__.py | 2 +- .../v2/sql_queries/_client.py | 4 +- .../v2/sql_queries/errors.py | 6 +- .../v2/sql_queries/models.py | 2 +- .../v2/sql_queries/query.py | 12 +- .../v2/streams/__init__.py | 2 +- .../v2/streams/_client.py | 4 +- .../v2/streams/dataset.py | 18 +- {foundry => foundry_sdk}/v2/streams/errors.py | 8 +- {foundry => foundry_sdk}/v2/streams/models.py | 8 +- {foundry => foundry_sdk}/v2/streams/stream.py | 12 +- .../v2/third_party_applications/__init__.py | 2 +- .../v2/third_party_applications/_client.py | 4 +- .../v2/third_party_applications/errors.py | 8 +- .../v2/third_party_applications/models.py | 4 +- .../third_party_application.py | 16 +- .../v2/third_party_applications/version.py | 14 +- .../v2/third_party_applications/website.py | 14 +- pyproject.toml | 6 +- scripts/set_version.py | 2 +- tests/auth/test_confidential_client.py | 4 +- ...confidential_client_oauth_flow_provider.py | 6 +- tests/auth/test_oauth_utils.py | 12 +- tests/auth/test_public_client.py | 12 +- .../test_public_client_oauth_flow_provider.py | 6 +- tests/auth/test_user_auth_token_client.py | 2 +- tests/test_api_client.py | 44 +- tests/test_discriminators.py | 38 +- tests/test_errors.py | 8 +- tests/test_exception.py | 10 +- tests/test_http_client.py | 6 +- tests/test_performance.py | 128 +- tests/test_resorce_import.py | 144 +- tests/test_resource_iterator.py | 2 +- tests/test_utils.py | 12 +- 262 files changed, 3827 insertions(+), 3799 deletions(-) delete mode 100644 foundry/__init__.py delete mode 100644 foundry/_core/__init__.py delete mode 100644 foundry/_errors/__init__.py create mode 100644 foundry_sdk/__init__.py create mode 100644 foundry_sdk/_core/__init__.py rename {foundry => foundry_sdk}/_core/api_client.py (93%) rename {foundry => foundry_sdk}/_core/auth_utils.py (96%) rename {foundry => foundry_sdk}/_core/binary_stream.py (100%) rename {foundry => foundry_sdk}/_core/compute_module_pipeline_auth.py (89%) rename {foundry => foundry_sdk}/_core/confidential_client_auth.py (92%) rename {foundry => foundry_sdk}/_core/config.py (100%) rename {foundry => foundry_sdk}/_core/http_client.py (94%) rename {foundry => foundry_sdk}/_core/oauth_utils.py (98%) rename {foundry => foundry_sdk}/_core/page_iterator.py (100%) rename {foundry => foundry_sdk}/_core/public_client_auth.py (92%) rename {foundry => foundry_sdk}/_core/resource_iterator.py (100%) rename {foundry => foundry_sdk}/_core/user_token_auth_client.py (89%) rename {foundry => foundry_sdk}/_core/utils.py (100%) create mode 100644 foundry_sdk/_errors/__init__.py rename {foundry => foundry_sdk}/_errors/api_not_found.py (91%) rename {foundry => foundry_sdk}/_errors/connection_error.py (92%) rename {foundry => foundry_sdk}/_errors/environment_not_configured.py (91%) rename {foundry => foundry_sdk}/_errors/not_authenticated.py (90%) rename {foundry => foundry_sdk}/_errors/palantir_exception.py (100%) rename {foundry => foundry_sdk}/_errors/palantir_rpc_exception.py (97%) rename {foundry => foundry_sdk}/_errors/sdk_internal_error.py (92%) rename {foundry => foundry_sdk}/_errors/stream_error.py (91%) rename {foundry => foundry_sdk}/_errors/timeout_error.py (89%) rename {foundry => foundry_sdk}/_errors/utils.py (93%) rename {foundry => foundry_sdk}/_versions.py (100%) rename {foundry => foundry_sdk}/py.typed (100%) rename {foundry/v2 => foundry_sdk/v1}/__init__.py (93%) rename {foundry => foundry_sdk}/v1/cli.py (96%) rename {foundry => foundry_sdk}/v1/client.py (88%) rename {foundry => foundry_sdk}/v1/core/errors.py (98%) rename {foundry => foundry_sdk}/v1/core/models.py (99%) rename {foundry => foundry_sdk}/v1/datasets/__init__.py (91%) rename {foundry => foundry_sdk}/v1/datasets/_client.py (93%) rename {foundry => foundry_sdk}/v1/datasets/branch.py (98%) rename {foundry => foundry_sdk}/v1/datasets/dataset.py (97%) rename {foundry => foundry_sdk}/v1/datasets/errors.py (98%) rename {foundry => foundry_sdk}/v1/datasets/file.py (99%) rename {foundry => foundry_sdk}/v1/datasets/models.py (98%) rename {foundry => foundry_sdk}/v1/datasets/transaction.py (98%) rename {foundry => foundry_sdk}/v1/geo/errors.py (100%) rename {foundry => foundry_sdk}/v1/geo/models.py (94%) rename {foundry/v2 => foundry_sdk/v1}/ontologies/__init__.py (91%) rename {foundry => foundry_sdk}/v1/ontologies/_client.py (84%) rename {foundry => foundry_sdk}/v1/ontologies/action.py (98%) rename {foundry => foundry_sdk}/v1/ontologies/action_type.py (97%) rename {foundry => foundry_sdk}/v1/ontologies/attachment.py (97%) rename {foundry/v2 => foundry_sdk/v1}/ontologies/errors.py (99%) rename {foundry => foundry_sdk}/v1/ontologies/models.py (99%) rename {foundry => foundry_sdk}/v1/ontologies/object_type.py (98%) rename {foundry => foundry_sdk}/v1/ontologies/ontology.py (93%) rename {foundry => foundry_sdk}/v1/ontologies/ontology_object.py (99%) rename {foundry => foundry_sdk}/v1/ontologies/query.py (96%) rename {foundry => foundry_sdk}/v1/ontologies/query_type.py (97%) rename {foundry/v1 => foundry_sdk/v2}/__init__.py (93%) rename {foundry => foundry_sdk}/v2/admin/__init__.py (92%) rename {foundry => foundry_sdk}/v2/admin/_client.py (84%) rename {foundry => foundry_sdk}/v2/admin/authentication_provider.py (98%) rename {foundry => foundry_sdk}/v2/admin/enrollment.py (93%) rename {foundry => foundry_sdk}/v2/admin/errors.py (99%) rename {foundry => foundry_sdk}/v2/admin/group.py (97%) rename {foundry => foundry_sdk}/v2/admin/group_member.py (97%) rename {foundry => foundry_sdk}/v2/admin/group_membership.py (96%) rename {foundry => foundry_sdk}/v2/admin/group_provider_info.py (96%) rename {foundry => foundry_sdk}/v2/admin/host.py (95%) rename {foundry => foundry_sdk}/v2/admin/marking.py (96%) rename {foundry => foundry_sdk}/v2/admin/marking_category.py (96%) rename {foundry => foundry_sdk}/v2/admin/marking_member.py (97%) rename {foundry => foundry_sdk}/v2/admin/marking_role_assignment.py (97%) rename {foundry => foundry_sdk}/v2/admin/models.py (99%) rename {foundry => foundry_sdk}/v2/admin/organization.py (96%) rename {foundry => foundry_sdk}/v2/admin/user.py (97%) rename {foundry => foundry_sdk}/v2/admin/user_provider_info.py (96%) rename {foundry => foundry_sdk}/v2/aip_agents/__init__.py (91%) rename {foundry => foundry_sdk}/v2/aip_agents/_client.py (93%) rename {foundry => foundry_sdk}/v2/aip_agents/agent.py (94%) rename {foundry => foundry_sdk}/v2/aip_agents/agent_version.py (96%) rename {foundry => foundry_sdk}/v2/aip_agents/content.py (93%) rename {foundry => foundry_sdk}/v2/aip_agents/errors.py (98%) rename {foundry => foundry_sdk}/v2/aip_agents/models.py (99%) rename {foundry => foundry_sdk}/v2/aip_agents/session.py (99%) rename {foundry => foundry_sdk}/v2/cli.py (96%) rename {foundry => foundry_sdk}/v2/client.py (70%) rename {foundry => foundry_sdk}/v2/connectivity/__init__.py (90%) rename {foundry => foundry_sdk}/v2/connectivity/_client.py (92%) rename {foundry => foundry_sdk}/v2/connectivity/connection.py (96%) rename {foundry => foundry_sdk}/v2/connectivity/errors.py (98%) rename {foundry => foundry_sdk}/v2/connectivity/file_import.py (98%) rename {foundry => foundry_sdk}/v2/connectivity/models.py (99%) rename {foundry => foundry_sdk}/v2/connectivity/table_import.py (97%) rename {foundry => foundry_sdk}/v2/core/errors.py (99%) rename {foundry => foundry_sdk}/v2/core/models.py (99%) rename {foundry => foundry_sdk}/v2/datasets/__init__.py (91%) rename {foundry => foundry_sdk}/v2/datasets/_client.py (93%) rename {foundry => foundry_sdk}/v2/datasets/branch.py (97%) rename {foundry => foundry_sdk}/v2/datasets/dataset.py (95%) rename {foundry => foundry_sdk}/v2/datasets/errors.py (98%) rename {foundry => foundry_sdk}/v2/datasets/file.py (99%) rename {foundry => foundry_sdk}/v2/datasets/models.py (97%) rename {foundry => foundry_sdk}/v2/datasets/transaction.py (98%) rename {foundry => foundry_sdk}/v2/filesystem/__init__.py (91%) rename {foundry => foundry_sdk}/v2/filesystem/_client.py (86%) rename {foundry => foundry_sdk}/v2/filesystem/errors.py (99%) rename {foundry => foundry_sdk}/v2/filesystem/folder.py (97%) rename {foundry => foundry_sdk}/v2/filesystem/models.py (99%) rename {foundry => foundry_sdk}/v2/filesystem/project.py (98%) rename {foundry => foundry_sdk}/v2/filesystem/resource.py (98%) rename {foundry => foundry_sdk}/v2/filesystem/resource_role.py (97%) rename {foundry => foundry_sdk}/v2/filesystem/space.py (95%) rename {foundry => foundry_sdk}/v2/functions/__init__.py (91%) rename {foundry => foundry_sdk}/v2/functions/_client.py (90%) rename {foundry => foundry_sdk}/v2/functions/errors.py (98%) rename {foundry => foundry_sdk}/v2/functions/models.py (99%) rename {foundry => foundry_sdk}/v2/functions/query.py (97%) rename {foundry => foundry_sdk}/v2/functions/value_type.py (92%) rename {foundry => foundry_sdk}/v2/functions/version_id.py (93%) rename {foundry => foundry_sdk}/v2/geo/errors.py (100%) rename {foundry => foundry_sdk}/v2/geo/models.py (99%) rename {foundry => foundry_sdk}/v2/media_sets/__init__.py (91%) rename {foundry => foundry_sdk}/v2/media_sets/_client.py (92%) rename {foundry => foundry_sdk}/v2/media_sets/errors.py (94%) rename {foundry => foundry_sdk}/v2/media_sets/media_set.py (99%) rename {foundry => foundry_sdk}/v2/media_sets/models.py (97%) rename {foundry/v1 => foundry_sdk/v2}/ontologies/__init__.py (91%) rename {foundry => foundry_sdk}/v2/ontologies/_client.py (78%) rename {foundry => foundry_sdk}/v2/ontologies/action.py (98%) rename {foundry => foundry_sdk}/v2/ontologies/action_type.py (97%) rename {foundry => foundry_sdk}/v2/ontologies/attachment.py (97%) rename {foundry => foundry_sdk}/v2/ontologies/attachment_property.py (99%) rename {foundry/v1 => foundry_sdk/v2}/ontologies/errors.py (99%) rename {foundry => foundry_sdk}/v2/ontologies/linked_object.py (98%) rename {foundry => foundry_sdk}/v2/ontologies/media_reference_property.py (98%) rename {foundry => foundry_sdk}/v2/ontologies/models.py (99%) rename {foundry => foundry_sdk}/v2/ontologies/object_type.py (98%) rename {foundry => foundry_sdk}/v2/ontologies/ontology.py (95%) rename {foundry => foundry_sdk}/v2/ontologies/ontology_interface.py (99%) rename {foundry => foundry_sdk}/v2/ontologies/ontology_object.py (99%) rename {foundry => foundry_sdk}/v2/ontologies/ontology_object_set.py (99%) rename {foundry => foundry_sdk}/v2/ontologies/query.py (97%) rename {foundry => foundry_sdk}/v2/ontologies/query_type.py (97%) rename {foundry => foundry_sdk}/v2/ontologies/time_series_property_v2.py (98%) rename {foundry => foundry_sdk}/v2/ontologies/time_series_value_bank_property.py (98%) rename {foundry => foundry_sdk}/v2/orchestration/__init__.py (90%) rename {foundry => foundry_sdk}/v2/orchestration/_client.py (85%) rename {foundry => foundry_sdk}/v2/orchestration/build.py (98%) rename {foundry => foundry_sdk}/v2/orchestration/errors.py (98%) rename {foundry => foundry_sdk}/v2/orchestration/job.py (95%) rename {foundry => foundry_sdk}/v2/orchestration/models.py (99%) rename {foundry => foundry_sdk}/v2/orchestration/schedule.py (98%) rename {foundry => foundry_sdk}/v2/orchestration/schedule_version.py (95%) rename {foundry => foundry_sdk}/v2/sql_queries/__init__.py (90%) rename {foundry => foundry_sdk}/v2/sql_queries/_client.py (93%) rename {foundry => foundry_sdk}/v2/sql_queries/errors.py (97%) rename {foundry => foundry_sdk}/v2/sql_queries/models.py (98%) rename {foundry => foundry_sdk}/v2/sql_queries/query.py (97%) rename {foundry => foundry_sdk}/v2/streams/__init__.py (91%) rename {foundry => foundry_sdk}/v2/streams/_client.py (93%) rename {foundry => foundry_sdk}/v2/streams/dataset.py (93%) rename {foundry => foundry_sdk}/v2/streams/errors.py (97%) rename {foundry => foundry_sdk}/v2/streams/models.py (96%) rename {foundry => foundry_sdk}/v2/streams/stream.py (98%) rename {foundry => foundry_sdk}/v2/third_party_applications/__init__.py (88%) rename {foundry => foundry_sdk}/v2/third_party_applications/_client.py (92%) rename {foundry => foundry_sdk}/v2/third_party_applications/errors.py (97%) rename {foundry => foundry_sdk}/v2/third_party_applications/models.py (97%) rename {foundry => foundry_sdk}/v2/third_party_applications/third_party_application.py (90%) rename {foundry => foundry_sdk}/v2/third_party_applications/version.py (97%) rename {foundry => foundry_sdk}/v2/third_party_applications/website.py (95%) diff --git a/README.md b/README.md index ee66e14d1..ec4d8bda8 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ > This SDK is incubating and subject to change. The Foundry Platform SDK is a Python SDK built on top of the Foundry API. -Review [Foundry API documentation](https://www.palantir.com/docs/foundry/api/) for more details. +Review [Foundry API documentation](https://www.palantir.com/docs/foundry_sdk/api/) for more details. > [!NOTE] > This Python package is automatically generated based on the Foundry API specification. @@ -54,10 +54,10 @@ https:///api/v1/... This SDK exposes several clients, one for each major version of the API. For example, the latest major version of the SDK is **v2** and is exposed using the `FoundryClient` located in the -`foundry.v2` package. To use this SDK, you must choose the specific client (or clients) +`foundry_sdk.v2` package. To use this SDK, you must choose the specific client (or clients) you would like to use. -More information about how the API is versioned can be found [here](https://www.palantir.com/docs/foundry/api/general/overview/versioning/). +More information about how the API is versioned can be found [here](https://www.palantir.com/docs/foundry_sdk/api/general/overview/versioning/). ## Authorization and client initalization @@ -87,11 +87,11 @@ You can pass in the hostname and token as keyword arguments when initializing the `UserTokenAuth`: ```python -import foundry -import foundry.v2 +import foundry_sdk +import foundry_sdk.v2 -client = foundry.v2.FoundryClient( - auth=foundry.UserTokenAuth(token=os.environ["BEARER_TOKEN"]), +client = foundry_sdk.v2.FoundryClient( + auth=foundry_sdk.UserTokenAuth(token=os.environ["BEARER_TOKEN"]), hostname="example.palantirfoundry.com", ) @@ -110,9 +110,9 @@ lifespan (one hour), we automatically retry all operations one time if a `401` (Unauthorized) error is thrown after refreshing the token. ```python -import foundry +import foundry_sdk -auth = foundry.ConfidentialClientAuth( +auth = foundry_sdk.ConfidentialClientAuth( client_id=os.environ["CLIENT_ID"], client_secret=os.environ["CLIENT_SECRET"], scopes=[...], # optional list of scopes @@ -127,9 +127,9 @@ auth = foundry.ConfidentialClientAuth( After creating the `ConfidentialClientAuth` object, pass it in to the `FoundryClient`, ```python -import foundry.v2 +import foundry_sdk.v2 -client = foundry.v2.FoundryClient(auth=auth, hostname="example.palantirfoundry.com") +client = foundry_sdk.v2.FoundryClient(auth=auth, hostname="example.palantirfoundry.com") ``` @@ -146,11 +146,11 @@ best suited for your instance before following this example. For simplicity, the purposes. ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -166,7 +166,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Branch.create: %s\n" % e) ``` @@ -234,7 +234,7 @@ class DatasetNotFound(NotFoundError): As a user, you can catch this exception and handle it accordingly. ```python -from foundry.v2.datasets.errors import DatasetNotFound +from foundry_sdk.v2.datasets.errors import DatasetNotFound try: response = client.datasets.Dataset.get(dataset_rid) @@ -261,8 +261,8 @@ catch a generic subclass of `PalantirRPCException` such as `BadRequestError` or | Other | `PalantirRPCException` | ```python -from foundry import PalantirRPCException -from foundry import UnauthorizedError +from foundry_sdk import PalantirRPCException +from foundry_sdk import UnauthorizedError try: api_response = client.datasets.Dataset.get(dataset_rid) @@ -274,13 +274,13 @@ except PalantirRPCException as e: ``` -All HTTP exceptions will have the following properties. See the [Foundry API docs](https://www.palantir.com/docs/foundry/api/general/overview/errors) for details about the Foundry error information. +All HTTP exceptions will have the following properties. See the [Foundry API docs](https://www.palantir.com/docs/foundry_sdk/api/general/overview/errors) for details about the Foundry error information. | Property | Type | Description | | ----------------- | -----------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| name | str | The Palantir error name. See the [Foundry API docs](https://www.palantir.com/docs/foundry/api/general/overview/errors). | -| error_instance_id | str | The Palantir error instance ID. See the [Foundry API docs](https://www.palantir.com/docs/foundry/api/general/overview/errors). | -| parameters | Dict[str, Any] | The Palantir error parameters. See the [Foundry API docs](https://www.palantir.com/docs/foundry/api/general/overview/errors). | +| name | str | The Palantir error name. See the [Foundry API docs](https://www.palantir.com/docs/foundry_sdk/api/general/overview/errors). | +| error_instance_id | str | The Palantir error instance ID. See the [Foundry API docs](https://www.palantir.com/docs/foundry_sdk/api/general/overview/errors). | +| parameters | Dict[str, Any] | The Palantir error parameters. See the [Foundry API docs](https://www.palantir.com/docs/foundry_sdk/api/general/overview/errors). | ### Other exceptions There are a handful of other exception classes that could be thrown when instantiating or using a client. @@ -373,10 +373,10 @@ All request parameters and responses with nested fields are typed using a Pydant ``` ```python -import foundry.v2 -from foundry.v2.admin.models import GroupSearchFilter +import foundry_sdk.v2 +from foundry_sdk.v2.admin.models import GroupSearchFilter -client = foundry.v2.FoundryClient(...) +client = foundry_sdk.v2.FoundryClient(...) result = client.admin.Group.search(where=GroupSearchFilter(type="queryString", value="John Doe")) print(result.data) @@ -405,9 +405,9 @@ print(branch.branchName) You can configure various parts of the HTTP session using the `Config` class. ```python -from foundry import Config -from foundry import UserTokenAuth -from foundry.v2 import FoundryClient +from foundry_sdk import Config +from foundry_sdk import UserTokenAuth +from foundry_sdk.v2 import FoundryClient client = FoundryClient( auth=UserTokenAuth(...), @@ -698,988 +698,988 @@ Namespace | Resource | Operation | HTTP request | Namespace | Name | Import | --------- | ---- | ------ | -**Admin** | [AttributeName](docs/v2/Admin/models/AttributeName.md) | `from foundry.v2.admin.models import AttributeName` | -**Admin** | [AttributeValue](docs/v2/Admin/models/AttributeValue.md) | `from foundry.v2.admin.models import AttributeValue` | -**Admin** | [AttributeValues](docs/v2/Admin/models/AttributeValues.md) | `from foundry.v2.admin.models import AttributeValues` | -**Admin** | [AuthenticationProtocol](docs/v2/Admin/models/AuthenticationProtocol.md) | `from foundry.v2.admin.models import AuthenticationProtocol` | -**Admin** | [AuthenticationProvider](docs/v2/Admin/models/AuthenticationProvider.md) | `from foundry.v2.admin.models import AuthenticationProvider` | -**Admin** | [AuthenticationProviderEnabled](docs/v2/Admin/models/AuthenticationProviderEnabled.md) | `from foundry.v2.admin.models import AuthenticationProviderEnabled` | -**Admin** | [AuthenticationProviderName](docs/v2/Admin/models/AuthenticationProviderName.md) | `from foundry.v2.admin.models import AuthenticationProviderName` | -**Admin** | [AuthenticationProviderRid](docs/v2/Admin/models/AuthenticationProviderRid.md) | `from foundry.v2.admin.models import AuthenticationProviderRid` | -**Admin** | [CertificateInfo](docs/v2/Admin/models/CertificateInfo.md) | `from foundry.v2.admin.models import CertificateInfo` | -**Admin** | [CertificateUsageType](docs/v2/Admin/models/CertificateUsageType.md) | `from foundry.v2.admin.models import CertificateUsageType` | -**Admin** | [Enrollment](docs/v2/Admin/models/Enrollment.md) | `from foundry.v2.admin.models import Enrollment` | -**Admin** | [EnrollmentName](docs/v2/Admin/models/EnrollmentName.md) | `from foundry.v2.admin.models import EnrollmentName` | -**Admin** | [GetGroupsBatchRequestElement](docs/v2/Admin/models/GetGroupsBatchRequestElement.md) | `from foundry.v2.admin.models import GetGroupsBatchRequestElement` | -**Admin** | [GetGroupsBatchResponse](docs/v2/Admin/models/GetGroupsBatchResponse.md) | `from foundry.v2.admin.models import GetGroupsBatchResponse` | -**Admin** | [GetMarkingsBatchRequestElement](docs/v2/Admin/models/GetMarkingsBatchRequestElement.md) | `from foundry.v2.admin.models import GetMarkingsBatchRequestElement` | -**Admin** | [GetMarkingsBatchResponse](docs/v2/Admin/models/GetMarkingsBatchResponse.md) | `from foundry.v2.admin.models import GetMarkingsBatchResponse` | -**Admin** | [GetUserMarkingsResponse](docs/v2/Admin/models/GetUserMarkingsResponse.md) | `from foundry.v2.admin.models import GetUserMarkingsResponse` | -**Admin** | [GetUsersBatchRequestElement](docs/v2/Admin/models/GetUsersBatchRequestElement.md) | `from foundry.v2.admin.models import GetUsersBatchRequestElement` | -**Admin** | [GetUsersBatchResponse](docs/v2/Admin/models/GetUsersBatchResponse.md) | `from foundry.v2.admin.models import GetUsersBatchResponse` | -**Admin** | [Group](docs/v2/Admin/models/Group.md) | `from foundry.v2.admin.models import Group` | -**Admin** | [GroupMember](docs/v2/Admin/models/GroupMember.md) | `from foundry.v2.admin.models import GroupMember` | -**Admin** | [GroupMembership](docs/v2/Admin/models/GroupMembership.md) | `from foundry.v2.admin.models import GroupMembership` | -**Admin** | [GroupMembershipExpiration](docs/v2/Admin/models/GroupMembershipExpiration.md) | `from foundry.v2.admin.models import GroupMembershipExpiration` | -**Admin** | [GroupName](docs/v2/Admin/models/GroupName.md) | `from foundry.v2.admin.models import GroupName` | -**Admin** | [GroupProviderInfo](docs/v2/Admin/models/GroupProviderInfo.md) | `from foundry.v2.admin.models import GroupProviderInfo` | -**Admin** | [GroupSearchFilter](docs/v2/Admin/models/GroupSearchFilter.md) | `from foundry.v2.admin.models import GroupSearchFilter` | -**Admin** | [Host](docs/v2/Admin/models/Host.md) | `from foundry.v2.admin.models import Host` | -**Admin** | [HostName](docs/v2/Admin/models/HostName.md) | `from foundry.v2.admin.models import HostName` | -**Admin** | [ListAuthenticationProvidersResponse](docs/v2/Admin/models/ListAuthenticationProvidersResponse.md) | `from foundry.v2.admin.models import ListAuthenticationProvidersResponse` | -**Admin** | [ListGroupMembershipsResponse](docs/v2/Admin/models/ListGroupMembershipsResponse.md) | `from foundry.v2.admin.models import ListGroupMembershipsResponse` | -**Admin** | [ListGroupMembersResponse](docs/v2/Admin/models/ListGroupMembersResponse.md) | `from foundry.v2.admin.models import ListGroupMembersResponse` | -**Admin** | [ListGroupsResponse](docs/v2/Admin/models/ListGroupsResponse.md) | `from foundry.v2.admin.models import ListGroupsResponse` | -**Admin** | [ListHostsResponse](docs/v2/Admin/models/ListHostsResponse.md) | `from foundry.v2.admin.models import ListHostsResponse` | -**Admin** | [ListMarkingCategoriesResponse](docs/v2/Admin/models/ListMarkingCategoriesResponse.md) | `from foundry.v2.admin.models import ListMarkingCategoriesResponse` | -**Admin** | [ListMarkingMembersResponse](docs/v2/Admin/models/ListMarkingMembersResponse.md) | `from foundry.v2.admin.models import ListMarkingMembersResponse` | -**Admin** | [ListMarkingRoleAssignmentsResponse](docs/v2/Admin/models/ListMarkingRoleAssignmentsResponse.md) | `from foundry.v2.admin.models import ListMarkingRoleAssignmentsResponse` | -**Admin** | [ListMarkingsResponse](docs/v2/Admin/models/ListMarkingsResponse.md) | `from foundry.v2.admin.models import ListMarkingsResponse` | -**Admin** | [ListUsersResponse](docs/v2/Admin/models/ListUsersResponse.md) | `from foundry.v2.admin.models import ListUsersResponse` | -**Admin** | [Marking](docs/v2/Admin/models/Marking.md) | `from foundry.v2.admin.models import Marking` | -**Admin** | [MarkingCategory](docs/v2/Admin/models/MarkingCategory.md) | `from foundry.v2.admin.models import MarkingCategory` | -**Admin** | [MarkingCategoryId](docs/v2/Admin/models/MarkingCategoryId.md) | `from foundry.v2.admin.models import MarkingCategoryId` | -**Admin** | [MarkingCategoryName](docs/v2/Admin/models/MarkingCategoryName.md) | `from foundry.v2.admin.models import MarkingCategoryName` | -**Admin** | [MarkingCategoryType](docs/v2/Admin/models/MarkingCategoryType.md) | `from foundry.v2.admin.models import MarkingCategoryType` | -**Admin** | [MarkingMember](docs/v2/Admin/models/MarkingMember.md) | `from foundry.v2.admin.models import MarkingMember` | -**Admin** | [MarkingName](docs/v2/Admin/models/MarkingName.md) | `from foundry.v2.admin.models import MarkingName` | -**Admin** | [MarkingRole](docs/v2/Admin/models/MarkingRole.md) | `from foundry.v2.admin.models import MarkingRole` | -**Admin** | [MarkingRoleAssignment](docs/v2/Admin/models/MarkingRoleAssignment.md) | `from foundry.v2.admin.models import MarkingRoleAssignment` | -**Admin** | [MarkingRoleUpdate](docs/v2/Admin/models/MarkingRoleUpdate.md) | `from foundry.v2.admin.models import MarkingRoleUpdate` | -**Admin** | [MarkingType](docs/v2/Admin/models/MarkingType.md) | `from foundry.v2.admin.models import MarkingType` | -**Admin** | [OidcAuthenticationProtocol](docs/v2/Admin/models/OidcAuthenticationProtocol.md) | `from foundry.v2.admin.models import OidcAuthenticationProtocol` | -**Admin** | [Organization](docs/v2/Admin/models/Organization.md) | `from foundry.v2.admin.models import Organization` | -**Admin** | [OrganizationName](docs/v2/Admin/models/OrganizationName.md) | `from foundry.v2.admin.models import OrganizationName` | -**Admin** | [PrincipalFilterType](docs/v2/Admin/models/PrincipalFilterType.md) | `from foundry.v2.admin.models import PrincipalFilterType` | -**Admin** | [ProviderId](docs/v2/Admin/models/ProviderId.md) | `from foundry.v2.admin.models import ProviderId` | -**Admin** | [SamlAuthenticationProtocol](docs/v2/Admin/models/SamlAuthenticationProtocol.md) | `from foundry.v2.admin.models import SamlAuthenticationProtocol` | -**Admin** | [SamlServiceProviderMetadata](docs/v2/Admin/models/SamlServiceProviderMetadata.md) | `from foundry.v2.admin.models import SamlServiceProviderMetadata` | -**Admin** | [SearchGroupsResponse](docs/v2/Admin/models/SearchGroupsResponse.md) | `from foundry.v2.admin.models import SearchGroupsResponse` | -**Admin** | [SearchUsersResponse](docs/v2/Admin/models/SearchUsersResponse.md) | `from foundry.v2.admin.models import SearchUsersResponse` | -**Admin** | [User](docs/v2/Admin/models/User.md) | `from foundry.v2.admin.models import User` | -**Admin** | [UserProviderInfo](docs/v2/Admin/models/UserProviderInfo.md) | `from foundry.v2.admin.models import UserProviderInfo` | -**Admin** | [UserSearchFilter](docs/v2/Admin/models/UserSearchFilter.md) | `from foundry.v2.admin.models import UserSearchFilter` | -**Admin** | [UserUsername](docs/v2/Admin/models/UserUsername.md) | `from foundry.v2.admin.models import UserUsername` | -**AipAgents** | [Agent](docs/v2/AipAgents/models/Agent.md) | `from foundry.v2.aip_agents.models import Agent` | -**AipAgents** | [AgentMarkdownResponse](docs/v2/AipAgents/models/AgentMarkdownResponse.md) | `from foundry.v2.aip_agents.models import AgentMarkdownResponse` | -**AipAgents** | [AgentMetadata](docs/v2/AipAgents/models/AgentMetadata.md) | `from foundry.v2.aip_agents.models import AgentMetadata` | -**AipAgents** | [AgentRid](docs/v2/AipAgents/models/AgentRid.md) | `from foundry.v2.aip_agents.models import AgentRid` | -**AipAgents** | [AgentSessionRagContextResponse](docs/v2/AipAgents/models/AgentSessionRagContextResponse.md) | `from foundry.v2.aip_agents.models import AgentSessionRagContextResponse` | -**AipAgents** | [AgentsSessionsPage](docs/v2/AipAgents/models/AgentsSessionsPage.md) | `from foundry.v2.aip_agents.models import AgentsSessionsPage` | -**AipAgents** | [AgentVersion](docs/v2/AipAgents/models/AgentVersion.md) | `from foundry.v2.aip_agents.models import AgentVersion` | -**AipAgents** | [AgentVersionDetails](docs/v2/AipAgents/models/AgentVersionDetails.md) | `from foundry.v2.aip_agents.models import AgentVersionDetails` | -**AipAgents** | [AgentVersionString](docs/v2/AipAgents/models/AgentVersionString.md) | `from foundry.v2.aip_agents.models import AgentVersionString` | -**AipAgents** | [CancelSessionResponse](docs/v2/AipAgents/models/CancelSessionResponse.md) | `from foundry.v2.aip_agents.models import CancelSessionResponse` | -**AipAgents** | [Content](docs/v2/AipAgents/models/Content.md) | `from foundry.v2.aip_agents.models import Content` | -**AipAgents** | [FunctionRetrievedContext](docs/v2/AipAgents/models/FunctionRetrievedContext.md) | `from foundry.v2.aip_agents.models import FunctionRetrievedContext` | -**AipAgents** | [InputContext](docs/v2/AipAgents/models/InputContext.md) | `from foundry.v2.aip_agents.models import InputContext` | -**AipAgents** | [ListAgentVersionsResponse](docs/v2/AipAgents/models/ListAgentVersionsResponse.md) | `from foundry.v2.aip_agents.models import ListAgentVersionsResponse` | -**AipAgents** | [ListSessionsResponse](docs/v2/AipAgents/models/ListSessionsResponse.md) | `from foundry.v2.aip_agents.models import ListSessionsResponse` | -**AipAgents** | [MessageId](docs/v2/AipAgents/models/MessageId.md) | `from foundry.v2.aip_agents.models import MessageId` | -**AipAgents** | [ObjectContext](docs/v2/AipAgents/models/ObjectContext.md) | `from foundry.v2.aip_agents.models import ObjectContext` | -**AipAgents** | [ObjectSetParameter](docs/v2/AipAgents/models/ObjectSetParameter.md) | `from foundry.v2.aip_agents.models import ObjectSetParameter` | -**AipAgents** | [ObjectSetParameterValue](docs/v2/AipAgents/models/ObjectSetParameterValue.md) | `from foundry.v2.aip_agents.models import ObjectSetParameterValue` | -**AipAgents** | [ObjectSetParameterValueUpdate](docs/v2/AipAgents/models/ObjectSetParameterValueUpdate.md) | `from foundry.v2.aip_agents.models import ObjectSetParameterValueUpdate` | -**AipAgents** | [Parameter](docs/v2/AipAgents/models/Parameter.md) | `from foundry.v2.aip_agents.models import Parameter` | -**AipAgents** | [ParameterAccessMode](docs/v2/AipAgents/models/ParameterAccessMode.md) | `from foundry.v2.aip_agents.models import ParameterAccessMode` | -**AipAgents** | [ParameterId](docs/v2/AipAgents/models/ParameterId.md) | `from foundry.v2.aip_agents.models import ParameterId` | -**AipAgents** | [ParameterType](docs/v2/AipAgents/models/ParameterType.md) | `from foundry.v2.aip_agents.models import ParameterType` | -**AipAgents** | [ParameterValue](docs/v2/AipAgents/models/ParameterValue.md) | `from foundry.v2.aip_agents.models import ParameterValue` | -**AipAgents** | [ParameterValueUpdate](docs/v2/AipAgents/models/ParameterValueUpdate.md) | `from foundry.v2.aip_agents.models import ParameterValueUpdate` | -**AipAgents** | [Session](docs/v2/AipAgents/models/Session.md) | `from foundry.v2.aip_agents.models import Session` | -**AipAgents** | [SessionExchange](docs/v2/AipAgents/models/SessionExchange.md) | `from foundry.v2.aip_agents.models import SessionExchange` | -**AipAgents** | [SessionExchangeContexts](docs/v2/AipAgents/models/SessionExchangeContexts.md) | `from foundry.v2.aip_agents.models import SessionExchangeContexts` | -**AipAgents** | [SessionExchangeResult](docs/v2/AipAgents/models/SessionExchangeResult.md) | `from foundry.v2.aip_agents.models import SessionExchangeResult` | -**AipAgents** | [SessionMetadata](docs/v2/AipAgents/models/SessionMetadata.md) | `from foundry.v2.aip_agents.models import SessionMetadata` | -**AipAgents** | [SessionRid](docs/v2/AipAgents/models/SessionRid.md) | `from foundry.v2.aip_agents.models import SessionRid` | -**AipAgents** | [StringParameter](docs/v2/AipAgents/models/StringParameter.md) | `from foundry.v2.aip_agents.models import StringParameter` | -**AipAgents** | [StringParameterValue](docs/v2/AipAgents/models/StringParameterValue.md) | `from foundry.v2.aip_agents.models import StringParameterValue` | -**AipAgents** | [UserTextInput](docs/v2/AipAgents/models/UserTextInput.md) | `from foundry.v2.aip_agents.models import UserTextInput` | -**Connectivity** | [ApiKeyAuthentication](docs/v2/Connectivity/models/ApiKeyAuthentication.md) | `from foundry.v2.connectivity.models import ApiKeyAuthentication` | -**Connectivity** | [AsPlaintextValue](docs/v2/Connectivity/models/AsPlaintextValue.md) | `from foundry.v2.connectivity.models import AsPlaintextValue` | -**Connectivity** | [AsSecretName](docs/v2/Connectivity/models/AsSecretName.md) | `from foundry.v2.connectivity.models import AsSecretName` | -**Connectivity** | [AwsAccessKey](docs/v2/Connectivity/models/AwsAccessKey.md) | `from foundry.v2.connectivity.models import AwsAccessKey` | -**Connectivity** | [AwsOidcAuthentication](docs/v2/Connectivity/models/AwsOidcAuthentication.md) | `from foundry.v2.connectivity.models import AwsOidcAuthentication` | -**Connectivity** | [BasicCredentials](docs/v2/Connectivity/models/BasicCredentials.md) | `from foundry.v2.connectivity.models import BasicCredentials` | -**Connectivity** | [BearerToken](docs/v2/Connectivity/models/BearerToken.md) | `from foundry.v2.connectivity.models import BearerToken` | -**Connectivity** | [CloudIdentity](docs/v2/Connectivity/models/CloudIdentity.md) | `from foundry.v2.connectivity.models import CloudIdentity` | -**Connectivity** | [CloudIdentityRid](docs/v2/Connectivity/models/CloudIdentityRid.md) | `from foundry.v2.connectivity.models import CloudIdentityRid` | -**Connectivity** | [Connection](docs/v2/Connectivity/models/Connection.md) | `from foundry.v2.connectivity.models import Connection` | -**Connectivity** | [ConnectionConfiguration](docs/v2/Connectivity/models/ConnectionConfiguration.md) | `from foundry.v2.connectivity.models import ConnectionConfiguration` | -**Connectivity** | [ConnectionDisplayName](docs/v2/Connectivity/models/ConnectionDisplayName.md) | `from foundry.v2.connectivity.models import ConnectionDisplayName` | -**Connectivity** | [ConnectionRid](docs/v2/Connectivity/models/ConnectionRid.md) | `from foundry.v2.connectivity.models import ConnectionRid` | -**Connectivity** | [CreateConnectionRequestConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestConnectionConfiguration.md) | `from foundry.v2.connectivity.models import CreateConnectionRequestConnectionConfiguration` | -**Connectivity** | [CreateConnectionRequestJdbcConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestJdbcConnectionConfiguration.md) | `from foundry.v2.connectivity.models import CreateConnectionRequestJdbcConnectionConfiguration` | -**Connectivity** | [CreateConnectionRequestRestConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestRestConnectionConfiguration.md) | `from foundry.v2.connectivity.models import CreateConnectionRequestRestConnectionConfiguration` | -**Connectivity** | [CreateConnectionRequestS3ConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestS3ConnectionConfiguration.md) | `from foundry.v2.connectivity.models import CreateConnectionRequestS3ConnectionConfiguration` | -**Connectivity** | [CreateTableImportRequestJdbcImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestJdbcImportConfig.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestJdbcImportConfig` | -**Connectivity** | [CreateTableImportRequestMicrosoftAccessImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfig.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestMicrosoftAccessImportConfig` | -**Connectivity** | [CreateTableImportRequestMicrosoftSqlServerImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfig.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestMicrosoftSqlServerImportConfig` | -**Connectivity** | [CreateTableImportRequestOracleImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestOracleImportConfig.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestOracleImportConfig` | -**Connectivity** | [CreateTableImportRequestPostgreSqlImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestPostgreSqlImportConfig.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestPostgreSqlImportConfig` | -**Connectivity** | [CreateTableImportRequestTableImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfig.md) | `from foundry.v2.connectivity.models import CreateTableImportRequestTableImportConfig` | -**Connectivity** | [Domain](docs/v2/Connectivity/models/Domain.md) | `from foundry.v2.connectivity.models import Domain` | -**Connectivity** | [EncryptedProperty](docs/v2/Connectivity/models/EncryptedProperty.md) | `from foundry.v2.connectivity.models import EncryptedProperty` | -**Connectivity** | [FileAnyPathMatchesFilter](docs/v2/Connectivity/models/FileAnyPathMatchesFilter.md) | `from foundry.v2.connectivity.models import FileAnyPathMatchesFilter` | -**Connectivity** | [FileAtLeastCountFilter](docs/v2/Connectivity/models/FileAtLeastCountFilter.md) | `from foundry.v2.connectivity.models import FileAtLeastCountFilter` | -**Connectivity** | [FileChangedSinceLastUploadFilter](docs/v2/Connectivity/models/FileChangedSinceLastUploadFilter.md) | `from foundry.v2.connectivity.models import FileChangedSinceLastUploadFilter` | -**Connectivity** | [FileImport](docs/v2/Connectivity/models/FileImport.md) | `from foundry.v2.connectivity.models import FileImport` | -**Connectivity** | [FileImportCustomFilter](docs/v2/Connectivity/models/FileImportCustomFilter.md) | `from foundry.v2.connectivity.models import FileImportCustomFilter` | -**Connectivity** | [FileImportDisplayName](docs/v2/Connectivity/models/FileImportDisplayName.md) | `from foundry.v2.connectivity.models import FileImportDisplayName` | -**Connectivity** | [FileImportFilter](docs/v2/Connectivity/models/FileImportFilter.md) | `from foundry.v2.connectivity.models import FileImportFilter` | -**Connectivity** | [FileImportMode](docs/v2/Connectivity/models/FileImportMode.md) | `from foundry.v2.connectivity.models import FileImportMode` | -**Connectivity** | [FileImportRid](docs/v2/Connectivity/models/FileImportRid.md) | `from foundry.v2.connectivity.models import FileImportRid` | -**Connectivity** | [FileLastModifiedAfterFilter](docs/v2/Connectivity/models/FileLastModifiedAfterFilter.md) | `from foundry.v2.connectivity.models import FileLastModifiedAfterFilter` | -**Connectivity** | [FilePathMatchesFilter](docs/v2/Connectivity/models/FilePathMatchesFilter.md) | `from foundry.v2.connectivity.models import FilePathMatchesFilter` | -**Connectivity** | [FilePathNotMatchesFilter](docs/v2/Connectivity/models/FilePathNotMatchesFilter.md) | `from foundry.v2.connectivity.models import FilePathNotMatchesFilter` | -**Connectivity** | [FileProperty](docs/v2/Connectivity/models/FileProperty.md) | `from foundry.v2.connectivity.models import FileProperty` | -**Connectivity** | [FilesCountLimitFilter](docs/v2/Connectivity/models/FilesCountLimitFilter.md) | `from foundry.v2.connectivity.models import FilesCountLimitFilter` | -**Connectivity** | [FileSizeFilter](docs/v2/Connectivity/models/FileSizeFilter.md) | `from foundry.v2.connectivity.models import FileSizeFilter` | -**Connectivity** | [HeaderApiKey](docs/v2/Connectivity/models/HeaderApiKey.md) | `from foundry.v2.connectivity.models import HeaderApiKey` | -**Connectivity** | [JdbcConnectionConfiguration](docs/v2/Connectivity/models/JdbcConnectionConfiguration.md) | `from foundry.v2.connectivity.models import JdbcConnectionConfiguration` | -**Connectivity** | [JdbcImportConfig](docs/v2/Connectivity/models/JdbcImportConfig.md) | `from foundry.v2.connectivity.models import JdbcImportConfig` | -**Connectivity** | [ListFileImportsResponse](docs/v2/Connectivity/models/ListFileImportsResponse.md) | `from foundry.v2.connectivity.models import ListFileImportsResponse` | -**Connectivity** | [ListTableImportsResponse](docs/v2/Connectivity/models/ListTableImportsResponse.md) | `from foundry.v2.connectivity.models import ListTableImportsResponse` | -**Connectivity** | [MicrosoftAccessImportConfig](docs/v2/Connectivity/models/MicrosoftAccessImportConfig.md) | `from foundry.v2.connectivity.models import MicrosoftAccessImportConfig` | -**Connectivity** | [MicrosoftSqlServerImportConfig](docs/v2/Connectivity/models/MicrosoftSqlServerImportConfig.md) | `from foundry.v2.connectivity.models import MicrosoftSqlServerImportConfig` | -**Connectivity** | [OracleImportConfig](docs/v2/Connectivity/models/OracleImportConfig.md) | `from foundry.v2.connectivity.models import OracleImportConfig` | -**Connectivity** | [PlaintextValue](docs/v2/Connectivity/models/PlaintextValue.md) | `from foundry.v2.connectivity.models import PlaintextValue` | -**Connectivity** | [PostgreSqlImportConfig](docs/v2/Connectivity/models/PostgreSqlImportConfig.md) | `from foundry.v2.connectivity.models import PostgreSqlImportConfig` | -**Connectivity** | [Protocol](docs/v2/Connectivity/models/Protocol.md) | `from foundry.v2.connectivity.models import Protocol` | -**Connectivity** | [QueryParameterApiKey](docs/v2/Connectivity/models/QueryParameterApiKey.md) | `from foundry.v2.connectivity.models import QueryParameterApiKey` | -**Connectivity** | [Region](docs/v2/Connectivity/models/Region.md) | `from foundry.v2.connectivity.models import Region` | -**Connectivity** | [RestAuthenticationMode](docs/v2/Connectivity/models/RestAuthenticationMode.md) | `from foundry.v2.connectivity.models import RestAuthenticationMode` | -**Connectivity** | [RestConnectionAdditionalSecrets](docs/v2/Connectivity/models/RestConnectionAdditionalSecrets.md) | `from foundry.v2.connectivity.models import RestConnectionAdditionalSecrets` | -**Connectivity** | [RestConnectionConfiguration](docs/v2/Connectivity/models/RestConnectionConfiguration.md) | `from foundry.v2.connectivity.models import RestConnectionConfiguration` | -**Connectivity** | [RestConnectionOAuth2](docs/v2/Connectivity/models/RestConnectionOAuth2.md) | `from foundry.v2.connectivity.models import RestConnectionOAuth2` | -**Connectivity** | [RestRequestApiKeyLocation](docs/v2/Connectivity/models/RestRequestApiKeyLocation.md) | `from foundry.v2.connectivity.models import RestRequestApiKeyLocation` | -**Connectivity** | [S3AuthenticationMode](docs/v2/Connectivity/models/S3AuthenticationMode.md) | `from foundry.v2.connectivity.models import S3AuthenticationMode` | -**Connectivity** | [S3ConnectionConfiguration](docs/v2/Connectivity/models/S3ConnectionConfiguration.md) | `from foundry.v2.connectivity.models import S3ConnectionConfiguration` | -**Connectivity** | [S3KmsConfiguration](docs/v2/Connectivity/models/S3KmsConfiguration.md) | `from foundry.v2.connectivity.models import S3KmsConfiguration` | -**Connectivity** | [S3ProxyConfiguration](docs/v2/Connectivity/models/S3ProxyConfiguration.md) | `from foundry.v2.connectivity.models import S3ProxyConfiguration` | -**Connectivity** | [SecretName](docs/v2/Connectivity/models/SecretName.md) | `from foundry.v2.connectivity.models import SecretName` | -**Connectivity** | [SecretsNames](docs/v2/Connectivity/models/SecretsNames.md) | `from foundry.v2.connectivity.models import SecretsNames` | -**Connectivity** | [SecretsWithPlaintextValues](docs/v2/Connectivity/models/SecretsWithPlaintextValues.md) | `from foundry.v2.connectivity.models import SecretsWithPlaintextValues` | -**Connectivity** | [StsRoleConfiguration](docs/v2/Connectivity/models/StsRoleConfiguration.md) | `from foundry.v2.connectivity.models import StsRoleConfiguration` | -**Connectivity** | [TableImport](docs/v2/Connectivity/models/TableImport.md) | `from foundry.v2.connectivity.models import TableImport` | -**Connectivity** | [TableImportAllowSchemaChanges](docs/v2/Connectivity/models/TableImportAllowSchemaChanges.md) | `from foundry.v2.connectivity.models import TableImportAllowSchemaChanges` | -**Connectivity** | [TableImportConfig](docs/v2/Connectivity/models/TableImportConfig.md) | `from foundry.v2.connectivity.models import TableImportConfig` | -**Connectivity** | [TableImportDisplayName](docs/v2/Connectivity/models/TableImportDisplayName.md) | `from foundry.v2.connectivity.models import TableImportDisplayName` | -**Connectivity** | [TableImportMode](docs/v2/Connectivity/models/TableImportMode.md) | `from foundry.v2.connectivity.models import TableImportMode` | -**Connectivity** | [TableImportRid](docs/v2/Connectivity/models/TableImportRid.md) | `from foundry.v2.connectivity.models import TableImportRid` | -**Connectivity** | [UriScheme](docs/v2/Connectivity/models/UriScheme.md) | `from foundry.v2.connectivity.models import UriScheme` | -**Core** | [AnyType](docs/v2/Core/models/AnyType.md) | `from foundry.v2.core.models import AnyType` | -**Core** | [ArrayFieldType](docs/v2/Core/models/ArrayFieldType.md) | `from foundry.v2.core.models import ArrayFieldType` | -**Core** | [AttachmentType](docs/v2/Core/models/AttachmentType.md) | `from foundry.v2.core.models import AttachmentType` | -**Core** | [BinaryType](docs/v2/Core/models/BinaryType.md) | `from foundry.v2.core.models import BinaryType` | -**Core** | [BooleanType](docs/v2/Core/models/BooleanType.md) | `from foundry.v2.core.models import BooleanType` | -**Core** | [BuildRid](docs/v2/Core/models/BuildRid.md) | `from foundry.v2.core.models import BuildRid` | -**Core** | [ByteType](docs/v2/Core/models/ByteType.md) | `from foundry.v2.core.models import ByteType` | -**Core** | [ChangeDataCaptureConfiguration](docs/v2/Core/models/ChangeDataCaptureConfiguration.md) | `from foundry.v2.core.models import ChangeDataCaptureConfiguration` | -**Core** | [CipherTextType](docs/v2/Core/models/CipherTextType.md) | `from foundry.v2.core.models import CipherTextType` | -**Core** | [ContentLength](docs/v2/Core/models/ContentLength.md) | `from foundry.v2.core.models import ContentLength` | -**Core** | [ContentType](docs/v2/Core/models/ContentType.md) | `from foundry.v2.core.models import ContentType` | -**Core** | [CreatedBy](docs/v2/Core/models/CreatedBy.md) | `from foundry.v2.core.models import CreatedBy` | -**Core** | [CreatedTime](docs/v2/Core/models/CreatedTime.md) | `from foundry.v2.core.models import CreatedTime` | -**Core** | [CustomMetadata](docs/v2/Core/models/CustomMetadata.md) | `from foundry.v2.core.models import CustomMetadata` | -**Core** | [DateType](docs/v2/Core/models/DateType.md) | `from foundry.v2.core.models import DateType` | -**Core** | [DecimalType](docs/v2/Core/models/DecimalType.md) | `from foundry.v2.core.models import DecimalType` | -**Core** | [DisplayName](docs/v2/Core/models/DisplayName.md) | `from foundry.v2.core.models import DisplayName` | -**Core** | [Distance](docs/v2/Core/models/Distance.md) | `from foundry.v2.core.models import Distance` | -**Core** | [DistanceUnit](docs/v2/Core/models/DistanceUnit.md) | `from foundry.v2.core.models import DistanceUnit` | -**Core** | [DoubleType](docs/v2/Core/models/DoubleType.md) | `from foundry.v2.core.models import DoubleType` | -**Core** | [Duration](docs/v2/Core/models/Duration.md) | `from foundry.v2.core.models import Duration` | -**Core** | [EmbeddingModel](docs/v2/Core/models/EmbeddingModel.md) | `from foundry.v2.core.models import EmbeddingModel` | -**Core** | [EnrollmentRid](docs/v2/Core/models/EnrollmentRid.md) | `from foundry.v2.core.models import EnrollmentRid` | -**Core** | [Field](docs/v2/Core/models/Field.md) | `from foundry.v2.core.models import Field` | -**Core** | [FieldDataType](docs/v2/Core/models/FieldDataType.md) | `from foundry.v2.core.models import FieldDataType` | -**Core** | [FieldName](docs/v2/Core/models/FieldName.md) | `from foundry.v2.core.models import FieldName` | -**Core** | [FieldSchema](docs/v2/Core/models/FieldSchema.md) | `from foundry.v2.core.models import FieldSchema` | -**Core** | [Filename](docs/v2/Core/models/Filename.md) | `from foundry.v2.core.models import Filename` | -**Core** | [FilePath](docs/v2/Core/models/FilePath.md) | `from foundry.v2.core.models import FilePath` | -**Core** | [FilterBinaryType](docs/v2/Core/models/FilterBinaryType.md) | `from foundry.v2.core.models import FilterBinaryType` | -**Core** | [FilterBooleanType](docs/v2/Core/models/FilterBooleanType.md) | `from foundry.v2.core.models import FilterBooleanType` | -**Core** | [FilterDateTimeType](docs/v2/Core/models/FilterDateTimeType.md) | `from foundry.v2.core.models import FilterDateTimeType` | -**Core** | [FilterDateType](docs/v2/Core/models/FilterDateType.md) | `from foundry.v2.core.models import FilterDateType` | -**Core** | [FilterDoubleType](docs/v2/Core/models/FilterDoubleType.md) | `from foundry.v2.core.models import FilterDoubleType` | -**Core** | [FilterEnumType](docs/v2/Core/models/FilterEnumType.md) | `from foundry.v2.core.models import FilterEnumType` | -**Core** | [FilterFloatType](docs/v2/Core/models/FilterFloatType.md) | `from foundry.v2.core.models import FilterFloatType` | -**Core** | [FilterIntegerType](docs/v2/Core/models/FilterIntegerType.md) | `from foundry.v2.core.models import FilterIntegerType` | -**Core** | [FilterLongType](docs/v2/Core/models/FilterLongType.md) | `from foundry.v2.core.models import FilterLongType` | -**Core** | [FilterRidType](docs/v2/Core/models/FilterRidType.md) | `from foundry.v2.core.models import FilterRidType` | -**Core** | [FilterStringType](docs/v2/Core/models/FilterStringType.md) | `from foundry.v2.core.models import FilterStringType` | -**Core** | [FilterType](docs/v2/Core/models/FilterType.md) | `from foundry.v2.core.models import FilterType` | -**Core** | [FilterUuidType](docs/v2/Core/models/FilterUuidType.md) | `from foundry.v2.core.models import FilterUuidType` | -**Core** | [FloatType](docs/v2/Core/models/FloatType.md) | `from foundry.v2.core.models import FloatType` | -**Core** | [FolderRid](docs/v2/Core/models/FolderRid.md) | `from foundry.v2.core.models import FolderRid` | -**Core** | [FoundryLiveDeployment](docs/v2/Core/models/FoundryLiveDeployment.md) | `from foundry.v2.core.models import FoundryLiveDeployment` | -**Core** | [FullRowChangeDataCaptureConfiguration](docs/v2/Core/models/FullRowChangeDataCaptureConfiguration.md) | `from foundry.v2.core.models import FullRowChangeDataCaptureConfiguration` | -**Core** | [GeoPointType](docs/v2/Core/models/GeoPointType.md) | `from foundry.v2.core.models import GeoPointType` | -**Core** | [GeoShapeType](docs/v2/Core/models/GeoShapeType.md) | `from foundry.v2.core.models import GeoShapeType` | -**Core** | [GeotimeSeriesReferenceType](docs/v2/Core/models/GeotimeSeriesReferenceType.md) | `from foundry.v2.core.models import GeotimeSeriesReferenceType` | -**Core** | [GroupName](docs/v2/Core/models/GroupName.md) | `from foundry.v2.core.models import GroupName` | -**Core** | [GroupRid](docs/v2/Core/models/GroupRid.md) | `from foundry.v2.core.models import GroupRid` | -**Core** | [IntegerType](docs/v2/Core/models/IntegerType.md) | `from foundry.v2.core.models import IntegerType` | -**Core** | [JobRid](docs/v2/Core/models/JobRid.md) | `from foundry.v2.core.models import JobRid` | -**Core** | [LmsEmbeddingModel](docs/v2/Core/models/LmsEmbeddingModel.md) | `from foundry.v2.core.models import LmsEmbeddingModel` | -**Core** | [LmsEmbeddingModelValue](docs/v2/Core/models/LmsEmbeddingModelValue.md) | `from foundry.v2.core.models import LmsEmbeddingModelValue` | -**Core** | [LongType](docs/v2/Core/models/LongType.md) | `from foundry.v2.core.models import LongType` | -**Core** | [MapFieldType](docs/v2/Core/models/MapFieldType.md) | `from foundry.v2.core.models import MapFieldType` | -**Core** | [MarkingId](docs/v2/Core/models/MarkingId.md) | `from foundry.v2.core.models import MarkingId` | -**Core** | [MarkingType](docs/v2/Core/models/MarkingType.md) | `from foundry.v2.core.models import MarkingType` | -**Core** | [MediaItemPath](docs/v2/Core/models/MediaItemPath.md) | `from foundry.v2.core.models import MediaItemPath` | -**Core** | [MediaItemReadToken](docs/v2/Core/models/MediaItemReadToken.md) | `from foundry.v2.core.models import MediaItemReadToken` | -**Core** | [MediaItemRid](docs/v2/Core/models/MediaItemRid.md) | `from foundry.v2.core.models import MediaItemRid` | -**Core** | [MediaReference](docs/v2/Core/models/MediaReference.md) | `from foundry.v2.core.models import MediaReference` | -**Core** | [MediaReferenceType](docs/v2/Core/models/MediaReferenceType.md) | `from foundry.v2.core.models import MediaReferenceType` | -**Core** | [MediaSetRid](docs/v2/Core/models/MediaSetRid.md) | `from foundry.v2.core.models import MediaSetRid` | -**Core** | [MediaSetViewItem](docs/v2/Core/models/MediaSetViewItem.md) | `from foundry.v2.core.models import MediaSetViewItem` | -**Core** | [MediaSetViewItemWrapper](docs/v2/Core/models/MediaSetViewItemWrapper.md) | `from foundry.v2.core.models import MediaSetViewItemWrapper` | -**Core** | [MediaSetViewRid](docs/v2/Core/models/MediaSetViewRid.md) | `from foundry.v2.core.models import MediaSetViewRid` | -**Core** | [MediaType](docs/v2/Core/models/MediaType.md) | `from foundry.v2.core.models import MediaType` | -**Core** | [NullType](docs/v2/Core/models/NullType.md) | `from foundry.v2.core.models import NullType` | -**Core** | [OperationScope](docs/v2/Core/models/OperationScope.md) | `from foundry.v2.core.models import OperationScope` | -**Core** | [OrderByDirection](docs/v2/Core/models/OrderByDirection.md) | `from foundry.v2.core.models import OrderByDirection` | -**Core** | [OrganizationRid](docs/v2/Core/models/OrganizationRid.md) | `from foundry.v2.core.models import OrganizationRid` | -**Core** | [PageSize](docs/v2/Core/models/PageSize.md) | `from foundry.v2.core.models import PageSize` | -**Core** | [PageToken](docs/v2/Core/models/PageToken.md) | `from foundry.v2.core.models import PageToken` | -**Core** | [PreviewMode](docs/v2/Core/models/PreviewMode.md) | `from foundry.v2.core.models import PreviewMode` | -**Core** | [PrincipalId](docs/v2/Core/models/PrincipalId.md) | `from foundry.v2.core.models import PrincipalId` | -**Core** | [PrincipalType](docs/v2/Core/models/PrincipalType.md) | `from foundry.v2.core.models import PrincipalType` | -**Core** | [Realm](docs/v2/Core/models/Realm.md) | `from foundry.v2.core.models import Realm` | -**Core** | [Reference](docs/v2/Core/models/Reference.md) | `from foundry.v2.core.models import Reference` | -**Core** | [ReleaseStatus](docs/v2/Core/models/ReleaseStatus.md) | `from foundry.v2.core.models import ReleaseStatus` | -**Core** | [RoleId](docs/v2/Core/models/RoleId.md) | `from foundry.v2.core.models import RoleId` | -**Core** | [ShortType](docs/v2/Core/models/ShortType.md) | `from foundry.v2.core.models import ShortType` | -**Core** | [SizeBytes](docs/v2/Core/models/SizeBytes.md) | `from foundry.v2.core.models import SizeBytes` | -**Core** | [StreamSchema](docs/v2/Core/models/StreamSchema.md) | `from foundry.v2.core.models import StreamSchema` | -**Core** | [StringType](docs/v2/Core/models/StringType.md) | `from foundry.v2.core.models import StringType` | -**Core** | [StructFieldName](docs/v2/Core/models/StructFieldName.md) | `from foundry.v2.core.models import StructFieldName` | -**Core** | [StructFieldType](docs/v2/Core/models/StructFieldType.md) | `from foundry.v2.core.models import StructFieldType` | -**Core** | [TimeSeriesItemType](docs/v2/Core/models/TimeSeriesItemType.md) | `from foundry.v2.core.models import TimeSeriesItemType` | -**Core** | [TimeseriesType](docs/v2/Core/models/TimeseriesType.md) | `from foundry.v2.core.models import TimeseriesType` | -**Core** | [TimestampType](docs/v2/Core/models/TimestampType.md) | `from foundry.v2.core.models import TimestampType` | -**Core** | [TimeUnit](docs/v2/Core/models/TimeUnit.md) | `from foundry.v2.core.models import TimeUnit` | -**Core** | [TotalCount](docs/v2/Core/models/TotalCount.md) | `from foundry.v2.core.models import TotalCount` | -**Core** | [UnsupportedType](docs/v2/Core/models/UnsupportedType.md) | `from foundry.v2.core.models import UnsupportedType` | -**Core** | [UpdatedBy](docs/v2/Core/models/UpdatedBy.md) | `from foundry.v2.core.models import UpdatedBy` | -**Core** | [UpdatedTime](docs/v2/Core/models/UpdatedTime.md) | `from foundry.v2.core.models import UpdatedTime` | -**Core** | [UserId](docs/v2/Core/models/UserId.md) | `from foundry.v2.core.models import UserId` | -**Core** | [VectorSimilarityFunction](docs/v2/Core/models/VectorSimilarityFunction.md) | `from foundry.v2.core.models import VectorSimilarityFunction` | -**Core** | [VectorSimilarityFunctionValue](docs/v2/Core/models/VectorSimilarityFunctionValue.md) | `from foundry.v2.core.models import VectorSimilarityFunctionValue` | -**Core** | [VectorType](docs/v2/Core/models/VectorType.md) | `from foundry.v2.core.models import VectorType` | -**Core** | [ZoneId](docs/v2/Core/models/ZoneId.md) | `from foundry.v2.core.models import ZoneId` | -**Datasets** | [Branch](docs/v2/Datasets/models/Branch.md) | `from foundry.v2.datasets.models import Branch` | -**Datasets** | [BranchName](docs/v2/Datasets/models/BranchName.md) | `from foundry.v2.datasets.models import BranchName` | -**Datasets** | [Dataset](docs/v2/Datasets/models/Dataset.md) | `from foundry.v2.datasets.models import Dataset` | -**Datasets** | [DatasetName](docs/v2/Datasets/models/DatasetName.md) | `from foundry.v2.datasets.models import DatasetName` | -**Datasets** | [DatasetRid](docs/v2/Datasets/models/DatasetRid.md) | `from foundry.v2.datasets.models import DatasetRid` | -**Datasets** | [File](docs/v2/Datasets/models/File.md) | `from foundry.v2.datasets.models import File` | -**Datasets** | [FileUpdatedTime](docs/v2/Datasets/models/FileUpdatedTime.md) | `from foundry.v2.datasets.models import FileUpdatedTime` | -**Datasets** | [ListBranchesResponse](docs/v2/Datasets/models/ListBranchesResponse.md) | `from foundry.v2.datasets.models import ListBranchesResponse` | -**Datasets** | [ListFilesResponse](docs/v2/Datasets/models/ListFilesResponse.md) | `from foundry.v2.datasets.models import ListFilesResponse` | -**Datasets** | [TableExportFormat](docs/v2/Datasets/models/TableExportFormat.md) | `from foundry.v2.datasets.models import TableExportFormat` | -**Datasets** | [Transaction](docs/v2/Datasets/models/Transaction.md) | `from foundry.v2.datasets.models import Transaction` | -**Datasets** | [TransactionCreatedTime](docs/v2/Datasets/models/TransactionCreatedTime.md) | `from foundry.v2.datasets.models import TransactionCreatedTime` | -**Datasets** | [TransactionRid](docs/v2/Datasets/models/TransactionRid.md) | `from foundry.v2.datasets.models import TransactionRid` | -**Datasets** | [TransactionStatus](docs/v2/Datasets/models/TransactionStatus.md) | `from foundry.v2.datasets.models import TransactionStatus` | -**Datasets** | [TransactionType](docs/v2/Datasets/models/TransactionType.md) | `from foundry.v2.datasets.models import TransactionType` | -**Filesystem** | [AccessRequirements](docs/v2/Filesystem/models/AccessRequirements.md) | `from foundry.v2.filesystem.models import AccessRequirements` | -**Filesystem** | [Everyone](docs/v2/Filesystem/models/Everyone.md) | `from foundry.v2.filesystem.models import Everyone` | -**Filesystem** | [FileSystemId](docs/v2/Filesystem/models/FileSystemId.md) | `from foundry.v2.filesystem.models import FileSystemId` | -**Filesystem** | [Folder](docs/v2/Filesystem/models/Folder.md) | `from foundry.v2.filesystem.models import Folder` | -**Filesystem** | [FolderRid](docs/v2/Filesystem/models/FolderRid.md) | `from foundry.v2.filesystem.models import FolderRid` | -**Filesystem** | [FolderType](docs/v2/Filesystem/models/FolderType.md) | `from foundry.v2.filesystem.models import FolderType` | -**Filesystem** | [IsDirectlyApplied](docs/v2/Filesystem/models/IsDirectlyApplied.md) | `from foundry.v2.filesystem.models import IsDirectlyApplied` | -**Filesystem** | [ListChildrenOfFolderResponse](docs/v2/Filesystem/models/ListChildrenOfFolderResponse.md) | `from foundry.v2.filesystem.models import ListChildrenOfFolderResponse` | -**Filesystem** | [ListMarkingsOfResourceResponse](docs/v2/Filesystem/models/ListMarkingsOfResourceResponse.md) | `from foundry.v2.filesystem.models import ListMarkingsOfResourceResponse` | -**Filesystem** | [ListOrganizationsOfProjectResponse](docs/v2/Filesystem/models/ListOrganizationsOfProjectResponse.md) | `from foundry.v2.filesystem.models import ListOrganizationsOfProjectResponse` | -**Filesystem** | [ListResourceRolesResponse](docs/v2/Filesystem/models/ListResourceRolesResponse.md) | `from foundry.v2.filesystem.models import ListResourceRolesResponse` | -**Filesystem** | [ListSpacesResponse](docs/v2/Filesystem/models/ListSpacesResponse.md) | `from foundry.v2.filesystem.models import ListSpacesResponse` | -**Filesystem** | [Marking](docs/v2/Filesystem/models/Marking.md) | `from foundry.v2.filesystem.models import Marking` | -**Filesystem** | [Organization](docs/v2/Filesystem/models/Organization.md) | `from foundry.v2.filesystem.models import Organization` | -**Filesystem** | [PrincipalWithId](docs/v2/Filesystem/models/PrincipalWithId.md) | `from foundry.v2.filesystem.models import PrincipalWithId` | -**Filesystem** | [Project](docs/v2/Filesystem/models/Project.md) | `from foundry.v2.filesystem.models import Project` | -**Filesystem** | [ProjectRid](docs/v2/Filesystem/models/ProjectRid.md) | `from foundry.v2.filesystem.models import ProjectRid` | -**Filesystem** | [ProjectTemplateRid](docs/v2/Filesystem/models/ProjectTemplateRid.md) | `from foundry.v2.filesystem.models import ProjectTemplateRid` | -**Filesystem** | [ProjectTemplateVariableId](docs/v2/Filesystem/models/ProjectTemplateVariableId.md) | `from foundry.v2.filesystem.models import ProjectTemplateVariableId` | -**Filesystem** | [ProjectTemplateVariableValue](docs/v2/Filesystem/models/ProjectTemplateVariableValue.md) | `from foundry.v2.filesystem.models import ProjectTemplateVariableValue` | -**Filesystem** | [Resource](docs/v2/Filesystem/models/Resource.md) | `from foundry.v2.filesystem.models import Resource` | -**Filesystem** | [ResourceDisplayName](docs/v2/Filesystem/models/ResourceDisplayName.md) | `from foundry.v2.filesystem.models import ResourceDisplayName` | -**Filesystem** | [ResourcePath](docs/v2/Filesystem/models/ResourcePath.md) | `from foundry.v2.filesystem.models import ResourcePath` | -**Filesystem** | [ResourceRid](docs/v2/Filesystem/models/ResourceRid.md) | `from foundry.v2.filesystem.models import ResourceRid` | -**Filesystem** | [ResourceRole](docs/v2/Filesystem/models/ResourceRole.md) | `from foundry.v2.filesystem.models import ResourceRole` | -**Filesystem** | [ResourceRolePrincipal](docs/v2/Filesystem/models/ResourceRolePrincipal.md) | `from foundry.v2.filesystem.models import ResourceRolePrincipal` | -**Filesystem** | [ResourceType](docs/v2/Filesystem/models/ResourceType.md) | `from foundry.v2.filesystem.models import ResourceType` | -**Filesystem** | [Space](docs/v2/Filesystem/models/Space.md) | `from foundry.v2.filesystem.models import Space` | -**Filesystem** | [SpaceRid](docs/v2/Filesystem/models/SpaceRid.md) | `from foundry.v2.filesystem.models import SpaceRid` | -**Filesystem** | [TrashStatus](docs/v2/Filesystem/models/TrashStatus.md) | `from foundry.v2.filesystem.models import TrashStatus` | -**Filesystem** | [UsageAccountRid](docs/v2/Filesystem/models/UsageAccountRid.md) | `from foundry.v2.filesystem.models import UsageAccountRid` | -**Functions** | [DataValue](docs/v2/Functions/models/DataValue.md) | `from foundry.v2.functions.models import DataValue` | -**Functions** | [ExecuteQueryResponse](docs/v2/Functions/models/ExecuteQueryResponse.md) | `from foundry.v2.functions.models import ExecuteQueryResponse` | -**Functions** | [FunctionRid](docs/v2/Functions/models/FunctionRid.md) | `from foundry.v2.functions.models import FunctionRid` | -**Functions** | [FunctionVersion](docs/v2/Functions/models/FunctionVersion.md) | `from foundry.v2.functions.models import FunctionVersion` | -**Functions** | [Parameter](docs/v2/Functions/models/Parameter.md) | `from foundry.v2.functions.models import Parameter` | -**Functions** | [ParameterId](docs/v2/Functions/models/ParameterId.md) | `from foundry.v2.functions.models import ParameterId` | -**Functions** | [Query](docs/v2/Functions/models/Query.md) | `from foundry.v2.functions.models import Query` | -**Functions** | [QueryAggregationKeyType](docs/v2/Functions/models/QueryAggregationKeyType.md) | `from foundry.v2.functions.models import QueryAggregationKeyType` | -**Functions** | [QueryAggregationRangeSubType](docs/v2/Functions/models/QueryAggregationRangeSubType.md) | `from foundry.v2.functions.models import QueryAggregationRangeSubType` | -**Functions** | [QueryAggregationRangeType](docs/v2/Functions/models/QueryAggregationRangeType.md) | `from foundry.v2.functions.models import QueryAggregationRangeType` | -**Functions** | [QueryAggregationValueType](docs/v2/Functions/models/QueryAggregationValueType.md) | `from foundry.v2.functions.models import QueryAggregationValueType` | -**Functions** | [QueryApiName](docs/v2/Functions/models/QueryApiName.md) | `from foundry.v2.functions.models import QueryApiName` | -**Functions** | [QueryArrayType](docs/v2/Functions/models/QueryArrayType.md) | `from foundry.v2.functions.models import QueryArrayType` | -**Functions** | [QueryDataType](docs/v2/Functions/models/QueryDataType.md) | `from foundry.v2.functions.models import QueryDataType` | -**Functions** | [QueryRuntimeErrorParameter](docs/v2/Functions/models/QueryRuntimeErrorParameter.md) | `from foundry.v2.functions.models import QueryRuntimeErrorParameter` | -**Functions** | [QuerySetType](docs/v2/Functions/models/QuerySetType.md) | `from foundry.v2.functions.models import QuerySetType` | -**Functions** | [QueryStructField](docs/v2/Functions/models/QueryStructField.md) | `from foundry.v2.functions.models import QueryStructField` | -**Functions** | [QueryStructType](docs/v2/Functions/models/QueryStructType.md) | `from foundry.v2.functions.models import QueryStructType` | -**Functions** | [QueryUnionType](docs/v2/Functions/models/QueryUnionType.md) | `from foundry.v2.functions.models import QueryUnionType` | -**Functions** | [StructFieldName](docs/v2/Functions/models/StructFieldName.md) | `from foundry.v2.functions.models import StructFieldName` | -**Functions** | [ThreeDimensionalAggregation](docs/v2/Functions/models/ThreeDimensionalAggregation.md) | `from foundry.v2.functions.models import ThreeDimensionalAggregation` | -**Functions** | [TwoDimensionalAggregation](docs/v2/Functions/models/TwoDimensionalAggregation.md) | `from foundry.v2.functions.models import TwoDimensionalAggregation` | -**Functions** | [ValueType](docs/v2/Functions/models/ValueType.md) | `from foundry.v2.functions.models import ValueType` | -**Functions** | [ValueTypeApiName](docs/v2/Functions/models/ValueTypeApiName.md) | `from foundry.v2.functions.models import ValueTypeApiName` | -**Functions** | [ValueTypeDataType](docs/v2/Functions/models/ValueTypeDataType.md) | `from foundry.v2.functions.models import ValueTypeDataType` | -**Functions** | [ValueTypeDataTypeArrayType](docs/v2/Functions/models/ValueTypeDataTypeArrayType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeArrayType` | -**Functions** | [ValueTypeDataTypeBinaryType](docs/v2/Functions/models/ValueTypeDataTypeBinaryType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeBinaryType` | -**Functions** | [ValueTypeDataTypeBooleanType](docs/v2/Functions/models/ValueTypeDataTypeBooleanType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeBooleanType` | -**Functions** | [ValueTypeDataTypeByteType](docs/v2/Functions/models/ValueTypeDataTypeByteType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeByteType` | -**Functions** | [ValueTypeDataTypeDateType](docs/v2/Functions/models/ValueTypeDataTypeDateType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeDateType` | -**Functions** | [ValueTypeDataTypeDecimalType](docs/v2/Functions/models/ValueTypeDataTypeDecimalType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeDecimalType` | -**Functions** | [ValueTypeDataTypeDoubleType](docs/v2/Functions/models/ValueTypeDataTypeDoubleType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeDoubleType` | -**Functions** | [ValueTypeDataTypeFloatType](docs/v2/Functions/models/ValueTypeDataTypeFloatType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeFloatType` | -**Functions** | [ValueTypeDataTypeIntegerType](docs/v2/Functions/models/ValueTypeDataTypeIntegerType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeIntegerType` | -**Functions** | [ValueTypeDataTypeLongType](docs/v2/Functions/models/ValueTypeDataTypeLongType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeLongType` | -**Functions** | [ValueTypeDataTypeMapType](docs/v2/Functions/models/ValueTypeDataTypeMapType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeMapType` | -**Functions** | [ValueTypeDataTypeOptionalType](docs/v2/Functions/models/ValueTypeDataTypeOptionalType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeOptionalType` | -**Functions** | [ValueTypeDataTypeShortType](docs/v2/Functions/models/ValueTypeDataTypeShortType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeShortType` | -**Functions** | [ValueTypeDataTypeStringType](docs/v2/Functions/models/ValueTypeDataTypeStringType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeStringType` | -**Functions** | [ValueTypeDataTypeStructElement](docs/v2/Functions/models/ValueTypeDataTypeStructElement.md) | `from foundry.v2.functions.models import ValueTypeDataTypeStructElement` | -**Functions** | [ValueTypeDataTypeStructFieldIdentifier](docs/v2/Functions/models/ValueTypeDataTypeStructFieldIdentifier.md) | `from foundry.v2.functions.models import ValueTypeDataTypeStructFieldIdentifier` | -**Functions** | [ValueTypeDataTypeStructType](docs/v2/Functions/models/ValueTypeDataTypeStructType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeStructType` | -**Functions** | [ValueTypeDataTypeTimestampType](docs/v2/Functions/models/ValueTypeDataTypeTimestampType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeTimestampType` | -**Functions** | [ValueTypeDataTypeUnionType](docs/v2/Functions/models/ValueTypeDataTypeUnionType.md) | `from foundry.v2.functions.models import ValueTypeDataTypeUnionType` | -**Functions** | [ValueTypeDataTypeValueTypeReference](docs/v2/Functions/models/ValueTypeDataTypeValueTypeReference.md) | `from foundry.v2.functions.models import ValueTypeDataTypeValueTypeReference` | -**Functions** | [ValueTypeDescription](docs/v2/Functions/models/ValueTypeDescription.md) | `from foundry.v2.functions.models import ValueTypeDescription` | -**Functions** | [ValueTypeReference](docs/v2/Functions/models/ValueTypeReference.md) | `from foundry.v2.functions.models import ValueTypeReference` | -**Functions** | [ValueTypeRid](docs/v2/Functions/models/ValueTypeRid.md) | `from foundry.v2.functions.models import ValueTypeRid` | -**Functions** | [ValueTypeVersion](docs/v2/Functions/models/ValueTypeVersion.md) | `from foundry.v2.functions.models import ValueTypeVersion` | -**Functions** | [ValueTypeVersionId](docs/v2/Functions/models/ValueTypeVersionId.md) | `from foundry.v2.functions.models import ValueTypeVersionId` | -**Functions** | [VersionId](docs/v2/Functions/models/VersionId.md) | `from foundry.v2.functions.models import VersionId` | -**Geo** | [BBox](docs/v2/Geo/models/BBox.md) | `from foundry.v2.geo.models import BBox` | -**Geo** | [Coordinate](docs/v2/Geo/models/Coordinate.md) | `from foundry.v2.geo.models import Coordinate` | -**Geo** | [Feature](docs/v2/Geo/models/Feature.md) | `from foundry.v2.geo.models import Feature` | -**Geo** | [FeatureCollection](docs/v2/Geo/models/FeatureCollection.md) | `from foundry.v2.geo.models import FeatureCollection` | -**Geo** | [FeatureCollectionTypes](docs/v2/Geo/models/FeatureCollectionTypes.md) | `from foundry.v2.geo.models import FeatureCollectionTypes` | -**Geo** | [FeaturePropertyKey](docs/v2/Geo/models/FeaturePropertyKey.md) | `from foundry.v2.geo.models import FeaturePropertyKey` | -**Geo** | [Geometry](docs/v2/Geo/models/Geometry.md) | `from foundry.v2.geo.models import Geometry` | -**Geo** | [GeometryCollection](docs/v2/Geo/models/GeometryCollection.md) | `from foundry.v2.geo.models import GeometryCollection` | -**Geo** | [GeoPoint](docs/v2/Geo/models/GeoPoint.md) | `from foundry.v2.geo.models import GeoPoint` | -**Geo** | [LinearRing](docs/v2/Geo/models/LinearRing.md) | `from foundry.v2.geo.models import LinearRing` | -**Geo** | [LineString](docs/v2/Geo/models/LineString.md) | `from foundry.v2.geo.models import LineString` | -**Geo** | [LineStringCoordinates](docs/v2/Geo/models/LineStringCoordinates.md) | `from foundry.v2.geo.models import LineStringCoordinates` | -**Geo** | [MultiLineString](docs/v2/Geo/models/MultiLineString.md) | `from foundry.v2.geo.models import MultiLineString` | -**Geo** | [MultiPoint](docs/v2/Geo/models/MultiPoint.md) | `from foundry.v2.geo.models import MultiPoint` | -**Geo** | [MultiPolygon](docs/v2/Geo/models/MultiPolygon.md) | `from foundry.v2.geo.models import MultiPolygon` | -**Geo** | [Polygon](docs/v2/Geo/models/Polygon.md) | `from foundry.v2.geo.models import Polygon` | -**Geo** | [Position](docs/v2/Geo/models/Position.md) | `from foundry.v2.geo.models import Position` | -**MediaSets** | [BranchName](docs/v2/MediaSets/models/BranchName.md) | `from foundry.v2.media_sets.models import BranchName` | -**MediaSets** | [BranchRid](docs/v2/MediaSets/models/BranchRid.md) | `from foundry.v2.media_sets.models import BranchRid` | -**MediaSets** | [GetMediaItemInfoResponse](docs/v2/MediaSets/models/GetMediaItemInfoResponse.md) | `from foundry.v2.media_sets.models import GetMediaItemInfoResponse` | -**MediaSets** | [LogicalTimestamp](docs/v2/MediaSets/models/LogicalTimestamp.md) | `from foundry.v2.media_sets.models import LogicalTimestamp` | -**MediaSets** | [MediaAttribution](docs/v2/MediaSets/models/MediaAttribution.md) | `from foundry.v2.media_sets.models import MediaAttribution` | -**MediaSets** | [PutMediaItemResponse](docs/v2/MediaSets/models/PutMediaItemResponse.md) | `from foundry.v2.media_sets.models import PutMediaItemResponse` | -**MediaSets** | [TransactionId](docs/v2/MediaSets/models/TransactionId.md) | `from foundry.v2.media_sets.models import TransactionId` | -**Ontologies** | [AbsoluteTimeRange](docs/v2/Ontologies/models/AbsoluteTimeRange.md) | `from foundry.v2.ontologies.models import AbsoluteTimeRange` | -**Ontologies** | [AbsoluteValuePropertyExpression](docs/v2/Ontologies/models/AbsoluteValuePropertyExpression.md) | `from foundry.v2.ontologies.models import AbsoluteValuePropertyExpression` | -**Ontologies** | [ActionParameterArrayType](docs/v2/Ontologies/models/ActionParameterArrayType.md) | `from foundry.v2.ontologies.models import ActionParameterArrayType` | -**Ontologies** | [ActionParameterType](docs/v2/Ontologies/models/ActionParameterType.md) | `from foundry.v2.ontologies.models import ActionParameterType` | -**Ontologies** | [ActionParameterV2](docs/v2/Ontologies/models/ActionParameterV2.md) | `from foundry.v2.ontologies.models import ActionParameterV2` | -**Ontologies** | [ActionResults](docs/v2/Ontologies/models/ActionResults.md) | `from foundry.v2.ontologies.models import ActionResults` | -**Ontologies** | [ActionRid](docs/v2/Ontologies/models/ActionRid.md) | `from foundry.v2.ontologies.models import ActionRid` | -**Ontologies** | [ActionTypeApiName](docs/v2/Ontologies/models/ActionTypeApiName.md) | `from foundry.v2.ontologies.models import ActionTypeApiName` | -**Ontologies** | [ActionTypeRid](docs/v2/Ontologies/models/ActionTypeRid.md) | `from foundry.v2.ontologies.models import ActionTypeRid` | -**Ontologies** | [ActionTypeV2](docs/v2/Ontologies/models/ActionTypeV2.md) | `from foundry.v2.ontologies.models import ActionTypeV2` | -**Ontologies** | [ActivePropertyTypeStatus](docs/v2/Ontologies/models/ActivePropertyTypeStatus.md) | `from foundry.v2.ontologies.models import ActivePropertyTypeStatus` | -**Ontologies** | [AddLink](docs/v2/Ontologies/models/AddLink.md) | `from foundry.v2.ontologies.models import AddLink` | -**Ontologies** | [AddObject](docs/v2/Ontologies/models/AddObject.md) | `from foundry.v2.ontologies.models import AddObject` | -**Ontologies** | [AddPropertyExpression](docs/v2/Ontologies/models/AddPropertyExpression.md) | `from foundry.v2.ontologies.models import AddPropertyExpression` | -**Ontologies** | [AggregateObjectsResponseItemV2](docs/v2/Ontologies/models/AggregateObjectsResponseItemV2.md) | `from foundry.v2.ontologies.models import AggregateObjectsResponseItemV2` | -**Ontologies** | [AggregateObjectsResponseV2](docs/v2/Ontologies/models/AggregateObjectsResponseV2.md) | `from foundry.v2.ontologies.models import AggregateObjectsResponseV2` | -**Ontologies** | [AggregateTimeSeries](docs/v2/Ontologies/models/AggregateTimeSeries.md) | `from foundry.v2.ontologies.models import AggregateTimeSeries` | -**Ontologies** | [AggregationAccuracy](docs/v2/Ontologies/models/AggregationAccuracy.md) | `from foundry.v2.ontologies.models import AggregationAccuracy` | -**Ontologies** | [AggregationAccuracyRequest](docs/v2/Ontologies/models/AggregationAccuracyRequest.md) | `from foundry.v2.ontologies.models import AggregationAccuracyRequest` | -**Ontologies** | [AggregationDurationGroupingV2](docs/v2/Ontologies/models/AggregationDurationGroupingV2.md) | `from foundry.v2.ontologies.models import AggregationDurationGroupingV2` | -**Ontologies** | [AggregationExactGroupingV2](docs/v2/Ontologies/models/AggregationExactGroupingV2.md) | `from foundry.v2.ontologies.models import AggregationExactGroupingV2` | -**Ontologies** | [AggregationFixedWidthGroupingV2](docs/v2/Ontologies/models/AggregationFixedWidthGroupingV2.md) | `from foundry.v2.ontologies.models import AggregationFixedWidthGroupingV2` | -**Ontologies** | [AggregationGroupByV2](docs/v2/Ontologies/models/AggregationGroupByV2.md) | `from foundry.v2.ontologies.models import AggregationGroupByV2` | -**Ontologies** | [AggregationGroupKeyV2](docs/v2/Ontologies/models/AggregationGroupKeyV2.md) | `from foundry.v2.ontologies.models import AggregationGroupKeyV2` | -**Ontologies** | [AggregationGroupValueV2](docs/v2/Ontologies/models/AggregationGroupValueV2.md) | `from foundry.v2.ontologies.models import AggregationGroupValueV2` | -**Ontologies** | [AggregationMetricName](docs/v2/Ontologies/models/AggregationMetricName.md) | `from foundry.v2.ontologies.models import AggregationMetricName` | -**Ontologies** | [AggregationMetricResultV2](docs/v2/Ontologies/models/AggregationMetricResultV2.md) | `from foundry.v2.ontologies.models import AggregationMetricResultV2` | -**Ontologies** | [AggregationRangesGroupingV2](docs/v2/Ontologies/models/AggregationRangesGroupingV2.md) | `from foundry.v2.ontologies.models import AggregationRangesGroupingV2` | -**Ontologies** | [AggregationRangeV2](docs/v2/Ontologies/models/AggregationRangeV2.md) | `from foundry.v2.ontologies.models import AggregationRangeV2` | -**Ontologies** | [AggregationV2](docs/v2/Ontologies/models/AggregationV2.md) | `from foundry.v2.ontologies.models import AggregationV2` | -**Ontologies** | [AndQueryV2](docs/v2/Ontologies/models/AndQueryV2.md) | `from foundry.v2.ontologies.models import AndQueryV2` | -**Ontologies** | [ApplyActionMode](docs/v2/Ontologies/models/ApplyActionMode.md) | `from foundry.v2.ontologies.models import ApplyActionMode` | -**Ontologies** | [ApplyActionRequestOptions](docs/v2/Ontologies/models/ApplyActionRequestOptions.md) | `from foundry.v2.ontologies.models import ApplyActionRequestOptions` | -**Ontologies** | [ApproximateDistinctAggregationV2](docs/v2/Ontologies/models/ApproximateDistinctAggregationV2.md) | `from foundry.v2.ontologies.models import ApproximateDistinctAggregationV2` | -**Ontologies** | [ApproximatePercentileAggregationV2](docs/v2/Ontologies/models/ApproximatePercentileAggregationV2.md) | `from foundry.v2.ontologies.models import ApproximatePercentileAggregationV2` | -**Ontologies** | [ArraySizeConstraint](docs/v2/Ontologies/models/ArraySizeConstraint.md) | `from foundry.v2.ontologies.models import ArraySizeConstraint` | -**Ontologies** | [ArtifactRepositoryRid](docs/v2/Ontologies/models/ArtifactRepositoryRid.md) | `from foundry.v2.ontologies.models import ArtifactRepositoryRid` | -**Ontologies** | [AttachmentMetadataResponse](docs/v2/Ontologies/models/AttachmentMetadataResponse.md) | `from foundry.v2.ontologies.models import AttachmentMetadataResponse` | -**Ontologies** | [AttachmentRid](docs/v2/Ontologies/models/AttachmentRid.md) | `from foundry.v2.ontologies.models import AttachmentRid` | -**Ontologies** | [AttachmentV2](docs/v2/Ontologies/models/AttachmentV2.md) | `from foundry.v2.ontologies.models import AttachmentV2` | -**Ontologies** | [AvgAggregationV2](docs/v2/Ontologies/models/AvgAggregationV2.md) | `from foundry.v2.ontologies.models import AvgAggregationV2` | -**Ontologies** | [BatchActionObjectEdit](docs/v2/Ontologies/models/BatchActionObjectEdit.md) | `from foundry.v2.ontologies.models import BatchActionObjectEdit` | -**Ontologies** | [BatchActionObjectEdits](docs/v2/Ontologies/models/BatchActionObjectEdits.md) | `from foundry.v2.ontologies.models import BatchActionObjectEdits` | -**Ontologies** | [BatchActionResults](docs/v2/Ontologies/models/BatchActionResults.md) | `from foundry.v2.ontologies.models import BatchActionResults` | -**Ontologies** | [BatchApplyActionRequestItem](docs/v2/Ontologies/models/BatchApplyActionRequestItem.md) | `from foundry.v2.ontologies.models import BatchApplyActionRequestItem` | -**Ontologies** | [BatchApplyActionRequestOptions](docs/v2/Ontologies/models/BatchApplyActionRequestOptions.md) | `from foundry.v2.ontologies.models import BatchApplyActionRequestOptions` | -**Ontologies** | [BatchApplyActionResponseV2](docs/v2/Ontologies/models/BatchApplyActionResponseV2.md) | `from foundry.v2.ontologies.models import BatchApplyActionResponseV2` | -**Ontologies** | [BatchReturnEditsMode](docs/v2/Ontologies/models/BatchReturnEditsMode.md) | `from foundry.v2.ontologies.models import BatchReturnEditsMode` | -**Ontologies** | [BlueprintIcon](docs/v2/Ontologies/models/BlueprintIcon.md) | `from foundry.v2.ontologies.models import BlueprintIcon` | -**Ontologies** | [BoundingBoxValue](docs/v2/Ontologies/models/BoundingBoxValue.md) | `from foundry.v2.ontologies.models import BoundingBoxValue` | -**Ontologies** | [CenterPoint](docs/v2/Ontologies/models/CenterPoint.md) | `from foundry.v2.ontologies.models import CenterPoint` | -**Ontologies** | [CenterPointTypes](docs/v2/Ontologies/models/CenterPointTypes.md) | `from foundry.v2.ontologies.models import CenterPointTypes` | -**Ontologies** | [ContainsAllTermsInOrderPrefixLastTerm](docs/v2/Ontologies/models/ContainsAllTermsInOrderPrefixLastTerm.md) | `from foundry.v2.ontologies.models import ContainsAllTermsInOrderPrefixLastTerm` | -**Ontologies** | [ContainsAllTermsInOrderQuery](docs/v2/Ontologies/models/ContainsAllTermsInOrderQuery.md) | `from foundry.v2.ontologies.models import ContainsAllTermsInOrderQuery` | -**Ontologies** | [ContainsAllTermsQuery](docs/v2/Ontologies/models/ContainsAllTermsQuery.md) | `from foundry.v2.ontologies.models import ContainsAllTermsQuery` | -**Ontologies** | [ContainsAnyTermQuery](docs/v2/Ontologies/models/ContainsAnyTermQuery.md) | `from foundry.v2.ontologies.models import ContainsAnyTermQuery` | -**Ontologies** | [ContainsQueryV2](docs/v2/Ontologies/models/ContainsQueryV2.md) | `from foundry.v2.ontologies.models import ContainsQueryV2` | -**Ontologies** | [CountAggregationV2](docs/v2/Ontologies/models/CountAggregationV2.md) | `from foundry.v2.ontologies.models import CountAggregationV2` | -**Ontologies** | [CountObjectsResponseV2](docs/v2/Ontologies/models/CountObjectsResponseV2.md) | `from foundry.v2.ontologies.models import CountObjectsResponseV2` | -**Ontologies** | [CreateInterfaceObjectRule](docs/v2/Ontologies/models/CreateInterfaceObjectRule.md) | `from foundry.v2.ontologies.models import CreateInterfaceObjectRule` | -**Ontologies** | [CreateLinkRule](docs/v2/Ontologies/models/CreateLinkRule.md) | `from foundry.v2.ontologies.models import CreateLinkRule` | -**Ontologies** | [CreateObjectRule](docs/v2/Ontologies/models/CreateObjectRule.md) | `from foundry.v2.ontologies.models import CreateObjectRule` | -**Ontologies** | [CreateTemporaryObjectSetResponseV2](docs/v2/Ontologies/models/CreateTemporaryObjectSetResponseV2.md) | `from foundry.v2.ontologies.models import CreateTemporaryObjectSetResponseV2` | -**Ontologies** | [DataValue](docs/v2/Ontologies/models/DataValue.md) | `from foundry.v2.ontologies.models import DataValue` | -**Ontologies** | [DeleteInterfaceObjectRule](docs/v2/Ontologies/models/DeleteInterfaceObjectRule.md) | `from foundry.v2.ontologies.models import DeleteInterfaceObjectRule` | -**Ontologies** | [DeleteLink](docs/v2/Ontologies/models/DeleteLink.md) | `from foundry.v2.ontologies.models import DeleteLink` | -**Ontologies** | [DeleteLinkRule](docs/v2/Ontologies/models/DeleteLinkRule.md) | `from foundry.v2.ontologies.models import DeleteLinkRule` | -**Ontologies** | [DeleteObject](docs/v2/Ontologies/models/DeleteObject.md) | `from foundry.v2.ontologies.models import DeleteObject` | -**Ontologies** | [DeleteObjectRule](docs/v2/Ontologies/models/DeleteObjectRule.md) | `from foundry.v2.ontologies.models import DeleteObjectRule` | -**Ontologies** | [DeprecatedPropertyTypeStatus](docs/v2/Ontologies/models/DeprecatedPropertyTypeStatus.md) | `from foundry.v2.ontologies.models import DeprecatedPropertyTypeStatus` | -**Ontologies** | [DerivedPropertyApiName](docs/v2/Ontologies/models/DerivedPropertyApiName.md) | `from foundry.v2.ontologies.models import DerivedPropertyApiName` | -**Ontologies** | [DerivedPropertyDefinition](docs/v2/Ontologies/models/DerivedPropertyDefinition.md) | `from foundry.v2.ontologies.models import DerivedPropertyDefinition` | -**Ontologies** | [DividePropertyExpression](docs/v2/Ontologies/models/DividePropertyExpression.md) | `from foundry.v2.ontologies.models import DividePropertyExpression` | -**Ontologies** | [DoesNotIntersectBoundingBoxQuery](docs/v2/Ontologies/models/DoesNotIntersectBoundingBoxQuery.md) | `from foundry.v2.ontologies.models import DoesNotIntersectBoundingBoxQuery` | -**Ontologies** | [DoesNotIntersectPolygonQuery](docs/v2/Ontologies/models/DoesNotIntersectPolygonQuery.md) | `from foundry.v2.ontologies.models import DoesNotIntersectPolygonQuery` | -**Ontologies** | [DoubleVector](docs/v2/Ontologies/models/DoubleVector.md) | `from foundry.v2.ontologies.models import DoubleVector` | -**Ontologies** | [EntrySetType](docs/v2/Ontologies/models/EntrySetType.md) | `from foundry.v2.ontologies.models import EntrySetType` | -**Ontologies** | [EqualsQueryV2](docs/v2/Ontologies/models/EqualsQueryV2.md) | `from foundry.v2.ontologies.models import EqualsQueryV2` | -**Ontologies** | [ExactDistinctAggregationV2](docs/v2/Ontologies/models/ExactDistinctAggregationV2.md) | `from foundry.v2.ontologies.models import ExactDistinctAggregationV2` | -**Ontologies** | [ExamplePropertyTypeStatus](docs/v2/Ontologies/models/ExamplePropertyTypeStatus.md) | `from foundry.v2.ontologies.models import ExamplePropertyTypeStatus` | -**Ontologies** | [ExecuteQueryResponse](docs/v2/Ontologies/models/ExecuteQueryResponse.md) | `from foundry.v2.ontologies.models import ExecuteQueryResponse` | -**Ontologies** | [ExperimentalPropertyTypeStatus](docs/v2/Ontologies/models/ExperimentalPropertyTypeStatus.md) | `from foundry.v2.ontologies.models import ExperimentalPropertyTypeStatus` | -**Ontologies** | [ExtractDatePart](docs/v2/Ontologies/models/ExtractDatePart.md) | `from foundry.v2.ontologies.models import ExtractDatePart` | -**Ontologies** | [ExtractPropertyExpression](docs/v2/Ontologies/models/ExtractPropertyExpression.md) | `from foundry.v2.ontologies.models import ExtractPropertyExpression` | -**Ontologies** | [FilterValue](docs/v2/Ontologies/models/FilterValue.md) | `from foundry.v2.ontologies.models import FilterValue` | -**Ontologies** | [FunctionRid](docs/v2/Ontologies/models/FunctionRid.md) | `from foundry.v2.ontologies.models import FunctionRid` | -**Ontologies** | [FunctionVersion](docs/v2/Ontologies/models/FunctionVersion.md) | `from foundry.v2.ontologies.models import FunctionVersion` | -**Ontologies** | [FuzzyV2](docs/v2/Ontologies/models/FuzzyV2.md) | `from foundry.v2.ontologies.models import FuzzyV2` | -**Ontologies** | [GetSelectedPropertyOperation](docs/v2/Ontologies/models/GetSelectedPropertyOperation.md) | `from foundry.v2.ontologies.models import GetSelectedPropertyOperation` | -**Ontologies** | [GreatestPropertyExpression](docs/v2/Ontologies/models/GreatestPropertyExpression.md) | `from foundry.v2.ontologies.models import GreatestPropertyExpression` | -**Ontologies** | [GroupMemberConstraint](docs/v2/Ontologies/models/GroupMemberConstraint.md) | `from foundry.v2.ontologies.models import GroupMemberConstraint` | -**Ontologies** | [GteQueryV2](docs/v2/Ontologies/models/GteQueryV2.md) | `from foundry.v2.ontologies.models import GteQueryV2` | -**Ontologies** | [GtQueryV2](docs/v2/Ontologies/models/GtQueryV2.md) | `from foundry.v2.ontologies.models import GtQueryV2` | -**Ontologies** | [Icon](docs/v2/Ontologies/models/Icon.md) | `from foundry.v2.ontologies.models import Icon` | -**Ontologies** | [InQuery](docs/v2/Ontologies/models/InQuery.md) | `from foundry.v2.ontologies.models import InQuery` | -**Ontologies** | [InterfaceLinkType](docs/v2/Ontologies/models/InterfaceLinkType.md) | `from foundry.v2.ontologies.models import InterfaceLinkType` | -**Ontologies** | [InterfaceLinkTypeApiName](docs/v2/Ontologies/models/InterfaceLinkTypeApiName.md) | `from foundry.v2.ontologies.models import InterfaceLinkTypeApiName` | -**Ontologies** | [InterfaceLinkTypeCardinality](docs/v2/Ontologies/models/InterfaceLinkTypeCardinality.md) | `from foundry.v2.ontologies.models import InterfaceLinkTypeCardinality` | -**Ontologies** | [InterfaceLinkTypeLinkedEntityApiName](docs/v2/Ontologies/models/InterfaceLinkTypeLinkedEntityApiName.md) | `from foundry.v2.ontologies.models import InterfaceLinkTypeLinkedEntityApiName` | -**Ontologies** | [InterfaceLinkTypeRid](docs/v2/Ontologies/models/InterfaceLinkTypeRid.md) | `from foundry.v2.ontologies.models import InterfaceLinkTypeRid` | -**Ontologies** | [InterfaceSharedPropertyType](docs/v2/Ontologies/models/InterfaceSharedPropertyType.md) | `from foundry.v2.ontologies.models import InterfaceSharedPropertyType` | -**Ontologies** | [InterfaceToObjectTypeMapping](docs/v2/Ontologies/models/InterfaceToObjectTypeMapping.md) | `from foundry.v2.ontologies.models import InterfaceToObjectTypeMapping` | -**Ontologies** | [InterfaceToObjectTypeMappings](docs/v2/Ontologies/models/InterfaceToObjectTypeMappings.md) | `from foundry.v2.ontologies.models import InterfaceToObjectTypeMappings` | -**Ontologies** | [InterfaceType](docs/v2/Ontologies/models/InterfaceType.md) | `from foundry.v2.ontologies.models import InterfaceType` | -**Ontologies** | [InterfaceTypeApiName](docs/v2/Ontologies/models/InterfaceTypeApiName.md) | `from foundry.v2.ontologies.models import InterfaceTypeApiName` | -**Ontologies** | [InterfaceTypeRid](docs/v2/Ontologies/models/InterfaceTypeRid.md) | `from foundry.v2.ontologies.models import InterfaceTypeRid` | -**Ontologies** | [IntersectsBoundingBoxQuery](docs/v2/Ontologies/models/IntersectsBoundingBoxQuery.md) | `from foundry.v2.ontologies.models import IntersectsBoundingBoxQuery` | -**Ontologies** | [IntersectsPolygonQuery](docs/v2/Ontologies/models/IntersectsPolygonQuery.md) | `from foundry.v2.ontologies.models import IntersectsPolygonQuery` | -**Ontologies** | [IsNullQueryV2](docs/v2/Ontologies/models/IsNullQueryV2.md) | `from foundry.v2.ontologies.models import IsNullQueryV2` | -**Ontologies** | [LeastPropertyExpression](docs/v2/Ontologies/models/LeastPropertyExpression.md) | `from foundry.v2.ontologies.models import LeastPropertyExpression` | -**Ontologies** | [LinkedInterfaceTypeApiName](docs/v2/Ontologies/models/LinkedInterfaceTypeApiName.md) | `from foundry.v2.ontologies.models import LinkedInterfaceTypeApiName` | -**Ontologies** | [LinkedObjectTypeApiName](docs/v2/Ontologies/models/LinkedObjectTypeApiName.md) | `from foundry.v2.ontologies.models import LinkedObjectTypeApiName` | -**Ontologies** | [LinkSideObject](docs/v2/Ontologies/models/LinkSideObject.md) | `from foundry.v2.ontologies.models import LinkSideObject` | -**Ontologies** | [LinkTypeApiName](docs/v2/Ontologies/models/LinkTypeApiName.md) | `from foundry.v2.ontologies.models import LinkTypeApiName` | -**Ontologies** | [LinkTypeRid](docs/v2/Ontologies/models/LinkTypeRid.md) | `from foundry.v2.ontologies.models import LinkTypeRid` | -**Ontologies** | [LinkTypeSideCardinality](docs/v2/Ontologies/models/LinkTypeSideCardinality.md) | `from foundry.v2.ontologies.models import LinkTypeSideCardinality` | -**Ontologies** | [LinkTypeSideV2](docs/v2/Ontologies/models/LinkTypeSideV2.md) | `from foundry.v2.ontologies.models import LinkTypeSideV2` | -**Ontologies** | [ListActionTypesResponseV2](docs/v2/Ontologies/models/ListActionTypesResponseV2.md) | `from foundry.v2.ontologies.models import ListActionTypesResponseV2` | -**Ontologies** | [ListAttachmentsResponseV2](docs/v2/Ontologies/models/ListAttachmentsResponseV2.md) | `from foundry.v2.ontologies.models import ListAttachmentsResponseV2` | -**Ontologies** | [ListInterfaceTypesResponse](docs/v2/Ontologies/models/ListInterfaceTypesResponse.md) | `from foundry.v2.ontologies.models import ListInterfaceTypesResponse` | -**Ontologies** | [ListLinkedObjectsResponseV2](docs/v2/Ontologies/models/ListLinkedObjectsResponseV2.md) | `from foundry.v2.ontologies.models import ListLinkedObjectsResponseV2` | -**Ontologies** | [ListObjectsResponseV2](docs/v2/Ontologies/models/ListObjectsResponseV2.md) | `from foundry.v2.ontologies.models import ListObjectsResponseV2` | -**Ontologies** | [ListObjectTypesV2Response](docs/v2/Ontologies/models/ListObjectTypesV2Response.md) | `from foundry.v2.ontologies.models import ListObjectTypesV2Response` | -**Ontologies** | [ListOntologiesV2Response](docs/v2/Ontologies/models/ListOntologiesV2Response.md) | `from foundry.v2.ontologies.models import ListOntologiesV2Response` | -**Ontologies** | [ListOutgoingLinkTypesResponseV2](docs/v2/Ontologies/models/ListOutgoingLinkTypesResponseV2.md) | `from foundry.v2.ontologies.models import ListOutgoingLinkTypesResponseV2` | -**Ontologies** | [ListQueryTypesResponseV2](docs/v2/Ontologies/models/ListQueryTypesResponseV2.md) | `from foundry.v2.ontologies.models import ListQueryTypesResponseV2` | -**Ontologies** | [LoadObjectSetResponseV2](docs/v2/Ontologies/models/LoadObjectSetResponseV2.md) | `from foundry.v2.ontologies.models import LoadObjectSetResponseV2` | -**Ontologies** | [LoadObjectSetV2MultipleObjectTypesResponse](docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponse.md) | `from foundry.v2.ontologies.models import LoadObjectSetV2MultipleObjectTypesResponse` | -**Ontologies** | [LoadObjectSetV2ObjectsOrInterfacesResponse](docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesResponse.md) | `from foundry.v2.ontologies.models import LoadObjectSetV2ObjectsOrInterfacesResponse` | -**Ontologies** | [LogicRule](docs/v2/Ontologies/models/LogicRule.md) | `from foundry.v2.ontologies.models import LogicRule` | -**Ontologies** | [LteQueryV2](docs/v2/Ontologies/models/LteQueryV2.md) | `from foundry.v2.ontologies.models import LteQueryV2` | -**Ontologies** | [LtQueryV2](docs/v2/Ontologies/models/LtQueryV2.md) | `from foundry.v2.ontologies.models import LtQueryV2` | -**Ontologies** | [MaxAggregationV2](docs/v2/Ontologies/models/MaxAggregationV2.md) | `from foundry.v2.ontologies.models import MaxAggregationV2` | -**Ontologies** | [MediaMetadata](docs/v2/Ontologies/models/MediaMetadata.md) | `from foundry.v2.ontologies.models import MediaMetadata` | -**Ontologies** | [MethodObjectSet](docs/v2/Ontologies/models/MethodObjectSet.md) | `from foundry.v2.ontologies.models import MethodObjectSet` | -**Ontologies** | [MinAggregationV2](docs/v2/Ontologies/models/MinAggregationV2.md) | `from foundry.v2.ontologies.models import MinAggregationV2` | -**Ontologies** | [ModifyInterfaceObjectRule](docs/v2/Ontologies/models/ModifyInterfaceObjectRule.md) | `from foundry.v2.ontologies.models import ModifyInterfaceObjectRule` | -**Ontologies** | [ModifyObject](docs/v2/Ontologies/models/ModifyObject.md) | `from foundry.v2.ontologies.models import ModifyObject` | -**Ontologies** | [ModifyObjectRule](docs/v2/Ontologies/models/ModifyObjectRule.md) | `from foundry.v2.ontologies.models import ModifyObjectRule` | -**Ontologies** | [MultiplyPropertyExpression](docs/v2/Ontologies/models/MultiplyPropertyExpression.md) | `from foundry.v2.ontologies.models import MultiplyPropertyExpression` | -**Ontologies** | [NearestNeighborsQuery](docs/v2/Ontologies/models/NearestNeighborsQuery.md) | `from foundry.v2.ontologies.models import NearestNeighborsQuery` | -**Ontologies** | [NearestNeighborsQueryText](docs/v2/Ontologies/models/NearestNeighborsQueryText.md) | `from foundry.v2.ontologies.models import NearestNeighborsQueryText` | -**Ontologies** | [NegatePropertyExpression](docs/v2/Ontologies/models/NegatePropertyExpression.md) | `from foundry.v2.ontologies.models import NegatePropertyExpression` | -**Ontologies** | [NotQueryV2](docs/v2/Ontologies/models/NotQueryV2.md) | `from foundry.v2.ontologies.models import NotQueryV2` | -**Ontologies** | [ObjectEdit](docs/v2/Ontologies/models/ObjectEdit.md) | `from foundry.v2.ontologies.models import ObjectEdit` | -**Ontologies** | [ObjectEdits](docs/v2/Ontologies/models/ObjectEdits.md) | `from foundry.v2.ontologies.models import ObjectEdits` | -**Ontologies** | [ObjectPropertyType](docs/v2/Ontologies/models/ObjectPropertyType.md) | `from foundry.v2.ontologies.models import ObjectPropertyType` | -**Ontologies** | [ObjectPropertyValueConstraint](docs/v2/Ontologies/models/ObjectPropertyValueConstraint.md) | `from foundry.v2.ontologies.models import ObjectPropertyValueConstraint` | -**Ontologies** | [ObjectQueryResultConstraint](docs/v2/Ontologies/models/ObjectQueryResultConstraint.md) | `from foundry.v2.ontologies.models import ObjectQueryResultConstraint` | -**Ontologies** | [ObjectRid](docs/v2/Ontologies/models/ObjectRid.md) | `from foundry.v2.ontologies.models import ObjectRid` | -**Ontologies** | [ObjectSet](docs/v2/Ontologies/models/ObjectSet.md) | `from foundry.v2.ontologies.models import ObjectSet` | -**Ontologies** | [ObjectSetAsBaseObjectTypesType](docs/v2/Ontologies/models/ObjectSetAsBaseObjectTypesType.md) | `from foundry.v2.ontologies.models import ObjectSetAsBaseObjectTypesType` | -**Ontologies** | [ObjectSetAsTypeType](docs/v2/Ontologies/models/ObjectSetAsTypeType.md) | `from foundry.v2.ontologies.models import ObjectSetAsTypeType` | -**Ontologies** | [ObjectSetBaseType](docs/v2/Ontologies/models/ObjectSetBaseType.md) | `from foundry.v2.ontologies.models import ObjectSetBaseType` | -**Ontologies** | [ObjectSetFilterType](docs/v2/Ontologies/models/ObjectSetFilterType.md) | `from foundry.v2.ontologies.models import ObjectSetFilterType` | -**Ontologies** | [ObjectSetInterfaceBaseType](docs/v2/Ontologies/models/ObjectSetInterfaceBaseType.md) | `from foundry.v2.ontologies.models import ObjectSetInterfaceBaseType` | -**Ontologies** | [ObjectSetIntersectionType](docs/v2/Ontologies/models/ObjectSetIntersectionType.md) | `from foundry.v2.ontologies.models import ObjectSetIntersectionType` | -**Ontologies** | [ObjectSetMethodInputType](docs/v2/Ontologies/models/ObjectSetMethodInputType.md) | `from foundry.v2.ontologies.models import ObjectSetMethodInputType` | -**Ontologies** | [ObjectSetNearestNeighborsType](docs/v2/Ontologies/models/ObjectSetNearestNeighborsType.md) | `from foundry.v2.ontologies.models import ObjectSetNearestNeighborsType` | -**Ontologies** | [ObjectSetReferenceType](docs/v2/Ontologies/models/ObjectSetReferenceType.md) | `from foundry.v2.ontologies.models import ObjectSetReferenceType` | -**Ontologies** | [ObjectSetRid](docs/v2/Ontologies/models/ObjectSetRid.md) | `from foundry.v2.ontologies.models import ObjectSetRid` | -**Ontologies** | [ObjectSetSearchAroundType](docs/v2/Ontologies/models/ObjectSetSearchAroundType.md) | `from foundry.v2.ontologies.models import ObjectSetSearchAroundType` | -**Ontologies** | [ObjectSetStaticType](docs/v2/Ontologies/models/ObjectSetStaticType.md) | `from foundry.v2.ontologies.models import ObjectSetStaticType` | -**Ontologies** | [ObjectSetSubtractType](docs/v2/Ontologies/models/ObjectSetSubtractType.md) | `from foundry.v2.ontologies.models import ObjectSetSubtractType` | -**Ontologies** | [ObjectSetUnionType](docs/v2/Ontologies/models/ObjectSetUnionType.md) | `from foundry.v2.ontologies.models import ObjectSetUnionType` | -**Ontologies** | [ObjectSetWithPropertiesType](docs/v2/Ontologies/models/ObjectSetWithPropertiesType.md) | `from foundry.v2.ontologies.models import ObjectSetWithPropertiesType` | -**Ontologies** | [ObjectTypeApiName](docs/v2/Ontologies/models/ObjectTypeApiName.md) | `from foundry.v2.ontologies.models import ObjectTypeApiName` | -**Ontologies** | [ObjectTypeEdits](docs/v2/Ontologies/models/ObjectTypeEdits.md) | `from foundry.v2.ontologies.models import ObjectTypeEdits` | -**Ontologies** | [ObjectTypeFullMetadata](docs/v2/Ontologies/models/ObjectTypeFullMetadata.md) | `from foundry.v2.ontologies.models import ObjectTypeFullMetadata` | -**Ontologies** | [ObjectTypeId](docs/v2/Ontologies/models/ObjectTypeId.md) | `from foundry.v2.ontologies.models import ObjectTypeId` | -**Ontologies** | [ObjectTypeInterfaceImplementation](docs/v2/Ontologies/models/ObjectTypeInterfaceImplementation.md) | `from foundry.v2.ontologies.models import ObjectTypeInterfaceImplementation` | -**Ontologies** | [ObjectTypeRid](docs/v2/Ontologies/models/ObjectTypeRid.md) | `from foundry.v2.ontologies.models import ObjectTypeRid` | -**Ontologies** | [ObjectTypeV2](docs/v2/Ontologies/models/ObjectTypeV2.md) | `from foundry.v2.ontologies.models import ObjectTypeV2` | -**Ontologies** | [ObjectTypeVisibility](docs/v2/Ontologies/models/ObjectTypeVisibility.md) | `from foundry.v2.ontologies.models import ObjectTypeVisibility` | -**Ontologies** | [OneOfConstraint](docs/v2/Ontologies/models/OneOfConstraint.md) | `from foundry.v2.ontologies.models import OneOfConstraint` | -**Ontologies** | [OntologyApiName](docs/v2/Ontologies/models/OntologyApiName.md) | `from foundry.v2.ontologies.models import OntologyApiName` | -**Ontologies** | [OntologyArrayType](docs/v2/Ontologies/models/OntologyArrayType.md) | `from foundry.v2.ontologies.models import OntologyArrayType` | -**Ontologies** | [OntologyDataType](docs/v2/Ontologies/models/OntologyDataType.md) | `from foundry.v2.ontologies.models import OntologyDataType` | -**Ontologies** | [OntologyFullMetadata](docs/v2/Ontologies/models/OntologyFullMetadata.md) | `from foundry.v2.ontologies.models import OntologyFullMetadata` | -**Ontologies** | [OntologyIdentifier](docs/v2/Ontologies/models/OntologyIdentifier.md) | `from foundry.v2.ontologies.models import OntologyIdentifier` | -**Ontologies** | [OntologyInterfaceObjectType](docs/v2/Ontologies/models/OntologyInterfaceObjectType.md) | `from foundry.v2.ontologies.models import OntologyInterfaceObjectType` | -**Ontologies** | [OntologyMapType](docs/v2/Ontologies/models/OntologyMapType.md) | `from foundry.v2.ontologies.models import OntologyMapType` | -**Ontologies** | [OntologyObjectArrayType](docs/v2/Ontologies/models/OntologyObjectArrayType.md) | `from foundry.v2.ontologies.models import OntologyObjectArrayType` | -**Ontologies** | [OntologyObjectSetType](docs/v2/Ontologies/models/OntologyObjectSetType.md) | `from foundry.v2.ontologies.models import OntologyObjectSetType` | -**Ontologies** | [OntologyObjectType](docs/v2/Ontologies/models/OntologyObjectType.md) | `from foundry.v2.ontologies.models import OntologyObjectType` | -**Ontologies** | [OntologyObjectTypeReferenceType](docs/v2/Ontologies/models/OntologyObjectTypeReferenceType.md) | `from foundry.v2.ontologies.models import OntologyObjectTypeReferenceType` | -**Ontologies** | [OntologyObjectV2](docs/v2/Ontologies/models/OntologyObjectV2.md) | `from foundry.v2.ontologies.models import OntologyObjectV2` | -**Ontologies** | [OntologyRid](docs/v2/Ontologies/models/OntologyRid.md) | `from foundry.v2.ontologies.models import OntologyRid` | -**Ontologies** | [OntologySetType](docs/v2/Ontologies/models/OntologySetType.md) | `from foundry.v2.ontologies.models import OntologySetType` | -**Ontologies** | [OntologyStructField](docs/v2/Ontologies/models/OntologyStructField.md) | `from foundry.v2.ontologies.models import OntologyStructField` | -**Ontologies** | [OntologyStructType](docs/v2/Ontologies/models/OntologyStructType.md) | `from foundry.v2.ontologies.models import OntologyStructType` | -**Ontologies** | [OntologyV2](docs/v2/Ontologies/models/OntologyV2.md) | `from foundry.v2.ontologies.models import OntologyV2` | -**Ontologies** | [OrderBy](docs/v2/Ontologies/models/OrderBy.md) | `from foundry.v2.ontologies.models import OrderBy` | -**Ontologies** | [OrderByDirection](docs/v2/Ontologies/models/OrderByDirection.md) | `from foundry.v2.ontologies.models import OrderByDirection` | -**Ontologies** | [OrQueryV2](docs/v2/Ontologies/models/OrQueryV2.md) | `from foundry.v2.ontologies.models import OrQueryV2` | -**Ontologies** | [ParameterEvaluatedConstraint](docs/v2/Ontologies/models/ParameterEvaluatedConstraint.md) | `from foundry.v2.ontologies.models import ParameterEvaluatedConstraint` | -**Ontologies** | [ParameterEvaluationResult](docs/v2/Ontologies/models/ParameterEvaluationResult.md) | `from foundry.v2.ontologies.models import ParameterEvaluationResult` | -**Ontologies** | [ParameterId](docs/v2/Ontologies/models/ParameterId.md) | `from foundry.v2.ontologies.models import ParameterId` | -**Ontologies** | [ParameterOption](docs/v2/Ontologies/models/ParameterOption.md) | `from foundry.v2.ontologies.models import ParameterOption` | -**Ontologies** | [PolygonValue](docs/v2/Ontologies/models/PolygonValue.md) | `from foundry.v2.ontologies.models import PolygonValue` | -**Ontologies** | [PreciseDuration](docs/v2/Ontologies/models/PreciseDuration.md) | `from foundry.v2.ontologies.models import PreciseDuration` | -**Ontologies** | [PreciseTimeUnit](docs/v2/Ontologies/models/PreciseTimeUnit.md) | `from foundry.v2.ontologies.models import PreciseTimeUnit` | -**Ontologies** | [PrimaryKeyValue](docs/v2/Ontologies/models/PrimaryKeyValue.md) | `from foundry.v2.ontologies.models import PrimaryKeyValue` | -**Ontologies** | [PropertyApiName](docs/v2/Ontologies/models/PropertyApiName.md) | `from foundry.v2.ontologies.models import PropertyApiName` | -**Ontologies** | [PropertyApiNameSelector](docs/v2/Ontologies/models/PropertyApiNameSelector.md) | `from foundry.v2.ontologies.models import PropertyApiNameSelector` | -**Ontologies** | [PropertyFilter](docs/v2/Ontologies/models/PropertyFilter.md) | `from foundry.v2.ontologies.models import PropertyFilter` | -**Ontologies** | [PropertyId](docs/v2/Ontologies/models/PropertyId.md) | `from foundry.v2.ontologies.models import PropertyId` | -**Ontologies** | [PropertyIdentifier](docs/v2/Ontologies/models/PropertyIdentifier.md) | `from foundry.v2.ontologies.models import PropertyIdentifier` | -**Ontologies** | [PropertyTypeRid](docs/v2/Ontologies/models/PropertyTypeRid.md) | `from foundry.v2.ontologies.models import PropertyTypeRid` | -**Ontologies** | [PropertyTypeStatus](docs/v2/Ontologies/models/PropertyTypeStatus.md) | `from foundry.v2.ontologies.models import PropertyTypeStatus` | -**Ontologies** | [PropertyTypeVisibility](docs/v2/Ontologies/models/PropertyTypeVisibility.md) | `from foundry.v2.ontologies.models import PropertyTypeVisibility` | -**Ontologies** | [PropertyV2](docs/v2/Ontologies/models/PropertyV2.md) | `from foundry.v2.ontologies.models import PropertyV2` | -**Ontologies** | [PropertyValue](docs/v2/Ontologies/models/PropertyValue.md) | `from foundry.v2.ontologies.models import PropertyValue` | -**Ontologies** | [PropertyValueEscapedString](docs/v2/Ontologies/models/PropertyValueEscapedString.md) | `from foundry.v2.ontologies.models import PropertyValueEscapedString` | -**Ontologies** | [QueryAggregationKeyType](docs/v2/Ontologies/models/QueryAggregationKeyType.md) | `from foundry.v2.ontologies.models import QueryAggregationKeyType` | -**Ontologies** | [QueryAggregationRangeSubType](docs/v2/Ontologies/models/QueryAggregationRangeSubType.md) | `from foundry.v2.ontologies.models import QueryAggregationRangeSubType` | -**Ontologies** | [QueryAggregationRangeType](docs/v2/Ontologies/models/QueryAggregationRangeType.md) | `from foundry.v2.ontologies.models import QueryAggregationRangeType` | -**Ontologies** | [QueryAggregationValueType](docs/v2/Ontologies/models/QueryAggregationValueType.md) | `from foundry.v2.ontologies.models import QueryAggregationValueType` | -**Ontologies** | [QueryApiName](docs/v2/Ontologies/models/QueryApiName.md) | `from foundry.v2.ontologies.models import QueryApiName` | -**Ontologies** | [QueryArrayType](docs/v2/Ontologies/models/QueryArrayType.md) | `from foundry.v2.ontologies.models import QueryArrayType` | -**Ontologies** | [QueryDataType](docs/v2/Ontologies/models/QueryDataType.md) | `from foundry.v2.ontologies.models import QueryDataType` | -**Ontologies** | [QueryParameterV2](docs/v2/Ontologies/models/QueryParameterV2.md) | `from foundry.v2.ontologies.models import QueryParameterV2` | -**Ontologies** | [QueryRuntimeErrorParameter](docs/v2/Ontologies/models/QueryRuntimeErrorParameter.md) | `from foundry.v2.ontologies.models import QueryRuntimeErrorParameter` | -**Ontologies** | [QuerySetType](docs/v2/Ontologies/models/QuerySetType.md) | `from foundry.v2.ontologies.models import QuerySetType` | -**Ontologies** | [QueryStructField](docs/v2/Ontologies/models/QueryStructField.md) | `from foundry.v2.ontologies.models import QueryStructField` | -**Ontologies** | [QueryStructType](docs/v2/Ontologies/models/QueryStructType.md) | `from foundry.v2.ontologies.models import QueryStructType` | -**Ontologies** | [QueryTypeV2](docs/v2/Ontologies/models/QueryTypeV2.md) | `from foundry.v2.ontologies.models import QueryTypeV2` | -**Ontologies** | [QueryUnionType](docs/v2/Ontologies/models/QueryUnionType.md) | `from foundry.v2.ontologies.models import QueryUnionType` | -**Ontologies** | [RangeConstraint](docs/v2/Ontologies/models/RangeConstraint.md) | `from foundry.v2.ontologies.models import RangeConstraint` | -**Ontologies** | [RelativeTime](docs/v2/Ontologies/models/RelativeTime.md) | `from foundry.v2.ontologies.models import RelativeTime` | -**Ontologies** | [RelativeTimeRange](docs/v2/Ontologies/models/RelativeTimeRange.md) | `from foundry.v2.ontologies.models import RelativeTimeRange` | -**Ontologies** | [RelativeTimeRelation](docs/v2/Ontologies/models/RelativeTimeRelation.md) | `from foundry.v2.ontologies.models import RelativeTimeRelation` | -**Ontologies** | [RelativeTimeSeriesTimeUnit](docs/v2/Ontologies/models/RelativeTimeSeriesTimeUnit.md) | `from foundry.v2.ontologies.models import RelativeTimeSeriesTimeUnit` | -**Ontologies** | [ReturnEditsMode](docs/v2/Ontologies/models/ReturnEditsMode.md) | `from foundry.v2.ontologies.models import ReturnEditsMode` | -**Ontologies** | [RollingAggregateWindowPoints](docs/v2/Ontologies/models/RollingAggregateWindowPoints.md) | `from foundry.v2.ontologies.models import RollingAggregateWindowPoints` | -**Ontologies** | [SdkPackageName](docs/v2/Ontologies/models/SdkPackageName.md) | `from foundry.v2.ontologies.models import SdkPackageName` | -**Ontologies** | [SearchJsonQueryV2](docs/v2/Ontologies/models/SearchJsonQueryV2.md) | `from foundry.v2.ontologies.models import SearchJsonQueryV2` | -**Ontologies** | [SearchObjectsResponseV2](docs/v2/Ontologies/models/SearchObjectsResponseV2.md) | `from foundry.v2.ontologies.models import SearchObjectsResponseV2` | -**Ontologies** | [SearchOrderByType](docs/v2/Ontologies/models/SearchOrderByType.md) | `from foundry.v2.ontologies.models import SearchOrderByType` | -**Ontologies** | [SearchOrderByV2](docs/v2/Ontologies/models/SearchOrderByV2.md) | `from foundry.v2.ontologies.models import SearchOrderByV2` | -**Ontologies** | [SearchOrderingV2](docs/v2/Ontologies/models/SearchOrderingV2.md) | `from foundry.v2.ontologies.models import SearchOrderingV2` | -**Ontologies** | [SelectedPropertyApiName](docs/v2/Ontologies/models/SelectedPropertyApiName.md) | `from foundry.v2.ontologies.models import SelectedPropertyApiName` | -**Ontologies** | [SelectedPropertyApproximateDistinctAggregation](docs/v2/Ontologies/models/SelectedPropertyApproximateDistinctAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyApproximateDistinctAggregation` | -**Ontologies** | [SelectedPropertyApproximatePercentileAggregation](docs/v2/Ontologies/models/SelectedPropertyApproximatePercentileAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyApproximatePercentileAggregation` | -**Ontologies** | [SelectedPropertyAvgAggregation](docs/v2/Ontologies/models/SelectedPropertyAvgAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyAvgAggregation` | -**Ontologies** | [SelectedPropertyCollectListAggregation](docs/v2/Ontologies/models/SelectedPropertyCollectListAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyCollectListAggregation` | -**Ontologies** | [SelectedPropertyCollectSetAggregation](docs/v2/Ontologies/models/SelectedPropertyCollectSetAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyCollectSetAggregation` | -**Ontologies** | [SelectedPropertyCountAggregation](docs/v2/Ontologies/models/SelectedPropertyCountAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyCountAggregation` | -**Ontologies** | [SelectedPropertyExactDistinctAggregation](docs/v2/Ontologies/models/SelectedPropertyExactDistinctAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyExactDistinctAggregation` | -**Ontologies** | [SelectedPropertyExpression](docs/v2/Ontologies/models/SelectedPropertyExpression.md) | `from foundry.v2.ontologies.models import SelectedPropertyExpression` | -**Ontologies** | [SelectedPropertyMaxAggregation](docs/v2/Ontologies/models/SelectedPropertyMaxAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyMaxAggregation` | -**Ontologies** | [SelectedPropertyMinAggregation](docs/v2/Ontologies/models/SelectedPropertyMinAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertyMinAggregation` | -**Ontologies** | [SelectedPropertyOperation](docs/v2/Ontologies/models/SelectedPropertyOperation.md) | `from foundry.v2.ontologies.models import SelectedPropertyOperation` | -**Ontologies** | [SelectedPropertySumAggregation](docs/v2/Ontologies/models/SelectedPropertySumAggregation.md) | `from foundry.v2.ontologies.models import SelectedPropertySumAggregation` | -**Ontologies** | [SharedPropertyType](docs/v2/Ontologies/models/SharedPropertyType.md) | `from foundry.v2.ontologies.models import SharedPropertyType` | -**Ontologies** | [SharedPropertyTypeApiName](docs/v2/Ontologies/models/SharedPropertyTypeApiName.md) | `from foundry.v2.ontologies.models import SharedPropertyTypeApiName` | -**Ontologies** | [SharedPropertyTypeRid](docs/v2/Ontologies/models/SharedPropertyTypeRid.md) | `from foundry.v2.ontologies.models import SharedPropertyTypeRid` | -**Ontologies** | [StartsWithQuery](docs/v2/Ontologies/models/StartsWithQuery.md) | `from foundry.v2.ontologies.models import StartsWithQuery` | -**Ontologies** | [StreamingOutputFormat](docs/v2/Ontologies/models/StreamingOutputFormat.md) | `from foundry.v2.ontologies.models import StreamingOutputFormat` | -**Ontologies** | [StringLengthConstraint](docs/v2/Ontologies/models/StringLengthConstraint.md) | `from foundry.v2.ontologies.models import StringLengthConstraint` | -**Ontologies** | [StringRegexMatchConstraint](docs/v2/Ontologies/models/StringRegexMatchConstraint.md) | `from foundry.v2.ontologies.models import StringRegexMatchConstraint` | -**Ontologies** | [StructFieldApiName](docs/v2/Ontologies/models/StructFieldApiName.md) | `from foundry.v2.ontologies.models import StructFieldApiName` | -**Ontologies** | [StructFieldSelector](docs/v2/Ontologies/models/StructFieldSelector.md) | `from foundry.v2.ontologies.models import StructFieldSelector` | -**Ontologies** | [StructFieldType](docs/v2/Ontologies/models/StructFieldType.md) | `from foundry.v2.ontologies.models import StructFieldType` | -**Ontologies** | [StructType](docs/v2/Ontologies/models/StructType.md) | `from foundry.v2.ontologies.models import StructType` | -**Ontologies** | [SubmissionCriteriaEvaluation](docs/v2/Ontologies/models/SubmissionCriteriaEvaluation.md) | `from foundry.v2.ontologies.models import SubmissionCriteriaEvaluation` | -**Ontologies** | [SubtractPropertyExpression](docs/v2/Ontologies/models/SubtractPropertyExpression.md) | `from foundry.v2.ontologies.models import SubtractPropertyExpression` | -**Ontologies** | [SumAggregationV2](docs/v2/Ontologies/models/SumAggregationV2.md) | `from foundry.v2.ontologies.models import SumAggregationV2` | -**Ontologies** | [SyncApplyActionResponseV2](docs/v2/Ontologies/models/SyncApplyActionResponseV2.md) | `from foundry.v2.ontologies.models import SyncApplyActionResponseV2` | -**Ontologies** | [ThreeDimensionalAggregation](docs/v2/Ontologies/models/ThreeDimensionalAggregation.md) | `from foundry.v2.ontologies.models import ThreeDimensionalAggregation` | -**Ontologies** | [TimeRange](docs/v2/Ontologies/models/TimeRange.md) | `from foundry.v2.ontologies.models import TimeRange` | -**Ontologies** | [TimeSeriesAggregationMethod](docs/v2/Ontologies/models/TimeSeriesAggregationMethod.md) | `from foundry.v2.ontologies.models import TimeSeriesAggregationMethod` | -**Ontologies** | [TimeSeriesAggregationStrategy](docs/v2/Ontologies/models/TimeSeriesAggregationStrategy.md) | `from foundry.v2.ontologies.models import TimeSeriesAggregationStrategy` | -**Ontologies** | [TimeSeriesCumulativeAggregate](docs/v2/Ontologies/models/TimeSeriesCumulativeAggregate.md) | `from foundry.v2.ontologies.models import TimeSeriesCumulativeAggregate` | -**Ontologies** | [TimeseriesEntry](docs/v2/Ontologies/models/TimeseriesEntry.md) | `from foundry.v2.ontologies.models import TimeseriesEntry` | -**Ontologies** | [TimeSeriesPeriodicAggregate](docs/v2/Ontologies/models/TimeSeriesPeriodicAggregate.md) | `from foundry.v2.ontologies.models import TimeSeriesPeriodicAggregate` | -**Ontologies** | [TimeSeriesPoint](docs/v2/Ontologies/models/TimeSeriesPoint.md) | `from foundry.v2.ontologies.models import TimeSeriesPoint` | -**Ontologies** | [TimeSeriesRollingAggregate](docs/v2/Ontologies/models/TimeSeriesRollingAggregate.md) | `from foundry.v2.ontologies.models import TimeSeriesRollingAggregate` | -**Ontologies** | [TimeSeriesRollingAggregateWindow](docs/v2/Ontologies/models/TimeSeriesRollingAggregateWindow.md) | `from foundry.v2.ontologies.models import TimeSeriesRollingAggregateWindow` | -**Ontologies** | [TimeSeriesWindowType](docs/v2/Ontologies/models/TimeSeriesWindowType.md) | `from foundry.v2.ontologies.models import TimeSeriesWindowType` | -**Ontologies** | [TimeUnit](docs/v2/Ontologies/models/TimeUnit.md) | `from foundry.v2.ontologies.models import TimeUnit` | -**Ontologies** | [TwoDimensionalAggregation](docs/v2/Ontologies/models/TwoDimensionalAggregation.md) | `from foundry.v2.ontologies.models import TwoDimensionalAggregation` | -**Ontologies** | [UnevaluableConstraint](docs/v2/Ontologies/models/UnevaluableConstraint.md) | `from foundry.v2.ontologies.models import UnevaluableConstraint` | -**Ontologies** | [ValidateActionResponseV2](docs/v2/Ontologies/models/ValidateActionResponseV2.md) | `from foundry.v2.ontologies.models import ValidateActionResponseV2` | -**Ontologies** | [ValidationResult](docs/v2/Ontologies/models/ValidationResult.md) | `from foundry.v2.ontologies.models import ValidationResult` | -**Ontologies** | [ValueType](docs/v2/Ontologies/models/ValueType.md) | `from foundry.v2.ontologies.models import ValueType` | -**Ontologies** | [WithinBoundingBoxPoint](docs/v2/Ontologies/models/WithinBoundingBoxPoint.md) | `from foundry.v2.ontologies.models import WithinBoundingBoxPoint` | -**Ontologies** | [WithinBoundingBoxQuery](docs/v2/Ontologies/models/WithinBoundingBoxQuery.md) | `from foundry.v2.ontologies.models import WithinBoundingBoxQuery` | -**Ontologies** | [WithinDistanceOfQuery](docs/v2/Ontologies/models/WithinDistanceOfQuery.md) | `from foundry.v2.ontologies.models import WithinDistanceOfQuery` | -**Ontologies** | [WithinPolygonQuery](docs/v2/Ontologies/models/WithinPolygonQuery.md) | `from foundry.v2.ontologies.models import WithinPolygonQuery` | -**Orchestration** | [AbortOnFailure](docs/v2/Orchestration/models/AbortOnFailure.md) | `from foundry.v2.orchestration.models import AbortOnFailure` | -**Orchestration** | [Action](docs/v2/Orchestration/models/Action.md) | `from foundry.v2.orchestration.models import Action` | -**Orchestration** | [AndTrigger](docs/v2/Orchestration/models/AndTrigger.md) | `from foundry.v2.orchestration.models import AndTrigger` | -**Orchestration** | [Build](docs/v2/Orchestration/models/Build.md) | `from foundry.v2.orchestration.models import Build` | -**Orchestration** | [BuildableRid](docs/v2/Orchestration/models/BuildableRid.md) | `from foundry.v2.orchestration.models import BuildableRid` | -**Orchestration** | [BuildStatus](docs/v2/Orchestration/models/BuildStatus.md) | `from foundry.v2.orchestration.models import BuildStatus` | -**Orchestration** | [BuildTarget](docs/v2/Orchestration/models/BuildTarget.md) | `from foundry.v2.orchestration.models import BuildTarget` | -**Orchestration** | [ConnectingTarget](docs/v2/Orchestration/models/ConnectingTarget.md) | `from foundry.v2.orchestration.models import ConnectingTarget` | -**Orchestration** | [CreateScheduleRequestAction](docs/v2/Orchestration/models/CreateScheduleRequestAction.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestAction` | -**Orchestration** | [CreateScheduleRequestBuildTarget](docs/v2/Orchestration/models/CreateScheduleRequestBuildTarget.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestBuildTarget` | -**Orchestration** | [CreateScheduleRequestConnectingTarget](docs/v2/Orchestration/models/CreateScheduleRequestConnectingTarget.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestConnectingTarget` | -**Orchestration** | [CreateScheduleRequestManualTarget](docs/v2/Orchestration/models/CreateScheduleRequestManualTarget.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestManualTarget` | -**Orchestration** | [CreateScheduleRequestProjectScope](docs/v2/Orchestration/models/CreateScheduleRequestProjectScope.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestProjectScope` | -**Orchestration** | [CreateScheduleRequestScopeMode](docs/v2/Orchestration/models/CreateScheduleRequestScopeMode.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestScopeMode` | -**Orchestration** | [CreateScheduleRequestUpstreamTarget](docs/v2/Orchestration/models/CreateScheduleRequestUpstreamTarget.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestUpstreamTarget` | -**Orchestration** | [CreateScheduleRequestUserScope](docs/v2/Orchestration/models/CreateScheduleRequestUserScope.md) | `from foundry.v2.orchestration.models import CreateScheduleRequestUserScope` | -**Orchestration** | [CronExpression](docs/v2/Orchestration/models/CronExpression.md) | `from foundry.v2.orchestration.models import CronExpression` | -**Orchestration** | [DatasetJobOutput](docs/v2/Orchestration/models/DatasetJobOutput.md) | `from foundry.v2.orchestration.models import DatasetJobOutput` | -**Orchestration** | [DatasetUpdatedTrigger](docs/v2/Orchestration/models/DatasetUpdatedTrigger.md) | `from foundry.v2.orchestration.models import DatasetUpdatedTrigger` | -**Orchestration** | [FallbackBranches](docs/v2/Orchestration/models/FallbackBranches.md) | `from foundry.v2.orchestration.models import FallbackBranches` | -**Orchestration** | [ForceBuild](docs/v2/Orchestration/models/ForceBuild.md) | `from foundry.v2.orchestration.models import ForceBuild` | -**Orchestration** | [GetBuildsBatchRequestElement](docs/v2/Orchestration/models/GetBuildsBatchRequestElement.md) | `from foundry.v2.orchestration.models import GetBuildsBatchRequestElement` | -**Orchestration** | [GetBuildsBatchResponse](docs/v2/Orchestration/models/GetBuildsBatchResponse.md) | `from foundry.v2.orchestration.models import GetBuildsBatchResponse` | -**Orchestration** | [GetJobsBatchRequestElement](docs/v2/Orchestration/models/GetJobsBatchRequestElement.md) | `from foundry.v2.orchestration.models import GetJobsBatchRequestElement` | -**Orchestration** | [GetJobsBatchResponse](docs/v2/Orchestration/models/GetJobsBatchResponse.md) | `from foundry.v2.orchestration.models import GetJobsBatchResponse` | -**Orchestration** | [Job](docs/v2/Orchestration/models/Job.md) | `from foundry.v2.orchestration.models import Job` | -**Orchestration** | [JobOutput](docs/v2/Orchestration/models/JobOutput.md) | `from foundry.v2.orchestration.models import JobOutput` | -**Orchestration** | [JobStartedTime](docs/v2/Orchestration/models/JobStartedTime.md) | `from foundry.v2.orchestration.models import JobStartedTime` | -**Orchestration** | [JobStatus](docs/v2/Orchestration/models/JobStatus.md) | `from foundry.v2.orchestration.models import JobStatus` | -**Orchestration** | [JobSucceededTrigger](docs/v2/Orchestration/models/JobSucceededTrigger.md) | `from foundry.v2.orchestration.models import JobSucceededTrigger` | -**Orchestration** | [ListJobsOfBuildResponse](docs/v2/Orchestration/models/ListJobsOfBuildResponse.md) | `from foundry.v2.orchestration.models import ListJobsOfBuildResponse` | -**Orchestration** | [ListRunsOfScheduleResponse](docs/v2/Orchestration/models/ListRunsOfScheduleResponse.md) | `from foundry.v2.orchestration.models import ListRunsOfScheduleResponse` | -**Orchestration** | [ManualTarget](docs/v2/Orchestration/models/ManualTarget.md) | `from foundry.v2.orchestration.models import ManualTarget` | -**Orchestration** | [MediaSetUpdatedTrigger](docs/v2/Orchestration/models/MediaSetUpdatedTrigger.md) | `from foundry.v2.orchestration.models import MediaSetUpdatedTrigger` | -**Orchestration** | [NewLogicTrigger](docs/v2/Orchestration/models/NewLogicTrigger.md) | `from foundry.v2.orchestration.models import NewLogicTrigger` | -**Orchestration** | [NotificationsEnabled](docs/v2/Orchestration/models/NotificationsEnabled.md) | `from foundry.v2.orchestration.models import NotificationsEnabled` | -**Orchestration** | [OrTrigger](docs/v2/Orchestration/models/OrTrigger.md) | `from foundry.v2.orchestration.models import OrTrigger` | -**Orchestration** | [ProjectScope](docs/v2/Orchestration/models/ProjectScope.md) | `from foundry.v2.orchestration.models import ProjectScope` | -**Orchestration** | [ReplaceScheduleRequestAction](docs/v2/Orchestration/models/ReplaceScheduleRequestAction.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestAction` | -**Orchestration** | [ReplaceScheduleRequestBuildTarget](docs/v2/Orchestration/models/ReplaceScheduleRequestBuildTarget.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestBuildTarget` | -**Orchestration** | [ReplaceScheduleRequestConnectingTarget](docs/v2/Orchestration/models/ReplaceScheduleRequestConnectingTarget.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestConnectingTarget` | -**Orchestration** | [ReplaceScheduleRequestManualTarget](docs/v2/Orchestration/models/ReplaceScheduleRequestManualTarget.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestManualTarget` | -**Orchestration** | [ReplaceScheduleRequestProjectScope](docs/v2/Orchestration/models/ReplaceScheduleRequestProjectScope.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestProjectScope` | -**Orchestration** | [ReplaceScheduleRequestScopeMode](docs/v2/Orchestration/models/ReplaceScheduleRequestScopeMode.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestScopeMode` | -**Orchestration** | [ReplaceScheduleRequestUpstreamTarget](docs/v2/Orchestration/models/ReplaceScheduleRequestUpstreamTarget.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestUpstreamTarget` | -**Orchestration** | [ReplaceScheduleRequestUserScope](docs/v2/Orchestration/models/ReplaceScheduleRequestUserScope.md) | `from foundry.v2.orchestration.models import ReplaceScheduleRequestUserScope` | -**Orchestration** | [RetryBackoffDuration](docs/v2/Orchestration/models/RetryBackoffDuration.md) | `from foundry.v2.orchestration.models import RetryBackoffDuration` | -**Orchestration** | [RetryCount](docs/v2/Orchestration/models/RetryCount.md) | `from foundry.v2.orchestration.models import RetryCount` | -**Orchestration** | [Schedule](docs/v2/Orchestration/models/Schedule.md) | `from foundry.v2.orchestration.models import Schedule` | -**Orchestration** | [SchedulePaused](docs/v2/Orchestration/models/SchedulePaused.md) | `from foundry.v2.orchestration.models import SchedulePaused` | -**Orchestration** | [ScheduleRid](docs/v2/Orchestration/models/ScheduleRid.md) | `from foundry.v2.orchestration.models import ScheduleRid` | -**Orchestration** | [ScheduleRun](docs/v2/Orchestration/models/ScheduleRun.md) | `from foundry.v2.orchestration.models import ScheduleRun` | -**Orchestration** | [ScheduleRunError](docs/v2/Orchestration/models/ScheduleRunError.md) | `from foundry.v2.orchestration.models import ScheduleRunError` | -**Orchestration** | [ScheduleRunErrorName](docs/v2/Orchestration/models/ScheduleRunErrorName.md) | `from foundry.v2.orchestration.models import ScheduleRunErrorName` | -**Orchestration** | [ScheduleRunIgnored](docs/v2/Orchestration/models/ScheduleRunIgnored.md) | `from foundry.v2.orchestration.models import ScheduleRunIgnored` | -**Orchestration** | [ScheduleRunResult](docs/v2/Orchestration/models/ScheduleRunResult.md) | `from foundry.v2.orchestration.models import ScheduleRunResult` | -**Orchestration** | [ScheduleRunRid](docs/v2/Orchestration/models/ScheduleRunRid.md) | `from foundry.v2.orchestration.models import ScheduleRunRid` | -**Orchestration** | [ScheduleRunSubmitted](docs/v2/Orchestration/models/ScheduleRunSubmitted.md) | `from foundry.v2.orchestration.models import ScheduleRunSubmitted` | -**Orchestration** | [ScheduleSucceededTrigger](docs/v2/Orchestration/models/ScheduleSucceededTrigger.md) | `from foundry.v2.orchestration.models import ScheduleSucceededTrigger` | -**Orchestration** | [ScheduleVersion](docs/v2/Orchestration/models/ScheduleVersion.md) | `from foundry.v2.orchestration.models import ScheduleVersion` | -**Orchestration** | [ScheduleVersionRid](docs/v2/Orchestration/models/ScheduleVersionRid.md) | `from foundry.v2.orchestration.models import ScheduleVersionRid` | -**Orchestration** | [ScopeMode](docs/v2/Orchestration/models/ScopeMode.md) | `from foundry.v2.orchestration.models import ScopeMode` | -**Orchestration** | [SearchBuildsAndFilter](docs/v2/Orchestration/models/SearchBuildsAndFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsAndFilter` | -**Orchestration** | [SearchBuildsEqualsFilter](docs/v2/Orchestration/models/SearchBuildsEqualsFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsEqualsFilter` | -**Orchestration** | [SearchBuildsEqualsFilterField](docs/v2/Orchestration/models/SearchBuildsEqualsFilterField.md) | `from foundry.v2.orchestration.models import SearchBuildsEqualsFilterField` | -**Orchestration** | [SearchBuildsFilter](docs/v2/Orchestration/models/SearchBuildsFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsFilter` | -**Orchestration** | [SearchBuildsGteFilter](docs/v2/Orchestration/models/SearchBuildsGteFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsGteFilter` | -**Orchestration** | [SearchBuildsGteFilterField](docs/v2/Orchestration/models/SearchBuildsGteFilterField.md) | `from foundry.v2.orchestration.models import SearchBuildsGteFilterField` | -**Orchestration** | [SearchBuildsLtFilter](docs/v2/Orchestration/models/SearchBuildsLtFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsLtFilter` | -**Orchestration** | [SearchBuildsLtFilterField](docs/v2/Orchestration/models/SearchBuildsLtFilterField.md) | `from foundry.v2.orchestration.models import SearchBuildsLtFilterField` | -**Orchestration** | [SearchBuildsNotFilter](docs/v2/Orchestration/models/SearchBuildsNotFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsNotFilter` | -**Orchestration** | [SearchBuildsOrderBy](docs/v2/Orchestration/models/SearchBuildsOrderBy.md) | `from foundry.v2.orchestration.models import SearchBuildsOrderBy` | -**Orchestration** | [SearchBuildsOrderByField](docs/v2/Orchestration/models/SearchBuildsOrderByField.md) | `from foundry.v2.orchestration.models import SearchBuildsOrderByField` | -**Orchestration** | [SearchBuildsOrderByItem](docs/v2/Orchestration/models/SearchBuildsOrderByItem.md) | `from foundry.v2.orchestration.models import SearchBuildsOrderByItem` | -**Orchestration** | [SearchBuildsOrFilter](docs/v2/Orchestration/models/SearchBuildsOrFilter.md) | `from foundry.v2.orchestration.models import SearchBuildsOrFilter` | -**Orchestration** | [SearchBuildsResponse](docs/v2/Orchestration/models/SearchBuildsResponse.md) | `from foundry.v2.orchestration.models import SearchBuildsResponse` | -**Orchestration** | [TimeTrigger](docs/v2/Orchestration/models/TimeTrigger.md) | `from foundry.v2.orchestration.models import TimeTrigger` | -**Orchestration** | [TransactionalMediaSetJobOutput](docs/v2/Orchestration/models/TransactionalMediaSetJobOutput.md) | `from foundry.v2.orchestration.models import TransactionalMediaSetJobOutput` | -**Orchestration** | [Trigger](docs/v2/Orchestration/models/Trigger.md) | `from foundry.v2.orchestration.models import Trigger` | -**Orchestration** | [UpstreamTarget](docs/v2/Orchestration/models/UpstreamTarget.md) | `from foundry.v2.orchestration.models import UpstreamTarget` | -**Orchestration** | [UserScope](docs/v2/Orchestration/models/UserScope.md) | `from foundry.v2.orchestration.models import UserScope` | -**SqlQueries** | [CanceledQueryStatus](docs/v2/SqlQueries/models/CanceledQueryStatus.md) | `from foundry.v2.sql_queries.models import CanceledQueryStatus` | -**SqlQueries** | [FailedQueryStatus](docs/v2/SqlQueries/models/FailedQueryStatus.md) | `from foundry.v2.sql_queries.models import FailedQueryStatus` | -**SqlQueries** | [QueryId](docs/v2/SqlQueries/models/QueryId.md) | `from foundry.v2.sql_queries.models import QueryId` | -**SqlQueries** | [QueryStatus](docs/v2/SqlQueries/models/QueryStatus.md) | `from foundry.v2.sql_queries.models import QueryStatus` | -**SqlQueries** | [RunningQueryStatus](docs/v2/SqlQueries/models/RunningQueryStatus.md) | `from foundry.v2.sql_queries.models import RunningQueryStatus` | -**SqlQueries** | [SucceededQueryStatus](docs/v2/SqlQueries/models/SucceededQueryStatus.md) | `from foundry.v2.sql_queries.models import SucceededQueryStatus` | -**Streams** | [Compressed](docs/v2/Streams/models/Compressed.md) | `from foundry.v2.streams.models import Compressed` | -**Streams** | [CreateStreamRequestStreamSchema](docs/v2/Streams/models/CreateStreamRequestStreamSchema.md) | `from foundry.v2.streams.models import CreateStreamRequestStreamSchema` | -**Streams** | [Dataset](docs/v2/Streams/models/Dataset.md) | `from foundry.v2.streams.models import Dataset` | -**Streams** | [PartitionsCount](docs/v2/Streams/models/PartitionsCount.md) | `from foundry.v2.streams.models import PartitionsCount` | -**Streams** | [Record](docs/v2/Streams/models/Record.md) | `from foundry.v2.streams.models import Record` | -**Streams** | [Stream](docs/v2/Streams/models/Stream.md) | `from foundry.v2.streams.models import Stream` | -**Streams** | [StreamType](docs/v2/Streams/models/StreamType.md) | `from foundry.v2.streams.models import StreamType` | -**Streams** | [ViewRid](docs/v2/Streams/models/ViewRid.md) | `from foundry.v2.streams.models import ViewRid` | -**ThirdPartyApplications** | [ListVersionsResponse](docs/v2/ThirdPartyApplications/models/ListVersionsResponse.md) | `from foundry.v2.third_party_applications.models import ListVersionsResponse` | -**ThirdPartyApplications** | [Subdomain](docs/v2/ThirdPartyApplications/models/Subdomain.md) | `from foundry.v2.third_party_applications.models import Subdomain` | -**ThirdPartyApplications** | [ThirdPartyApplication](docs/v2/ThirdPartyApplications/models/ThirdPartyApplication.md) | `from foundry.v2.third_party_applications.models import ThirdPartyApplication` | -**ThirdPartyApplications** | [ThirdPartyApplicationRid](docs/v2/ThirdPartyApplications/models/ThirdPartyApplicationRid.md) | `from foundry.v2.third_party_applications.models import ThirdPartyApplicationRid` | -**ThirdPartyApplications** | [Version](docs/v2/ThirdPartyApplications/models/Version.md) | `from foundry.v2.third_party_applications.models import Version` | -**ThirdPartyApplications** | [VersionVersion](docs/v2/ThirdPartyApplications/models/VersionVersion.md) | `from foundry.v2.third_party_applications.models import VersionVersion` | -**ThirdPartyApplications** | [Website](docs/v2/ThirdPartyApplications/models/Website.md) | `from foundry.v2.third_party_applications.models import Website` | +**Admin** | [AttributeName](docs/v2/Admin/models/AttributeName.md) | `from foundry_sdk.v2.admin.models import AttributeName` | +**Admin** | [AttributeValue](docs/v2/Admin/models/AttributeValue.md) | `from foundry_sdk.v2.admin.models import AttributeValue` | +**Admin** | [AttributeValues](docs/v2/Admin/models/AttributeValues.md) | `from foundry_sdk.v2.admin.models import AttributeValues` | +**Admin** | [AuthenticationProtocol](docs/v2/Admin/models/AuthenticationProtocol.md) | `from foundry_sdk.v2.admin.models import AuthenticationProtocol` | +**Admin** | [AuthenticationProvider](docs/v2/Admin/models/AuthenticationProvider.md) | `from foundry_sdk.v2.admin.models import AuthenticationProvider` | +**Admin** | [AuthenticationProviderEnabled](docs/v2/Admin/models/AuthenticationProviderEnabled.md) | `from foundry_sdk.v2.admin.models import AuthenticationProviderEnabled` | +**Admin** | [AuthenticationProviderName](docs/v2/Admin/models/AuthenticationProviderName.md) | `from foundry_sdk.v2.admin.models import AuthenticationProviderName` | +**Admin** | [AuthenticationProviderRid](docs/v2/Admin/models/AuthenticationProviderRid.md) | `from foundry_sdk.v2.admin.models import AuthenticationProviderRid` | +**Admin** | [CertificateInfo](docs/v2/Admin/models/CertificateInfo.md) | `from foundry_sdk.v2.admin.models import CertificateInfo` | +**Admin** | [CertificateUsageType](docs/v2/Admin/models/CertificateUsageType.md) | `from foundry_sdk.v2.admin.models import CertificateUsageType` | +**Admin** | [Enrollment](docs/v2/Admin/models/Enrollment.md) | `from foundry_sdk.v2.admin.models import Enrollment` | +**Admin** | [EnrollmentName](docs/v2/Admin/models/EnrollmentName.md) | `from foundry_sdk.v2.admin.models import EnrollmentName` | +**Admin** | [GetGroupsBatchRequestElement](docs/v2/Admin/models/GetGroupsBatchRequestElement.md) | `from foundry_sdk.v2.admin.models import GetGroupsBatchRequestElement` | +**Admin** | [GetGroupsBatchResponse](docs/v2/Admin/models/GetGroupsBatchResponse.md) | `from foundry_sdk.v2.admin.models import GetGroupsBatchResponse` | +**Admin** | [GetMarkingsBatchRequestElement](docs/v2/Admin/models/GetMarkingsBatchRequestElement.md) | `from foundry_sdk.v2.admin.models import GetMarkingsBatchRequestElement` | +**Admin** | [GetMarkingsBatchResponse](docs/v2/Admin/models/GetMarkingsBatchResponse.md) | `from foundry_sdk.v2.admin.models import GetMarkingsBatchResponse` | +**Admin** | [GetUserMarkingsResponse](docs/v2/Admin/models/GetUserMarkingsResponse.md) | `from foundry_sdk.v2.admin.models import GetUserMarkingsResponse` | +**Admin** | [GetUsersBatchRequestElement](docs/v2/Admin/models/GetUsersBatchRequestElement.md) | `from foundry_sdk.v2.admin.models import GetUsersBatchRequestElement` | +**Admin** | [GetUsersBatchResponse](docs/v2/Admin/models/GetUsersBatchResponse.md) | `from foundry_sdk.v2.admin.models import GetUsersBatchResponse` | +**Admin** | [Group](docs/v2/Admin/models/Group.md) | `from foundry_sdk.v2.admin.models import Group` | +**Admin** | [GroupMember](docs/v2/Admin/models/GroupMember.md) | `from foundry_sdk.v2.admin.models import GroupMember` | +**Admin** | [GroupMembership](docs/v2/Admin/models/GroupMembership.md) | `from foundry_sdk.v2.admin.models import GroupMembership` | +**Admin** | [GroupMembershipExpiration](docs/v2/Admin/models/GroupMembershipExpiration.md) | `from foundry_sdk.v2.admin.models import GroupMembershipExpiration` | +**Admin** | [GroupName](docs/v2/Admin/models/GroupName.md) | `from foundry_sdk.v2.admin.models import GroupName` | +**Admin** | [GroupProviderInfo](docs/v2/Admin/models/GroupProviderInfo.md) | `from foundry_sdk.v2.admin.models import GroupProviderInfo` | +**Admin** | [GroupSearchFilter](docs/v2/Admin/models/GroupSearchFilter.md) | `from foundry_sdk.v2.admin.models import GroupSearchFilter` | +**Admin** | [Host](docs/v2/Admin/models/Host.md) | `from foundry_sdk.v2.admin.models import Host` | +**Admin** | [HostName](docs/v2/Admin/models/HostName.md) | `from foundry_sdk.v2.admin.models import HostName` | +**Admin** | [ListAuthenticationProvidersResponse](docs/v2/Admin/models/ListAuthenticationProvidersResponse.md) | `from foundry_sdk.v2.admin.models import ListAuthenticationProvidersResponse` | +**Admin** | [ListGroupMembershipsResponse](docs/v2/Admin/models/ListGroupMembershipsResponse.md) | `from foundry_sdk.v2.admin.models import ListGroupMembershipsResponse` | +**Admin** | [ListGroupMembersResponse](docs/v2/Admin/models/ListGroupMembersResponse.md) | `from foundry_sdk.v2.admin.models import ListGroupMembersResponse` | +**Admin** | [ListGroupsResponse](docs/v2/Admin/models/ListGroupsResponse.md) | `from foundry_sdk.v2.admin.models import ListGroupsResponse` | +**Admin** | [ListHostsResponse](docs/v2/Admin/models/ListHostsResponse.md) | `from foundry_sdk.v2.admin.models import ListHostsResponse` | +**Admin** | [ListMarkingCategoriesResponse](docs/v2/Admin/models/ListMarkingCategoriesResponse.md) | `from foundry_sdk.v2.admin.models import ListMarkingCategoriesResponse` | +**Admin** | [ListMarkingMembersResponse](docs/v2/Admin/models/ListMarkingMembersResponse.md) | `from foundry_sdk.v2.admin.models import ListMarkingMembersResponse` | +**Admin** | [ListMarkingRoleAssignmentsResponse](docs/v2/Admin/models/ListMarkingRoleAssignmentsResponse.md) | `from foundry_sdk.v2.admin.models import ListMarkingRoleAssignmentsResponse` | +**Admin** | [ListMarkingsResponse](docs/v2/Admin/models/ListMarkingsResponse.md) | `from foundry_sdk.v2.admin.models import ListMarkingsResponse` | +**Admin** | [ListUsersResponse](docs/v2/Admin/models/ListUsersResponse.md) | `from foundry_sdk.v2.admin.models import ListUsersResponse` | +**Admin** | [Marking](docs/v2/Admin/models/Marking.md) | `from foundry_sdk.v2.admin.models import Marking` | +**Admin** | [MarkingCategory](docs/v2/Admin/models/MarkingCategory.md) | `from foundry_sdk.v2.admin.models import MarkingCategory` | +**Admin** | [MarkingCategoryId](docs/v2/Admin/models/MarkingCategoryId.md) | `from foundry_sdk.v2.admin.models import MarkingCategoryId` | +**Admin** | [MarkingCategoryName](docs/v2/Admin/models/MarkingCategoryName.md) | `from foundry_sdk.v2.admin.models import MarkingCategoryName` | +**Admin** | [MarkingCategoryType](docs/v2/Admin/models/MarkingCategoryType.md) | `from foundry_sdk.v2.admin.models import MarkingCategoryType` | +**Admin** | [MarkingMember](docs/v2/Admin/models/MarkingMember.md) | `from foundry_sdk.v2.admin.models import MarkingMember` | +**Admin** | [MarkingName](docs/v2/Admin/models/MarkingName.md) | `from foundry_sdk.v2.admin.models import MarkingName` | +**Admin** | [MarkingRole](docs/v2/Admin/models/MarkingRole.md) | `from foundry_sdk.v2.admin.models import MarkingRole` | +**Admin** | [MarkingRoleAssignment](docs/v2/Admin/models/MarkingRoleAssignment.md) | `from foundry_sdk.v2.admin.models import MarkingRoleAssignment` | +**Admin** | [MarkingRoleUpdate](docs/v2/Admin/models/MarkingRoleUpdate.md) | `from foundry_sdk.v2.admin.models import MarkingRoleUpdate` | +**Admin** | [MarkingType](docs/v2/Admin/models/MarkingType.md) | `from foundry_sdk.v2.admin.models import MarkingType` | +**Admin** | [OidcAuthenticationProtocol](docs/v2/Admin/models/OidcAuthenticationProtocol.md) | `from foundry_sdk.v2.admin.models import OidcAuthenticationProtocol` | +**Admin** | [Organization](docs/v2/Admin/models/Organization.md) | `from foundry_sdk.v2.admin.models import Organization` | +**Admin** | [OrganizationName](docs/v2/Admin/models/OrganizationName.md) | `from foundry_sdk.v2.admin.models import OrganizationName` | +**Admin** | [PrincipalFilterType](docs/v2/Admin/models/PrincipalFilterType.md) | `from foundry_sdk.v2.admin.models import PrincipalFilterType` | +**Admin** | [ProviderId](docs/v2/Admin/models/ProviderId.md) | `from foundry_sdk.v2.admin.models import ProviderId` | +**Admin** | [SamlAuthenticationProtocol](docs/v2/Admin/models/SamlAuthenticationProtocol.md) | `from foundry_sdk.v2.admin.models import SamlAuthenticationProtocol` | +**Admin** | [SamlServiceProviderMetadata](docs/v2/Admin/models/SamlServiceProviderMetadata.md) | `from foundry_sdk.v2.admin.models import SamlServiceProviderMetadata` | +**Admin** | [SearchGroupsResponse](docs/v2/Admin/models/SearchGroupsResponse.md) | `from foundry_sdk.v2.admin.models import SearchGroupsResponse` | +**Admin** | [SearchUsersResponse](docs/v2/Admin/models/SearchUsersResponse.md) | `from foundry_sdk.v2.admin.models import SearchUsersResponse` | +**Admin** | [User](docs/v2/Admin/models/User.md) | `from foundry_sdk.v2.admin.models import User` | +**Admin** | [UserProviderInfo](docs/v2/Admin/models/UserProviderInfo.md) | `from foundry_sdk.v2.admin.models import UserProviderInfo` | +**Admin** | [UserSearchFilter](docs/v2/Admin/models/UserSearchFilter.md) | `from foundry_sdk.v2.admin.models import UserSearchFilter` | +**Admin** | [UserUsername](docs/v2/Admin/models/UserUsername.md) | `from foundry_sdk.v2.admin.models import UserUsername` | +**AipAgents** | [Agent](docs/v2/AipAgents/models/Agent.md) | `from foundry_sdk.v2.aip_agents.models import Agent` | +**AipAgents** | [AgentMarkdownResponse](docs/v2/AipAgents/models/AgentMarkdownResponse.md) | `from foundry_sdk.v2.aip_agents.models import AgentMarkdownResponse` | +**AipAgents** | [AgentMetadata](docs/v2/AipAgents/models/AgentMetadata.md) | `from foundry_sdk.v2.aip_agents.models import AgentMetadata` | +**AipAgents** | [AgentRid](docs/v2/AipAgents/models/AgentRid.md) | `from foundry_sdk.v2.aip_agents.models import AgentRid` | +**AipAgents** | [AgentSessionRagContextResponse](docs/v2/AipAgents/models/AgentSessionRagContextResponse.md) | `from foundry_sdk.v2.aip_agents.models import AgentSessionRagContextResponse` | +**AipAgents** | [AgentsSessionsPage](docs/v2/AipAgents/models/AgentsSessionsPage.md) | `from foundry_sdk.v2.aip_agents.models import AgentsSessionsPage` | +**AipAgents** | [AgentVersion](docs/v2/AipAgents/models/AgentVersion.md) | `from foundry_sdk.v2.aip_agents.models import AgentVersion` | +**AipAgents** | [AgentVersionDetails](docs/v2/AipAgents/models/AgentVersionDetails.md) | `from foundry_sdk.v2.aip_agents.models import AgentVersionDetails` | +**AipAgents** | [AgentVersionString](docs/v2/AipAgents/models/AgentVersionString.md) | `from foundry_sdk.v2.aip_agents.models import AgentVersionString` | +**AipAgents** | [CancelSessionResponse](docs/v2/AipAgents/models/CancelSessionResponse.md) | `from foundry_sdk.v2.aip_agents.models import CancelSessionResponse` | +**AipAgents** | [Content](docs/v2/AipAgents/models/Content.md) | `from foundry_sdk.v2.aip_agents.models import Content` | +**AipAgents** | [FunctionRetrievedContext](docs/v2/AipAgents/models/FunctionRetrievedContext.md) | `from foundry_sdk.v2.aip_agents.models import FunctionRetrievedContext` | +**AipAgents** | [InputContext](docs/v2/AipAgents/models/InputContext.md) | `from foundry_sdk.v2.aip_agents.models import InputContext` | +**AipAgents** | [ListAgentVersionsResponse](docs/v2/AipAgents/models/ListAgentVersionsResponse.md) | `from foundry_sdk.v2.aip_agents.models import ListAgentVersionsResponse` | +**AipAgents** | [ListSessionsResponse](docs/v2/AipAgents/models/ListSessionsResponse.md) | `from foundry_sdk.v2.aip_agents.models import ListSessionsResponse` | +**AipAgents** | [MessageId](docs/v2/AipAgents/models/MessageId.md) | `from foundry_sdk.v2.aip_agents.models import MessageId` | +**AipAgents** | [ObjectContext](docs/v2/AipAgents/models/ObjectContext.md) | `from foundry_sdk.v2.aip_agents.models import ObjectContext` | +**AipAgents** | [ObjectSetParameter](docs/v2/AipAgents/models/ObjectSetParameter.md) | `from foundry_sdk.v2.aip_agents.models import ObjectSetParameter` | +**AipAgents** | [ObjectSetParameterValue](docs/v2/AipAgents/models/ObjectSetParameterValue.md) | `from foundry_sdk.v2.aip_agents.models import ObjectSetParameterValue` | +**AipAgents** | [ObjectSetParameterValueUpdate](docs/v2/AipAgents/models/ObjectSetParameterValueUpdate.md) | `from foundry_sdk.v2.aip_agents.models import ObjectSetParameterValueUpdate` | +**AipAgents** | [Parameter](docs/v2/AipAgents/models/Parameter.md) | `from foundry_sdk.v2.aip_agents.models import Parameter` | +**AipAgents** | [ParameterAccessMode](docs/v2/AipAgents/models/ParameterAccessMode.md) | `from foundry_sdk.v2.aip_agents.models import ParameterAccessMode` | +**AipAgents** | [ParameterId](docs/v2/AipAgents/models/ParameterId.md) | `from foundry_sdk.v2.aip_agents.models import ParameterId` | +**AipAgents** | [ParameterType](docs/v2/AipAgents/models/ParameterType.md) | `from foundry_sdk.v2.aip_agents.models import ParameterType` | +**AipAgents** | [ParameterValue](docs/v2/AipAgents/models/ParameterValue.md) | `from foundry_sdk.v2.aip_agents.models import ParameterValue` | +**AipAgents** | [ParameterValueUpdate](docs/v2/AipAgents/models/ParameterValueUpdate.md) | `from foundry_sdk.v2.aip_agents.models import ParameterValueUpdate` | +**AipAgents** | [Session](docs/v2/AipAgents/models/Session.md) | `from foundry_sdk.v2.aip_agents.models import Session` | +**AipAgents** | [SessionExchange](docs/v2/AipAgents/models/SessionExchange.md) | `from foundry_sdk.v2.aip_agents.models import SessionExchange` | +**AipAgents** | [SessionExchangeContexts](docs/v2/AipAgents/models/SessionExchangeContexts.md) | `from foundry_sdk.v2.aip_agents.models import SessionExchangeContexts` | +**AipAgents** | [SessionExchangeResult](docs/v2/AipAgents/models/SessionExchangeResult.md) | `from foundry_sdk.v2.aip_agents.models import SessionExchangeResult` | +**AipAgents** | [SessionMetadata](docs/v2/AipAgents/models/SessionMetadata.md) | `from foundry_sdk.v2.aip_agents.models import SessionMetadata` | +**AipAgents** | [SessionRid](docs/v2/AipAgents/models/SessionRid.md) | `from foundry_sdk.v2.aip_agents.models import SessionRid` | +**AipAgents** | [StringParameter](docs/v2/AipAgents/models/StringParameter.md) | `from foundry_sdk.v2.aip_agents.models import StringParameter` | +**AipAgents** | [StringParameterValue](docs/v2/AipAgents/models/StringParameterValue.md) | `from foundry_sdk.v2.aip_agents.models import StringParameterValue` | +**AipAgents** | [UserTextInput](docs/v2/AipAgents/models/UserTextInput.md) | `from foundry_sdk.v2.aip_agents.models import UserTextInput` | +**Connectivity** | [ApiKeyAuthentication](docs/v2/Connectivity/models/ApiKeyAuthentication.md) | `from foundry_sdk.v2.connectivity.models import ApiKeyAuthentication` | +**Connectivity** | [AsPlaintextValue](docs/v2/Connectivity/models/AsPlaintextValue.md) | `from foundry_sdk.v2.connectivity.models import AsPlaintextValue` | +**Connectivity** | [AsSecretName](docs/v2/Connectivity/models/AsSecretName.md) | `from foundry_sdk.v2.connectivity.models import AsSecretName` | +**Connectivity** | [AwsAccessKey](docs/v2/Connectivity/models/AwsAccessKey.md) | `from foundry_sdk.v2.connectivity.models import AwsAccessKey` | +**Connectivity** | [AwsOidcAuthentication](docs/v2/Connectivity/models/AwsOidcAuthentication.md) | `from foundry_sdk.v2.connectivity.models import AwsOidcAuthentication` | +**Connectivity** | [BasicCredentials](docs/v2/Connectivity/models/BasicCredentials.md) | `from foundry_sdk.v2.connectivity.models import BasicCredentials` | +**Connectivity** | [BearerToken](docs/v2/Connectivity/models/BearerToken.md) | `from foundry_sdk.v2.connectivity.models import BearerToken` | +**Connectivity** | [CloudIdentity](docs/v2/Connectivity/models/CloudIdentity.md) | `from foundry_sdk.v2.connectivity.models import CloudIdentity` | +**Connectivity** | [CloudIdentityRid](docs/v2/Connectivity/models/CloudIdentityRid.md) | `from foundry_sdk.v2.connectivity.models import CloudIdentityRid` | +**Connectivity** | [Connection](docs/v2/Connectivity/models/Connection.md) | `from foundry_sdk.v2.connectivity.models import Connection` | +**Connectivity** | [ConnectionConfiguration](docs/v2/Connectivity/models/ConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import ConnectionConfiguration` | +**Connectivity** | [ConnectionDisplayName](docs/v2/Connectivity/models/ConnectionDisplayName.md) | `from foundry_sdk.v2.connectivity.models import ConnectionDisplayName` | +**Connectivity** | [ConnectionRid](docs/v2/Connectivity/models/ConnectionRid.md) | `from foundry_sdk.v2.connectivity.models import ConnectionRid` | +**Connectivity** | [CreateConnectionRequestConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestConnectionConfiguration` | +**Connectivity** | [CreateConnectionRequestJdbcConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestJdbcConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestJdbcConnectionConfiguration` | +**Connectivity** | [CreateConnectionRequestRestConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestRestConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestRestConnectionConfiguration` | +**Connectivity** | [CreateConnectionRequestS3ConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestS3ConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestS3ConnectionConfiguration` | +**Connectivity** | [CreateTableImportRequestJdbcImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestJdbcImportConfig.md) | `from foundry_sdk.v2.connectivity.models import CreateTableImportRequestJdbcImportConfig` | +**Connectivity** | [CreateTableImportRequestMicrosoftAccessImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfig.md) | `from foundry_sdk.v2.connectivity.models import CreateTableImportRequestMicrosoftAccessImportConfig` | +**Connectivity** | [CreateTableImportRequestMicrosoftSqlServerImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfig.md) | `from foundry_sdk.v2.connectivity.models import CreateTableImportRequestMicrosoftSqlServerImportConfig` | +**Connectivity** | [CreateTableImportRequestOracleImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestOracleImportConfig.md) | `from foundry_sdk.v2.connectivity.models import CreateTableImportRequestOracleImportConfig` | +**Connectivity** | [CreateTableImportRequestPostgreSqlImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestPostgreSqlImportConfig.md) | `from foundry_sdk.v2.connectivity.models import CreateTableImportRequestPostgreSqlImportConfig` | +**Connectivity** | [CreateTableImportRequestTableImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfig.md) | `from foundry_sdk.v2.connectivity.models import CreateTableImportRequestTableImportConfig` | +**Connectivity** | [Domain](docs/v2/Connectivity/models/Domain.md) | `from foundry_sdk.v2.connectivity.models import Domain` | +**Connectivity** | [EncryptedProperty](docs/v2/Connectivity/models/EncryptedProperty.md) | `from foundry_sdk.v2.connectivity.models import EncryptedProperty` | +**Connectivity** | [FileAnyPathMatchesFilter](docs/v2/Connectivity/models/FileAnyPathMatchesFilter.md) | `from foundry_sdk.v2.connectivity.models import FileAnyPathMatchesFilter` | +**Connectivity** | [FileAtLeastCountFilter](docs/v2/Connectivity/models/FileAtLeastCountFilter.md) | `from foundry_sdk.v2.connectivity.models import FileAtLeastCountFilter` | +**Connectivity** | [FileChangedSinceLastUploadFilter](docs/v2/Connectivity/models/FileChangedSinceLastUploadFilter.md) | `from foundry_sdk.v2.connectivity.models import FileChangedSinceLastUploadFilter` | +**Connectivity** | [FileImport](docs/v2/Connectivity/models/FileImport.md) | `from foundry_sdk.v2.connectivity.models import FileImport` | +**Connectivity** | [FileImportCustomFilter](docs/v2/Connectivity/models/FileImportCustomFilter.md) | `from foundry_sdk.v2.connectivity.models import FileImportCustomFilter` | +**Connectivity** | [FileImportDisplayName](docs/v2/Connectivity/models/FileImportDisplayName.md) | `from foundry_sdk.v2.connectivity.models import FileImportDisplayName` | +**Connectivity** | [FileImportFilter](docs/v2/Connectivity/models/FileImportFilter.md) | `from foundry_sdk.v2.connectivity.models import FileImportFilter` | +**Connectivity** | [FileImportMode](docs/v2/Connectivity/models/FileImportMode.md) | `from foundry_sdk.v2.connectivity.models import FileImportMode` | +**Connectivity** | [FileImportRid](docs/v2/Connectivity/models/FileImportRid.md) | `from foundry_sdk.v2.connectivity.models import FileImportRid` | +**Connectivity** | [FileLastModifiedAfterFilter](docs/v2/Connectivity/models/FileLastModifiedAfterFilter.md) | `from foundry_sdk.v2.connectivity.models import FileLastModifiedAfterFilter` | +**Connectivity** | [FilePathMatchesFilter](docs/v2/Connectivity/models/FilePathMatchesFilter.md) | `from foundry_sdk.v2.connectivity.models import FilePathMatchesFilter` | +**Connectivity** | [FilePathNotMatchesFilter](docs/v2/Connectivity/models/FilePathNotMatchesFilter.md) | `from foundry_sdk.v2.connectivity.models import FilePathNotMatchesFilter` | +**Connectivity** | [FileProperty](docs/v2/Connectivity/models/FileProperty.md) | `from foundry_sdk.v2.connectivity.models import FileProperty` | +**Connectivity** | [FilesCountLimitFilter](docs/v2/Connectivity/models/FilesCountLimitFilter.md) | `from foundry_sdk.v2.connectivity.models import FilesCountLimitFilter` | +**Connectivity** | [FileSizeFilter](docs/v2/Connectivity/models/FileSizeFilter.md) | `from foundry_sdk.v2.connectivity.models import FileSizeFilter` | +**Connectivity** | [HeaderApiKey](docs/v2/Connectivity/models/HeaderApiKey.md) | `from foundry_sdk.v2.connectivity.models import HeaderApiKey` | +**Connectivity** | [JdbcConnectionConfiguration](docs/v2/Connectivity/models/JdbcConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import JdbcConnectionConfiguration` | +**Connectivity** | [JdbcImportConfig](docs/v2/Connectivity/models/JdbcImportConfig.md) | `from foundry_sdk.v2.connectivity.models import JdbcImportConfig` | +**Connectivity** | [ListFileImportsResponse](docs/v2/Connectivity/models/ListFileImportsResponse.md) | `from foundry_sdk.v2.connectivity.models import ListFileImportsResponse` | +**Connectivity** | [ListTableImportsResponse](docs/v2/Connectivity/models/ListTableImportsResponse.md) | `from foundry_sdk.v2.connectivity.models import ListTableImportsResponse` | +**Connectivity** | [MicrosoftAccessImportConfig](docs/v2/Connectivity/models/MicrosoftAccessImportConfig.md) | `from foundry_sdk.v2.connectivity.models import MicrosoftAccessImportConfig` | +**Connectivity** | [MicrosoftSqlServerImportConfig](docs/v2/Connectivity/models/MicrosoftSqlServerImportConfig.md) | `from foundry_sdk.v2.connectivity.models import MicrosoftSqlServerImportConfig` | +**Connectivity** | [OracleImportConfig](docs/v2/Connectivity/models/OracleImportConfig.md) | `from foundry_sdk.v2.connectivity.models import OracleImportConfig` | +**Connectivity** | [PlaintextValue](docs/v2/Connectivity/models/PlaintextValue.md) | `from foundry_sdk.v2.connectivity.models import PlaintextValue` | +**Connectivity** | [PostgreSqlImportConfig](docs/v2/Connectivity/models/PostgreSqlImportConfig.md) | `from foundry_sdk.v2.connectivity.models import PostgreSqlImportConfig` | +**Connectivity** | [Protocol](docs/v2/Connectivity/models/Protocol.md) | `from foundry_sdk.v2.connectivity.models import Protocol` | +**Connectivity** | [QueryParameterApiKey](docs/v2/Connectivity/models/QueryParameterApiKey.md) | `from foundry_sdk.v2.connectivity.models import QueryParameterApiKey` | +**Connectivity** | [Region](docs/v2/Connectivity/models/Region.md) | `from foundry_sdk.v2.connectivity.models import Region` | +**Connectivity** | [RestAuthenticationMode](docs/v2/Connectivity/models/RestAuthenticationMode.md) | `from foundry_sdk.v2.connectivity.models import RestAuthenticationMode` | +**Connectivity** | [RestConnectionAdditionalSecrets](docs/v2/Connectivity/models/RestConnectionAdditionalSecrets.md) | `from foundry_sdk.v2.connectivity.models import RestConnectionAdditionalSecrets` | +**Connectivity** | [RestConnectionConfiguration](docs/v2/Connectivity/models/RestConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import RestConnectionConfiguration` | +**Connectivity** | [RestConnectionOAuth2](docs/v2/Connectivity/models/RestConnectionOAuth2.md) | `from foundry_sdk.v2.connectivity.models import RestConnectionOAuth2` | +**Connectivity** | [RestRequestApiKeyLocation](docs/v2/Connectivity/models/RestRequestApiKeyLocation.md) | `from foundry_sdk.v2.connectivity.models import RestRequestApiKeyLocation` | +**Connectivity** | [S3AuthenticationMode](docs/v2/Connectivity/models/S3AuthenticationMode.md) | `from foundry_sdk.v2.connectivity.models import S3AuthenticationMode` | +**Connectivity** | [S3ConnectionConfiguration](docs/v2/Connectivity/models/S3ConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import S3ConnectionConfiguration` | +**Connectivity** | [S3KmsConfiguration](docs/v2/Connectivity/models/S3KmsConfiguration.md) | `from foundry_sdk.v2.connectivity.models import S3KmsConfiguration` | +**Connectivity** | [S3ProxyConfiguration](docs/v2/Connectivity/models/S3ProxyConfiguration.md) | `from foundry_sdk.v2.connectivity.models import S3ProxyConfiguration` | +**Connectivity** | [SecretName](docs/v2/Connectivity/models/SecretName.md) | `from foundry_sdk.v2.connectivity.models import SecretName` | +**Connectivity** | [SecretsNames](docs/v2/Connectivity/models/SecretsNames.md) | `from foundry_sdk.v2.connectivity.models import SecretsNames` | +**Connectivity** | [SecretsWithPlaintextValues](docs/v2/Connectivity/models/SecretsWithPlaintextValues.md) | `from foundry_sdk.v2.connectivity.models import SecretsWithPlaintextValues` | +**Connectivity** | [StsRoleConfiguration](docs/v2/Connectivity/models/StsRoleConfiguration.md) | `from foundry_sdk.v2.connectivity.models import StsRoleConfiguration` | +**Connectivity** | [TableImport](docs/v2/Connectivity/models/TableImport.md) | `from foundry_sdk.v2.connectivity.models import TableImport` | +**Connectivity** | [TableImportAllowSchemaChanges](docs/v2/Connectivity/models/TableImportAllowSchemaChanges.md) | `from foundry_sdk.v2.connectivity.models import TableImportAllowSchemaChanges` | +**Connectivity** | [TableImportConfig](docs/v2/Connectivity/models/TableImportConfig.md) | `from foundry_sdk.v2.connectivity.models import TableImportConfig` | +**Connectivity** | [TableImportDisplayName](docs/v2/Connectivity/models/TableImportDisplayName.md) | `from foundry_sdk.v2.connectivity.models import TableImportDisplayName` | +**Connectivity** | [TableImportMode](docs/v2/Connectivity/models/TableImportMode.md) | `from foundry_sdk.v2.connectivity.models import TableImportMode` | +**Connectivity** | [TableImportRid](docs/v2/Connectivity/models/TableImportRid.md) | `from foundry_sdk.v2.connectivity.models import TableImportRid` | +**Connectivity** | [UriScheme](docs/v2/Connectivity/models/UriScheme.md) | `from foundry_sdk.v2.connectivity.models import UriScheme` | +**Core** | [AnyType](docs/v2/Core/models/AnyType.md) | `from foundry_sdk.v2.core.models import AnyType` | +**Core** | [ArrayFieldType](docs/v2/Core/models/ArrayFieldType.md) | `from foundry_sdk.v2.core.models import ArrayFieldType` | +**Core** | [AttachmentType](docs/v2/Core/models/AttachmentType.md) | `from foundry_sdk.v2.core.models import AttachmentType` | +**Core** | [BinaryType](docs/v2/Core/models/BinaryType.md) | `from foundry_sdk.v2.core.models import BinaryType` | +**Core** | [BooleanType](docs/v2/Core/models/BooleanType.md) | `from foundry_sdk.v2.core.models import BooleanType` | +**Core** | [BuildRid](docs/v2/Core/models/BuildRid.md) | `from foundry_sdk.v2.core.models import BuildRid` | +**Core** | [ByteType](docs/v2/Core/models/ByteType.md) | `from foundry_sdk.v2.core.models import ByteType` | +**Core** | [ChangeDataCaptureConfiguration](docs/v2/Core/models/ChangeDataCaptureConfiguration.md) | `from foundry_sdk.v2.core.models import ChangeDataCaptureConfiguration` | +**Core** | [CipherTextType](docs/v2/Core/models/CipherTextType.md) | `from foundry_sdk.v2.core.models import CipherTextType` | +**Core** | [ContentLength](docs/v2/Core/models/ContentLength.md) | `from foundry_sdk.v2.core.models import ContentLength` | +**Core** | [ContentType](docs/v2/Core/models/ContentType.md) | `from foundry_sdk.v2.core.models import ContentType` | +**Core** | [CreatedBy](docs/v2/Core/models/CreatedBy.md) | `from foundry_sdk.v2.core.models import CreatedBy` | +**Core** | [CreatedTime](docs/v2/Core/models/CreatedTime.md) | `from foundry_sdk.v2.core.models import CreatedTime` | +**Core** | [CustomMetadata](docs/v2/Core/models/CustomMetadata.md) | `from foundry_sdk.v2.core.models import CustomMetadata` | +**Core** | [DateType](docs/v2/Core/models/DateType.md) | `from foundry_sdk.v2.core.models import DateType` | +**Core** | [DecimalType](docs/v2/Core/models/DecimalType.md) | `from foundry_sdk.v2.core.models import DecimalType` | +**Core** | [DisplayName](docs/v2/Core/models/DisplayName.md) | `from foundry_sdk.v2.core.models import DisplayName` | +**Core** | [Distance](docs/v2/Core/models/Distance.md) | `from foundry_sdk.v2.core.models import Distance` | +**Core** | [DistanceUnit](docs/v2/Core/models/DistanceUnit.md) | `from foundry_sdk.v2.core.models import DistanceUnit` | +**Core** | [DoubleType](docs/v2/Core/models/DoubleType.md) | `from foundry_sdk.v2.core.models import DoubleType` | +**Core** | [Duration](docs/v2/Core/models/Duration.md) | `from foundry_sdk.v2.core.models import Duration` | +**Core** | [EmbeddingModel](docs/v2/Core/models/EmbeddingModel.md) | `from foundry_sdk.v2.core.models import EmbeddingModel` | +**Core** | [EnrollmentRid](docs/v2/Core/models/EnrollmentRid.md) | `from foundry_sdk.v2.core.models import EnrollmentRid` | +**Core** | [Field](docs/v2/Core/models/Field.md) | `from foundry_sdk.v2.core.models import Field` | +**Core** | [FieldDataType](docs/v2/Core/models/FieldDataType.md) | `from foundry_sdk.v2.core.models import FieldDataType` | +**Core** | [FieldName](docs/v2/Core/models/FieldName.md) | `from foundry_sdk.v2.core.models import FieldName` | +**Core** | [FieldSchema](docs/v2/Core/models/FieldSchema.md) | `from foundry_sdk.v2.core.models import FieldSchema` | +**Core** | [Filename](docs/v2/Core/models/Filename.md) | `from foundry_sdk.v2.core.models import Filename` | +**Core** | [FilePath](docs/v2/Core/models/FilePath.md) | `from foundry_sdk.v2.core.models import FilePath` | +**Core** | [FilterBinaryType](docs/v2/Core/models/FilterBinaryType.md) | `from foundry_sdk.v2.core.models import FilterBinaryType` | +**Core** | [FilterBooleanType](docs/v2/Core/models/FilterBooleanType.md) | `from foundry_sdk.v2.core.models import FilterBooleanType` | +**Core** | [FilterDateTimeType](docs/v2/Core/models/FilterDateTimeType.md) | `from foundry_sdk.v2.core.models import FilterDateTimeType` | +**Core** | [FilterDateType](docs/v2/Core/models/FilterDateType.md) | `from foundry_sdk.v2.core.models import FilterDateType` | +**Core** | [FilterDoubleType](docs/v2/Core/models/FilterDoubleType.md) | `from foundry_sdk.v2.core.models import FilterDoubleType` | +**Core** | [FilterEnumType](docs/v2/Core/models/FilterEnumType.md) | `from foundry_sdk.v2.core.models import FilterEnumType` | +**Core** | [FilterFloatType](docs/v2/Core/models/FilterFloatType.md) | `from foundry_sdk.v2.core.models import FilterFloatType` | +**Core** | [FilterIntegerType](docs/v2/Core/models/FilterIntegerType.md) | `from foundry_sdk.v2.core.models import FilterIntegerType` | +**Core** | [FilterLongType](docs/v2/Core/models/FilterLongType.md) | `from foundry_sdk.v2.core.models import FilterLongType` | +**Core** | [FilterRidType](docs/v2/Core/models/FilterRidType.md) | `from foundry_sdk.v2.core.models import FilterRidType` | +**Core** | [FilterStringType](docs/v2/Core/models/FilterStringType.md) | `from foundry_sdk.v2.core.models import FilterStringType` | +**Core** | [FilterType](docs/v2/Core/models/FilterType.md) | `from foundry_sdk.v2.core.models import FilterType` | +**Core** | [FilterUuidType](docs/v2/Core/models/FilterUuidType.md) | `from foundry_sdk.v2.core.models import FilterUuidType` | +**Core** | [FloatType](docs/v2/Core/models/FloatType.md) | `from foundry_sdk.v2.core.models import FloatType` | +**Core** | [FolderRid](docs/v2/Core/models/FolderRid.md) | `from foundry_sdk.v2.core.models import FolderRid` | +**Core** | [FoundryLiveDeployment](docs/v2/Core/models/FoundryLiveDeployment.md) | `from foundry_sdk.v2.core.models import FoundryLiveDeployment` | +**Core** | [FullRowChangeDataCaptureConfiguration](docs/v2/Core/models/FullRowChangeDataCaptureConfiguration.md) | `from foundry_sdk.v2.core.models import FullRowChangeDataCaptureConfiguration` | +**Core** | [GeoPointType](docs/v2/Core/models/GeoPointType.md) | `from foundry_sdk.v2.core.models import GeoPointType` | +**Core** | [GeoShapeType](docs/v2/Core/models/GeoShapeType.md) | `from foundry_sdk.v2.core.models import GeoShapeType` | +**Core** | [GeotimeSeriesReferenceType](docs/v2/Core/models/GeotimeSeriesReferenceType.md) | `from foundry_sdk.v2.core.models import GeotimeSeriesReferenceType` | +**Core** | [GroupName](docs/v2/Core/models/GroupName.md) | `from foundry_sdk.v2.core.models import GroupName` | +**Core** | [GroupRid](docs/v2/Core/models/GroupRid.md) | `from foundry_sdk.v2.core.models import GroupRid` | +**Core** | [IntegerType](docs/v2/Core/models/IntegerType.md) | `from foundry_sdk.v2.core.models import IntegerType` | +**Core** | [JobRid](docs/v2/Core/models/JobRid.md) | `from foundry_sdk.v2.core.models import JobRid` | +**Core** | [LmsEmbeddingModel](docs/v2/Core/models/LmsEmbeddingModel.md) | `from foundry_sdk.v2.core.models import LmsEmbeddingModel` | +**Core** | [LmsEmbeddingModelValue](docs/v2/Core/models/LmsEmbeddingModelValue.md) | `from foundry_sdk.v2.core.models import LmsEmbeddingModelValue` | +**Core** | [LongType](docs/v2/Core/models/LongType.md) | `from foundry_sdk.v2.core.models import LongType` | +**Core** | [MapFieldType](docs/v2/Core/models/MapFieldType.md) | `from foundry_sdk.v2.core.models import MapFieldType` | +**Core** | [MarkingId](docs/v2/Core/models/MarkingId.md) | `from foundry_sdk.v2.core.models import MarkingId` | +**Core** | [MarkingType](docs/v2/Core/models/MarkingType.md) | `from foundry_sdk.v2.core.models import MarkingType` | +**Core** | [MediaItemPath](docs/v2/Core/models/MediaItemPath.md) | `from foundry_sdk.v2.core.models import MediaItemPath` | +**Core** | [MediaItemReadToken](docs/v2/Core/models/MediaItemReadToken.md) | `from foundry_sdk.v2.core.models import MediaItemReadToken` | +**Core** | [MediaItemRid](docs/v2/Core/models/MediaItemRid.md) | `from foundry_sdk.v2.core.models import MediaItemRid` | +**Core** | [MediaReference](docs/v2/Core/models/MediaReference.md) | `from foundry_sdk.v2.core.models import MediaReference` | +**Core** | [MediaReferenceType](docs/v2/Core/models/MediaReferenceType.md) | `from foundry_sdk.v2.core.models import MediaReferenceType` | +**Core** | [MediaSetRid](docs/v2/Core/models/MediaSetRid.md) | `from foundry_sdk.v2.core.models import MediaSetRid` | +**Core** | [MediaSetViewItem](docs/v2/Core/models/MediaSetViewItem.md) | `from foundry_sdk.v2.core.models import MediaSetViewItem` | +**Core** | [MediaSetViewItemWrapper](docs/v2/Core/models/MediaSetViewItemWrapper.md) | `from foundry_sdk.v2.core.models import MediaSetViewItemWrapper` | +**Core** | [MediaSetViewRid](docs/v2/Core/models/MediaSetViewRid.md) | `from foundry_sdk.v2.core.models import MediaSetViewRid` | +**Core** | [MediaType](docs/v2/Core/models/MediaType.md) | `from foundry_sdk.v2.core.models import MediaType` | +**Core** | [NullType](docs/v2/Core/models/NullType.md) | `from foundry_sdk.v2.core.models import NullType` | +**Core** | [OperationScope](docs/v2/Core/models/OperationScope.md) | `from foundry_sdk.v2.core.models import OperationScope` | +**Core** | [OrderByDirection](docs/v2/Core/models/OrderByDirection.md) | `from foundry_sdk.v2.core.models import OrderByDirection` | +**Core** | [OrganizationRid](docs/v2/Core/models/OrganizationRid.md) | `from foundry_sdk.v2.core.models import OrganizationRid` | +**Core** | [PageSize](docs/v2/Core/models/PageSize.md) | `from foundry_sdk.v2.core.models import PageSize` | +**Core** | [PageToken](docs/v2/Core/models/PageToken.md) | `from foundry_sdk.v2.core.models import PageToken` | +**Core** | [PreviewMode](docs/v2/Core/models/PreviewMode.md) | `from foundry_sdk.v2.core.models import PreviewMode` | +**Core** | [PrincipalId](docs/v2/Core/models/PrincipalId.md) | `from foundry_sdk.v2.core.models import PrincipalId` | +**Core** | [PrincipalType](docs/v2/Core/models/PrincipalType.md) | `from foundry_sdk.v2.core.models import PrincipalType` | +**Core** | [Realm](docs/v2/Core/models/Realm.md) | `from foundry_sdk.v2.core.models import Realm` | +**Core** | [Reference](docs/v2/Core/models/Reference.md) | `from foundry_sdk.v2.core.models import Reference` | +**Core** | [ReleaseStatus](docs/v2/Core/models/ReleaseStatus.md) | `from foundry_sdk.v2.core.models import ReleaseStatus` | +**Core** | [RoleId](docs/v2/Core/models/RoleId.md) | `from foundry_sdk.v2.core.models import RoleId` | +**Core** | [ShortType](docs/v2/Core/models/ShortType.md) | `from foundry_sdk.v2.core.models import ShortType` | +**Core** | [SizeBytes](docs/v2/Core/models/SizeBytes.md) | `from foundry_sdk.v2.core.models import SizeBytes` | +**Core** | [StreamSchema](docs/v2/Core/models/StreamSchema.md) | `from foundry_sdk.v2.core.models import StreamSchema` | +**Core** | [StringType](docs/v2/Core/models/StringType.md) | `from foundry_sdk.v2.core.models import StringType` | +**Core** | [StructFieldName](docs/v2/Core/models/StructFieldName.md) | `from foundry_sdk.v2.core.models import StructFieldName` | +**Core** | [StructFieldType](docs/v2/Core/models/StructFieldType.md) | `from foundry_sdk.v2.core.models import StructFieldType` | +**Core** | [TimeSeriesItemType](docs/v2/Core/models/TimeSeriesItemType.md) | `from foundry_sdk.v2.core.models import TimeSeriesItemType` | +**Core** | [TimeseriesType](docs/v2/Core/models/TimeseriesType.md) | `from foundry_sdk.v2.core.models import TimeseriesType` | +**Core** | [TimestampType](docs/v2/Core/models/TimestampType.md) | `from foundry_sdk.v2.core.models import TimestampType` | +**Core** | [TimeUnit](docs/v2/Core/models/TimeUnit.md) | `from foundry_sdk.v2.core.models import TimeUnit` | +**Core** | [TotalCount](docs/v2/Core/models/TotalCount.md) | `from foundry_sdk.v2.core.models import TotalCount` | +**Core** | [UnsupportedType](docs/v2/Core/models/UnsupportedType.md) | `from foundry_sdk.v2.core.models import UnsupportedType` | +**Core** | [UpdatedBy](docs/v2/Core/models/UpdatedBy.md) | `from foundry_sdk.v2.core.models import UpdatedBy` | +**Core** | [UpdatedTime](docs/v2/Core/models/UpdatedTime.md) | `from foundry_sdk.v2.core.models import UpdatedTime` | +**Core** | [UserId](docs/v2/Core/models/UserId.md) | `from foundry_sdk.v2.core.models import UserId` | +**Core** | [VectorSimilarityFunction](docs/v2/Core/models/VectorSimilarityFunction.md) | `from foundry_sdk.v2.core.models import VectorSimilarityFunction` | +**Core** | [VectorSimilarityFunctionValue](docs/v2/Core/models/VectorSimilarityFunctionValue.md) | `from foundry_sdk.v2.core.models import VectorSimilarityFunctionValue` | +**Core** | [VectorType](docs/v2/Core/models/VectorType.md) | `from foundry_sdk.v2.core.models import VectorType` | +**Core** | [ZoneId](docs/v2/Core/models/ZoneId.md) | `from foundry_sdk.v2.core.models import ZoneId` | +**Datasets** | [Branch](docs/v2/Datasets/models/Branch.md) | `from foundry_sdk.v2.datasets.models import Branch` | +**Datasets** | [BranchName](docs/v2/Datasets/models/BranchName.md) | `from foundry_sdk.v2.datasets.models import BranchName` | +**Datasets** | [Dataset](docs/v2/Datasets/models/Dataset.md) | `from foundry_sdk.v2.datasets.models import Dataset` | +**Datasets** | [DatasetName](docs/v2/Datasets/models/DatasetName.md) | `from foundry_sdk.v2.datasets.models import DatasetName` | +**Datasets** | [DatasetRid](docs/v2/Datasets/models/DatasetRid.md) | `from foundry_sdk.v2.datasets.models import DatasetRid` | +**Datasets** | [File](docs/v2/Datasets/models/File.md) | `from foundry_sdk.v2.datasets.models import File` | +**Datasets** | [FileUpdatedTime](docs/v2/Datasets/models/FileUpdatedTime.md) | `from foundry_sdk.v2.datasets.models import FileUpdatedTime` | +**Datasets** | [ListBranchesResponse](docs/v2/Datasets/models/ListBranchesResponse.md) | `from foundry_sdk.v2.datasets.models import ListBranchesResponse` | +**Datasets** | [ListFilesResponse](docs/v2/Datasets/models/ListFilesResponse.md) | `from foundry_sdk.v2.datasets.models import ListFilesResponse` | +**Datasets** | [TableExportFormat](docs/v2/Datasets/models/TableExportFormat.md) | `from foundry_sdk.v2.datasets.models import TableExportFormat` | +**Datasets** | [Transaction](docs/v2/Datasets/models/Transaction.md) | `from foundry_sdk.v2.datasets.models import Transaction` | +**Datasets** | [TransactionCreatedTime](docs/v2/Datasets/models/TransactionCreatedTime.md) | `from foundry_sdk.v2.datasets.models import TransactionCreatedTime` | +**Datasets** | [TransactionRid](docs/v2/Datasets/models/TransactionRid.md) | `from foundry_sdk.v2.datasets.models import TransactionRid` | +**Datasets** | [TransactionStatus](docs/v2/Datasets/models/TransactionStatus.md) | `from foundry_sdk.v2.datasets.models import TransactionStatus` | +**Datasets** | [TransactionType](docs/v2/Datasets/models/TransactionType.md) | `from foundry_sdk.v2.datasets.models import TransactionType` | +**Filesystem** | [AccessRequirements](docs/v2/Filesystem/models/AccessRequirements.md) | `from foundry_sdk.v2.filesystem.models import AccessRequirements` | +**Filesystem** | [Everyone](docs/v2/Filesystem/models/Everyone.md) | `from foundry_sdk.v2.filesystem.models import Everyone` | +**Filesystem** | [FileSystemId](docs/v2/Filesystem/models/FileSystemId.md) | `from foundry_sdk.v2.filesystem.models import FileSystemId` | +**Filesystem** | [Folder](docs/v2/Filesystem/models/Folder.md) | `from foundry_sdk.v2.filesystem.models import Folder` | +**Filesystem** | [FolderRid](docs/v2/Filesystem/models/FolderRid.md) | `from foundry_sdk.v2.filesystem.models import FolderRid` | +**Filesystem** | [FolderType](docs/v2/Filesystem/models/FolderType.md) | `from foundry_sdk.v2.filesystem.models import FolderType` | +**Filesystem** | [IsDirectlyApplied](docs/v2/Filesystem/models/IsDirectlyApplied.md) | `from foundry_sdk.v2.filesystem.models import IsDirectlyApplied` | +**Filesystem** | [ListChildrenOfFolderResponse](docs/v2/Filesystem/models/ListChildrenOfFolderResponse.md) | `from foundry_sdk.v2.filesystem.models import ListChildrenOfFolderResponse` | +**Filesystem** | [ListMarkingsOfResourceResponse](docs/v2/Filesystem/models/ListMarkingsOfResourceResponse.md) | `from foundry_sdk.v2.filesystem.models import ListMarkingsOfResourceResponse` | +**Filesystem** | [ListOrganizationsOfProjectResponse](docs/v2/Filesystem/models/ListOrganizationsOfProjectResponse.md) | `from foundry_sdk.v2.filesystem.models import ListOrganizationsOfProjectResponse` | +**Filesystem** | [ListResourceRolesResponse](docs/v2/Filesystem/models/ListResourceRolesResponse.md) | `from foundry_sdk.v2.filesystem.models import ListResourceRolesResponse` | +**Filesystem** | [ListSpacesResponse](docs/v2/Filesystem/models/ListSpacesResponse.md) | `from foundry_sdk.v2.filesystem.models import ListSpacesResponse` | +**Filesystem** | [Marking](docs/v2/Filesystem/models/Marking.md) | `from foundry_sdk.v2.filesystem.models import Marking` | +**Filesystem** | [Organization](docs/v2/Filesystem/models/Organization.md) | `from foundry_sdk.v2.filesystem.models import Organization` | +**Filesystem** | [PrincipalWithId](docs/v2/Filesystem/models/PrincipalWithId.md) | `from foundry_sdk.v2.filesystem.models import PrincipalWithId` | +**Filesystem** | [Project](docs/v2/Filesystem/models/Project.md) | `from foundry_sdk.v2.filesystem.models import Project` | +**Filesystem** | [ProjectRid](docs/v2/Filesystem/models/ProjectRid.md) | `from foundry_sdk.v2.filesystem.models import ProjectRid` | +**Filesystem** | [ProjectTemplateRid](docs/v2/Filesystem/models/ProjectTemplateRid.md) | `from foundry_sdk.v2.filesystem.models import ProjectTemplateRid` | +**Filesystem** | [ProjectTemplateVariableId](docs/v2/Filesystem/models/ProjectTemplateVariableId.md) | `from foundry_sdk.v2.filesystem.models import ProjectTemplateVariableId` | +**Filesystem** | [ProjectTemplateVariableValue](docs/v2/Filesystem/models/ProjectTemplateVariableValue.md) | `from foundry_sdk.v2.filesystem.models import ProjectTemplateVariableValue` | +**Filesystem** | [Resource](docs/v2/Filesystem/models/Resource.md) | `from foundry_sdk.v2.filesystem.models import Resource` | +**Filesystem** | [ResourceDisplayName](docs/v2/Filesystem/models/ResourceDisplayName.md) | `from foundry_sdk.v2.filesystem.models import ResourceDisplayName` | +**Filesystem** | [ResourcePath](docs/v2/Filesystem/models/ResourcePath.md) | `from foundry_sdk.v2.filesystem.models import ResourcePath` | +**Filesystem** | [ResourceRid](docs/v2/Filesystem/models/ResourceRid.md) | `from foundry_sdk.v2.filesystem.models import ResourceRid` | +**Filesystem** | [ResourceRole](docs/v2/Filesystem/models/ResourceRole.md) | `from foundry_sdk.v2.filesystem.models import ResourceRole` | +**Filesystem** | [ResourceRolePrincipal](docs/v2/Filesystem/models/ResourceRolePrincipal.md) | `from foundry_sdk.v2.filesystem.models import ResourceRolePrincipal` | +**Filesystem** | [ResourceType](docs/v2/Filesystem/models/ResourceType.md) | `from foundry_sdk.v2.filesystem.models import ResourceType` | +**Filesystem** | [Space](docs/v2/Filesystem/models/Space.md) | `from foundry_sdk.v2.filesystem.models import Space` | +**Filesystem** | [SpaceRid](docs/v2/Filesystem/models/SpaceRid.md) | `from foundry_sdk.v2.filesystem.models import SpaceRid` | +**Filesystem** | [TrashStatus](docs/v2/Filesystem/models/TrashStatus.md) | `from foundry_sdk.v2.filesystem.models import TrashStatus` | +**Filesystem** | [UsageAccountRid](docs/v2/Filesystem/models/UsageAccountRid.md) | `from foundry_sdk.v2.filesystem.models import UsageAccountRid` | +**Functions** | [DataValue](docs/v2/Functions/models/DataValue.md) | `from foundry_sdk.v2.functions.models import DataValue` | +**Functions** | [ExecuteQueryResponse](docs/v2/Functions/models/ExecuteQueryResponse.md) | `from foundry_sdk.v2.functions.models import ExecuteQueryResponse` | +**Functions** | [FunctionRid](docs/v2/Functions/models/FunctionRid.md) | `from foundry_sdk.v2.functions.models import FunctionRid` | +**Functions** | [FunctionVersion](docs/v2/Functions/models/FunctionVersion.md) | `from foundry_sdk.v2.functions.models import FunctionVersion` | +**Functions** | [Parameter](docs/v2/Functions/models/Parameter.md) | `from foundry_sdk.v2.functions.models import Parameter` | +**Functions** | [ParameterId](docs/v2/Functions/models/ParameterId.md) | `from foundry_sdk.v2.functions.models import ParameterId` | +**Functions** | [Query](docs/v2/Functions/models/Query.md) | `from foundry_sdk.v2.functions.models import Query` | +**Functions** | [QueryAggregationKeyType](docs/v2/Functions/models/QueryAggregationKeyType.md) | `from foundry_sdk.v2.functions.models import QueryAggregationKeyType` | +**Functions** | [QueryAggregationRangeSubType](docs/v2/Functions/models/QueryAggregationRangeSubType.md) | `from foundry_sdk.v2.functions.models import QueryAggregationRangeSubType` | +**Functions** | [QueryAggregationRangeType](docs/v2/Functions/models/QueryAggregationRangeType.md) | `from foundry_sdk.v2.functions.models import QueryAggregationRangeType` | +**Functions** | [QueryAggregationValueType](docs/v2/Functions/models/QueryAggregationValueType.md) | `from foundry_sdk.v2.functions.models import QueryAggregationValueType` | +**Functions** | [QueryApiName](docs/v2/Functions/models/QueryApiName.md) | `from foundry_sdk.v2.functions.models import QueryApiName` | +**Functions** | [QueryArrayType](docs/v2/Functions/models/QueryArrayType.md) | `from foundry_sdk.v2.functions.models import QueryArrayType` | +**Functions** | [QueryDataType](docs/v2/Functions/models/QueryDataType.md) | `from foundry_sdk.v2.functions.models import QueryDataType` | +**Functions** | [QueryRuntimeErrorParameter](docs/v2/Functions/models/QueryRuntimeErrorParameter.md) | `from foundry_sdk.v2.functions.models import QueryRuntimeErrorParameter` | +**Functions** | [QuerySetType](docs/v2/Functions/models/QuerySetType.md) | `from foundry_sdk.v2.functions.models import QuerySetType` | +**Functions** | [QueryStructField](docs/v2/Functions/models/QueryStructField.md) | `from foundry_sdk.v2.functions.models import QueryStructField` | +**Functions** | [QueryStructType](docs/v2/Functions/models/QueryStructType.md) | `from foundry_sdk.v2.functions.models import QueryStructType` | +**Functions** | [QueryUnionType](docs/v2/Functions/models/QueryUnionType.md) | `from foundry_sdk.v2.functions.models import QueryUnionType` | +**Functions** | [StructFieldName](docs/v2/Functions/models/StructFieldName.md) | `from foundry_sdk.v2.functions.models import StructFieldName` | +**Functions** | [ThreeDimensionalAggregation](docs/v2/Functions/models/ThreeDimensionalAggregation.md) | `from foundry_sdk.v2.functions.models import ThreeDimensionalAggregation` | +**Functions** | [TwoDimensionalAggregation](docs/v2/Functions/models/TwoDimensionalAggregation.md) | `from foundry_sdk.v2.functions.models import TwoDimensionalAggregation` | +**Functions** | [ValueType](docs/v2/Functions/models/ValueType.md) | `from foundry_sdk.v2.functions.models import ValueType` | +**Functions** | [ValueTypeApiName](docs/v2/Functions/models/ValueTypeApiName.md) | `from foundry_sdk.v2.functions.models import ValueTypeApiName` | +**Functions** | [ValueTypeDataType](docs/v2/Functions/models/ValueTypeDataType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataType` | +**Functions** | [ValueTypeDataTypeArrayType](docs/v2/Functions/models/ValueTypeDataTypeArrayType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeArrayType` | +**Functions** | [ValueTypeDataTypeBinaryType](docs/v2/Functions/models/ValueTypeDataTypeBinaryType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeBinaryType` | +**Functions** | [ValueTypeDataTypeBooleanType](docs/v2/Functions/models/ValueTypeDataTypeBooleanType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeBooleanType` | +**Functions** | [ValueTypeDataTypeByteType](docs/v2/Functions/models/ValueTypeDataTypeByteType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeByteType` | +**Functions** | [ValueTypeDataTypeDateType](docs/v2/Functions/models/ValueTypeDataTypeDateType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeDateType` | +**Functions** | [ValueTypeDataTypeDecimalType](docs/v2/Functions/models/ValueTypeDataTypeDecimalType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeDecimalType` | +**Functions** | [ValueTypeDataTypeDoubleType](docs/v2/Functions/models/ValueTypeDataTypeDoubleType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeDoubleType` | +**Functions** | [ValueTypeDataTypeFloatType](docs/v2/Functions/models/ValueTypeDataTypeFloatType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeFloatType` | +**Functions** | [ValueTypeDataTypeIntegerType](docs/v2/Functions/models/ValueTypeDataTypeIntegerType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeIntegerType` | +**Functions** | [ValueTypeDataTypeLongType](docs/v2/Functions/models/ValueTypeDataTypeLongType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeLongType` | +**Functions** | [ValueTypeDataTypeMapType](docs/v2/Functions/models/ValueTypeDataTypeMapType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeMapType` | +**Functions** | [ValueTypeDataTypeOptionalType](docs/v2/Functions/models/ValueTypeDataTypeOptionalType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeOptionalType` | +**Functions** | [ValueTypeDataTypeShortType](docs/v2/Functions/models/ValueTypeDataTypeShortType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeShortType` | +**Functions** | [ValueTypeDataTypeStringType](docs/v2/Functions/models/ValueTypeDataTypeStringType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeStringType` | +**Functions** | [ValueTypeDataTypeStructElement](docs/v2/Functions/models/ValueTypeDataTypeStructElement.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeStructElement` | +**Functions** | [ValueTypeDataTypeStructFieldIdentifier](docs/v2/Functions/models/ValueTypeDataTypeStructFieldIdentifier.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeStructFieldIdentifier` | +**Functions** | [ValueTypeDataTypeStructType](docs/v2/Functions/models/ValueTypeDataTypeStructType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeStructType` | +**Functions** | [ValueTypeDataTypeTimestampType](docs/v2/Functions/models/ValueTypeDataTypeTimestampType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeTimestampType` | +**Functions** | [ValueTypeDataTypeUnionType](docs/v2/Functions/models/ValueTypeDataTypeUnionType.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeUnionType` | +**Functions** | [ValueTypeDataTypeValueTypeReference](docs/v2/Functions/models/ValueTypeDataTypeValueTypeReference.md) | `from foundry_sdk.v2.functions.models import ValueTypeDataTypeValueTypeReference` | +**Functions** | [ValueTypeDescription](docs/v2/Functions/models/ValueTypeDescription.md) | `from foundry_sdk.v2.functions.models import ValueTypeDescription` | +**Functions** | [ValueTypeReference](docs/v2/Functions/models/ValueTypeReference.md) | `from foundry_sdk.v2.functions.models import ValueTypeReference` | +**Functions** | [ValueTypeRid](docs/v2/Functions/models/ValueTypeRid.md) | `from foundry_sdk.v2.functions.models import ValueTypeRid` | +**Functions** | [ValueTypeVersion](docs/v2/Functions/models/ValueTypeVersion.md) | `from foundry_sdk.v2.functions.models import ValueTypeVersion` | +**Functions** | [ValueTypeVersionId](docs/v2/Functions/models/ValueTypeVersionId.md) | `from foundry_sdk.v2.functions.models import ValueTypeVersionId` | +**Functions** | [VersionId](docs/v2/Functions/models/VersionId.md) | `from foundry_sdk.v2.functions.models import VersionId` | +**Geo** | [BBox](docs/v2/Geo/models/BBox.md) | `from foundry_sdk.v2.geo.models import BBox` | +**Geo** | [Coordinate](docs/v2/Geo/models/Coordinate.md) | `from foundry_sdk.v2.geo.models import Coordinate` | +**Geo** | [Feature](docs/v2/Geo/models/Feature.md) | `from foundry_sdk.v2.geo.models import Feature` | +**Geo** | [FeatureCollection](docs/v2/Geo/models/FeatureCollection.md) | `from foundry_sdk.v2.geo.models import FeatureCollection` | +**Geo** | [FeatureCollectionTypes](docs/v2/Geo/models/FeatureCollectionTypes.md) | `from foundry_sdk.v2.geo.models import FeatureCollectionTypes` | +**Geo** | [FeaturePropertyKey](docs/v2/Geo/models/FeaturePropertyKey.md) | `from foundry_sdk.v2.geo.models import FeaturePropertyKey` | +**Geo** | [Geometry](docs/v2/Geo/models/Geometry.md) | `from foundry_sdk.v2.geo.models import Geometry` | +**Geo** | [GeometryCollection](docs/v2/Geo/models/GeometryCollection.md) | `from foundry_sdk.v2.geo.models import GeometryCollection` | +**Geo** | [GeoPoint](docs/v2/Geo/models/GeoPoint.md) | `from foundry_sdk.v2.geo.models import GeoPoint` | +**Geo** | [LinearRing](docs/v2/Geo/models/LinearRing.md) | `from foundry_sdk.v2.geo.models import LinearRing` | +**Geo** | [LineString](docs/v2/Geo/models/LineString.md) | `from foundry_sdk.v2.geo.models import LineString` | +**Geo** | [LineStringCoordinates](docs/v2/Geo/models/LineStringCoordinates.md) | `from foundry_sdk.v2.geo.models import LineStringCoordinates` | +**Geo** | [MultiLineString](docs/v2/Geo/models/MultiLineString.md) | `from foundry_sdk.v2.geo.models import MultiLineString` | +**Geo** | [MultiPoint](docs/v2/Geo/models/MultiPoint.md) | `from foundry_sdk.v2.geo.models import MultiPoint` | +**Geo** | [MultiPolygon](docs/v2/Geo/models/MultiPolygon.md) | `from foundry_sdk.v2.geo.models import MultiPolygon` | +**Geo** | [Polygon](docs/v2/Geo/models/Polygon.md) | `from foundry_sdk.v2.geo.models import Polygon` | +**Geo** | [Position](docs/v2/Geo/models/Position.md) | `from foundry_sdk.v2.geo.models import Position` | +**MediaSets** | [BranchName](docs/v2/MediaSets/models/BranchName.md) | `from foundry_sdk.v2.media_sets.models import BranchName` | +**MediaSets** | [BranchRid](docs/v2/MediaSets/models/BranchRid.md) | `from foundry_sdk.v2.media_sets.models import BranchRid` | +**MediaSets** | [GetMediaItemInfoResponse](docs/v2/MediaSets/models/GetMediaItemInfoResponse.md) | `from foundry_sdk.v2.media_sets.models import GetMediaItemInfoResponse` | +**MediaSets** | [LogicalTimestamp](docs/v2/MediaSets/models/LogicalTimestamp.md) | `from foundry_sdk.v2.media_sets.models import LogicalTimestamp` | +**MediaSets** | [MediaAttribution](docs/v2/MediaSets/models/MediaAttribution.md) | `from foundry_sdk.v2.media_sets.models import MediaAttribution` | +**MediaSets** | [PutMediaItemResponse](docs/v2/MediaSets/models/PutMediaItemResponse.md) | `from foundry_sdk.v2.media_sets.models import PutMediaItemResponse` | +**MediaSets** | [TransactionId](docs/v2/MediaSets/models/TransactionId.md) | `from foundry_sdk.v2.media_sets.models import TransactionId` | +**Ontologies** | [AbsoluteTimeRange](docs/v2/Ontologies/models/AbsoluteTimeRange.md) | `from foundry_sdk.v2.ontologies.models import AbsoluteTimeRange` | +**Ontologies** | [AbsoluteValuePropertyExpression](docs/v2/Ontologies/models/AbsoluteValuePropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import AbsoluteValuePropertyExpression` | +**Ontologies** | [ActionParameterArrayType](docs/v2/Ontologies/models/ActionParameterArrayType.md) | `from foundry_sdk.v2.ontologies.models import ActionParameterArrayType` | +**Ontologies** | [ActionParameterType](docs/v2/Ontologies/models/ActionParameterType.md) | `from foundry_sdk.v2.ontologies.models import ActionParameterType` | +**Ontologies** | [ActionParameterV2](docs/v2/Ontologies/models/ActionParameterV2.md) | `from foundry_sdk.v2.ontologies.models import ActionParameterV2` | +**Ontologies** | [ActionResults](docs/v2/Ontologies/models/ActionResults.md) | `from foundry_sdk.v2.ontologies.models import ActionResults` | +**Ontologies** | [ActionRid](docs/v2/Ontologies/models/ActionRid.md) | `from foundry_sdk.v2.ontologies.models import ActionRid` | +**Ontologies** | [ActionTypeApiName](docs/v2/Ontologies/models/ActionTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeApiName` | +**Ontologies** | [ActionTypeRid](docs/v2/Ontologies/models/ActionTypeRid.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeRid` | +**Ontologies** | [ActionTypeV2](docs/v2/Ontologies/models/ActionTypeV2.md) | `from foundry_sdk.v2.ontologies.models import ActionTypeV2` | +**Ontologies** | [ActivePropertyTypeStatus](docs/v2/Ontologies/models/ActivePropertyTypeStatus.md) | `from foundry_sdk.v2.ontologies.models import ActivePropertyTypeStatus` | +**Ontologies** | [AddLink](docs/v2/Ontologies/models/AddLink.md) | `from foundry_sdk.v2.ontologies.models import AddLink` | +**Ontologies** | [AddObject](docs/v2/Ontologies/models/AddObject.md) | `from foundry_sdk.v2.ontologies.models import AddObject` | +**Ontologies** | [AddPropertyExpression](docs/v2/Ontologies/models/AddPropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import AddPropertyExpression` | +**Ontologies** | [AggregateObjectsResponseItemV2](docs/v2/Ontologies/models/AggregateObjectsResponseItemV2.md) | `from foundry_sdk.v2.ontologies.models import AggregateObjectsResponseItemV2` | +**Ontologies** | [AggregateObjectsResponseV2](docs/v2/Ontologies/models/AggregateObjectsResponseV2.md) | `from foundry_sdk.v2.ontologies.models import AggregateObjectsResponseV2` | +**Ontologies** | [AggregateTimeSeries](docs/v2/Ontologies/models/AggregateTimeSeries.md) | `from foundry_sdk.v2.ontologies.models import AggregateTimeSeries` | +**Ontologies** | [AggregationAccuracy](docs/v2/Ontologies/models/AggregationAccuracy.md) | `from foundry_sdk.v2.ontologies.models import AggregationAccuracy` | +**Ontologies** | [AggregationAccuracyRequest](docs/v2/Ontologies/models/AggregationAccuracyRequest.md) | `from foundry_sdk.v2.ontologies.models import AggregationAccuracyRequest` | +**Ontologies** | [AggregationDurationGroupingV2](docs/v2/Ontologies/models/AggregationDurationGroupingV2.md) | `from foundry_sdk.v2.ontologies.models import AggregationDurationGroupingV2` | +**Ontologies** | [AggregationExactGroupingV2](docs/v2/Ontologies/models/AggregationExactGroupingV2.md) | `from foundry_sdk.v2.ontologies.models import AggregationExactGroupingV2` | +**Ontologies** | [AggregationFixedWidthGroupingV2](docs/v2/Ontologies/models/AggregationFixedWidthGroupingV2.md) | `from foundry_sdk.v2.ontologies.models import AggregationFixedWidthGroupingV2` | +**Ontologies** | [AggregationGroupByV2](docs/v2/Ontologies/models/AggregationGroupByV2.md) | `from foundry_sdk.v2.ontologies.models import AggregationGroupByV2` | +**Ontologies** | [AggregationGroupKeyV2](docs/v2/Ontologies/models/AggregationGroupKeyV2.md) | `from foundry_sdk.v2.ontologies.models import AggregationGroupKeyV2` | +**Ontologies** | [AggregationGroupValueV2](docs/v2/Ontologies/models/AggregationGroupValueV2.md) | `from foundry_sdk.v2.ontologies.models import AggregationGroupValueV2` | +**Ontologies** | [AggregationMetricName](docs/v2/Ontologies/models/AggregationMetricName.md) | `from foundry_sdk.v2.ontologies.models import AggregationMetricName` | +**Ontologies** | [AggregationMetricResultV2](docs/v2/Ontologies/models/AggregationMetricResultV2.md) | `from foundry_sdk.v2.ontologies.models import AggregationMetricResultV2` | +**Ontologies** | [AggregationRangesGroupingV2](docs/v2/Ontologies/models/AggregationRangesGroupingV2.md) | `from foundry_sdk.v2.ontologies.models import AggregationRangesGroupingV2` | +**Ontologies** | [AggregationRangeV2](docs/v2/Ontologies/models/AggregationRangeV2.md) | `from foundry_sdk.v2.ontologies.models import AggregationRangeV2` | +**Ontologies** | [AggregationV2](docs/v2/Ontologies/models/AggregationV2.md) | `from foundry_sdk.v2.ontologies.models import AggregationV2` | +**Ontologies** | [AndQueryV2](docs/v2/Ontologies/models/AndQueryV2.md) | `from foundry_sdk.v2.ontologies.models import AndQueryV2` | +**Ontologies** | [ApplyActionMode](docs/v2/Ontologies/models/ApplyActionMode.md) | `from foundry_sdk.v2.ontologies.models import ApplyActionMode` | +**Ontologies** | [ApplyActionRequestOptions](docs/v2/Ontologies/models/ApplyActionRequestOptions.md) | `from foundry_sdk.v2.ontologies.models import ApplyActionRequestOptions` | +**Ontologies** | [ApproximateDistinctAggregationV2](docs/v2/Ontologies/models/ApproximateDistinctAggregationV2.md) | `from foundry_sdk.v2.ontologies.models import ApproximateDistinctAggregationV2` | +**Ontologies** | [ApproximatePercentileAggregationV2](docs/v2/Ontologies/models/ApproximatePercentileAggregationV2.md) | `from foundry_sdk.v2.ontologies.models import ApproximatePercentileAggregationV2` | +**Ontologies** | [ArraySizeConstraint](docs/v2/Ontologies/models/ArraySizeConstraint.md) | `from foundry_sdk.v2.ontologies.models import ArraySizeConstraint` | +**Ontologies** | [ArtifactRepositoryRid](docs/v2/Ontologies/models/ArtifactRepositoryRid.md) | `from foundry_sdk.v2.ontologies.models import ArtifactRepositoryRid` | +**Ontologies** | [AttachmentMetadataResponse](docs/v2/Ontologies/models/AttachmentMetadataResponse.md) | `from foundry_sdk.v2.ontologies.models import AttachmentMetadataResponse` | +**Ontologies** | [AttachmentRid](docs/v2/Ontologies/models/AttachmentRid.md) | `from foundry_sdk.v2.ontologies.models import AttachmentRid` | +**Ontologies** | [AttachmentV2](docs/v2/Ontologies/models/AttachmentV2.md) | `from foundry_sdk.v2.ontologies.models import AttachmentV2` | +**Ontologies** | [AvgAggregationV2](docs/v2/Ontologies/models/AvgAggregationV2.md) | `from foundry_sdk.v2.ontologies.models import AvgAggregationV2` | +**Ontologies** | [BatchActionObjectEdit](docs/v2/Ontologies/models/BatchActionObjectEdit.md) | `from foundry_sdk.v2.ontologies.models import BatchActionObjectEdit` | +**Ontologies** | [BatchActionObjectEdits](docs/v2/Ontologies/models/BatchActionObjectEdits.md) | `from foundry_sdk.v2.ontologies.models import BatchActionObjectEdits` | +**Ontologies** | [BatchActionResults](docs/v2/Ontologies/models/BatchActionResults.md) | `from foundry_sdk.v2.ontologies.models import BatchActionResults` | +**Ontologies** | [BatchApplyActionRequestItem](docs/v2/Ontologies/models/BatchApplyActionRequestItem.md) | `from foundry_sdk.v2.ontologies.models import BatchApplyActionRequestItem` | +**Ontologies** | [BatchApplyActionRequestOptions](docs/v2/Ontologies/models/BatchApplyActionRequestOptions.md) | `from foundry_sdk.v2.ontologies.models import BatchApplyActionRequestOptions` | +**Ontologies** | [BatchApplyActionResponseV2](docs/v2/Ontologies/models/BatchApplyActionResponseV2.md) | `from foundry_sdk.v2.ontologies.models import BatchApplyActionResponseV2` | +**Ontologies** | [BatchReturnEditsMode](docs/v2/Ontologies/models/BatchReturnEditsMode.md) | `from foundry_sdk.v2.ontologies.models import BatchReturnEditsMode` | +**Ontologies** | [BlueprintIcon](docs/v2/Ontologies/models/BlueprintIcon.md) | `from foundry_sdk.v2.ontologies.models import BlueprintIcon` | +**Ontologies** | [BoundingBoxValue](docs/v2/Ontologies/models/BoundingBoxValue.md) | `from foundry_sdk.v2.ontologies.models import BoundingBoxValue` | +**Ontologies** | [CenterPoint](docs/v2/Ontologies/models/CenterPoint.md) | `from foundry_sdk.v2.ontologies.models import CenterPoint` | +**Ontologies** | [CenterPointTypes](docs/v2/Ontologies/models/CenterPointTypes.md) | `from foundry_sdk.v2.ontologies.models import CenterPointTypes` | +**Ontologies** | [ContainsAllTermsInOrderPrefixLastTerm](docs/v2/Ontologies/models/ContainsAllTermsInOrderPrefixLastTerm.md) | `from foundry_sdk.v2.ontologies.models import ContainsAllTermsInOrderPrefixLastTerm` | +**Ontologies** | [ContainsAllTermsInOrderQuery](docs/v2/Ontologies/models/ContainsAllTermsInOrderQuery.md) | `from foundry_sdk.v2.ontologies.models import ContainsAllTermsInOrderQuery` | +**Ontologies** | [ContainsAllTermsQuery](docs/v2/Ontologies/models/ContainsAllTermsQuery.md) | `from foundry_sdk.v2.ontologies.models import ContainsAllTermsQuery` | +**Ontologies** | [ContainsAnyTermQuery](docs/v2/Ontologies/models/ContainsAnyTermQuery.md) | `from foundry_sdk.v2.ontologies.models import ContainsAnyTermQuery` | +**Ontologies** | [ContainsQueryV2](docs/v2/Ontologies/models/ContainsQueryV2.md) | `from foundry_sdk.v2.ontologies.models import ContainsQueryV2` | +**Ontologies** | [CountAggregationV2](docs/v2/Ontologies/models/CountAggregationV2.md) | `from foundry_sdk.v2.ontologies.models import CountAggregationV2` | +**Ontologies** | [CountObjectsResponseV2](docs/v2/Ontologies/models/CountObjectsResponseV2.md) | `from foundry_sdk.v2.ontologies.models import CountObjectsResponseV2` | +**Ontologies** | [CreateInterfaceObjectRule](docs/v2/Ontologies/models/CreateInterfaceObjectRule.md) | `from foundry_sdk.v2.ontologies.models import CreateInterfaceObjectRule` | +**Ontologies** | [CreateLinkRule](docs/v2/Ontologies/models/CreateLinkRule.md) | `from foundry_sdk.v2.ontologies.models import CreateLinkRule` | +**Ontologies** | [CreateObjectRule](docs/v2/Ontologies/models/CreateObjectRule.md) | `from foundry_sdk.v2.ontologies.models import CreateObjectRule` | +**Ontologies** | [CreateTemporaryObjectSetResponseV2](docs/v2/Ontologies/models/CreateTemporaryObjectSetResponseV2.md) | `from foundry_sdk.v2.ontologies.models import CreateTemporaryObjectSetResponseV2` | +**Ontologies** | [DataValue](docs/v2/Ontologies/models/DataValue.md) | `from foundry_sdk.v2.ontologies.models import DataValue` | +**Ontologies** | [DeleteInterfaceObjectRule](docs/v2/Ontologies/models/DeleteInterfaceObjectRule.md) | `from foundry_sdk.v2.ontologies.models import DeleteInterfaceObjectRule` | +**Ontologies** | [DeleteLink](docs/v2/Ontologies/models/DeleteLink.md) | `from foundry_sdk.v2.ontologies.models import DeleteLink` | +**Ontologies** | [DeleteLinkRule](docs/v2/Ontologies/models/DeleteLinkRule.md) | `from foundry_sdk.v2.ontologies.models import DeleteLinkRule` | +**Ontologies** | [DeleteObject](docs/v2/Ontologies/models/DeleteObject.md) | `from foundry_sdk.v2.ontologies.models import DeleteObject` | +**Ontologies** | [DeleteObjectRule](docs/v2/Ontologies/models/DeleteObjectRule.md) | `from foundry_sdk.v2.ontologies.models import DeleteObjectRule` | +**Ontologies** | [DeprecatedPropertyTypeStatus](docs/v2/Ontologies/models/DeprecatedPropertyTypeStatus.md) | `from foundry_sdk.v2.ontologies.models import DeprecatedPropertyTypeStatus` | +**Ontologies** | [DerivedPropertyApiName](docs/v2/Ontologies/models/DerivedPropertyApiName.md) | `from foundry_sdk.v2.ontologies.models import DerivedPropertyApiName` | +**Ontologies** | [DerivedPropertyDefinition](docs/v2/Ontologies/models/DerivedPropertyDefinition.md) | `from foundry_sdk.v2.ontologies.models import DerivedPropertyDefinition` | +**Ontologies** | [DividePropertyExpression](docs/v2/Ontologies/models/DividePropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import DividePropertyExpression` | +**Ontologies** | [DoesNotIntersectBoundingBoxQuery](docs/v2/Ontologies/models/DoesNotIntersectBoundingBoxQuery.md) | `from foundry_sdk.v2.ontologies.models import DoesNotIntersectBoundingBoxQuery` | +**Ontologies** | [DoesNotIntersectPolygonQuery](docs/v2/Ontologies/models/DoesNotIntersectPolygonQuery.md) | `from foundry_sdk.v2.ontologies.models import DoesNotIntersectPolygonQuery` | +**Ontologies** | [DoubleVector](docs/v2/Ontologies/models/DoubleVector.md) | `from foundry_sdk.v2.ontologies.models import DoubleVector` | +**Ontologies** | [EntrySetType](docs/v2/Ontologies/models/EntrySetType.md) | `from foundry_sdk.v2.ontologies.models import EntrySetType` | +**Ontologies** | [EqualsQueryV2](docs/v2/Ontologies/models/EqualsQueryV2.md) | `from foundry_sdk.v2.ontologies.models import EqualsQueryV2` | +**Ontologies** | [ExactDistinctAggregationV2](docs/v2/Ontologies/models/ExactDistinctAggregationV2.md) | `from foundry_sdk.v2.ontologies.models import ExactDistinctAggregationV2` | +**Ontologies** | [ExamplePropertyTypeStatus](docs/v2/Ontologies/models/ExamplePropertyTypeStatus.md) | `from foundry_sdk.v2.ontologies.models import ExamplePropertyTypeStatus` | +**Ontologies** | [ExecuteQueryResponse](docs/v2/Ontologies/models/ExecuteQueryResponse.md) | `from foundry_sdk.v2.ontologies.models import ExecuteQueryResponse` | +**Ontologies** | [ExperimentalPropertyTypeStatus](docs/v2/Ontologies/models/ExperimentalPropertyTypeStatus.md) | `from foundry_sdk.v2.ontologies.models import ExperimentalPropertyTypeStatus` | +**Ontologies** | [ExtractDatePart](docs/v2/Ontologies/models/ExtractDatePart.md) | `from foundry_sdk.v2.ontologies.models import ExtractDatePart` | +**Ontologies** | [ExtractPropertyExpression](docs/v2/Ontologies/models/ExtractPropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import ExtractPropertyExpression` | +**Ontologies** | [FilterValue](docs/v2/Ontologies/models/FilterValue.md) | `from foundry_sdk.v2.ontologies.models import FilterValue` | +**Ontologies** | [FunctionRid](docs/v2/Ontologies/models/FunctionRid.md) | `from foundry_sdk.v2.ontologies.models import FunctionRid` | +**Ontologies** | [FunctionVersion](docs/v2/Ontologies/models/FunctionVersion.md) | `from foundry_sdk.v2.ontologies.models import FunctionVersion` | +**Ontologies** | [FuzzyV2](docs/v2/Ontologies/models/FuzzyV2.md) | `from foundry_sdk.v2.ontologies.models import FuzzyV2` | +**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` | +**Ontologies** | [GteQueryV2](docs/v2/Ontologies/models/GteQueryV2.md) | `from foundry_sdk.v2.ontologies.models import GteQueryV2` | +**Ontologies** | [GtQueryV2](docs/v2/Ontologies/models/GtQueryV2.md) | `from foundry_sdk.v2.ontologies.models import GtQueryV2` | +**Ontologies** | [Icon](docs/v2/Ontologies/models/Icon.md) | `from foundry_sdk.v2.ontologies.models import Icon` | +**Ontologies** | [InQuery](docs/v2/Ontologies/models/InQuery.md) | `from foundry_sdk.v2.ontologies.models import InQuery` | +**Ontologies** | [InterfaceLinkType](docs/v2/Ontologies/models/InterfaceLinkType.md) | `from foundry_sdk.v2.ontologies.models import InterfaceLinkType` | +**Ontologies** | [InterfaceLinkTypeApiName](docs/v2/Ontologies/models/InterfaceLinkTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import InterfaceLinkTypeApiName` | +**Ontologies** | [InterfaceLinkTypeCardinality](docs/v2/Ontologies/models/InterfaceLinkTypeCardinality.md) | `from foundry_sdk.v2.ontologies.models import InterfaceLinkTypeCardinality` | +**Ontologies** | [InterfaceLinkTypeLinkedEntityApiName](docs/v2/Ontologies/models/InterfaceLinkTypeLinkedEntityApiName.md) | `from foundry_sdk.v2.ontologies.models import InterfaceLinkTypeLinkedEntityApiName` | +**Ontologies** | [InterfaceLinkTypeRid](docs/v2/Ontologies/models/InterfaceLinkTypeRid.md) | `from foundry_sdk.v2.ontologies.models import InterfaceLinkTypeRid` | +**Ontologies** | [InterfaceSharedPropertyType](docs/v2/Ontologies/models/InterfaceSharedPropertyType.md) | `from foundry_sdk.v2.ontologies.models import InterfaceSharedPropertyType` | +**Ontologies** | [InterfaceToObjectTypeMapping](docs/v2/Ontologies/models/InterfaceToObjectTypeMapping.md) | `from foundry_sdk.v2.ontologies.models import InterfaceToObjectTypeMapping` | +**Ontologies** | [InterfaceToObjectTypeMappings](docs/v2/Ontologies/models/InterfaceToObjectTypeMappings.md) | `from foundry_sdk.v2.ontologies.models import InterfaceToObjectTypeMappings` | +**Ontologies** | [InterfaceType](docs/v2/Ontologies/models/InterfaceType.md) | `from foundry_sdk.v2.ontologies.models import InterfaceType` | +**Ontologies** | [InterfaceTypeApiName](docs/v2/Ontologies/models/InterfaceTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import InterfaceTypeApiName` | +**Ontologies** | [InterfaceTypeRid](docs/v2/Ontologies/models/InterfaceTypeRid.md) | `from foundry_sdk.v2.ontologies.models import InterfaceTypeRid` | +**Ontologies** | [IntersectsBoundingBoxQuery](docs/v2/Ontologies/models/IntersectsBoundingBoxQuery.md) | `from foundry_sdk.v2.ontologies.models import IntersectsBoundingBoxQuery` | +**Ontologies** | [IntersectsPolygonQuery](docs/v2/Ontologies/models/IntersectsPolygonQuery.md) | `from foundry_sdk.v2.ontologies.models import IntersectsPolygonQuery` | +**Ontologies** | [IsNullQueryV2](docs/v2/Ontologies/models/IsNullQueryV2.md) | `from foundry_sdk.v2.ontologies.models import IsNullQueryV2` | +**Ontologies** | [LeastPropertyExpression](docs/v2/Ontologies/models/LeastPropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import LeastPropertyExpression` | +**Ontologies** | [LinkedInterfaceTypeApiName](docs/v2/Ontologies/models/LinkedInterfaceTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import LinkedInterfaceTypeApiName` | +**Ontologies** | [LinkedObjectTypeApiName](docs/v2/Ontologies/models/LinkedObjectTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import LinkedObjectTypeApiName` | +**Ontologies** | [LinkSideObject](docs/v2/Ontologies/models/LinkSideObject.md) | `from foundry_sdk.v2.ontologies.models import LinkSideObject` | +**Ontologies** | [LinkTypeApiName](docs/v2/Ontologies/models/LinkTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import LinkTypeApiName` | +**Ontologies** | [LinkTypeRid](docs/v2/Ontologies/models/LinkTypeRid.md) | `from foundry_sdk.v2.ontologies.models import LinkTypeRid` | +**Ontologies** | [LinkTypeSideCardinality](docs/v2/Ontologies/models/LinkTypeSideCardinality.md) | `from foundry_sdk.v2.ontologies.models import LinkTypeSideCardinality` | +**Ontologies** | [LinkTypeSideV2](docs/v2/Ontologies/models/LinkTypeSideV2.md) | `from foundry_sdk.v2.ontologies.models import LinkTypeSideV2` | +**Ontologies** | [ListActionTypesResponseV2](docs/v2/Ontologies/models/ListActionTypesResponseV2.md) | `from foundry_sdk.v2.ontologies.models import ListActionTypesResponseV2` | +**Ontologies** | [ListAttachmentsResponseV2](docs/v2/Ontologies/models/ListAttachmentsResponseV2.md) | `from foundry_sdk.v2.ontologies.models import ListAttachmentsResponseV2` | +**Ontologies** | [ListInterfaceTypesResponse](docs/v2/Ontologies/models/ListInterfaceTypesResponse.md) | `from foundry_sdk.v2.ontologies.models import ListInterfaceTypesResponse` | +**Ontologies** | [ListLinkedObjectsResponseV2](docs/v2/Ontologies/models/ListLinkedObjectsResponseV2.md) | `from foundry_sdk.v2.ontologies.models import ListLinkedObjectsResponseV2` | +**Ontologies** | [ListObjectsResponseV2](docs/v2/Ontologies/models/ListObjectsResponseV2.md) | `from foundry_sdk.v2.ontologies.models import ListObjectsResponseV2` | +**Ontologies** | [ListObjectTypesV2Response](docs/v2/Ontologies/models/ListObjectTypesV2Response.md) | `from foundry_sdk.v2.ontologies.models import ListObjectTypesV2Response` | +**Ontologies** | [ListOntologiesV2Response](docs/v2/Ontologies/models/ListOntologiesV2Response.md) | `from foundry_sdk.v2.ontologies.models import ListOntologiesV2Response` | +**Ontologies** | [ListOutgoingLinkTypesResponseV2](docs/v2/Ontologies/models/ListOutgoingLinkTypesResponseV2.md) | `from foundry_sdk.v2.ontologies.models import ListOutgoingLinkTypesResponseV2` | +**Ontologies** | [ListQueryTypesResponseV2](docs/v2/Ontologies/models/ListQueryTypesResponseV2.md) | `from foundry_sdk.v2.ontologies.models import ListQueryTypesResponseV2` | +**Ontologies** | [LoadObjectSetResponseV2](docs/v2/Ontologies/models/LoadObjectSetResponseV2.md) | `from foundry_sdk.v2.ontologies.models import LoadObjectSetResponseV2` | +**Ontologies** | [LoadObjectSetV2MultipleObjectTypesResponse](docs/v2/Ontologies/models/LoadObjectSetV2MultipleObjectTypesResponse.md) | `from foundry_sdk.v2.ontologies.models import LoadObjectSetV2MultipleObjectTypesResponse` | +**Ontologies** | [LoadObjectSetV2ObjectsOrInterfacesResponse](docs/v2/Ontologies/models/LoadObjectSetV2ObjectsOrInterfacesResponse.md) | `from foundry_sdk.v2.ontologies.models import LoadObjectSetV2ObjectsOrInterfacesResponse` | +**Ontologies** | [LogicRule](docs/v2/Ontologies/models/LogicRule.md) | `from foundry_sdk.v2.ontologies.models import LogicRule` | +**Ontologies** | [LteQueryV2](docs/v2/Ontologies/models/LteQueryV2.md) | `from foundry_sdk.v2.ontologies.models import LteQueryV2` | +**Ontologies** | [LtQueryV2](docs/v2/Ontologies/models/LtQueryV2.md) | `from foundry_sdk.v2.ontologies.models import LtQueryV2` | +**Ontologies** | [MaxAggregationV2](docs/v2/Ontologies/models/MaxAggregationV2.md) | `from foundry_sdk.v2.ontologies.models import MaxAggregationV2` | +**Ontologies** | [MediaMetadata](docs/v2/Ontologies/models/MediaMetadata.md) | `from foundry_sdk.v2.ontologies.models import MediaMetadata` | +**Ontologies** | [MethodObjectSet](docs/v2/Ontologies/models/MethodObjectSet.md) | `from foundry_sdk.v2.ontologies.models import MethodObjectSet` | +**Ontologies** | [MinAggregationV2](docs/v2/Ontologies/models/MinAggregationV2.md) | `from foundry_sdk.v2.ontologies.models import MinAggregationV2` | +**Ontologies** | [ModifyInterfaceObjectRule](docs/v2/Ontologies/models/ModifyInterfaceObjectRule.md) | `from foundry_sdk.v2.ontologies.models import ModifyInterfaceObjectRule` | +**Ontologies** | [ModifyObject](docs/v2/Ontologies/models/ModifyObject.md) | `from foundry_sdk.v2.ontologies.models import ModifyObject` | +**Ontologies** | [ModifyObjectRule](docs/v2/Ontologies/models/ModifyObjectRule.md) | `from foundry_sdk.v2.ontologies.models import ModifyObjectRule` | +**Ontologies** | [MultiplyPropertyExpression](docs/v2/Ontologies/models/MultiplyPropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import MultiplyPropertyExpression` | +**Ontologies** | [NearestNeighborsQuery](docs/v2/Ontologies/models/NearestNeighborsQuery.md) | `from foundry_sdk.v2.ontologies.models import NearestNeighborsQuery` | +**Ontologies** | [NearestNeighborsQueryText](docs/v2/Ontologies/models/NearestNeighborsQueryText.md) | `from foundry_sdk.v2.ontologies.models import NearestNeighborsQueryText` | +**Ontologies** | [NegatePropertyExpression](docs/v2/Ontologies/models/NegatePropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import NegatePropertyExpression` | +**Ontologies** | [NotQueryV2](docs/v2/Ontologies/models/NotQueryV2.md) | `from foundry_sdk.v2.ontologies.models import NotQueryV2` | +**Ontologies** | [ObjectEdit](docs/v2/Ontologies/models/ObjectEdit.md) | `from foundry_sdk.v2.ontologies.models import ObjectEdit` | +**Ontologies** | [ObjectEdits](docs/v2/Ontologies/models/ObjectEdits.md) | `from foundry_sdk.v2.ontologies.models import ObjectEdits` | +**Ontologies** | [ObjectPropertyType](docs/v2/Ontologies/models/ObjectPropertyType.md) | `from foundry_sdk.v2.ontologies.models import ObjectPropertyType` | +**Ontologies** | [ObjectPropertyValueConstraint](docs/v2/Ontologies/models/ObjectPropertyValueConstraint.md) | `from foundry_sdk.v2.ontologies.models import ObjectPropertyValueConstraint` | +**Ontologies** | [ObjectQueryResultConstraint](docs/v2/Ontologies/models/ObjectQueryResultConstraint.md) | `from foundry_sdk.v2.ontologies.models import ObjectQueryResultConstraint` | +**Ontologies** | [ObjectRid](docs/v2/Ontologies/models/ObjectRid.md) | `from foundry_sdk.v2.ontologies.models import ObjectRid` | +**Ontologies** | [ObjectSet](docs/v2/Ontologies/models/ObjectSet.md) | `from foundry_sdk.v2.ontologies.models import ObjectSet` | +**Ontologies** | [ObjectSetAsBaseObjectTypesType](docs/v2/Ontologies/models/ObjectSetAsBaseObjectTypesType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetAsBaseObjectTypesType` | +**Ontologies** | [ObjectSetAsTypeType](docs/v2/Ontologies/models/ObjectSetAsTypeType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetAsTypeType` | +**Ontologies** | [ObjectSetBaseType](docs/v2/Ontologies/models/ObjectSetBaseType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetBaseType` | +**Ontologies** | [ObjectSetFilterType](docs/v2/Ontologies/models/ObjectSetFilterType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetFilterType` | +**Ontologies** | [ObjectSetInterfaceBaseType](docs/v2/Ontologies/models/ObjectSetInterfaceBaseType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetInterfaceBaseType` | +**Ontologies** | [ObjectSetIntersectionType](docs/v2/Ontologies/models/ObjectSetIntersectionType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetIntersectionType` | +**Ontologies** | [ObjectSetMethodInputType](docs/v2/Ontologies/models/ObjectSetMethodInputType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetMethodInputType` | +**Ontologies** | [ObjectSetNearestNeighborsType](docs/v2/Ontologies/models/ObjectSetNearestNeighborsType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetNearestNeighborsType` | +**Ontologies** | [ObjectSetReferenceType](docs/v2/Ontologies/models/ObjectSetReferenceType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetReferenceType` | +**Ontologies** | [ObjectSetRid](docs/v2/Ontologies/models/ObjectSetRid.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetRid` | +**Ontologies** | [ObjectSetSearchAroundType](docs/v2/Ontologies/models/ObjectSetSearchAroundType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetSearchAroundType` | +**Ontologies** | [ObjectSetStaticType](docs/v2/Ontologies/models/ObjectSetStaticType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetStaticType` | +**Ontologies** | [ObjectSetSubtractType](docs/v2/Ontologies/models/ObjectSetSubtractType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetSubtractType` | +**Ontologies** | [ObjectSetUnionType](docs/v2/Ontologies/models/ObjectSetUnionType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetUnionType` | +**Ontologies** | [ObjectSetWithPropertiesType](docs/v2/Ontologies/models/ObjectSetWithPropertiesType.md) | `from foundry_sdk.v2.ontologies.models import ObjectSetWithPropertiesType` | +**Ontologies** | [ObjectTypeApiName](docs/v2/Ontologies/models/ObjectTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import ObjectTypeApiName` | +**Ontologies** | [ObjectTypeEdits](docs/v2/Ontologies/models/ObjectTypeEdits.md) | `from foundry_sdk.v2.ontologies.models import ObjectTypeEdits` | +**Ontologies** | [ObjectTypeFullMetadata](docs/v2/Ontologies/models/ObjectTypeFullMetadata.md) | `from foundry_sdk.v2.ontologies.models import ObjectTypeFullMetadata` | +**Ontologies** | [ObjectTypeId](docs/v2/Ontologies/models/ObjectTypeId.md) | `from foundry_sdk.v2.ontologies.models import ObjectTypeId` | +**Ontologies** | [ObjectTypeInterfaceImplementation](docs/v2/Ontologies/models/ObjectTypeInterfaceImplementation.md) | `from foundry_sdk.v2.ontologies.models import ObjectTypeInterfaceImplementation` | +**Ontologies** | [ObjectTypeRid](docs/v2/Ontologies/models/ObjectTypeRid.md) | `from foundry_sdk.v2.ontologies.models import ObjectTypeRid` | +**Ontologies** | [ObjectTypeV2](docs/v2/Ontologies/models/ObjectTypeV2.md) | `from foundry_sdk.v2.ontologies.models import ObjectTypeV2` | +**Ontologies** | [ObjectTypeVisibility](docs/v2/Ontologies/models/ObjectTypeVisibility.md) | `from foundry_sdk.v2.ontologies.models import ObjectTypeVisibility` | +**Ontologies** | [OneOfConstraint](docs/v2/Ontologies/models/OneOfConstraint.md) | `from foundry_sdk.v2.ontologies.models import OneOfConstraint` | +**Ontologies** | [OntologyApiName](docs/v2/Ontologies/models/OntologyApiName.md) | `from foundry_sdk.v2.ontologies.models import OntologyApiName` | +**Ontologies** | [OntologyArrayType](docs/v2/Ontologies/models/OntologyArrayType.md) | `from foundry_sdk.v2.ontologies.models import OntologyArrayType` | +**Ontologies** | [OntologyDataType](docs/v2/Ontologies/models/OntologyDataType.md) | `from foundry_sdk.v2.ontologies.models import OntologyDataType` | +**Ontologies** | [OntologyFullMetadata](docs/v2/Ontologies/models/OntologyFullMetadata.md) | `from foundry_sdk.v2.ontologies.models import OntologyFullMetadata` | +**Ontologies** | [OntologyIdentifier](docs/v2/Ontologies/models/OntologyIdentifier.md) | `from foundry_sdk.v2.ontologies.models import OntologyIdentifier` | +**Ontologies** | [OntologyInterfaceObjectType](docs/v2/Ontologies/models/OntologyInterfaceObjectType.md) | `from foundry_sdk.v2.ontologies.models import OntologyInterfaceObjectType` | +**Ontologies** | [OntologyMapType](docs/v2/Ontologies/models/OntologyMapType.md) | `from foundry_sdk.v2.ontologies.models import OntologyMapType` | +**Ontologies** | [OntologyObjectArrayType](docs/v2/Ontologies/models/OntologyObjectArrayType.md) | `from foundry_sdk.v2.ontologies.models import OntologyObjectArrayType` | +**Ontologies** | [OntologyObjectSetType](docs/v2/Ontologies/models/OntologyObjectSetType.md) | `from foundry_sdk.v2.ontologies.models import OntologyObjectSetType` | +**Ontologies** | [OntologyObjectType](docs/v2/Ontologies/models/OntologyObjectType.md) | `from foundry_sdk.v2.ontologies.models import OntologyObjectType` | +**Ontologies** | [OntologyObjectTypeReferenceType](docs/v2/Ontologies/models/OntologyObjectTypeReferenceType.md) | `from foundry_sdk.v2.ontologies.models import OntologyObjectTypeReferenceType` | +**Ontologies** | [OntologyObjectV2](docs/v2/Ontologies/models/OntologyObjectV2.md) | `from foundry_sdk.v2.ontologies.models import OntologyObjectV2` | +**Ontologies** | [OntologyRid](docs/v2/Ontologies/models/OntologyRid.md) | `from foundry_sdk.v2.ontologies.models import OntologyRid` | +**Ontologies** | [OntologySetType](docs/v2/Ontologies/models/OntologySetType.md) | `from foundry_sdk.v2.ontologies.models import OntologySetType` | +**Ontologies** | [OntologyStructField](docs/v2/Ontologies/models/OntologyStructField.md) | `from foundry_sdk.v2.ontologies.models import OntologyStructField` | +**Ontologies** | [OntologyStructType](docs/v2/Ontologies/models/OntologyStructType.md) | `from foundry_sdk.v2.ontologies.models import OntologyStructType` | +**Ontologies** | [OntologyV2](docs/v2/Ontologies/models/OntologyV2.md) | `from foundry_sdk.v2.ontologies.models import OntologyV2` | +**Ontologies** | [OrderBy](docs/v2/Ontologies/models/OrderBy.md) | `from foundry_sdk.v2.ontologies.models import OrderBy` | +**Ontologies** | [OrderByDirection](docs/v2/Ontologies/models/OrderByDirection.md) | `from foundry_sdk.v2.ontologies.models import OrderByDirection` | +**Ontologies** | [OrQueryV2](docs/v2/Ontologies/models/OrQueryV2.md) | `from foundry_sdk.v2.ontologies.models import OrQueryV2` | +**Ontologies** | [ParameterEvaluatedConstraint](docs/v2/Ontologies/models/ParameterEvaluatedConstraint.md) | `from foundry_sdk.v2.ontologies.models import ParameterEvaluatedConstraint` | +**Ontologies** | [ParameterEvaluationResult](docs/v2/Ontologies/models/ParameterEvaluationResult.md) | `from foundry_sdk.v2.ontologies.models import ParameterEvaluationResult` | +**Ontologies** | [ParameterId](docs/v2/Ontologies/models/ParameterId.md) | `from foundry_sdk.v2.ontologies.models import ParameterId` | +**Ontologies** | [ParameterOption](docs/v2/Ontologies/models/ParameterOption.md) | `from foundry_sdk.v2.ontologies.models import ParameterOption` | +**Ontologies** | [PolygonValue](docs/v2/Ontologies/models/PolygonValue.md) | `from foundry_sdk.v2.ontologies.models import PolygonValue` | +**Ontologies** | [PreciseDuration](docs/v2/Ontologies/models/PreciseDuration.md) | `from foundry_sdk.v2.ontologies.models import PreciseDuration` | +**Ontologies** | [PreciseTimeUnit](docs/v2/Ontologies/models/PreciseTimeUnit.md) | `from foundry_sdk.v2.ontologies.models import PreciseTimeUnit` | +**Ontologies** | [PrimaryKeyValue](docs/v2/Ontologies/models/PrimaryKeyValue.md) | `from foundry_sdk.v2.ontologies.models import PrimaryKeyValue` | +**Ontologies** | [PropertyApiName](docs/v2/Ontologies/models/PropertyApiName.md) | `from foundry_sdk.v2.ontologies.models import PropertyApiName` | +**Ontologies** | [PropertyApiNameSelector](docs/v2/Ontologies/models/PropertyApiNameSelector.md) | `from foundry_sdk.v2.ontologies.models import PropertyApiNameSelector` | +**Ontologies** | [PropertyFilter](docs/v2/Ontologies/models/PropertyFilter.md) | `from foundry_sdk.v2.ontologies.models import PropertyFilter` | +**Ontologies** | [PropertyId](docs/v2/Ontologies/models/PropertyId.md) | `from foundry_sdk.v2.ontologies.models import PropertyId` | +**Ontologies** | [PropertyIdentifier](docs/v2/Ontologies/models/PropertyIdentifier.md) | `from foundry_sdk.v2.ontologies.models import PropertyIdentifier` | +**Ontologies** | [PropertyTypeRid](docs/v2/Ontologies/models/PropertyTypeRid.md) | `from foundry_sdk.v2.ontologies.models import PropertyTypeRid` | +**Ontologies** | [PropertyTypeStatus](docs/v2/Ontologies/models/PropertyTypeStatus.md) | `from foundry_sdk.v2.ontologies.models import PropertyTypeStatus` | +**Ontologies** | [PropertyTypeVisibility](docs/v2/Ontologies/models/PropertyTypeVisibility.md) | `from foundry_sdk.v2.ontologies.models import PropertyTypeVisibility` | +**Ontologies** | [PropertyV2](docs/v2/Ontologies/models/PropertyV2.md) | `from foundry_sdk.v2.ontologies.models import PropertyV2` | +**Ontologies** | [PropertyValue](docs/v2/Ontologies/models/PropertyValue.md) | `from foundry_sdk.v2.ontologies.models import PropertyValue` | +**Ontologies** | [PropertyValueEscapedString](docs/v2/Ontologies/models/PropertyValueEscapedString.md) | `from foundry_sdk.v2.ontologies.models import PropertyValueEscapedString` | +**Ontologies** | [QueryAggregationKeyType](docs/v2/Ontologies/models/QueryAggregationKeyType.md) | `from foundry_sdk.v2.ontologies.models import QueryAggregationKeyType` | +**Ontologies** | [QueryAggregationRangeSubType](docs/v2/Ontologies/models/QueryAggregationRangeSubType.md) | `from foundry_sdk.v2.ontologies.models import QueryAggregationRangeSubType` | +**Ontologies** | [QueryAggregationRangeType](docs/v2/Ontologies/models/QueryAggregationRangeType.md) | `from foundry_sdk.v2.ontologies.models import QueryAggregationRangeType` | +**Ontologies** | [QueryAggregationValueType](docs/v2/Ontologies/models/QueryAggregationValueType.md) | `from foundry_sdk.v2.ontologies.models import QueryAggregationValueType` | +**Ontologies** | [QueryApiName](docs/v2/Ontologies/models/QueryApiName.md) | `from foundry_sdk.v2.ontologies.models import QueryApiName` | +**Ontologies** | [QueryArrayType](docs/v2/Ontologies/models/QueryArrayType.md) | `from foundry_sdk.v2.ontologies.models import QueryArrayType` | +**Ontologies** | [QueryDataType](docs/v2/Ontologies/models/QueryDataType.md) | `from foundry_sdk.v2.ontologies.models import QueryDataType` | +**Ontologies** | [QueryParameterV2](docs/v2/Ontologies/models/QueryParameterV2.md) | `from foundry_sdk.v2.ontologies.models import QueryParameterV2` | +**Ontologies** | [QueryRuntimeErrorParameter](docs/v2/Ontologies/models/QueryRuntimeErrorParameter.md) | `from foundry_sdk.v2.ontologies.models import QueryRuntimeErrorParameter` | +**Ontologies** | [QuerySetType](docs/v2/Ontologies/models/QuerySetType.md) | `from foundry_sdk.v2.ontologies.models import QuerySetType` | +**Ontologies** | [QueryStructField](docs/v2/Ontologies/models/QueryStructField.md) | `from foundry_sdk.v2.ontologies.models import QueryStructField` | +**Ontologies** | [QueryStructType](docs/v2/Ontologies/models/QueryStructType.md) | `from foundry_sdk.v2.ontologies.models import QueryStructType` | +**Ontologies** | [QueryTypeV2](docs/v2/Ontologies/models/QueryTypeV2.md) | `from foundry_sdk.v2.ontologies.models import QueryTypeV2` | +**Ontologies** | [QueryUnionType](docs/v2/Ontologies/models/QueryUnionType.md) | `from foundry_sdk.v2.ontologies.models import QueryUnionType` | +**Ontologies** | [RangeConstraint](docs/v2/Ontologies/models/RangeConstraint.md) | `from foundry_sdk.v2.ontologies.models import RangeConstraint` | +**Ontologies** | [RelativeTime](docs/v2/Ontologies/models/RelativeTime.md) | `from foundry_sdk.v2.ontologies.models import RelativeTime` | +**Ontologies** | [RelativeTimeRange](docs/v2/Ontologies/models/RelativeTimeRange.md) | `from foundry_sdk.v2.ontologies.models import RelativeTimeRange` | +**Ontologies** | [RelativeTimeRelation](docs/v2/Ontologies/models/RelativeTimeRelation.md) | `from foundry_sdk.v2.ontologies.models import RelativeTimeRelation` | +**Ontologies** | [RelativeTimeSeriesTimeUnit](docs/v2/Ontologies/models/RelativeTimeSeriesTimeUnit.md) | `from foundry_sdk.v2.ontologies.models import RelativeTimeSeriesTimeUnit` | +**Ontologies** | [ReturnEditsMode](docs/v2/Ontologies/models/ReturnEditsMode.md) | `from foundry_sdk.v2.ontologies.models import ReturnEditsMode` | +**Ontologies** | [RollingAggregateWindowPoints](docs/v2/Ontologies/models/RollingAggregateWindowPoints.md) | `from foundry_sdk.v2.ontologies.models import RollingAggregateWindowPoints` | +**Ontologies** | [SdkPackageName](docs/v2/Ontologies/models/SdkPackageName.md) | `from foundry_sdk.v2.ontologies.models import SdkPackageName` | +**Ontologies** | [SearchJsonQueryV2](docs/v2/Ontologies/models/SearchJsonQueryV2.md) | `from foundry_sdk.v2.ontologies.models import SearchJsonQueryV2` | +**Ontologies** | [SearchObjectsResponseV2](docs/v2/Ontologies/models/SearchObjectsResponseV2.md) | `from foundry_sdk.v2.ontologies.models import SearchObjectsResponseV2` | +**Ontologies** | [SearchOrderByType](docs/v2/Ontologies/models/SearchOrderByType.md) | `from foundry_sdk.v2.ontologies.models import SearchOrderByType` | +**Ontologies** | [SearchOrderByV2](docs/v2/Ontologies/models/SearchOrderByV2.md) | `from foundry_sdk.v2.ontologies.models import SearchOrderByV2` | +**Ontologies** | [SearchOrderingV2](docs/v2/Ontologies/models/SearchOrderingV2.md) | `from foundry_sdk.v2.ontologies.models import SearchOrderingV2` | +**Ontologies** | [SelectedPropertyApiName](docs/v2/Ontologies/models/SelectedPropertyApiName.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyApiName` | +**Ontologies** | [SelectedPropertyApproximateDistinctAggregation](docs/v2/Ontologies/models/SelectedPropertyApproximateDistinctAggregation.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyApproximateDistinctAggregation` | +**Ontologies** | [SelectedPropertyApproximatePercentileAggregation](docs/v2/Ontologies/models/SelectedPropertyApproximatePercentileAggregation.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyApproximatePercentileAggregation` | +**Ontologies** | [SelectedPropertyAvgAggregation](docs/v2/Ontologies/models/SelectedPropertyAvgAggregation.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyAvgAggregation` | +**Ontologies** | [SelectedPropertyCollectListAggregation](docs/v2/Ontologies/models/SelectedPropertyCollectListAggregation.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyCollectListAggregation` | +**Ontologies** | [SelectedPropertyCollectSetAggregation](docs/v2/Ontologies/models/SelectedPropertyCollectSetAggregation.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyCollectSetAggregation` | +**Ontologies** | [SelectedPropertyCountAggregation](docs/v2/Ontologies/models/SelectedPropertyCountAggregation.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyCountAggregation` | +**Ontologies** | [SelectedPropertyExactDistinctAggregation](docs/v2/Ontologies/models/SelectedPropertyExactDistinctAggregation.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyExactDistinctAggregation` | +**Ontologies** | [SelectedPropertyExpression](docs/v2/Ontologies/models/SelectedPropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyExpression` | +**Ontologies** | [SelectedPropertyMaxAggregation](docs/v2/Ontologies/models/SelectedPropertyMaxAggregation.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyMaxAggregation` | +**Ontologies** | [SelectedPropertyMinAggregation](docs/v2/Ontologies/models/SelectedPropertyMinAggregation.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyMinAggregation` | +**Ontologies** | [SelectedPropertyOperation](docs/v2/Ontologies/models/SelectedPropertyOperation.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertyOperation` | +**Ontologies** | [SelectedPropertySumAggregation](docs/v2/Ontologies/models/SelectedPropertySumAggregation.md) | `from foundry_sdk.v2.ontologies.models import SelectedPropertySumAggregation` | +**Ontologies** | [SharedPropertyType](docs/v2/Ontologies/models/SharedPropertyType.md) | `from foundry_sdk.v2.ontologies.models import SharedPropertyType` | +**Ontologies** | [SharedPropertyTypeApiName](docs/v2/Ontologies/models/SharedPropertyTypeApiName.md) | `from foundry_sdk.v2.ontologies.models import SharedPropertyTypeApiName` | +**Ontologies** | [SharedPropertyTypeRid](docs/v2/Ontologies/models/SharedPropertyTypeRid.md) | `from foundry_sdk.v2.ontologies.models import SharedPropertyTypeRid` | +**Ontologies** | [StartsWithQuery](docs/v2/Ontologies/models/StartsWithQuery.md) | `from foundry_sdk.v2.ontologies.models import StartsWithQuery` | +**Ontologies** | [StreamingOutputFormat](docs/v2/Ontologies/models/StreamingOutputFormat.md) | `from foundry_sdk.v2.ontologies.models import StreamingOutputFormat` | +**Ontologies** | [StringLengthConstraint](docs/v2/Ontologies/models/StringLengthConstraint.md) | `from foundry_sdk.v2.ontologies.models import StringLengthConstraint` | +**Ontologies** | [StringRegexMatchConstraint](docs/v2/Ontologies/models/StringRegexMatchConstraint.md) | `from foundry_sdk.v2.ontologies.models import StringRegexMatchConstraint` | +**Ontologies** | [StructFieldApiName](docs/v2/Ontologies/models/StructFieldApiName.md) | `from foundry_sdk.v2.ontologies.models import StructFieldApiName` | +**Ontologies** | [StructFieldSelector](docs/v2/Ontologies/models/StructFieldSelector.md) | `from foundry_sdk.v2.ontologies.models import StructFieldSelector` | +**Ontologies** | [StructFieldType](docs/v2/Ontologies/models/StructFieldType.md) | `from foundry_sdk.v2.ontologies.models import StructFieldType` | +**Ontologies** | [StructType](docs/v2/Ontologies/models/StructType.md) | `from foundry_sdk.v2.ontologies.models import StructType` | +**Ontologies** | [SubmissionCriteriaEvaluation](docs/v2/Ontologies/models/SubmissionCriteriaEvaluation.md) | `from foundry_sdk.v2.ontologies.models import SubmissionCriteriaEvaluation` | +**Ontologies** | [SubtractPropertyExpression](docs/v2/Ontologies/models/SubtractPropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import SubtractPropertyExpression` | +**Ontologies** | [SumAggregationV2](docs/v2/Ontologies/models/SumAggregationV2.md) | `from foundry_sdk.v2.ontologies.models import SumAggregationV2` | +**Ontologies** | [SyncApplyActionResponseV2](docs/v2/Ontologies/models/SyncApplyActionResponseV2.md) | `from foundry_sdk.v2.ontologies.models import SyncApplyActionResponseV2` | +**Ontologies** | [ThreeDimensionalAggregation](docs/v2/Ontologies/models/ThreeDimensionalAggregation.md) | `from foundry_sdk.v2.ontologies.models import ThreeDimensionalAggregation` | +**Ontologies** | [TimeRange](docs/v2/Ontologies/models/TimeRange.md) | `from foundry_sdk.v2.ontologies.models import TimeRange` | +**Ontologies** | [TimeSeriesAggregationMethod](docs/v2/Ontologies/models/TimeSeriesAggregationMethod.md) | `from foundry_sdk.v2.ontologies.models import TimeSeriesAggregationMethod` | +**Ontologies** | [TimeSeriesAggregationStrategy](docs/v2/Ontologies/models/TimeSeriesAggregationStrategy.md) | `from foundry_sdk.v2.ontologies.models import TimeSeriesAggregationStrategy` | +**Ontologies** | [TimeSeriesCumulativeAggregate](docs/v2/Ontologies/models/TimeSeriesCumulativeAggregate.md) | `from foundry_sdk.v2.ontologies.models import TimeSeriesCumulativeAggregate` | +**Ontologies** | [TimeseriesEntry](docs/v2/Ontologies/models/TimeseriesEntry.md) | `from foundry_sdk.v2.ontologies.models import TimeseriesEntry` | +**Ontologies** | [TimeSeriesPeriodicAggregate](docs/v2/Ontologies/models/TimeSeriesPeriodicAggregate.md) | `from foundry_sdk.v2.ontologies.models import TimeSeriesPeriodicAggregate` | +**Ontologies** | [TimeSeriesPoint](docs/v2/Ontologies/models/TimeSeriesPoint.md) | `from foundry_sdk.v2.ontologies.models import TimeSeriesPoint` | +**Ontologies** | [TimeSeriesRollingAggregate](docs/v2/Ontologies/models/TimeSeriesRollingAggregate.md) | `from foundry_sdk.v2.ontologies.models import TimeSeriesRollingAggregate` | +**Ontologies** | [TimeSeriesRollingAggregateWindow](docs/v2/Ontologies/models/TimeSeriesRollingAggregateWindow.md) | `from foundry_sdk.v2.ontologies.models import TimeSeriesRollingAggregateWindow` | +**Ontologies** | [TimeSeriesWindowType](docs/v2/Ontologies/models/TimeSeriesWindowType.md) | `from foundry_sdk.v2.ontologies.models import TimeSeriesWindowType` | +**Ontologies** | [TimeUnit](docs/v2/Ontologies/models/TimeUnit.md) | `from foundry_sdk.v2.ontologies.models import TimeUnit` | +**Ontologies** | [TwoDimensionalAggregation](docs/v2/Ontologies/models/TwoDimensionalAggregation.md) | `from foundry_sdk.v2.ontologies.models import TwoDimensionalAggregation` | +**Ontologies** | [UnevaluableConstraint](docs/v2/Ontologies/models/UnevaluableConstraint.md) | `from foundry_sdk.v2.ontologies.models import UnevaluableConstraint` | +**Ontologies** | [ValidateActionResponseV2](docs/v2/Ontologies/models/ValidateActionResponseV2.md) | `from foundry_sdk.v2.ontologies.models import ValidateActionResponseV2` | +**Ontologies** | [ValidationResult](docs/v2/Ontologies/models/ValidationResult.md) | `from foundry_sdk.v2.ontologies.models import ValidationResult` | +**Ontologies** | [ValueType](docs/v2/Ontologies/models/ValueType.md) | `from foundry_sdk.v2.ontologies.models import ValueType` | +**Ontologies** | [WithinBoundingBoxPoint](docs/v2/Ontologies/models/WithinBoundingBoxPoint.md) | `from foundry_sdk.v2.ontologies.models import WithinBoundingBoxPoint` | +**Ontologies** | [WithinBoundingBoxQuery](docs/v2/Ontologies/models/WithinBoundingBoxQuery.md) | `from foundry_sdk.v2.ontologies.models import WithinBoundingBoxQuery` | +**Ontologies** | [WithinDistanceOfQuery](docs/v2/Ontologies/models/WithinDistanceOfQuery.md) | `from foundry_sdk.v2.ontologies.models import WithinDistanceOfQuery` | +**Ontologies** | [WithinPolygonQuery](docs/v2/Ontologies/models/WithinPolygonQuery.md) | `from foundry_sdk.v2.ontologies.models import WithinPolygonQuery` | +**Orchestration** | [AbortOnFailure](docs/v2/Orchestration/models/AbortOnFailure.md) | `from foundry_sdk.v2.orchestration.models import AbortOnFailure` | +**Orchestration** | [Action](docs/v2/Orchestration/models/Action.md) | `from foundry_sdk.v2.orchestration.models import Action` | +**Orchestration** | [AndTrigger](docs/v2/Orchestration/models/AndTrigger.md) | `from foundry_sdk.v2.orchestration.models import AndTrigger` | +**Orchestration** | [Build](docs/v2/Orchestration/models/Build.md) | `from foundry_sdk.v2.orchestration.models import Build` | +**Orchestration** | [BuildableRid](docs/v2/Orchestration/models/BuildableRid.md) | `from foundry_sdk.v2.orchestration.models import BuildableRid` | +**Orchestration** | [BuildStatus](docs/v2/Orchestration/models/BuildStatus.md) | `from foundry_sdk.v2.orchestration.models import BuildStatus` | +**Orchestration** | [BuildTarget](docs/v2/Orchestration/models/BuildTarget.md) | `from foundry_sdk.v2.orchestration.models import BuildTarget` | +**Orchestration** | [ConnectingTarget](docs/v2/Orchestration/models/ConnectingTarget.md) | `from foundry_sdk.v2.orchestration.models import ConnectingTarget` | +**Orchestration** | [CreateScheduleRequestAction](docs/v2/Orchestration/models/CreateScheduleRequestAction.md) | `from foundry_sdk.v2.orchestration.models import CreateScheduleRequestAction` | +**Orchestration** | [CreateScheduleRequestBuildTarget](docs/v2/Orchestration/models/CreateScheduleRequestBuildTarget.md) | `from foundry_sdk.v2.orchestration.models import CreateScheduleRequestBuildTarget` | +**Orchestration** | [CreateScheduleRequestConnectingTarget](docs/v2/Orchestration/models/CreateScheduleRequestConnectingTarget.md) | `from foundry_sdk.v2.orchestration.models import CreateScheduleRequestConnectingTarget` | +**Orchestration** | [CreateScheduleRequestManualTarget](docs/v2/Orchestration/models/CreateScheduleRequestManualTarget.md) | `from foundry_sdk.v2.orchestration.models import CreateScheduleRequestManualTarget` | +**Orchestration** | [CreateScheduleRequestProjectScope](docs/v2/Orchestration/models/CreateScheduleRequestProjectScope.md) | `from foundry_sdk.v2.orchestration.models import CreateScheduleRequestProjectScope` | +**Orchestration** | [CreateScheduleRequestScopeMode](docs/v2/Orchestration/models/CreateScheduleRequestScopeMode.md) | `from foundry_sdk.v2.orchestration.models import CreateScheduleRequestScopeMode` | +**Orchestration** | [CreateScheduleRequestUpstreamTarget](docs/v2/Orchestration/models/CreateScheduleRequestUpstreamTarget.md) | `from foundry_sdk.v2.orchestration.models import CreateScheduleRequestUpstreamTarget` | +**Orchestration** | [CreateScheduleRequestUserScope](docs/v2/Orchestration/models/CreateScheduleRequestUserScope.md) | `from foundry_sdk.v2.orchestration.models import CreateScheduleRequestUserScope` | +**Orchestration** | [CronExpression](docs/v2/Orchestration/models/CronExpression.md) | `from foundry_sdk.v2.orchestration.models import CronExpression` | +**Orchestration** | [DatasetJobOutput](docs/v2/Orchestration/models/DatasetJobOutput.md) | `from foundry_sdk.v2.orchestration.models import DatasetJobOutput` | +**Orchestration** | [DatasetUpdatedTrigger](docs/v2/Orchestration/models/DatasetUpdatedTrigger.md) | `from foundry_sdk.v2.orchestration.models import DatasetUpdatedTrigger` | +**Orchestration** | [FallbackBranches](docs/v2/Orchestration/models/FallbackBranches.md) | `from foundry_sdk.v2.orchestration.models import FallbackBranches` | +**Orchestration** | [ForceBuild](docs/v2/Orchestration/models/ForceBuild.md) | `from foundry_sdk.v2.orchestration.models import ForceBuild` | +**Orchestration** | [GetBuildsBatchRequestElement](docs/v2/Orchestration/models/GetBuildsBatchRequestElement.md) | `from foundry_sdk.v2.orchestration.models import GetBuildsBatchRequestElement` | +**Orchestration** | [GetBuildsBatchResponse](docs/v2/Orchestration/models/GetBuildsBatchResponse.md) | `from foundry_sdk.v2.orchestration.models import GetBuildsBatchResponse` | +**Orchestration** | [GetJobsBatchRequestElement](docs/v2/Orchestration/models/GetJobsBatchRequestElement.md) | `from foundry_sdk.v2.orchestration.models import GetJobsBatchRequestElement` | +**Orchestration** | [GetJobsBatchResponse](docs/v2/Orchestration/models/GetJobsBatchResponse.md) | `from foundry_sdk.v2.orchestration.models import GetJobsBatchResponse` | +**Orchestration** | [Job](docs/v2/Orchestration/models/Job.md) | `from foundry_sdk.v2.orchestration.models import Job` | +**Orchestration** | [JobOutput](docs/v2/Orchestration/models/JobOutput.md) | `from foundry_sdk.v2.orchestration.models import JobOutput` | +**Orchestration** | [JobStartedTime](docs/v2/Orchestration/models/JobStartedTime.md) | `from foundry_sdk.v2.orchestration.models import JobStartedTime` | +**Orchestration** | [JobStatus](docs/v2/Orchestration/models/JobStatus.md) | `from foundry_sdk.v2.orchestration.models import JobStatus` | +**Orchestration** | [JobSucceededTrigger](docs/v2/Orchestration/models/JobSucceededTrigger.md) | `from foundry_sdk.v2.orchestration.models import JobSucceededTrigger` | +**Orchestration** | [ListJobsOfBuildResponse](docs/v2/Orchestration/models/ListJobsOfBuildResponse.md) | `from foundry_sdk.v2.orchestration.models import ListJobsOfBuildResponse` | +**Orchestration** | [ListRunsOfScheduleResponse](docs/v2/Orchestration/models/ListRunsOfScheduleResponse.md) | `from foundry_sdk.v2.orchestration.models import ListRunsOfScheduleResponse` | +**Orchestration** | [ManualTarget](docs/v2/Orchestration/models/ManualTarget.md) | `from foundry_sdk.v2.orchestration.models import ManualTarget` | +**Orchestration** | [MediaSetUpdatedTrigger](docs/v2/Orchestration/models/MediaSetUpdatedTrigger.md) | `from foundry_sdk.v2.orchestration.models import MediaSetUpdatedTrigger` | +**Orchestration** | [NewLogicTrigger](docs/v2/Orchestration/models/NewLogicTrigger.md) | `from foundry_sdk.v2.orchestration.models import NewLogicTrigger` | +**Orchestration** | [NotificationsEnabled](docs/v2/Orchestration/models/NotificationsEnabled.md) | `from foundry_sdk.v2.orchestration.models import NotificationsEnabled` | +**Orchestration** | [OrTrigger](docs/v2/Orchestration/models/OrTrigger.md) | `from foundry_sdk.v2.orchestration.models import OrTrigger` | +**Orchestration** | [ProjectScope](docs/v2/Orchestration/models/ProjectScope.md) | `from foundry_sdk.v2.orchestration.models import ProjectScope` | +**Orchestration** | [ReplaceScheduleRequestAction](docs/v2/Orchestration/models/ReplaceScheduleRequestAction.md) | `from foundry_sdk.v2.orchestration.models import ReplaceScheduleRequestAction` | +**Orchestration** | [ReplaceScheduleRequestBuildTarget](docs/v2/Orchestration/models/ReplaceScheduleRequestBuildTarget.md) | `from foundry_sdk.v2.orchestration.models import ReplaceScheduleRequestBuildTarget` | +**Orchestration** | [ReplaceScheduleRequestConnectingTarget](docs/v2/Orchestration/models/ReplaceScheduleRequestConnectingTarget.md) | `from foundry_sdk.v2.orchestration.models import ReplaceScheduleRequestConnectingTarget` | +**Orchestration** | [ReplaceScheduleRequestManualTarget](docs/v2/Orchestration/models/ReplaceScheduleRequestManualTarget.md) | `from foundry_sdk.v2.orchestration.models import ReplaceScheduleRequestManualTarget` | +**Orchestration** | [ReplaceScheduleRequestProjectScope](docs/v2/Orchestration/models/ReplaceScheduleRequestProjectScope.md) | `from foundry_sdk.v2.orchestration.models import ReplaceScheduleRequestProjectScope` | +**Orchestration** | [ReplaceScheduleRequestScopeMode](docs/v2/Orchestration/models/ReplaceScheduleRequestScopeMode.md) | `from foundry_sdk.v2.orchestration.models import ReplaceScheduleRequestScopeMode` | +**Orchestration** | [ReplaceScheduleRequestUpstreamTarget](docs/v2/Orchestration/models/ReplaceScheduleRequestUpstreamTarget.md) | `from foundry_sdk.v2.orchestration.models import ReplaceScheduleRequestUpstreamTarget` | +**Orchestration** | [ReplaceScheduleRequestUserScope](docs/v2/Orchestration/models/ReplaceScheduleRequestUserScope.md) | `from foundry_sdk.v2.orchestration.models import ReplaceScheduleRequestUserScope` | +**Orchestration** | [RetryBackoffDuration](docs/v2/Orchestration/models/RetryBackoffDuration.md) | `from foundry_sdk.v2.orchestration.models import RetryBackoffDuration` | +**Orchestration** | [RetryCount](docs/v2/Orchestration/models/RetryCount.md) | `from foundry_sdk.v2.orchestration.models import RetryCount` | +**Orchestration** | [Schedule](docs/v2/Orchestration/models/Schedule.md) | `from foundry_sdk.v2.orchestration.models import Schedule` | +**Orchestration** | [SchedulePaused](docs/v2/Orchestration/models/SchedulePaused.md) | `from foundry_sdk.v2.orchestration.models import SchedulePaused` | +**Orchestration** | [ScheduleRid](docs/v2/Orchestration/models/ScheduleRid.md) | `from foundry_sdk.v2.orchestration.models import ScheduleRid` | +**Orchestration** | [ScheduleRun](docs/v2/Orchestration/models/ScheduleRun.md) | `from foundry_sdk.v2.orchestration.models import ScheduleRun` | +**Orchestration** | [ScheduleRunError](docs/v2/Orchestration/models/ScheduleRunError.md) | `from foundry_sdk.v2.orchestration.models import ScheduleRunError` | +**Orchestration** | [ScheduleRunErrorName](docs/v2/Orchestration/models/ScheduleRunErrorName.md) | `from foundry_sdk.v2.orchestration.models import ScheduleRunErrorName` | +**Orchestration** | [ScheduleRunIgnored](docs/v2/Orchestration/models/ScheduleRunIgnored.md) | `from foundry_sdk.v2.orchestration.models import ScheduleRunIgnored` | +**Orchestration** | [ScheduleRunResult](docs/v2/Orchestration/models/ScheduleRunResult.md) | `from foundry_sdk.v2.orchestration.models import ScheduleRunResult` | +**Orchestration** | [ScheduleRunRid](docs/v2/Orchestration/models/ScheduleRunRid.md) | `from foundry_sdk.v2.orchestration.models import ScheduleRunRid` | +**Orchestration** | [ScheduleRunSubmitted](docs/v2/Orchestration/models/ScheduleRunSubmitted.md) | `from foundry_sdk.v2.orchestration.models import ScheduleRunSubmitted` | +**Orchestration** | [ScheduleSucceededTrigger](docs/v2/Orchestration/models/ScheduleSucceededTrigger.md) | `from foundry_sdk.v2.orchestration.models import ScheduleSucceededTrigger` | +**Orchestration** | [ScheduleVersion](docs/v2/Orchestration/models/ScheduleVersion.md) | `from foundry_sdk.v2.orchestration.models import ScheduleVersion` | +**Orchestration** | [ScheduleVersionRid](docs/v2/Orchestration/models/ScheduleVersionRid.md) | `from foundry_sdk.v2.orchestration.models import ScheduleVersionRid` | +**Orchestration** | [ScopeMode](docs/v2/Orchestration/models/ScopeMode.md) | `from foundry_sdk.v2.orchestration.models import ScopeMode` | +**Orchestration** | [SearchBuildsAndFilter](docs/v2/Orchestration/models/SearchBuildsAndFilter.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsAndFilter` | +**Orchestration** | [SearchBuildsEqualsFilter](docs/v2/Orchestration/models/SearchBuildsEqualsFilter.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsEqualsFilter` | +**Orchestration** | [SearchBuildsEqualsFilterField](docs/v2/Orchestration/models/SearchBuildsEqualsFilterField.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsEqualsFilterField` | +**Orchestration** | [SearchBuildsFilter](docs/v2/Orchestration/models/SearchBuildsFilter.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsFilter` | +**Orchestration** | [SearchBuildsGteFilter](docs/v2/Orchestration/models/SearchBuildsGteFilter.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsGteFilter` | +**Orchestration** | [SearchBuildsGteFilterField](docs/v2/Orchestration/models/SearchBuildsGteFilterField.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsGteFilterField` | +**Orchestration** | [SearchBuildsLtFilter](docs/v2/Orchestration/models/SearchBuildsLtFilter.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsLtFilter` | +**Orchestration** | [SearchBuildsLtFilterField](docs/v2/Orchestration/models/SearchBuildsLtFilterField.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsLtFilterField` | +**Orchestration** | [SearchBuildsNotFilter](docs/v2/Orchestration/models/SearchBuildsNotFilter.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsNotFilter` | +**Orchestration** | [SearchBuildsOrderBy](docs/v2/Orchestration/models/SearchBuildsOrderBy.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsOrderBy` | +**Orchestration** | [SearchBuildsOrderByField](docs/v2/Orchestration/models/SearchBuildsOrderByField.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsOrderByField` | +**Orchestration** | [SearchBuildsOrderByItem](docs/v2/Orchestration/models/SearchBuildsOrderByItem.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsOrderByItem` | +**Orchestration** | [SearchBuildsOrFilter](docs/v2/Orchestration/models/SearchBuildsOrFilter.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsOrFilter` | +**Orchestration** | [SearchBuildsResponse](docs/v2/Orchestration/models/SearchBuildsResponse.md) | `from foundry_sdk.v2.orchestration.models import SearchBuildsResponse` | +**Orchestration** | [TimeTrigger](docs/v2/Orchestration/models/TimeTrigger.md) | `from foundry_sdk.v2.orchestration.models import TimeTrigger` | +**Orchestration** | [TransactionalMediaSetJobOutput](docs/v2/Orchestration/models/TransactionalMediaSetJobOutput.md) | `from foundry_sdk.v2.orchestration.models import TransactionalMediaSetJobOutput` | +**Orchestration** | [Trigger](docs/v2/Orchestration/models/Trigger.md) | `from foundry_sdk.v2.orchestration.models import Trigger` | +**Orchestration** | [UpstreamTarget](docs/v2/Orchestration/models/UpstreamTarget.md) | `from foundry_sdk.v2.orchestration.models import UpstreamTarget` | +**Orchestration** | [UserScope](docs/v2/Orchestration/models/UserScope.md) | `from foundry_sdk.v2.orchestration.models import UserScope` | +**SqlQueries** | [CanceledQueryStatus](docs/v2/SqlQueries/models/CanceledQueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import CanceledQueryStatus` | +**SqlQueries** | [FailedQueryStatus](docs/v2/SqlQueries/models/FailedQueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import FailedQueryStatus` | +**SqlQueries** | [QueryId](docs/v2/SqlQueries/models/QueryId.md) | `from foundry_sdk.v2.sql_queries.models import QueryId` | +**SqlQueries** | [QueryStatus](docs/v2/SqlQueries/models/QueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import QueryStatus` | +**SqlQueries** | [RunningQueryStatus](docs/v2/SqlQueries/models/RunningQueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import RunningQueryStatus` | +**SqlQueries** | [SucceededQueryStatus](docs/v2/SqlQueries/models/SucceededQueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import SucceededQueryStatus` | +**Streams** | [Compressed](docs/v2/Streams/models/Compressed.md) | `from foundry_sdk.v2.streams.models import Compressed` | +**Streams** | [CreateStreamRequestStreamSchema](docs/v2/Streams/models/CreateStreamRequestStreamSchema.md) | `from foundry_sdk.v2.streams.models import CreateStreamRequestStreamSchema` | +**Streams** | [Dataset](docs/v2/Streams/models/Dataset.md) | `from foundry_sdk.v2.streams.models import Dataset` | +**Streams** | [PartitionsCount](docs/v2/Streams/models/PartitionsCount.md) | `from foundry_sdk.v2.streams.models import PartitionsCount` | +**Streams** | [Record](docs/v2/Streams/models/Record.md) | `from foundry_sdk.v2.streams.models import Record` | +**Streams** | [Stream](docs/v2/Streams/models/Stream.md) | `from foundry_sdk.v2.streams.models import Stream` | +**Streams** | [StreamType](docs/v2/Streams/models/StreamType.md) | `from foundry_sdk.v2.streams.models import StreamType` | +**Streams** | [ViewRid](docs/v2/Streams/models/ViewRid.md) | `from foundry_sdk.v2.streams.models import ViewRid` | +**ThirdPartyApplications** | [ListVersionsResponse](docs/v2/ThirdPartyApplications/models/ListVersionsResponse.md) | `from foundry_sdk.v2.third_party_applications.models import ListVersionsResponse` | +**ThirdPartyApplications** | [Subdomain](docs/v2/ThirdPartyApplications/models/Subdomain.md) | `from foundry_sdk.v2.third_party_applications.models import Subdomain` | +**ThirdPartyApplications** | [ThirdPartyApplication](docs/v2/ThirdPartyApplications/models/ThirdPartyApplication.md) | `from foundry_sdk.v2.third_party_applications.models import ThirdPartyApplication` | +**ThirdPartyApplications** | [ThirdPartyApplicationRid](docs/v2/ThirdPartyApplications/models/ThirdPartyApplicationRid.md) | `from foundry_sdk.v2.third_party_applications.models import ThirdPartyApplicationRid` | +**ThirdPartyApplications** | [Version](docs/v2/ThirdPartyApplications/models/Version.md) | `from foundry_sdk.v2.third_party_applications.models import Version` | +**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` | ## Documentation for V1 models Namespace | Name | Import | --------- | ---- | ------ | -**Core** | [AnyType](docs/v1/Core/models/AnyType.md) | `from foundry.v1.core.models import AnyType` | -**Core** | [AttachmentType](docs/v1/Core/models/AttachmentType.md) | `from foundry.v1.core.models import AttachmentType` | -**Core** | [BinaryType](docs/v1/Core/models/BinaryType.md) | `from foundry.v1.core.models import BinaryType` | -**Core** | [BooleanType](docs/v1/Core/models/BooleanType.md) | `from foundry.v1.core.models import BooleanType` | -**Core** | [ByteType](docs/v1/Core/models/ByteType.md) | `from foundry.v1.core.models import ByteType` | -**Core** | [CipherTextType](docs/v1/Core/models/CipherTextType.md) | `from foundry.v1.core.models import CipherTextType` | -**Core** | [ContentLength](docs/v1/Core/models/ContentLength.md) | `from foundry.v1.core.models import ContentLength` | -**Core** | [ContentType](docs/v1/Core/models/ContentType.md) | `from foundry.v1.core.models import ContentType` | -**Core** | [DateType](docs/v1/Core/models/DateType.md) | `from foundry.v1.core.models import DateType` | -**Core** | [DecimalType](docs/v1/Core/models/DecimalType.md) | `from foundry.v1.core.models import DecimalType` | -**Core** | [DisplayName](docs/v1/Core/models/DisplayName.md) | `from foundry.v1.core.models import DisplayName` | -**Core** | [DistanceUnit](docs/v1/Core/models/DistanceUnit.md) | `from foundry.v1.core.models import DistanceUnit` | -**Core** | [DoubleType](docs/v1/Core/models/DoubleType.md) | `from foundry.v1.core.models import DoubleType` | -**Core** | [Filename](docs/v1/Core/models/Filename.md) | `from foundry.v1.core.models import Filename` | -**Core** | [FilePath](docs/v1/Core/models/FilePath.md) | `from foundry.v1.core.models import FilePath` | -**Core** | [FloatType](docs/v1/Core/models/FloatType.md) | `from foundry.v1.core.models import FloatType` | -**Core** | [FolderRid](docs/v1/Core/models/FolderRid.md) | `from foundry.v1.core.models import FolderRid` | -**Core** | [IntegerType](docs/v1/Core/models/IntegerType.md) | `from foundry.v1.core.models import IntegerType` | -**Core** | [LongType](docs/v1/Core/models/LongType.md) | `from foundry.v1.core.models import LongType` | -**Core** | [MarkingType](docs/v1/Core/models/MarkingType.md) | `from foundry.v1.core.models import MarkingType` | -**Core** | [MediaType](docs/v1/Core/models/MediaType.md) | `from foundry.v1.core.models import MediaType` | -**Core** | [NullType](docs/v1/Core/models/NullType.md) | `from foundry.v1.core.models import NullType` | -**Core** | [OperationScope](docs/v1/Core/models/OperationScope.md) | `from foundry.v1.core.models import OperationScope` | -**Core** | [PageSize](docs/v1/Core/models/PageSize.md) | `from foundry.v1.core.models import PageSize` | -**Core** | [PageToken](docs/v1/Core/models/PageToken.md) | `from foundry.v1.core.models import PageToken` | -**Core** | [PreviewMode](docs/v1/Core/models/PreviewMode.md) | `from foundry.v1.core.models import PreviewMode` | -**Core** | [ReleaseStatus](docs/v1/Core/models/ReleaseStatus.md) | `from foundry.v1.core.models import ReleaseStatus` | -**Core** | [ShortType](docs/v1/Core/models/ShortType.md) | `from foundry.v1.core.models import ShortType` | -**Core** | [SizeBytes](docs/v1/Core/models/SizeBytes.md) | `from foundry.v1.core.models import SizeBytes` | -**Core** | [StringType](docs/v1/Core/models/StringType.md) | `from foundry.v1.core.models import StringType` | -**Core** | [StructFieldName](docs/v1/Core/models/StructFieldName.md) | `from foundry.v1.core.models import StructFieldName` | -**Core** | [TimestampType](docs/v1/Core/models/TimestampType.md) | `from foundry.v1.core.models import TimestampType` | -**Core** | [TotalCount](docs/v1/Core/models/TotalCount.md) | `from foundry.v1.core.models import TotalCount` | -**Core** | [UnsupportedType](docs/v1/Core/models/UnsupportedType.md) | `from foundry.v1.core.models import UnsupportedType` | -**Datasets** | [Branch](docs/v1/Datasets/models/Branch.md) | `from foundry.v1.datasets.models import Branch` | -**Datasets** | [BranchId](docs/v1/Datasets/models/BranchId.md) | `from foundry.v1.datasets.models import BranchId` | -**Datasets** | [Dataset](docs/v1/Datasets/models/Dataset.md) | `from foundry.v1.datasets.models import Dataset` | -**Datasets** | [DatasetName](docs/v1/Datasets/models/DatasetName.md) | `from foundry.v1.datasets.models import DatasetName` | -**Datasets** | [DatasetRid](docs/v1/Datasets/models/DatasetRid.md) | `from foundry.v1.datasets.models import DatasetRid` | -**Datasets** | [File](docs/v1/Datasets/models/File.md) | `from foundry.v1.datasets.models import File` | -**Datasets** | [ListBranchesResponse](docs/v1/Datasets/models/ListBranchesResponse.md) | `from foundry.v1.datasets.models import ListBranchesResponse` | -**Datasets** | [ListFilesResponse](docs/v1/Datasets/models/ListFilesResponse.md) | `from foundry.v1.datasets.models import ListFilesResponse` | -**Datasets** | [TableExportFormat](docs/v1/Datasets/models/TableExportFormat.md) | `from foundry.v1.datasets.models import TableExportFormat` | -**Datasets** | [Transaction](docs/v1/Datasets/models/Transaction.md) | `from foundry.v1.datasets.models import Transaction` | -**Datasets** | [TransactionRid](docs/v1/Datasets/models/TransactionRid.md) | `from foundry.v1.datasets.models import TransactionRid` | -**Datasets** | [TransactionStatus](docs/v1/Datasets/models/TransactionStatus.md) | `from foundry.v1.datasets.models import TransactionStatus` | -**Datasets** | [TransactionType](docs/v1/Datasets/models/TransactionType.md) | `from foundry.v1.datasets.models import TransactionType` | -**Ontologies** | [ActionRid](docs/v1/Ontologies/models/ActionRid.md) | `from foundry.v1.ontologies.models import ActionRid` | -**Ontologies** | [ActionType](docs/v1/Ontologies/models/ActionType.md) | `from foundry.v1.ontologies.models import ActionType` | -**Ontologies** | [ActionTypeApiName](docs/v1/Ontologies/models/ActionTypeApiName.md) | `from foundry.v1.ontologies.models import ActionTypeApiName` | -**Ontologies** | [ActionTypeRid](docs/v1/Ontologies/models/ActionTypeRid.md) | `from foundry.v1.ontologies.models import ActionTypeRid` | -**Ontologies** | [AggregateObjectsResponse](docs/v1/Ontologies/models/AggregateObjectsResponse.md) | `from foundry.v1.ontologies.models import AggregateObjectsResponse` | -**Ontologies** | [AggregateObjectsResponseItem](docs/v1/Ontologies/models/AggregateObjectsResponseItem.md) | `from foundry.v1.ontologies.models import AggregateObjectsResponseItem` | -**Ontologies** | [Aggregation](docs/v1/Ontologies/models/Aggregation.md) | `from foundry.v1.ontologies.models import Aggregation` | -**Ontologies** | [AggregationDurationGrouping](docs/v1/Ontologies/models/AggregationDurationGrouping.md) | `from foundry.v1.ontologies.models import AggregationDurationGrouping` | -**Ontologies** | [AggregationExactGrouping](docs/v1/Ontologies/models/AggregationExactGrouping.md) | `from foundry.v1.ontologies.models import AggregationExactGrouping` | -**Ontologies** | [AggregationFixedWidthGrouping](docs/v1/Ontologies/models/AggregationFixedWidthGrouping.md) | `from foundry.v1.ontologies.models import AggregationFixedWidthGrouping` | -**Ontologies** | [AggregationGroupBy](docs/v1/Ontologies/models/AggregationGroupBy.md) | `from foundry.v1.ontologies.models import AggregationGroupBy` | -**Ontologies** | [AggregationGroupKey](docs/v1/Ontologies/models/AggregationGroupKey.md) | `from foundry.v1.ontologies.models import AggregationGroupKey` | -**Ontologies** | [AggregationGroupValue](docs/v1/Ontologies/models/AggregationGroupValue.md) | `from foundry.v1.ontologies.models import AggregationGroupValue` | -**Ontologies** | [AggregationMetricName](docs/v1/Ontologies/models/AggregationMetricName.md) | `from foundry.v1.ontologies.models import AggregationMetricName` | -**Ontologies** | [AggregationMetricResult](docs/v1/Ontologies/models/AggregationMetricResult.md) | `from foundry.v1.ontologies.models import AggregationMetricResult` | -**Ontologies** | [AggregationRange](docs/v1/Ontologies/models/AggregationRange.md) | `from foundry.v1.ontologies.models import AggregationRange` | -**Ontologies** | [AggregationRangesGrouping](docs/v1/Ontologies/models/AggregationRangesGrouping.md) | `from foundry.v1.ontologies.models import AggregationRangesGrouping` | -**Ontologies** | [AllTermsQuery](docs/v1/Ontologies/models/AllTermsQuery.md) | `from foundry.v1.ontologies.models import AllTermsQuery` | -**Ontologies** | [AndQuery](docs/v1/Ontologies/models/AndQuery.md) | `from foundry.v1.ontologies.models import AndQuery` | -**Ontologies** | [AnyTermQuery](docs/v1/Ontologies/models/AnyTermQuery.md) | `from foundry.v1.ontologies.models import AnyTermQuery` | -**Ontologies** | [ApplyActionMode](docs/v1/Ontologies/models/ApplyActionMode.md) | `from foundry.v1.ontologies.models import ApplyActionMode` | -**Ontologies** | [ApplyActionRequest](docs/v1/Ontologies/models/ApplyActionRequest.md) | `from foundry.v1.ontologies.models import ApplyActionRequest` | -**Ontologies** | [ApplyActionRequestOptions](docs/v1/Ontologies/models/ApplyActionRequestOptions.md) | `from foundry.v1.ontologies.models import ApplyActionRequestOptions` | -**Ontologies** | [ApplyActionResponse](docs/v1/Ontologies/models/ApplyActionResponse.md) | `from foundry.v1.ontologies.models import ApplyActionResponse` | -**Ontologies** | [ApproximateDistinctAggregation](docs/v1/Ontologies/models/ApproximateDistinctAggregation.md) | `from foundry.v1.ontologies.models import ApproximateDistinctAggregation` | -**Ontologies** | [ArraySizeConstraint](docs/v1/Ontologies/models/ArraySizeConstraint.md) | `from foundry.v1.ontologies.models import ArraySizeConstraint` | -**Ontologies** | [ArtifactRepositoryRid](docs/v1/Ontologies/models/ArtifactRepositoryRid.md) | `from foundry.v1.ontologies.models import ArtifactRepositoryRid` | -**Ontologies** | [Attachment](docs/v1/Ontologies/models/Attachment.md) | `from foundry.v1.ontologies.models import Attachment` | -**Ontologies** | [AttachmentRid](docs/v1/Ontologies/models/AttachmentRid.md) | `from foundry.v1.ontologies.models import AttachmentRid` | -**Ontologies** | [AvgAggregation](docs/v1/Ontologies/models/AvgAggregation.md) | `from foundry.v1.ontologies.models import AvgAggregation` | -**Ontologies** | [BatchApplyActionResponse](docs/v1/Ontologies/models/BatchApplyActionResponse.md) | `from foundry.v1.ontologies.models import BatchApplyActionResponse` | -**Ontologies** | [ContainsQuery](docs/v1/Ontologies/models/ContainsQuery.md) | `from foundry.v1.ontologies.models import ContainsQuery` | -**Ontologies** | [CountAggregation](docs/v1/Ontologies/models/CountAggregation.md) | `from foundry.v1.ontologies.models import CountAggregation` | -**Ontologies** | [CreateInterfaceObjectRule](docs/v1/Ontologies/models/CreateInterfaceObjectRule.md) | `from foundry.v1.ontologies.models import CreateInterfaceObjectRule` | -**Ontologies** | [CreateLinkRule](docs/v1/Ontologies/models/CreateLinkRule.md) | `from foundry.v1.ontologies.models import CreateLinkRule` | -**Ontologies** | [CreateObjectRule](docs/v1/Ontologies/models/CreateObjectRule.md) | `from foundry.v1.ontologies.models import CreateObjectRule` | -**Ontologies** | [DataValue](docs/v1/Ontologies/models/DataValue.md) | `from foundry.v1.ontologies.models import DataValue` | -**Ontologies** | [DeleteInterfaceObjectRule](docs/v1/Ontologies/models/DeleteInterfaceObjectRule.md) | `from foundry.v1.ontologies.models import DeleteInterfaceObjectRule` | -**Ontologies** | [DeleteLinkRule](docs/v1/Ontologies/models/DeleteLinkRule.md) | `from foundry.v1.ontologies.models import DeleteLinkRule` | -**Ontologies** | [DeleteObjectRule](docs/v1/Ontologies/models/DeleteObjectRule.md) | `from foundry.v1.ontologies.models import DeleteObjectRule` | -**Ontologies** | [DerivedPropertyApiName](docs/v1/Ontologies/models/DerivedPropertyApiName.md) | `from foundry.v1.ontologies.models import DerivedPropertyApiName` | -**Ontologies** | [Duration](docs/v1/Ontologies/models/Duration.md) | `from foundry.v1.ontologies.models import Duration` | -**Ontologies** | [EntrySetType](docs/v1/Ontologies/models/EntrySetType.md) | `from foundry.v1.ontologies.models import EntrySetType` | -**Ontologies** | [EqualsQuery](docs/v1/Ontologies/models/EqualsQuery.md) | `from foundry.v1.ontologies.models import EqualsQuery` | -**Ontologies** | [ExecuteQueryResponse](docs/v1/Ontologies/models/ExecuteQueryResponse.md) | `from foundry.v1.ontologies.models import ExecuteQueryResponse` | -**Ontologies** | [FieldNameV1](docs/v1/Ontologies/models/FieldNameV1.md) | `from foundry.v1.ontologies.models import FieldNameV1` | -**Ontologies** | [FilterValue](docs/v1/Ontologies/models/FilterValue.md) | `from foundry.v1.ontologies.models import FilterValue` | -**Ontologies** | [FunctionRid](docs/v1/Ontologies/models/FunctionRid.md) | `from foundry.v1.ontologies.models import FunctionRid` | -**Ontologies** | [FunctionVersion](docs/v1/Ontologies/models/FunctionVersion.md) | `from foundry.v1.ontologies.models import FunctionVersion` | -**Ontologies** | [Fuzzy](docs/v1/Ontologies/models/Fuzzy.md) | `from foundry.v1.ontologies.models import Fuzzy` | -**Ontologies** | [GroupMemberConstraint](docs/v1/Ontologies/models/GroupMemberConstraint.md) | `from foundry.v1.ontologies.models import GroupMemberConstraint` | -**Ontologies** | [GteQuery](docs/v1/Ontologies/models/GteQuery.md) | `from foundry.v1.ontologies.models import GteQuery` | -**Ontologies** | [GtQuery](docs/v1/Ontologies/models/GtQuery.md) | `from foundry.v1.ontologies.models import GtQuery` | -**Ontologies** | [InterfaceTypeApiName](docs/v1/Ontologies/models/InterfaceTypeApiName.md) | `from foundry.v1.ontologies.models import InterfaceTypeApiName` | -**Ontologies** | [InterfaceTypeRid](docs/v1/Ontologies/models/InterfaceTypeRid.md) | `from foundry.v1.ontologies.models import InterfaceTypeRid` | -**Ontologies** | [IsNullQuery](docs/v1/Ontologies/models/IsNullQuery.md) | `from foundry.v1.ontologies.models import IsNullQuery` | -**Ontologies** | [LinkTypeApiName](docs/v1/Ontologies/models/LinkTypeApiName.md) | `from foundry.v1.ontologies.models import LinkTypeApiName` | -**Ontologies** | [LinkTypeSide](docs/v1/Ontologies/models/LinkTypeSide.md) | `from foundry.v1.ontologies.models import LinkTypeSide` | -**Ontologies** | [LinkTypeSideCardinality](docs/v1/Ontologies/models/LinkTypeSideCardinality.md) | `from foundry.v1.ontologies.models import LinkTypeSideCardinality` | -**Ontologies** | [ListActionTypesResponse](docs/v1/Ontologies/models/ListActionTypesResponse.md) | `from foundry.v1.ontologies.models import ListActionTypesResponse` | -**Ontologies** | [ListLinkedObjectsResponse](docs/v1/Ontologies/models/ListLinkedObjectsResponse.md) | `from foundry.v1.ontologies.models import ListLinkedObjectsResponse` | -**Ontologies** | [ListObjectsResponse](docs/v1/Ontologies/models/ListObjectsResponse.md) | `from foundry.v1.ontologies.models import ListObjectsResponse` | -**Ontologies** | [ListObjectTypesResponse](docs/v1/Ontologies/models/ListObjectTypesResponse.md) | `from foundry.v1.ontologies.models import ListObjectTypesResponse` | -**Ontologies** | [ListOntologiesResponse](docs/v1/Ontologies/models/ListOntologiesResponse.md) | `from foundry.v1.ontologies.models import ListOntologiesResponse` | -**Ontologies** | [ListOutgoingLinkTypesResponse](docs/v1/Ontologies/models/ListOutgoingLinkTypesResponse.md) | `from foundry.v1.ontologies.models import ListOutgoingLinkTypesResponse` | -**Ontologies** | [ListQueryTypesResponse](docs/v1/Ontologies/models/ListQueryTypesResponse.md) | `from foundry.v1.ontologies.models import ListQueryTypesResponse` | -**Ontologies** | [LogicRule](docs/v1/Ontologies/models/LogicRule.md) | `from foundry.v1.ontologies.models import LogicRule` | -**Ontologies** | [LteQuery](docs/v1/Ontologies/models/LteQuery.md) | `from foundry.v1.ontologies.models import LteQuery` | -**Ontologies** | [LtQuery](docs/v1/Ontologies/models/LtQuery.md) | `from foundry.v1.ontologies.models import LtQuery` | -**Ontologies** | [MaxAggregation](docs/v1/Ontologies/models/MaxAggregation.md) | `from foundry.v1.ontologies.models import MaxAggregation` | -**Ontologies** | [MinAggregation](docs/v1/Ontologies/models/MinAggregation.md) | `from foundry.v1.ontologies.models import MinAggregation` | -**Ontologies** | [ModifyInterfaceObjectRule](docs/v1/Ontologies/models/ModifyInterfaceObjectRule.md) | `from foundry.v1.ontologies.models import ModifyInterfaceObjectRule` | -**Ontologies** | [ModifyObjectRule](docs/v1/Ontologies/models/ModifyObjectRule.md) | `from foundry.v1.ontologies.models import ModifyObjectRule` | -**Ontologies** | [NotQuery](docs/v1/Ontologies/models/NotQuery.md) | `from foundry.v1.ontologies.models import NotQuery` | -**Ontologies** | [ObjectPropertyValueConstraint](docs/v1/Ontologies/models/ObjectPropertyValueConstraint.md) | `from foundry.v1.ontologies.models import ObjectPropertyValueConstraint` | -**Ontologies** | [ObjectQueryResultConstraint](docs/v1/Ontologies/models/ObjectQueryResultConstraint.md) | `from foundry.v1.ontologies.models import ObjectQueryResultConstraint` | -**Ontologies** | [ObjectRid](docs/v1/Ontologies/models/ObjectRid.md) | `from foundry.v1.ontologies.models import ObjectRid` | -**Ontologies** | [ObjectSetRid](docs/v1/Ontologies/models/ObjectSetRid.md) | `from foundry.v1.ontologies.models import ObjectSetRid` | -**Ontologies** | [ObjectType](docs/v1/Ontologies/models/ObjectType.md) | `from foundry.v1.ontologies.models import ObjectType` | -**Ontologies** | [ObjectTypeApiName](docs/v1/Ontologies/models/ObjectTypeApiName.md) | `from foundry.v1.ontologies.models import ObjectTypeApiName` | -**Ontologies** | [ObjectTypeRid](docs/v1/Ontologies/models/ObjectTypeRid.md) | `from foundry.v1.ontologies.models import ObjectTypeRid` | -**Ontologies** | [ObjectTypeVisibility](docs/v1/Ontologies/models/ObjectTypeVisibility.md) | `from foundry.v1.ontologies.models import ObjectTypeVisibility` | -**Ontologies** | [OneOfConstraint](docs/v1/Ontologies/models/OneOfConstraint.md) | `from foundry.v1.ontologies.models import OneOfConstraint` | -**Ontologies** | [Ontology](docs/v1/Ontologies/models/Ontology.md) | `from foundry.v1.ontologies.models import Ontology` | -**Ontologies** | [OntologyApiName](docs/v1/Ontologies/models/OntologyApiName.md) | `from foundry.v1.ontologies.models import OntologyApiName` | -**Ontologies** | [OntologyArrayType](docs/v1/Ontologies/models/OntologyArrayType.md) | `from foundry.v1.ontologies.models import OntologyArrayType` | -**Ontologies** | [OntologyDataType](docs/v1/Ontologies/models/OntologyDataType.md) | `from foundry.v1.ontologies.models import OntologyDataType` | -**Ontologies** | [OntologyMapType](docs/v1/Ontologies/models/OntologyMapType.md) | `from foundry.v1.ontologies.models import OntologyMapType` | -**Ontologies** | [OntologyObject](docs/v1/Ontologies/models/OntologyObject.md) | `from foundry.v1.ontologies.models import OntologyObject` | -**Ontologies** | [OntologyObjectSetType](docs/v1/Ontologies/models/OntologyObjectSetType.md) | `from foundry.v1.ontologies.models import OntologyObjectSetType` | -**Ontologies** | [OntologyObjectType](docs/v1/Ontologies/models/OntologyObjectType.md) | `from foundry.v1.ontologies.models import OntologyObjectType` | -**Ontologies** | [OntologyRid](docs/v1/Ontologies/models/OntologyRid.md) | `from foundry.v1.ontologies.models import OntologyRid` | -**Ontologies** | [OntologySetType](docs/v1/Ontologies/models/OntologySetType.md) | `from foundry.v1.ontologies.models import OntologySetType` | -**Ontologies** | [OntologyStructField](docs/v1/Ontologies/models/OntologyStructField.md) | `from foundry.v1.ontologies.models import OntologyStructField` | -**Ontologies** | [OntologyStructType](docs/v1/Ontologies/models/OntologyStructType.md) | `from foundry.v1.ontologies.models import OntologyStructType` | -**Ontologies** | [OrderBy](docs/v1/Ontologies/models/OrderBy.md) | `from foundry.v1.ontologies.models import OrderBy` | -**Ontologies** | [OrQuery](docs/v1/Ontologies/models/OrQuery.md) | `from foundry.v1.ontologies.models import OrQuery` | -**Ontologies** | [Parameter](docs/v1/Ontologies/models/Parameter.md) | `from foundry.v1.ontologies.models import Parameter` | -**Ontologies** | [ParameterEvaluatedConstraint](docs/v1/Ontologies/models/ParameterEvaluatedConstraint.md) | `from foundry.v1.ontologies.models import ParameterEvaluatedConstraint` | -**Ontologies** | [ParameterEvaluationResult](docs/v1/Ontologies/models/ParameterEvaluationResult.md) | `from foundry.v1.ontologies.models import ParameterEvaluationResult` | -**Ontologies** | [ParameterId](docs/v1/Ontologies/models/ParameterId.md) | `from foundry.v1.ontologies.models import ParameterId` | -**Ontologies** | [ParameterOption](docs/v1/Ontologies/models/ParameterOption.md) | `from foundry.v1.ontologies.models import ParameterOption` | -**Ontologies** | [PhraseQuery](docs/v1/Ontologies/models/PhraseQuery.md) | `from foundry.v1.ontologies.models import PhraseQuery` | -**Ontologies** | [PrefixQuery](docs/v1/Ontologies/models/PrefixQuery.md) | `from foundry.v1.ontologies.models import PrefixQuery` | -**Ontologies** | [PrimaryKeyValue](docs/v1/Ontologies/models/PrimaryKeyValue.md) | `from foundry.v1.ontologies.models import PrimaryKeyValue` | -**Ontologies** | [Property](docs/v1/Ontologies/models/Property.md) | `from foundry.v1.ontologies.models import Property` | -**Ontologies** | [PropertyApiName](docs/v1/Ontologies/models/PropertyApiName.md) | `from foundry.v1.ontologies.models import PropertyApiName` | -**Ontologies** | [PropertyFilter](docs/v1/Ontologies/models/PropertyFilter.md) | `from foundry.v1.ontologies.models import PropertyFilter` | -**Ontologies** | [PropertyId](docs/v1/Ontologies/models/PropertyId.md) | `from foundry.v1.ontologies.models import PropertyId` | -**Ontologies** | [PropertyValue](docs/v1/Ontologies/models/PropertyValue.md) | `from foundry.v1.ontologies.models import PropertyValue` | -**Ontologies** | [PropertyValueEscapedString](docs/v1/Ontologies/models/PropertyValueEscapedString.md) | `from foundry.v1.ontologies.models import PropertyValueEscapedString` | -**Ontologies** | [QueryAggregationKeyType](docs/v1/Ontologies/models/QueryAggregationKeyType.md) | `from foundry.v1.ontologies.models import QueryAggregationKeyType` | -**Ontologies** | [QueryAggregationRangeSubType](docs/v1/Ontologies/models/QueryAggregationRangeSubType.md) | `from foundry.v1.ontologies.models import QueryAggregationRangeSubType` | -**Ontologies** | [QueryAggregationRangeType](docs/v1/Ontologies/models/QueryAggregationRangeType.md) | `from foundry.v1.ontologies.models import QueryAggregationRangeType` | -**Ontologies** | [QueryAggregationValueType](docs/v1/Ontologies/models/QueryAggregationValueType.md) | `from foundry.v1.ontologies.models import QueryAggregationValueType` | -**Ontologies** | [QueryApiName](docs/v1/Ontologies/models/QueryApiName.md) | `from foundry.v1.ontologies.models import QueryApiName` | -**Ontologies** | [QueryArrayType](docs/v1/Ontologies/models/QueryArrayType.md) | `from foundry.v1.ontologies.models import QueryArrayType` | -**Ontologies** | [QueryDataType](docs/v1/Ontologies/models/QueryDataType.md) | `from foundry.v1.ontologies.models import QueryDataType` | -**Ontologies** | [QueryRuntimeErrorParameter](docs/v1/Ontologies/models/QueryRuntimeErrorParameter.md) | `from foundry.v1.ontologies.models import QueryRuntimeErrorParameter` | -**Ontologies** | [QuerySetType](docs/v1/Ontologies/models/QuerySetType.md) | `from foundry.v1.ontologies.models import QuerySetType` | -**Ontologies** | [QueryStructField](docs/v1/Ontologies/models/QueryStructField.md) | `from foundry.v1.ontologies.models import QueryStructField` | -**Ontologies** | [QueryStructType](docs/v1/Ontologies/models/QueryStructType.md) | `from foundry.v1.ontologies.models import QueryStructType` | -**Ontologies** | [QueryType](docs/v1/Ontologies/models/QueryType.md) | `from foundry.v1.ontologies.models import QueryType` | -**Ontologies** | [QueryUnionType](docs/v1/Ontologies/models/QueryUnionType.md) | `from foundry.v1.ontologies.models import QueryUnionType` | -**Ontologies** | [RangeConstraint](docs/v1/Ontologies/models/RangeConstraint.md) | `from foundry.v1.ontologies.models import RangeConstraint` | -**Ontologies** | [ReturnEditsMode](docs/v1/Ontologies/models/ReturnEditsMode.md) | `from foundry.v1.ontologies.models import ReturnEditsMode` | -**Ontologies** | [SdkPackageName](docs/v1/Ontologies/models/SdkPackageName.md) | `from foundry.v1.ontologies.models import SdkPackageName` | -**Ontologies** | [SearchJsonQuery](docs/v1/Ontologies/models/SearchJsonQuery.md) | `from foundry.v1.ontologies.models import SearchJsonQuery` | -**Ontologies** | [SearchObjectsResponse](docs/v1/Ontologies/models/SearchObjectsResponse.md) | `from foundry.v1.ontologies.models import SearchObjectsResponse` | -**Ontologies** | [SearchOrderBy](docs/v1/Ontologies/models/SearchOrderBy.md) | `from foundry.v1.ontologies.models import SearchOrderBy` | -**Ontologies** | [SearchOrderByType](docs/v1/Ontologies/models/SearchOrderByType.md) | `from foundry.v1.ontologies.models import SearchOrderByType` | -**Ontologies** | [SearchOrdering](docs/v1/Ontologies/models/SearchOrdering.md) | `from foundry.v1.ontologies.models import SearchOrdering` | -**Ontologies** | [SelectedPropertyApiName](docs/v1/Ontologies/models/SelectedPropertyApiName.md) | `from foundry.v1.ontologies.models import SelectedPropertyApiName` | -**Ontologies** | [SharedPropertyTypeApiName](docs/v1/Ontologies/models/SharedPropertyTypeApiName.md) | `from foundry.v1.ontologies.models import SharedPropertyTypeApiName` | -**Ontologies** | [SharedPropertyTypeRid](docs/v1/Ontologies/models/SharedPropertyTypeRid.md) | `from foundry.v1.ontologies.models import SharedPropertyTypeRid` | -**Ontologies** | [StringLengthConstraint](docs/v1/Ontologies/models/StringLengthConstraint.md) | `from foundry.v1.ontologies.models import StringLengthConstraint` | -**Ontologies** | [StringRegexMatchConstraint](docs/v1/Ontologies/models/StringRegexMatchConstraint.md) | `from foundry.v1.ontologies.models import StringRegexMatchConstraint` | -**Ontologies** | [SubmissionCriteriaEvaluation](docs/v1/Ontologies/models/SubmissionCriteriaEvaluation.md) | `from foundry.v1.ontologies.models import SubmissionCriteriaEvaluation` | -**Ontologies** | [SumAggregation](docs/v1/Ontologies/models/SumAggregation.md) | `from foundry.v1.ontologies.models import SumAggregation` | -**Ontologies** | [ThreeDimensionalAggregation](docs/v1/Ontologies/models/ThreeDimensionalAggregation.md) | `from foundry.v1.ontologies.models import ThreeDimensionalAggregation` | -**Ontologies** | [TwoDimensionalAggregation](docs/v1/Ontologies/models/TwoDimensionalAggregation.md) | `from foundry.v1.ontologies.models import TwoDimensionalAggregation` | -**Ontologies** | [UnevaluableConstraint](docs/v1/Ontologies/models/UnevaluableConstraint.md) | `from foundry.v1.ontologies.models import UnevaluableConstraint` | -**Ontologies** | [ValidateActionResponse](docs/v1/Ontologies/models/ValidateActionResponse.md) | `from foundry.v1.ontologies.models import ValidateActionResponse` | -**Ontologies** | [ValidationResult](docs/v1/Ontologies/models/ValidationResult.md) | `from foundry.v1.ontologies.models import ValidationResult` | -**Ontologies** | [ValueType](docs/v1/Ontologies/models/ValueType.md) | `from foundry.v1.ontologies.models import ValueType` | +**Core** | [AnyType](docs/v1/Core/models/AnyType.md) | `from foundry_sdk.v1.core.models import AnyType` | +**Core** | [AttachmentType](docs/v1/Core/models/AttachmentType.md) | `from foundry_sdk.v1.core.models import AttachmentType` | +**Core** | [BinaryType](docs/v1/Core/models/BinaryType.md) | `from foundry_sdk.v1.core.models import BinaryType` | +**Core** | [BooleanType](docs/v1/Core/models/BooleanType.md) | `from foundry_sdk.v1.core.models import BooleanType` | +**Core** | [ByteType](docs/v1/Core/models/ByteType.md) | `from foundry_sdk.v1.core.models import ByteType` | +**Core** | [CipherTextType](docs/v1/Core/models/CipherTextType.md) | `from foundry_sdk.v1.core.models import CipherTextType` | +**Core** | [ContentLength](docs/v1/Core/models/ContentLength.md) | `from foundry_sdk.v1.core.models import ContentLength` | +**Core** | [ContentType](docs/v1/Core/models/ContentType.md) | `from foundry_sdk.v1.core.models import ContentType` | +**Core** | [DateType](docs/v1/Core/models/DateType.md) | `from foundry_sdk.v1.core.models import DateType` | +**Core** | [DecimalType](docs/v1/Core/models/DecimalType.md) | `from foundry_sdk.v1.core.models import DecimalType` | +**Core** | [DisplayName](docs/v1/Core/models/DisplayName.md) | `from foundry_sdk.v1.core.models import DisplayName` | +**Core** | [DistanceUnit](docs/v1/Core/models/DistanceUnit.md) | `from foundry_sdk.v1.core.models import DistanceUnit` | +**Core** | [DoubleType](docs/v1/Core/models/DoubleType.md) | `from foundry_sdk.v1.core.models import DoubleType` | +**Core** | [Filename](docs/v1/Core/models/Filename.md) | `from foundry_sdk.v1.core.models import Filename` | +**Core** | [FilePath](docs/v1/Core/models/FilePath.md) | `from foundry_sdk.v1.core.models import FilePath` | +**Core** | [FloatType](docs/v1/Core/models/FloatType.md) | `from foundry_sdk.v1.core.models import FloatType` | +**Core** | [FolderRid](docs/v1/Core/models/FolderRid.md) | `from foundry_sdk.v1.core.models import FolderRid` | +**Core** | [IntegerType](docs/v1/Core/models/IntegerType.md) | `from foundry_sdk.v1.core.models import IntegerType` | +**Core** | [LongType](docs/v1/Core/models/LongType.md) | `from foundry_sdk.v1.core.models import LongType` | +**Core** | [MarkingType](docs/v1/Core/models/MarkingType.md) | `from foundry_sdk.v1.core.models import MarkingType` | +**Core** | [MediaType](docs/v1/Core/models/MediaType.md) | `from foundry_sdk.v1.core.models import MediaType` | +**Core** | [NullType](docs/v1/Core/models/NullType.md) | `from foundry_sdk.v1.core.models import NullType` | +**Core** | [OperationScope](docs/v1/Core/models/OperationScope.md) | `from foundry_sdk.v1.core.models import OperationScope` | +**Core** | [PageSize](docs/v1/Core/models/PageSize.md) | `from foundry_sdk.v1.core.models import PageSize` | +**Core** | [PageToken](docs/v1/Core/models/PageToken.md) | `from foundry_sdk.v1.core.models import PageToken` | +**Core** | [PreviewMode](docs/v1/Core/models/PreviewMode.md) | `from foundry_sdk.v1.core.models import PreviewMode` | +**Core** | [ReleaseStatus](docs/v1/Core/models/ReleaseStatus.md) | `from foundry_sdk.v1.core.models import ReleaseStatus` | +**Core** | [ShortType](docs/v1/Core/models/ShortType.md) | `from foundry_sdk.v1.core.models import ShortType` | +**Core** | [SizeBytes](docs/v1/Core/models/SizeBytes.md) | `from foundry_sdk.v1.core.models import SizeBytes` | +**Core** | [StringType](docs/v1/Core/models/StringType.md) | `from foundry_sdk.v1.core.models import StringType` | +**Core** | [StructFieldName](docs/v1/Core/models/StructFieldName.md) | `from foundry_sdk.v1.core.models import StructFieldName` | +**Core** | [TimestampType](docs/v1/Core/models/TimestampType.md) | `from foundry_sdk.v1.core.models import TimestampType` | +**Core** | [TotalCount](docs/v1/Core/models/TotalCount.md) | `from foundry_sdk.v1.core.models import TotalCount` | +**Core** | [UnsupportedType](docs/v1/Core/models/UnsupportedType.md) | `from foundry_sdk.v1.core.models import UnsupportedType` | +**Datasets** | [Branch](docs/v1/Datasets/models/Branch.md) | `from foundry_sdk.v1.datasets.models import Branch` | +**Datasets** | [BranchId](docs/v1/Datasets/models/BranchId.md) | `from foundry_sdk.v1.datasets.models import BranchId` | +**Datasets** | [Dataset](docs/v1/Datasets/models/Dataset.md) | `from foundry_sdk.v1.datasets.models import Dataset` | +**Datasets** | [DatasetName](docs/v1/Datasets/models/DatasetName.md) | `from foundry_sdk.v1.datasets.models import DatasetName` | +**Datasets** | [DatasetRid](docs/v1/Datasets/models/DatasetRid.md) | `from foundry_sdk.v1.datasets.models import DatasetRid` | +**Datasets** | [File](docs/v1/Datasets/models/File.md) | `from foundry_sdk.v1.datasets.models import File` | +**Datasets** | [ListBranchesResponse](docs/v1/Datasets/models/ListBranchesResponse.md) | `from foundry_sdk.v1.datasets.models import ListBranchesResponse` | +**Datasets** | [ListFilesResponse](docs/v1/Datasets/models/ListFilesResponse.md) | `from foundry_sdk.v1.datasets.models import ListFilesResponse` | +**Datasets** | [TableExportFormat](docs/v1/Datasets/models/TableExportFormat.md) | `from foundry_sdk.v1.datasets.models import TableExportFormat` | +**Datasets** | [Transaction](docs/v1/Datasets/models/Transaction.md) | `from foundry_sdk.v1.datasets.models import Transaction` | +**Datasets** | [TransactionRid](docs/v1/Datasets/models/TransactionRid.md) | `from foundry_sdk.v1.datasets.models import TransactionRid` | +**Datasets** | [TransactionStatus](docs/v1/Datasets/models/TransactionStatus.md) | `from foundry_sdk.v1.datasets.models import TransactionStatus` | +**Datasets** | [TransactionType](docs/v1/Datasets/models/TransactionType.md) | `from foundry_sdk.v1.datasets.models import TransactionType` | +**Ontologies** | [ActionRid](docs/v1/Ontologies/models/ActionRid.md) | `from foundry_sdk.v1.ontologies.models import ActionRid` | +**Ontologies** | [ActionType](docs/v1/Ontologies/models/ActionType.md) | `from foundry_sdk.v1.ontologies.models import ActionType` | +**Ontologies** | [ActionTypeApiName](docs/v1/Ontologies/models/ActionTypeApiName.md) | `from foundry_sdk.v1.ontologies.models import ActionTypeApiName` | +**Ontologies** | [ActionTypeRid](docs/v1/Ontologies/models/ActionTypeRid.md) | `from foundry_sdk.v1.ontologies.models import ActionTypeRid` | +**Ontologies** | [AggregateObjectsResponse](docs/v1/Ontologies/models/AggregateObjectsResponse.md) | `from foundry_sdk.v1.ontologies.models import AggregateObjectsResponse` | +**Ontologies** | [AggregateObjectsResponseItem](docs/v1/Ontologies/models/AggregateObjectsResponseItem.md) | `from foundry_sdk.v1.ontologies.models import AggregateObjectsResponseItem` | +**Ontologies** | [Aggregation](docs/v1/Ontologies/models/Aggregation.md) | `from foundry_sdk.v1.ontologies.models import Aggregation` | +**Ontologies** | [AggregationDurationGrouping](docs/v1/Ontologies/models/AggregationDurationGrouping.md) | `from foundry_sdk.v1.ontologies.models import AggregationDurationGrouping` | +**Ontologies** | [AggregationExactGrouping](docs/v1/Ontologies/models/AggregationExactGrouping.md) | `from foundry_sdk.v1.ontologies.models import AggregationExactGrouping` | +**Ontologies** | [AggregationFixedWidthGrouping](docs/v1/Ontologies/models/AggregationFixedWidthGrouping.md) | `from foundry_sdk.v1.ontologies.models import AggregationFixedWidthGrouping` | +**Ontologies** | [AggregationGroupBy](docs/v1/Ontologies/models/AggregationGroupBy.md) | `from foundry_sdk.v1.ontologies.models import AggregationGroupBy` | +**Ontologies** | [AggregationGroupKey](docs/v1/Ontologies/models/AggregationGroupKey.md) | `from foundry_sdk.v1.ontologies.models import AggregationGroupKey` | +**Ontologies** | [AggregationGroupValue](docs/v1/Ontologies/models/AggregationGroupValue.md) | `from foundry_sdk.v1.ontologies.models import AggregationGroupValue` | +**Ontologies** | [AggregationMetricName](docs/v1/Ontologies/models/AggregationMetricName.md) | `from foundry_sdk.v1.ontologies.models import AggregationMetricName` | +**Ontologies** | [AggregationMetricResult](docs/v1/Ontologies/models/AggregationMetricResult.md) | `from foundry_sdk.v1.ontologies.models import AggregationMetricResult` | +**Ontologies** | [AggregationRange](docs/v1/Ontologies/models/AggregationRange.md) | `from foundry_sdk.v1.ontologies.models import AggregationRange` | +**Ontologies** | [AggregationRangesGrouping](docs/v1/Ontologies/models/AggregationRangesGrouping.md) | `from foundry_sdk.v1.ontologies.models import AggregationRangesGrouping` | +**Ontologies** | [AllTermsQuery](docs/v1/Ontologies/models/AllTermsQuery.md) | `from foundry_sdk.v1.ontologies.models import AllTermsQuery` | +**Ontologies** | [AndQuery](docs/v1/Ontologies/models/AndQuery.md) | `from foundry_sdk.v1.ontologies.models import AndQuery` | +**Ontologies** | [AnyTermQuery](docs/v1/Ontologies/models/AnyTermQuery.md) | `from foundry_sdk.v1.ontologies.models import AnyTermQuery` | +**Ontologies** | [ApplyActionMode](docs/v1/Ontologies/models/ApplyActionMode.md) | `from foundry_sdk.v1.ontologies.models import ApplyActionMode` | +**Ontologies** | [ApplyActionRequest](docs/v1/Ontologies/models/ApplyActionRequest.md) | `from foundry_sdk.v1.ontologies.models import ApplyActionRequest` | +**Ontologies** | [ApplyActionRequestOptions](docs/v1/Ontologies/models/ApplyActionRequestOptions.md) | `from foundry_sdk.v1.ontologies.models import ApplyActionRequestOptions` | +**Ontologies** | [ApplyActionResponse](docs/v1/Ontologies/models/ApplyActionResponse.md) | `from foundry_sdk.v1.ontologies.models import ApplyActionResponse` | +**Ontologies** | [ApproximateDistinctAggregation](docs/v1/Ontologies/models/ApproximateDistinctAggregation.md) | `from foundry_sdk.v1.ontologies.models import ApproximateDistinctAggregation` | +**Ontologies** | [ArraySizeConstraint](docs/v1/Ontologies/models/ArraySizeConstraint.md) | `from foundry_sdk.v1.ontologies.models import ArraySizeConstraint` | +**Ontologies** | [ArtifactRepositoryRid](docs/v1/Ontologies/models/ArtifactRepositoryRid.md) | `from foundry_sdk.v1.ontologies.models import ArtifactRepositoryRid` | +**Ontologies** | [Attachment](docs/v1/Ontologies/models/Attachment.md) | `from foundry_sdk.v1.ontologies.models import Attachment` | +**Ontologies** | [AttachmentRid](docs/v1/Ontologies/models/AttachmentRid.md) | `from foundry_sdk.v1.ontologies.models import AttachmentRid` | +**Ontologies** | [AvgAggregation](docs/v1/Ontologies/models/AvgAggregation.md) | `from foundry_sdk.v1.ontologies.models import AvgAggregation` | +**Ontologies** | [BatchApplyActionResponse](docs/v1/Ontologies/models/BatchApplyActionResponse.md) | `from foundry_sdk.v1.ontologies.models import BatchApplyActionResponse` | +**Ontologies** | [ContainsQuery](docs/v1/Ontologies/models/ContainsQuery.md) | `from foundry_sdk.v1.ontologies.models import ContainsQuery` | +**Ontologies** | [CountAggregation](docs/v1/Ontologies/models/CountAggregation.md) | `from foundry_sdk.v1.ontologies.models import CountAggregation` | +**Ontologies** | [CreateInterfaceObjectRule](docs/v1/Ontologies/models/CreateInterfaceObjectRule.md) | `from foundry_sdk.v1.ontologies.models import CreateInterfaceObjectRule` | +**Ontologies** | [CreateLinkRule](docs/v1/Ontologies/models/CreateLinkRule.md) | `from foundry_sdk.v1.ontologies.models import CreateLinkRule` | +**Ontologies** | [CreateObjectRule](docs/v1/Ontologies/models/CreateObjectRule.md) | `from foundry_sdk.v1.ontologies.models import CreateObjectRule` | +**Ontologies** | [DataValue](docs/v1/Ontologies/models/DataValue.md) | `from foundry_sdk.v1.ontologies.models import DataValue` | +**Ontologies** | [DeleteInterfaceObjectRule](docs/v1/Ontologies/models/DeleteInterfaceObjectRule.md) | `from foundry_sdk.v1.ontologies.models import DeleteInterfaceObjectRule` | +**Ontologies** | [DeleteLinkRule](docs/v1/Ontologies/models/DeleteLinkRule.md) | `from foundry_sdk.v1.ontologies.models import DeleteLinkRule` | +**Ontologies** | [DeleteObjectRule](docs/v1/Ontologies/models/DeleteObjectRule.md) | `from foundry_sdk.v1.ontologies.models import DeleteObjectRule` | +**Ontologies** | [DerivedPropertyApiName](docs/v1/Ontologies/models/DerivedPropertyApiName.md) | `from foundry_sdk.v1.ontologies.models import DerivedPropertyApiName` | +**Ontologies** | [Duration](docs/v1/Ontologies/models/Duration.md) | `from foundry_sdk.v1.ontologies.models import Duration` | +**Ontologies** | [EntrySetType](docs/v1/Ontologies/models/EntrySetType.md) | `from foundry_sdk.v1.ontologies.models import EntrySetType` | +**Ontologies** | [EqualsQuery](docs/v1/Ontologies/models/EqualsQuery.md) | `from foundry_sdk.v1.ontologies.models import EqualsQuery` | +**Ontologies** | [ExecuteQueryResponse](docs/v1/Ontologies/models/ExecuteQueryResponse.md) | `from foundry_sdk.v1.ontologies.models import ExecuteQueryResponse` | +**Ontologies** | [FieldNameV1](docs/v1/Ontologies/models/FieldNameV1.md) | `from foundry_sdk.v1.ontologies.models import FieldNameV1` | +**Ontologies** | [FilterValue](docs/v1/Ontologies/models/FilterValue.md) | `from foundry_sdk.v1.ontologies.models import FilterValue` | +**Ontologies** | [FunctionRid](docs/v1/Ontologies/models/FunctionRid.md) | `from foundry_sdk.v1.ontologies.models import FunctionRid` | +**Ontologies** | [FunctionVersion](docs/v1/Ontologies/models/FunctionVersion.md) | `from foundry_sdk.v1.ontologies.models import FunctionVersion` | +**Ontologies** | [Fuzzy](docs/v1/Ontologies/models/Fuzzy.md) | `from foundry_sdk.v1.ontologies.models import Fuzzy` | +**Ontologies** | [GroupMemberConstraint](docs/v1/Ontologies/models/GroupMemberConstraint.md) | `from foundry_sdk.v1.ontologies.models import GroupMemberConstraint` | +**Ontologies** | [GteQuery](docs/v1/Ontologies/models/GteQuery.md) | `from foundry_sdk.v1.ontologies.models import GteQuery` | +**Ontologies** | [GtQuery](docs/v1/Ontologies/models/GtQuery.md) | `from foundry_sdk.v1.ontologies.models import GtQuery` | +**Ontologies** | [InterfaceTypeApiName](docs/v1/Ontologies/models/InterfaceTypeApiName.md) | `from foundry_sdk.v1.ontologies.models import InterfaceTypeApiName` | +**Ontologies** | [InterfaceTypeRid](docs/v1/Ontologies/models/InterfaceTypeRid.md) | `from foundry_sdk.v1.ontologies.models import InterfaceTypeRid` | +**Ontologies** | [IsNullQuery](docs/v1/Ontologies/models/IsNullQuery.md) | `from foundry_sdk.v1.ontologies.models import IsNullQuery` | +**Ontologies** | [LinkTypeApiName](docs/v1/Ontologies/models/LinkTypeApiName.md) | `from foundry_sdk.v1.ontologies.models import LinkTypeApiName` | +**Ontologies** | [LinkTypeSide](docs/v1/Ontologies/models/LinkTypeSide.md) | `from foundry_sdk.v1.ontologies.models import LinkTypeSide` | +**Ontologies** | [LinkTypeSideCardinality](docs/v1/Ontologies/models/LinkTypeSideCardinality.md) | `from foundry_sdk.v1.ontologies.models import LinkTypeSideCardinality` | +**Ontologies** | [ListActionTypesResponse](docs/v1/Ontologies/models/ListActionTypesResponse.md) | `from foundry_sdk.v1.ontologies.models import ListActionTypesResponse` | +**Ontologies** | [ListLinkedObjectsResponse](docs/v1/Ontologies/models/ListLinkedObjectsResponse.md) | `from foundry_sdk.v1.ontologies.models import ListLinkedObjectsResponse` | +**Ontologies** | [ListObjectsResponse](docs/v1/Ontologies/models/ListObjectsResponse.md) | `from foundry_sdk.v1.ontologies.models import ListObjectsResponse` | +**Ontologies** | [ListObjectTypesResponse](docs/v1/Ontologies/models/ListObjectTypesResponse.md) | `from foundry_sdk.v1.ontologies.models import ListObjectTypesResponse` | +**Ontologies** | [ListOntologiesResponse](docs/v1/Ontologies/models/ListOntologiesResponse.md) | `from foundry_sdk.v1.ontologies.models import ListOntologiesResponse` | +**Ontologies** | [ListOutgoingLinkTypesResponse](docs/v1/Ontologies/models/ListOutgoingLinkTypesResponse.md) | `from foundry_sdk.v1.ontologies.models import ListOutgoingLinkTypesResponse` | +**Ontologies** | [ListQueryTypesResponse](docs/v1/Ontologies/models/ListQueryTypesResponse.md) | `from foundry_sdk.v1.ontologies.models import ListQueryTypesResponse` | +**Ontologies** | [LogicRule](docs/v1/Ontologies/models/LogicRule.md) | `from foundry_sdk.v1.ontologies.models import LogicRule` | +**Ontologies** | [LteQuery](docs/v1/Ontologies/models/LteQuery.md) | `from foundry_sdk.v1.ontologies.models import LteQuery` | +**Ontologies** | [LtQuery](docs/v1/Ontologies/models/LtQuery.md) | `from foundry_sdk.v1.ontologies.models import LtQuery` | +**Ontologies** | [MaxAggregation](docs/v1/Ontologies/models/MaxAggregation.md) | `from foundry_sdk.v1.ontologies.models import MaxAggregation` | +**Ontologies** | [MinAggregation](docs/v1/Ontologies/models/MinAggregation.md) | `from foundry_sdk.v1.ontologies.models import MinAggregation` | +**Ontologies** | [ModifyInterfaceObjectRule](docs/v1/Ontologies/models/ModifyInterfaceObjectRule.md) | `from foundry_sdk.v1.ontologies.models import ModifyInterfaceObjectRule` | +**Ontologies** | [ModifyObjectRule](docs/v1/Ontologies/models/ModifyObjectRule.md) | `from foundry_sdk.v1.ontologies.models import ModifyObjectRule` | +**Ontologies** | [NotQuery](docs/v1/Ontologies/models/NotQuery.md) | `from foundry_sdk.v1.ontologies.models import NotQuery` | +**Ontologies** | [ObjectPropertyValueConstraint](docs/v1/Ontologies/models/ObjectPropertyValueConstraint.md) | `from foundry_sdk.v1.ontologies.models import ObjectPropertyValueConstraint` | +**Ontologies** | [ObjectQueryResultConstraint](docs/v1/Ontologies/models/ObjectQueryResultConstraint.md) | `from foundry_sdk.v1.ontologies.models import ObjectQueryResultConstraint` | +**Ontologies** | [ObjectRid](docs/v1/Ontologies/models/ObjectRid.md) | `from foundry_sdk.v1.ontologies.models import ObjectRid` | +**Ontologies** | [ObjectSetRid](docs/v1/Ontologies/models/ObjectSetRid.md) | `from foundry_sdk.v1.ontologies.models import ObjectSetRid` | +**Ontologies** | [ObjectType](docs/v1/Ontologies/models/ObjectType.md) | `from foundry_sdk.v1.ontologies.models import ObjectType` | +**Ontologies** | [ObjectTypeApiName](docs/v1/Ontologies/models/ObjectTypeApiName.md) | `from foundry_sdk.v1.ontologies.models import ObjectTypeApiName` | +**Ontologies** | [ObjectTypeRid](docs/v1/Ontologies/models/ObjectTypeRid.md) | `from foundry_sdk.v1.ontologies.models import ObjectTypeRid` | +**Ontologies** | [ObjectTypeVisibility](docs/v1/Ontologies/models/ObjectTypeVisibility.md) | `from foundry_sdk.v1.ontologies.models import ObjectTypeVisibility` | +**Ontologies** | [OneOfConstraint](docs/v1/Ontologies/models/OneOfConstraint.md) | `from foundry_sdk.v1.ontologies.models import OneOfConstraint` | +**Ontologies** | [Ontology](docs/v1/Ontologies/models/Ontology.md) | `from foundry_sdk.v1.ontologies.models import Ontology` | +**Ontologies** | [OntologyApiName](docs/v1/Ontologies/models/OntologyApiName.md) | `from foundry_sdk.v1.ontologies.models import OntologyApiName` | +**Ontologies** | [OntologyArrayType](docs/v1/Ontologies/models/OntologyArrayType.md) | `from foundry_sdk.v1.ontologies.models import OntologyArrayType` | +**Ontologies** | [OntologyDataType](docs/v1/Ontologies/models/OntologyDataType.md) | `from foundry_sdk.v1.ontologies.models import OntologyDataType` | +**Ontologies** | [OntologyMapType](docs/v1/Ontologies/models/OntologyMapType.md) | `from foundry_sdk.v1.ontologies.models import OntologyMapType` | +**Ontologies** | [OntologyObject](docs/v1/Ontologies/models/OntologyObject.md) | `from foundry_sdk.v1.ontologies.models import OntologyObject` | +**Ontologies** | [OntologyObjectSetType](docs/v1/Ontologies/models/OntologyObjectSetType.md) | `from foundry_sdk.v1.ontologies.models import OntologyObjectSetType` | +**Ontologies** | [OntologyObjectType](docs/v1/Ontologies/models/OntologyObjectType.md) | `from foundry_sdk.v1.ontologies.models import OntologyObjectType` | +**Ontologies** | [OntologyRid](docs/v1/Ontologies/models/OntologyRid.md) | `from foundry_sdk.v1.ontologies.models import OntologyRid` | +**Ontologies** | [OntologySetType](docs/v1/Ontologies/models/OntologySetType.md) | `from foundry_sdk.v1.ontologies.models import OntologySetType` | +**Ontologies** | [OntologyStructField](docs/v1/Ontologies/models/OntologyStructField.md) | `from foundry_sdk.v1.ontologies.models import OntologyStructField` | +**Ontologies** | [OntologyStructType](docs/v1/Ontologies/models/OntologyStructType.md) | `from foundry_sdk.v1.ontologies.models import OntologyStructType` | +**Ontologies** | [OrderBy](docs/v1/Ontologies/models/OrderBy.md) | `from foundry_sdk.v1.ontologies.models import OrderBy` | +**Ontologies** | [OrQuery](docs/v1/Ontologies/models/OrQuery.md) | `from foundry_sdk.v1.ontologies.models import OrQuery` | +**Ontologies** | [Parameter](docs/v1/Ontologies/models/Parameter.md) | `from foundry_sdk.v1.ontologies.models import Parameter` | +**Ontologies** | [ParameterEvaluatedConstraint](docs/v1/Ontologies/models/ParameterEvaluatedConstraint.md) | `from foundry_sdk.v1.ontologies.models import ParameterEvaluatedConstraint` | +**Ontologies** | [ParameterEvaluationResult](docs/v1/Ontologies/models/ParameterEvaluationResult.md) | `from foundry_sdk.v1.ontologies.models import ParameterEvaluationResult` | +**Ontologies** | [ParameterId](docs/v1/Ontologies/models/ParameterId.md) | `from foundry_sdk.v1.ontologies.models import ParameterId` | +**Ontologies** | [ParameterOption](docs/v1/Ontologies/models/ParameterOption.md) | `from foundry_sdk.v1.ontologies.models import ParameterOption` | +**Ontologies** | [PhraseQuery](docs/v1/Ontologies/models/PhraseQuery.md) | `from foundry_sdk.v1.ontologies.models import PhraseQuery` | +**Ontologies** | [PrefixQuery](docs/v1/Ontologies/models/PrefixQuery.md) | `from foundry_sdk.v1.ontologies.models import PrefixQuery` | +**Ontologies** | [PrimaryKeyValue](docs/v1/Ontologies/models/PrimaryKeyValue.md) | `from foundry_sdk.v1.ontologies.models import PrimaryKeyValue` | +**Ontologies** | [Property](docs/v1/Ontologies/models/Property.md) | `from foundry_sdk.v1.ontologies.models import Property` | +**Ontologies** | [PropertyApiName](docs/v1/Ontologies/models/PropertyApiName.md) | `from foundry_sdk.v1.ontologies.models import PropertyApiName` | +**Ontologies** | [PropertyFilter](docs/v1/Ontologies/models/PropertyFilter.md) | `from foundry_sdk.v1.ontologies.models import PropertyFilter` | +**Ontologies** | [PropertyId](docs/v1/Ontologies/models/PropertyId.md) | `from foundry_sdk.v1.ontologies.models import PropertyId` | +**Ontologies** | [PropertyValue](docs/v1/Ontologies/models/PropertyValue.md) | `from foundry_sdk.v1.ontologies.models import PropertyValue` | +**Ontologies** | [PropertyValueEscapedString](docs/v1/Ontologies/models/PropertyValueEscapedString.md) | `from foundry_sdk.v1.ontologies.models import PropertyValueEscapedString` | +**Ontologies** | [QueryAggregationKeyType](docs/v1/Ontologies/models/QueryAggregationKeyType.md) | `from foundry_sdk.v1.ontologies.models import QueryAggregationKeyType` | +**Ontologies** | [QueryAggregationRangeSubType](docs/v1/Ontologies/models/QueryAggregationRangeSubType.md) | `from foundry_sdk.v1.ontologies.models import QueryAggregationRangeSubType` | +**Ontologies** | [QueryAggregationRangeType](docs/v1/Ontologies/models/QueryAggregationRangeType.md) | `from foundry_sdk.v1.ontologies.models import QueryAggregationRangeType` | +**Ontologies** | [QueryAggregationValueType](docs/v1/Ontologies/models/QueryAggregationValueType.md) | `from foundry_sdk.v1.ontologies.models import QueryAggregationValueType` | +**Ontologies** | [QueryApiName](docs/v1/Ontologies/models/QueryApiName.md) | `from foundry_sdk.v1.ontologies.models import QueryApiName` | +**Ontologies** | [QueryArrayType](docs/v1/Ontologies/models/QueryArrayType.md) | `from foundry_sdk.v1.ontologies.models import QueryArrayType` | +**Ontologies** | [QueryDataType](docs/v1/Ontologies/models/QueryDataType.md) | `from foundry_sdk.v1.ontologies.models import QueryDataType` | +**Ontologies** | [QueryRuntimeErrorParameter](docs/v1/Ontologies/models/QueryRuntimeErrorParameter.md) | `from foundry_sdk.v1.ontologies.models import QueryRuntimeErrorParameter` | +**Ontologies** | [QuerySetType](docs/v1/Ontologies/models/QuerySetType.md) | `from foundry_sdk.v1.ontologies.models import QuerySetType` | +**Ontologies** | [QueryStructField](docs/v1/Ontologies/models/QueryStructField.md) | `from foundry_sdk.v1.ontologies.models import QueryStructField` | +**Ontologies** | [QueryStructType](docs/v1/Ontologies/models/QueryStructType.md) | `from foundry_sdk.v1.ontologies.models import QueryStructType` | +**Ontologies** | [QueryType](docs/v1/Ontologies/models/QueryType.md) | `from foundry_sdk.v1.ontologies.models import QueryType` | +**Ontologies** | [QueryUnionType](docs/v1/Ontologies/models/QueryUnionType.md) | `from foundry_sdk.v1.ontologies.models import QueryUnionType` | +**Ontologies** | [RangeConstraint](docs/v1/Ontologies/models/RangeConstraint.md) | `from foundry_sdk.v1.ontologies.models import RangeConstraint` | +**Ontologies** | [ReturnEditsMode](docs/v1/Ontologies/models/ReturnEditsMode.md) | `from foundry_sdk.v1.ontologies.models import ReturnEditsMode` | +**Ontologies** | [SdkPackageName](docs/v1/Ontologies/models/SdkPackageName.md) | `from foundry_sdk.v1.ontologies.models import SdkPackageName` | +**Ontologies** | [SearchJsonQuery](docs/v1/Ontologies/models/SearchJsonQuery.md) | `from foundry_sdk.v1.ontologies.models import SearchJsonQuery` | +**Ontologies** | [SearchObjectsResponse](docs/v1/Ontologies/models/SearchObjectsResponse.md) | `from foundry_sdk.v1.ontologies.models import SearchObjectsResponse` | +**Ontologies** | [SearchOrderBy](docs/v1/Ontologies/models/SearchOrderBy.md) | `from foundry_sdk.v1.ontologies.models import SearchOrderBy` | +**Ontologies** | [SearchOrderByType](docs/v1/Ontologies/models/SearchOrderByType.md) | `from foundry_sdk.v1.ontologies.models import SearchOrderByType` | +**Ontologies** | [SearchOrdering](docs/v1/Ontologies/models/SearchOrdering.md) | `from foundry_sdk.v1.ontologies.models import SearchOrdering` | +**Ontologies** | [SelectedPropertyApiName](docs/v1/Ontologies/models/SelectedPropertyApiName.md) | `from foundry_sdk.v1.ontologies.models import SelectedPropertyApiName` | +**Ontologies** | [SharedPropertyTypeApiName](docs/v1/Ontologies/models/SharedPropertyTypeApiName.md) | `from foundry_sdk.v1.ontologies.models import SharedPropertyTypeApiName` | +**Ontologies** | [SharedPropertyTypeRid](docs/v1/Ontologies/models/SharedPropertyTypeRid.md) | `from foundry_sdk.v1.ontologies.models import SharedPropertyTypeRid` | +**Ontologies** | [StringLengthConstraint](docs/v1/Ontologies/models/StringLengthConstraint.md) | `from foundry_sdk.v1.ontologies.models import StringLengthConstraint` | +**Ontologies** | [StringRegexMatchConstraint](docs/v1/Ontologies/models/StringRegexMatchConstraint.md) | `from foundry_sdk.v1.ontologies.models import StringRegexMatchConstraint` | +**Ontologies** | [SubmissionCriteriaEvaluation](docs/v1/Ontologies/models/SubmissionCriteriaEvaluation.md) | `from foundry_sdk.v1.ontologies.models import SubmissionCriteriaEvaluation` | +**Ontologies** | [SumAggregation](docs/v1/Ontologies/models/SumAggregation.md) | `from foundry_sdk.v1.ontologies.models import SumAggregation` | +**Ontologies** | [ThreeDimensionalAggregation](docs/v1/Ontologies/models/ThreeDimensionalAggregation.md) | `from foundry_sdk.v1.ontologies.models import ThreeDimensionalAggregation` | +**Ontologies** | [TwoDimensionalAggregation](docs/v1/Ontologies/models/TwoDimensionalAggregation.md) | `from foundry_sdk.v1.ontologies.models import TwoDimensionalAggregation` | +**Ontologies** | [UnevaluableConstraint](docs/v1/Ontologies/models/UnevaluableConstraint.md) | `from foundry_sdk.v1.ontologies.models import UnevaluableConstraint` | +**Ontologies** | [ValidateActionResponse](docs/v1/Ontologies/models/ValidateActionResponse.md) | `from foundry_sdk.v1.ontologies.models import ValidateActionResponse` | +**Ontologies** | [ValidationResult](docs/v1/Ontologies/models/ValidationResult.md) | `from foundry_sdk.v1.ontologies.models import ValidationResult` | +**Ontologies** | [ValueType](docs/v1/Ontologies/models/ValueType.md) | `from foundry_sdk.v1.ontologies.models import ValueType` | @@ -1689,552 +1689,552 @@ Namespace | Name | Import | Namespace | Name | Import | --------- | ---- | ------ | -**Admin** | AddGroupMembersPermissionDenied | `from foundry.v2.admin.errors import AddGroupMembersPermissionDenied` | -**Admin** | AddMarkingMembersPermissionDenied | `from foundry.v2.admin.errors import AddMarkingMembersPermissionDenied` | -**Admin** | AddMarkingRoleAssignmentsPermissionDenied | `from foundry.v2.admin.errors import AddMarkingRoleAssignmentsPermissionDenied` | -**Admin** | AuthenticationProviderNotFound | `from foundry.v2.admin.errors import AuthenticationProviderNotFound` | -**Admin** | CannotReplaceProviderInfoForPrincipalInProtectedRealm | `from foundry.v2.admin.errors import CannotReplaceProviderInfoForPrincipalInProtectedRealm` | -**Admin** | CreateGroupPermissionDenied | `from foundry.v2.admin.errors import CreateGroupPermissionDenied` | -**Admin** | CreateMarkingMissingInitialAdminRole | `from foundry.v2.admin.errors import CreateMarkingMissingInitialAdminRole` | -**Admin** | CreateMarkingNameInCategoryAlreadyExists | `from foundry.v2.admin.errors import CreateMarkingNameInCategoryAlreadyExists` | -**Admin** | CreateMarkingPermissionDenied | `from foundry.v2.admin.errors import CreateMarkingPermissionDenied` | -**Admin** | DeleteGroupPermissionDenied | `from foundry.v2.admin.errors import DeleteGroupPermissionDenied` | -**Admin** | DeleteUserPermissionDenied | `from foundry.v2.admin.errors import DeleteUserPermissionDenied` | -**Admin** | EnrollmentNotFound | `from foundry.v2.admin.errors import EnrollmentNotFound` | -**Admin** | GetCurrentEnrollmentPermissionDenied | `from foundry.v2.admin.errors import GetCurrentEnrollmentPermissionDenied` | -**Admin** | GetCurrentUserPermissionDenied | `from foundry.v2.admin.errors import GetCurrentUserPermissionDenied` | -**Admin** | GetGroupProviderInfoPermissionDenied | `from foundry.v2.admin.errors import GetGroupProviderInfoPermissionDenied` | -**Admin** | GetMarkingCategoryPermissionDenied | `from foundry.v2.admin.errors import GetMarkingCategoryPermissionDenied` | -**Admin** | GetMarkingPermissionDenied | `from foundry.v2.admin.errors import GetMarkingPermissionDenied` | -**Admin** | GetMarkingsUserPermissionDenied | `from foundry.v2.admin.errors import GetMarkingsUserPermissionDenied` | -**Admin** | GetProfilePictureOfUserPermissionDenied | `from foundry.v2.admin.errors import GetProfilePictureOfUserPermissionDenied` | -**Admin** | GetUserProviderInfoPermissionDenied | `from foundry.v2.admin.errors import GetUserProviderInfoPermissionDenied` | -**Admin** | GroupNameAlreadyExists | `from foundry.v2.admin.errors import GroupNameAlreadyExists` | -**Admin** | GroupNotFound | `from foundry.v2.admin.errors import GroupNotFound` | -**Admin** | GroupProviderInfoNotFound | `from foundry.v2.admin.errors import GroupProviderInfoNotFound` | -**Admin** | InvalidGroupMembershipExpiration | `from foundry.v2.admin.errors import InvalidGroupMembershipExpiration` | -**Admin** | InvalidGroupOrganizations | `from foundry.v2.admin.errors import InvalidGroupOrganizations` | -**Admin** | InvalidHostName | `from foundry.v2.admin.errors import InvalidHostName` | -**Admin** | InvalidProfilePicture | `from foundry.v2.admin.errors import InvalidProfilePicture` | -**Admin** | ListHostsPermissionDenied | `from foundry.v2.admin.errors import ListHostsPermissionDenied` | -**Admin** | ListMarkingMembersPermissionDenied | `from foundry.v2.admin.errors import ListMarkingMembersPermissionDenied` | -**Admin** | ListMarkingRoleAssignmentsPermissionDenied | `from foundry.v2.admin.errors import ListMarkingRoleAssignmentsPermissionDenied` | -**Admin** | MarkingCategoryNotFound | `from foundry.v2.admin.errors import MarkingCategoryNotFound` | -**Admin** | MarkingNotFound | `from foundry.v2.admin.errors import MarkingNotFound` | -**Admin** | OrganizationNotFound | `from foundry.v2.admin.errors import OrganizationNotFound` | -**Admin** | PreregisterGroupPermissionDenied | `from foundry.v2.admin.errors import PreregisterGroupPermissionDenied` | -**Admin** | PreregisterUserPermissionDenied | `from foundry.v2.admin.errors import PreregisterUserPermissionDenied` | -**Admin** | PrincipalNotFound | `from foundry.v2.admin.errors import PrincipalNotFound` | -**Admin** | ProfilePictureNotFound | `from foundry.v2.admin.errors import ProfilePictureNotFound` | -**Admin** | RemoveGroupMembersPermissionDenied | `from foundry.v2.admin.errors import RemoveGroupMembersPermissionDenied` | -**Admin** | RemoveMarkingMembersPermissionDenied | `from foundry.v2.admin.errors import RemoveMarkingMembersPermissionDenied` | -**Admin** | RemoveMarkingRoleAssignmentsPermissionDenied | `from foundry.v2.admin.errors import RemoveMarkingRoleAssignmentsPermissionDenied` | -**Admin** | RemoveMarkingRoleAssignmentsRemoveAllAdministratorsNotAllowed | `from foundry.v2.admin.errors import RemoveMarkingRoleAssignmentsRemoveAllAdministratorsNotAllowed` | -**Admin** | ReplaceGroupProviderInfoPermissionDenied | `from foundry.v2.admin.errors import ReplaceGroupProviderInfoPermissionDenied` | -**Admin** | ReplaceOrganizationPermissionDenied | `from foundry.v2.admin.errors import ReplaceOrganizationPermissionDenied` | -**Admin** | ReplaceUserProviderInfoPermissionDenied | `from foundry.v2.admin.errors import ReplaceUserProviderInfoPermissionDenied` | -**Admin** | SearchGroupsPermissionDenied | `from foundry.v2.admin.errors import SearchGroupsPermissionDenied` | -**Admin** | SearchUsersPermissionDenied | `from foundry.v2.admin.errors import SearchUsersPermissionDenied` | -**Admin** | UserNotFound | `from foundry.v2.admin.errors import UserNotFound` | -**Admin** | UserProviderInfoNotFound | `from foundry.v2.admin.errors import UserProviderInfoNotFound` | -**AipAgents** | AgentIterationsExceededLimit | `from foundry.v2.aip_agents.errors import AgentIterationsExceededLimit` | -**AipAgents** | AgentNotFound | `from foundry.v2.aip_agents.errors import AgentNotFound` | -**AipAgents** | AgentVersionNotFound | `from foundry.v2.aip_agents.errors import AgentVersionNotFound` | -**AipAgents** | BlockingContinueSessionPermissionDenied | `from foundry.v2.aip_agents.errors import BlockingContinueSessionPermissionDenied` | -**AipAgents** | CancelSessionFailedMessageNotInProgress | `from foundry.v2.aip_agents.errors import CancelSessionFailedMessageNotInProgress` | -**AipAgents** | CancelSessionPermissionDenied | `from foundry.v2.aip_agents.errors import CancelSessionPermissionDenied` | -**AipAgents** | ContentNotFound | `from foundry.v2.aip_agents.errors import ContentNotFound` | -**AipAgents** | ContextSizeExceededLimit | `from foundry.v2.aip_agents.errors import ContextSizeExceededLimit` | -**AipAgents** | CreateSessionPermissionDenied | `from foundry.v2.aip_agents.errors import CreateSessionPermissionDenied` | -**AipAgents** | FunctionLocatorNotFound | `from foundry.v2.aip_agents.errors import FunctionLocatorNotFound` | -**AipAgents** | GetAllSessionsAgentsPermissionDenied | `from foundry.v2.aip_agents.errors import GetAllSessionsAgentsPermissionDenied` | -**AipAgents** | GetRagContextForSessionPermissionDenied | `from foundry.v2.aip_agents.errors import GetRagContextForSessionPermissionDenied` | -**AipAgents** | InvalidAgentVersion | `from foundry.v2.aip_agents.errors import InvalidAgentVersion` | -**AipAgents** | InvalidParameter | `from foundry.v2.aip_agents.errors import InvalidParameter` | -**AipAgents** | InvalidParameterType | `from foundry.v2.aip_agents.errors import InvalidParameterType` | -**AipAgents** | ListSessionsForAgentsPermissionDenied | `from foundry.v2.aip_agents.errors import ListSessionsForAgentsPermissionDenied` | -**AipAgents** | NoPublishedAgentVersion | `from foundry.v2.aip_agents.errors import NoPublishedAgentVersion` | -**AipAgents** | ObjectTypeIdsNotFound | `from foundry.v2.aip_agents.errors import ObjectTypeIdsNotFound` | -**AipAgents** | ObjectTypeRidsNotFound | `from foundry.v2.aip_agents.errors import ObjectTypeRidsNotFound` | -**AipAgents** | RateLimitExceeded | `from foundry.v2.aip_agents.errors import RateLimitExceeded` | -**AipAgents** | SessionExecutionFailed | `from foundry.v2.aip_agents.errors import SessionExecutionFailed` | -**AipAgents** | SessionNotFound | `from foundry.v2.aip_agents.errors import SessionNotFound` | -**AipAgents** | StreamingContinueSessionPermissionDenied | `from foundry.v2.aip_agents.errors import StreamingContinueSessionPermissionDenied` | -**AipAgents** | UpdateSessionTitlePermissionDenied | `from foundry.v2.aip_agents.errors import UpdateSessionTitlePermissionDenied` | -**Connectivity** | AdditionalSecretsMustBeSpecifiedAsPlaintextValueMap | `from foundry.v2.connectivity.errors import AdditionalSecretsMustBeSpecifiedAsPlaintextValueMap` | -**Connectivity** | ChangingBranchNameNotSupportedForImports | `from foundry.v2.connectivity.errors import ChangingBranchNameNotSupportedForImports` | -**Connectivity** | ChangingOutputDatasetNotSupportedForImports | `from foundry.v2.connectivity.errors import ChangingOutputDatasetNotSupportedForImports` | -**Connectivity** | ConnectionDetailsNotDetermined | `from foundry.v2.connectivity.errors import ConnectionDetailsNotDetermined` | -**Connectivity** | ConnectionNotFound | `from foundry.v2.connectivity.errors import ConnectionNotFound` | -**Connectivity** | ConnectionTypeNotSupported | `from foundry.v2.connectivity.errors import ConnectionTypeNotSupported` | -**Connectivity** | CreateConnectionPermissionDenied | `from foundry.v2.connectivity.errors import CreateConnectionPermissionDenied` | -**Connectivity** | CreateFileImportPermissionDenied | `from foundry.v2.connectivity.errors import CreateFileImportPermissionDenied` | -**Connectivity** | CreateTableImportPermissionDenied | `from foundry.v2.connectivity.errors import CreateTableImportPermissionDenied` | -**Connectivity** | DeleteFileImportPermissionDenied | `from foundry.v2.connectivity.errors import DeleteFileImportPermissionDenied` | -**Connectivity** | DeleteTableImportPermissionDenied | `from foundry.v2.connectivity.errors import DeleteTableImportPermissionDenied` | -**Connectivity** | DomainMustUseHttpsWithAuthentication | `from foundry.v2.connectivity.errors import DomainMustUseHttpsWithAuthentication` | -**Connectivity** | EncryptedPropertyMustBeSpecifiedAsPlaintextValue | `from foundry.v2.connectivity.errors import EncryptedPropertyMustBeSpecifiedAsPlaintextValue` | -**Connectivity** | ExecuteFileImportPermissionDenied | `from foundry.v2.connectivity.errors import ExecuteFileImportPermissionDenied` | -**Connectivity** | ExecuteTableImportPermissionDenied | `from foundry.v2.connectivity.errors import ExecuteTableImportPermissionDenied` | -**Connectivity** | FileAtLeastCountFilterInvalidMinCount | `from foundry.v2.connectivity.errors import FileAtLeastCountFilterInvalidMinCount` | -**Connectivity** | FileImportCustomFilterCannotBeUsedToCreateOrUpdateFileImports | `from foundry.v2.connectivity.errors import FileImportCustomFilterCannotBeUsedToCreateOrUpdateFileImports` | -**Connectivity** | FileImportNotFound | `from foundry.v2.connectivity.errors import FileImportNotFound` | -**Connectivity** | FileImportNotSupportedForConnection | `from foundry.v2.connectivity.errors import FileImportNotSupportedForConnection` | -**Connectivity** | FilesCountLimitFilterInvalidLimit | `from foundry.v2.connectivity.errors import FilesCountLimitFilterInvalidLimit` | -**Connectivity** | FileSizeFilterGreaterThanCannotBeNegative | `from foundry.v2.connectivity.errors import FileSizeFilterGreaterThanCannotBeNegative` | -**Connectivity** | FileSizeFilterInvalidGreaterThanAndLessThanRange | `from foundry.v2.connectivity.errors import FileSizeFilterInvalidGreaterThanAndLessThanRange` | -**Connectivity** | FileSizeFilterLessThanMustBeOneByteOrLarger | `from foundry.v2.connectivity.errors import FileSizeFilterLessThanMustBeOneByteOrLarger` | -**Connectivity** | FileSizeFilterMissingGreaterThanAndLessThan | `from foundry.v2.connectivity.errors import FileSizeFilterMissingGreaterThanAndLessThan` | -**Connectivity** | GetConfigurationPermissionDenied | `from foundry.v2.connectivity.errors import GetConfigurationPermissionDenied` | -**Connectivity** | ParentFolderNotFoundForConnection | `from foundry.v2.connectivity.errors import ParentFolderNotFoundForConnection` | -**Connectivity** | PropertyCannotBeBlank | `from foundry.v2.connectivity.errors import PropertyCannotBeBlank` | -**Connectivity** | PropertyCannotBeEmpty | `from foundry.v2.connectivity.errors import PropertyCannotBeEmpty` | -**Connectivity** | ReplaceFileImportPermissionDenied | `from foundry.v2.connectivity.errors import ReplaceFileImportPermissionDenied` | -**Connectivity** | SecretNamesDoNotExist | `from foundry.v2.connectivity.errors import SecretNamesDoNotExist` | -**Connectivity** | TableImportNotFound | `from foundry.v2.connectivity.errors import TableImportNotFound` | -**Connectivity** | TableImportNotSupportedForConnection | `from foundry.v2.connectivity.errors import TableImportNotSupportedForConnection` | -**Connectivity** | TableImportTypeNotSupported | `from foundry.v2.connectivity.errors import TableImportTypeNotSupported` | -**Connectivity** | UpdateSecretsForConnectionPermissionDenied | `from foundry.v2.connectivity.errors import UpdateSecretsForConnectionPermissionDenied` | -**Core** | ApiFeaturePreviewUsageOnly | `from foundry.v2.core.errors import ApiFeaturePreviewUsageOnly` | -**Core** | ApiUsageDenied | `from foundry.v2.core.errors import ApiUsageDenied` | -**Core** | BatchRequestSizeExceededLimit | `from foundry.v2.core.errors import BatchRequestSizeExceededLimit` | -**Core** | FolderNotFound | `from foundry.v2.core.errors import FolderNotFound` | -**Core** | InvalidAndFilter | `from foundry.v2.core.errors import InvalidAndFilter` | -**Core** | InvalidChangeDataCaptureConfiguration | `from foundry.v2.core.errors import InvalidChangeDataCaptureConfiguration` | -**Core** | InvalidFieldSchema | `from foundry.v2.core.errors import InvalidFieldSchema` | -**Core** | InvalidFilterValue | `from foundry.v2.core.errors import InvalidFilterValue` | -**Core** | InvalidOrFilter | `from foundry.v2.core.errors import InvalidOrFilter` | -**Core** | InvalidPageSize | `from foundry.v2.core.errors import InvalidPageSize` | -**Core** | InvalidPageToken | `from foundry.v2.core.errors import InvalidPageToken` | -**Core** | InvalidParameterCombination | `from foundry.v2.core.errors import InvalidParameterCombination` | -**Core** | InvalidSchema | `from foundry.v2.core.errors import InvalidSchema` | -**Core** | InvalidTimeZone | `from foundry.v2.core.errors import InvalidTimeZone` | -**Core** | MissingBatchRequest | `from foundry.v2.core.errors import MissingBatchRequest` | -**Core** | MissingPostBody | `from foundry.v2.core.errors import MissingPostBody` | -**Core** | ResourceNameAlreadyExists | `from foundry.v2.core.errors import ResourceNameAlreadyExists` | -**Core** | SchemaIsNotStreamSchema | `from foundry.v2.core.errors import SchemaIsNotStreamSchema` | -**Core** | UnknownDistanceUnit | `from foundry.v2.core.errors import UnknownDistanceUnit` | -**Datasets** | AbortTransactionPermissionDenied | `from foundry.v2.datasets.errors import AbortTransactionPermissionDenied` | -**Datasets** | BranchAlreadyExists | `from foundry.v2.datasets.errors import BranchAlreadyExists` | -**Datasets** | BranchNotFound | `from foundry.v2.datasets.errors import BranchNotFound` | -**Datasets** | BuildTransactionPermissionDenied | `from foundry.v2.datasets.errors import BuildTransactionPermissionDenied` | -**Datasets** | ColumnTypesNotSupported | `from foundry.v2.datasets.errors import ColumnTypesNotSupported` | -**Datasets** | CommitTransactionPermissionDenied | `from foundry.v2.datasets.errors import CommitTransactionPermissionDenied` | -**Datasets** | CreateBranchPermissionDenied | `from foundry.v2.datasets.errors import CreateBranchPermissionDenied` | -**Datasets** | CreateDatasetPermissionDenied | `from foundry.v2.datasets.errors import CreateDatasetPermissionDenied` | -**Datasets** | CreateTransactionPermissionDenied | `from foundry.v2.datasets.errors import CreateTransactionPermissionDenied` | -**Datasets** | DatasetNotFound | `from foundry.v2.datasets.errors import DatasetNotFound` | -**Datasets** | DatasetReadNotSupported | `from foundry.v2.datasets.errors import DatasetReadNotSupported` | -**Datasets** | DeleteBranchPermissionDenied | `from foundry.v2.datasets.errors import DeleteBranchPermissionDenied` | -**Datasets** | DeleteFilePermissionDenied | `from foundry.v2.datasets.errors import DeleteFilePermissionDenied` | -**Datasets** | DeleteSchemaPermissionDenied | `from foundry.v2.datasets.errors import DeleteSchemaPermissionDenied` | -**Datasets** | FileAlreadyExists | `from foundry.v2.datasets.errors import FileAlreadyExists` | -**Datasets** | FileNotFound | `from foundry.v2.datasets.errors import FileNotFound` | -**Datasets** | FileNotFoundOnBranch | `from foundry.v2.datasets.errors import FileNotFoundOnBranch` | -**Datasets** | FileNotFoundOnTransactionRange | `from foundry.v2.datasets.errors import FileNotFoundOnTransactionRange` | -**Datasets** | GetFileContentPermissionDenied | `from foundry.v2.datasets.errors import GetFileContentPermissionDenied` | -**Datasets** | InvalidBranchName | `from foundry.v2.datasets.errors import InvalidBranchName` | -**Datasets** | InvalidTransactionType | `from foundry.v2.datasets.errors import InvalidTransactionType` | -**Datasets** | JobTransactionPermissionDenied | `from foundry.v2.datasets.errors import JobTransactionPermissionDenied` | -**Datasets** | OpenTransactionAlreadyExists | `from foundry.v2.datasets.errors import OpenTransactionAlreadyExists` | -**Datasets** | PutSchemaPermissionDenied | `from foundry.v2.datasets.errors import PutSchemaPermissionDenied` | -**Datasets** | ReadTableDatasetPermissionDenied | `from foundry.v2.datasets.errors import ReadTableDatasetPermissionDenied` | -**Datasets** | ReadTableError | `from foundry.v2.datasets.errors import ReadTableError` | -**Datasets** | ReadTableRowLimitExceeded | `from foundry.v2.datasets.errors import ReadTableRowLimitExceeded` | -**Datasets** | ReadTableTimeout | `from foundry.v2.datasets.errors import ReadTableTimeout` | -**Datasets** | SchemaNotFound | `from foundry.v2.datasets.errors import SchemaNotFound` | -**Datasets** | TransactionNotCommitted | `from foundry.v2.datasets.errors import TransactionNotCommitted` | -**Datasets** | TransactionNotFound | `from foundry.v2.datasets.errors import TransactionNotFound` | -**Datasets** | TransactionNotOpen | `from foundry.v2.datasets.errors import TransactionNotOpen` | -**Datasets** | UploadFilePermissionDenied | `from foundry.v2.datasets.errors import UploadFilePermissionDenied` | -**Filesystem** | AddGroupToParentGroupPermissionDenied | `from foundry.v2.filesystem.errors import AddGroupToParentGroupPermissionDenied` | -**Filesystem** | AddMarkingsPermissionDenied | `from foundry.v2.filesystem.errors import AddMarkingsPermissionDenied` | -**Filesystem** | AddOrganizationsPermissionDenied | `from foundry.v2.filesystem.errors import AddOrganizationsPermissionDenied` | -**Filesystem** | AddResourceRolesPermissionDenied | `from foundry.v2.filesystem.errors import AddResourceRolesPermissionDenied` | -**Filesystem** | CreateFolderOutsideProjectNotSupported | `from foundry.v2.filesystem.errors import CreateFolderOutsideProjectNotSupported` | -**Filesystem** | CreateFolderPermissionDenied | `from foundry.v2.filesystem.errors import CreateFolderPermissionDenied` | -**Filesystem** | CreateGroupPermissionDenied | `from foundry.v2.filesystem.errors import CreateGroupPermissionDenied` | -**Filesystem** | CreateProjectFromTemplatePermissionDenied | `from foundry.v2.filesystem.errors import CreateProjectFromTemplatePermissionDenied` | -**Filesystem** | CreateProjectNoOwnerLikeRoleGrant | `from foundry.v2.filesystem.errors import CreateProjectNoOwnerLikeRoleGrant` | -**Filesystem** | CreateProjectPermissionDenied | `from foundry.v2.filesystem.errors import CreateProjectPermissionDenied` | -**Filesystem** | DefaultRolesNotInSpaceRoleSet | `from foundry.v2.filesystem.errors import DefaultRolesNotInSpaceRoleSet` | -**Filesystem** | DeleteResourcePermissionDenied | `from foundry.v2.filesystem.errors import DeleteResourcePermissionDenied` | -**Filesystem** | FolderNotFound | `from foundry.v2.filesystem.errors import FolderNotFound` | -**Filesystem** | ForbiddenOperationOnAutosavedResource | `from foundry.v2.filesystem.errors import ForbiddenOperationOnAutosavedResource` | -**Filesystem** | ForbiddenOperationOnHiddenResource | `from foundry.v2.filesystem.errors import ForbiddenOperationOnHiddenResource` | -**Filesystem** | GetAccessRequirementsPermissionDenied | `from foundry.v2.filesystem.errors import GetAccessRequirementsPermissionDenied` | -**Filesystem** | GetByPathPermissionDenied | `from foundry.v2.filesystem.errors import GetByPathPermissionDenied` | -**Filesystem** | GetRootFolderNotSupported | `from foundry.v2.filesystem.errors import GetRootFolderNotSupported` | -**Filesystem** | GetSpaceResourceNotSupported | `from foundry.v2.filesystem.errors import GetSpaceResourceNotSupported` | -**Filesystem** | InvalidDefaultRoles | `from foundry.v2.filesystem.errors import InvalidDefaultRoles` | -**Filesystem** | InvalidDescription | `from foundry.v2.filesystem.errors import InvalidDescription` | -**Filesystem** | InvalidDisplayName | `from foundry.v2.filesystem.errors import InvalidDisplayName` | -**Filesystem** | InvalidFolder | `from foundry.v2.filesystem.errors import InvalidFolder` | -**Filesystem** | InvalidOrganizationHierarchy | `from foundry.v2.filesystem.errors import InvalidOrganizationHierarchy` | -**Filesystem** | InvalidOrganizations | `from foundry.v2.filesystem.errors import InvalidOrganizations` | -**Filesystem** | InvalidPath | `from foundry.v2.filesystem.errors import InvalidPath` | -**Filesystem** | InvalidPrincipalIdsForGroupTemplate | `from foundry.v2.filesystem.errors import InvalidPrincipalIdsForGroupTemplate` | -**Filesystem** | InvalidRoleIds | `from foundry.v2.filesystem.errors import InvalidRoleIds` | -**Filesystem** | InvalidVariable | `from foundry.v2.filesystem.errors import InvalidVariable` | -**Filesystem** | InvalidVariableEnumOption | `from foundry.v2.filesystem.errors import InvalidVariableEnumOption` | -**Filesystem** | MarkingNotFound | `from foundry.v2.filesystem.errors import MarkingNotFound` | -**Filesystem** | MissingDisplayName | `from foundry.v2.filesystem.errors import MissingDisplayName` | -**Filesystem** | MissingVariableValue | `from foundry.v2.filesystem.errors import MissingVariableValue` | -**Filesystem** | NotAuthorizedToApplyOrganization | `from foundry.v2.filesystem.errors import NotAuthorizedToApplyOrganization` | -**Filesystem** | OrganizationCannotBeRemoved | `from foundry.v2.filesystem.errors import OrganizationCannotBeRemoved` | -**Filesystem** | OrganizationMarkingNotOnSpace | `from foundry.v2.filesystem.errors import OrganizationMarkingNotOnSpace` | -**Filesystem** | OrganizationMarkingNotSupported | `from foundry.v2.filesystem.errors import OrganizationMarkingNotSupported` | -**Filesystem** | OrganizationsNotFound | `from foundry.v2.filesystem.errors import OrganizationsNotFound` | -**Filesystem** | PathNotFound | `from foundry.v2.filesystem.errors import PathNotFound` | -**Filesystem** | PermanentlyDeleteResourcePermissionDenied | `from foundry.v2.filesystem.errors import PermanentlyDeleteResourcePermissionDenied` | -**Filesystem** | ProjectCreationNotSupported | `from foundry.v2.filesystem.errors import ProjectCreationNotSupported` | -**Filesystem** | ProjectNameAlreadyExists | `from foundry.v2.filesystem.errors import ProjectNameAlreadyExists` | -**Filesystem** | ProjectNotFound | `from foundry.v2.filesystem.errors import ProjectNotFound` | -**Filesystem** | ProjectTemplateNotFound | `from foundry.v2.filesystem.errors import ProjectTemplateNotFound` | -**Filesystem** | RemoveMarkingsPermissionDenied | `from foundry.v2.filesystem.errors import RemoveMarkingsPermissionDenied` | -**Filesystem** | RemoveOrganizationsPermissionDenied | `from foundry.v2.filesystem.errors import RemoveOrganizationsPermissionDenied` | -**Filesystem** | RemoveResourceRolesPermissionDenied | `from foundry.v2.filesystem.errors import RemoveResourceRolesPermissionDenied` | -**Filesystem** | ResourceNameAlreadyExists | `from foundry.v2.filesystem.errors import ResourceNameAlreadyExists` | -**Filesystem** | ResourceNotDirectlyTrashed | `from foundry.v2.filesystem.errors import ResourceNotDirectlyTrashed` | -**Filesystem** | ResourceNotFound | `from foundry.v2.filesystem.errors import ResourceNotFound` | -**Filesystem** | ResourceNotTrashed | `from foundry.v2.filesystem.errors import ResourceNotTrashed` | -**Filesystem** | RestoreResourcePermissionDenied | `from foundry.v2.filesystem.errors import RestoreResourcePermissionDenied` | -**Filesystem** | SpaceNotFound | `from foundry.v2.filesystem.errors import SpaceNotFound` | -**Filesystem** | TemplateGroupNameConflict | `from foundry.v2.filesystem.errors import TemplateGroupNameConflict` | -**Filesystem** | TemplateMarkingNameConflict | `from foundry.v2.filesystem.errors import TemplateMarkingNameConflict` | -**Filesystem** | TrashingAutosavedResourcesNotSupported | `from foundry.v2.filesystem.errors import TrashingAutosavedResourcesNotSupported` | -**Filesystem** | TrashingHiddenResourcesNotSupported | `from foundry.v2.filesystem.errors import TrashingHiddenResourcesNotSupported` | -**Filesystem** | TrashingSpaceNotSupported | `from foundry.v2.filesystem.errors import TrashingSpaceNotSupported` | -**Functions** | ExecuteQueryPermissionDenied | `from foundry.v2.functions.errors import ExecuteQueryPermissionDenied` | -**Functions** | GetByRidQueriesPermissionDenied | `from foundry.v2.functions.errors import GetByRidQueriesPermissionDenied` | -**Functions** | InvalidQueryParameterValue | `from foundry.v2.functions.errors import InvalidQueryParameterValue` | -**Functions** | MissingParameter | `from foundry.v2.functions.errors import MissingParameter` | -**Functions** | QueryEncounteredUserFacingError | `from foundry.v2.functions.errors import QueryEncounteredUserFacingError` | -**Functions** | QueryMemoryExceededLimit | `from foundry.v2.functions.errors import QueryMemoryExceededLimit` | -**Functions** | QueryNotFound | `from foundry.v2.functions.errors import QueryNotFound` | -**Functions** | QueryRuntimeError | `from foundry.v2.functions.errors import QueryRuntimeError` | -**Functions** | QueryTimeExceededLimit | `from foundry.v2.functions.errors import QueryTimeExceededLimit` | -**Functions** | UnknownParameter | `from foundry.v2.functions.errors import UnknownParameter` | -**Functions** | ValueTypeNotFound | `from foundry.v2.functions.errors import ValueTypeNotFound` | -**Functions** | VersionIdNotFound | `from foundry.v2.functions.errors import VersionIdNotFound` | -**MediaSets** | ConflictingMediaSetIdentifiers | `from foundry.v2.media_sets.errors import ConflictingMediaSetIdentifiers` | -**MediaSets** | MediaItemNotFound | `from foundry.v2.media_sets.errors import MediaItemNotFound` | -**Ontologies** | ActionContainsDuplicateEdits | `from foundry.v2.ontologies.errors import ActionContainsDuplicateEdits` | -**Ontologies** | ActionEditedPropertiesNotFound | `from foundry.v2.ontologies.errors import ActionEditedPropertiesNotFound` | -**Ontologies** | ActionEditsReadOnlyEntity | `from foundry.v2.ontologies.errors import ActionEditsReadOnlyEntity` | -**Ontologies** | ActionNotFound | `from foundry.v2.ontologies.errors import ActionNotFound` | -**Ontologies** | ActionParameterInterfaceTypeNotFound | `from foundry.v2.ontologies.errors import ActionParameterInterfaceTypeNotFound` | -**Ontologies** | ActionParameterObjectNotFound | `from foundry.v2.ontologies.errors import ActionParameterObjectNotFound` | -**Ontologies** | ActionParameterObjectTypeNotFound | `from foundry.v2.ontologies.errors import ActionParameterObjectTypeNotFound` | -**Ontologies** | ActionTypeNotFound | `from foundry.v2.ontologies.errors import ActionTypeNotFound` | -**Ontologies** | ActionValidationFailed | `from foundry.v2.ontologies.errors import ActionValidationFailed` | -**Ontologies** | AggregationGroupCountExceededLimit | `from foundry.v2.ontologies.errors import AggregationGroupCountExceededLimit` | -**Ontologies** | AggregationMemoryExceededLimit | `from foundry.v2.ontologies.errors import AggregationMemoryExceededLimit` | -**Ontologies** | AggregationNestedObjectSetSizeExceededLimit | `from foundry.v2.ontologies.errors import AggregationNestedObjectSetSizeExceededLimit` | -**Ontologies** | ApplyActionFailed | `from foundry.v2.ontologies.errors import ApplyActionFailed` | -**Ontologies** | AttachmentNotFound | `from foundry.v2.ontologies.errors import AttachmentNotFound` | -**Ontologies** | AttachmentSizeExceededLimit | `from foundry.v2.ontologies.errors import AttachmentSizeExceededLimit` | -**Ontologies** | CompositePrimaryKeyNotSupported | `from foundry.v2.ontologies.errors import CompositePrimaryKeyNotSupported` | -**Ontologies** | DerivedPropertyApiNamesNotUnique | `from foundry.v2.ontologies.errors import DerivedPropertyApiNamesNotUnique` | -**Ontologies** | DuplicateOrderBy | `from foundry.v2.ontologies.errors import DuplicateOrderBy` | -**Ontologies** | EditObjectPermissionDenied | `from foundry.v2.ontologies.errors import EditObjectPermissionDenied` | -**Ontologies** | FunctionEncounteredUserFacingError | `from foundry.v2.ontologies.errors import FunctionEncounteredUserFacingError` | -**Ontologies** | FunctionExecutionFailed | `from foundry.v2.ontologies.errors import FunctionExecutionFailed` | -**Ontologies** | FunctionExecutionTimedOut | `from foundry.v2.ontologies.errors import FunctionExecutionTimedOut` | -**Ontologies** | FunctionInvalidInput | `from foundry.v2.ontologies.errors import FunctionInvalidInput` | -**Ontologies** | HighScaleComputationNotEnabled | `from foundry.v2.ontologies.errors import HighScaleComputationNotEnabled` | -**Ontologies** | InterfaceTypeNotFound | `from foundry.v2.ontologies.errors import InterfaceTypeNotFound` | -**Ontologies** | InterfaceTypesNotFound | `from foundry.v2.ontologies.errors import InterfaceTypesNotFound` | -**Ontologies** | InvalidAggregationOrdering | `from foundry.v2.ontologies.errors import InvalidAggregationOrdering` | -**Ontologies** | InvalidAggregationRange | `from foundry.v2.ontologies.errors import InvalidAggregationRange` | -**Ontologies** | InvalidAggregationRangePropertyType | `from foundry.v2.ontologies.errors import InvalidAggregationRangePropertyType` | -**Ontologies** | InvalidAggregationRangeValue | `from foundry.v2.ontologies.errors import InvalidAggregationRangeValue` | -**Ontologies** | InvalidApplyActionOptionCombination | `from foundry.v2.ontologies.errors import InvalidApplyActionOptionCombination` | -**Ontologies** | InvalidContentLength | `from foundry.v2.ontologies.errors import InvalidContentLength` | -**Ontologies** | InvalidContentType | `from foundry.v2.ontologies.errors import InvalidContentType` | -**Ontologies** | InvalidDerivedPropertyDefinition | `from foundry.v2.ontologies.errors import InvalidDerivedPropertyDefinition` | -**Ontologies** | InvalidDurationGroupByPropertyType | `from foundry.v2.ontologies.errors import InvalidDurationGroupByPropertyType` | -**Ontologies** | InvalidDurationGroupByValue | `from foundry.v2.ontologies.errors import InvalidDurationGroupByValue` | -**Ontologies** | InvalidFields | `from foundry.v2.ontologies.errors import InvalidFields` | -**Ontologies** | InvalidGroupId | `from foundry.v2.ontologies.errors import InvalidGroupId` | -**Ontologies** | InvalidOrderType | `from foundry.v2.ontologies.errors import InvalidOrderType` | -**Ontologies** | InvalidParameterValue | `from foundry.v2.ontologies.errors import InvalidParameterValue` | -**Ontologies** | InvalidPropertyFiltersCombination | `from foundry.v2.ontologies.errors import InvalidPropertyFiltersCombination` | -**Ontologies** | InvalidPropertyFilterValue | `from foundry.v2.ontologies.errors import InvalidPropertyFilterValue` | -**Ontologies** | InvalidPropertyType | `from foundry.v2.ontologies.errors import InvalidPropertyType` | -**Ontologies** | InvalidPropertyValue | `from foundry.v2.ontologies.errors import InvalidPropertyValue` | -**Ontologies** | InvalidQueryParameterValue | `from foundry.v2.ontologies.errors import InvalidQueryParameterValue` | -**Ontologies** | InvalidRangeQuery | `from foundry.v2.ontologies.errors import InvalidRangeQuery` | -**Ontologies** | InvalidSortOrder | `from foundry.v2.ontologies.errors import InvalidSortOrder` | -**Ontologies** | InvalidSortType | `from foundry.v2.ontologies.errors import InvalidSortType` | -**Ontologies** | InvalidUserId | `from foundry.v2.ontologies.errors import InvalidUserId` | -**Ontologies** | LinkAlreadyExists | `from foundry.v2.ontologies.errors import LinkAlreadyExists` | -**Ontologies** | LinkedObjectNotFound | `from foundry.v2.ontologies.errors import LinkedObjectNotFound` | -**Ontologies** | LinkTypeNotFound | `from foundry.v2.ontologies.errors import LinkTypeNotFound` | -**Ontologies** | MalformedPropertyFilters | `from foundry.v2.ontologies.errors import MalformedPropertyFilters` | -**Ontologies** | MarketplaceActionMappingNotFound | `from foundry.v2.ontologies.errors import MarketplaceActionMappingNotFound` | -**Ontologies** | MarketplaceInstallationNotFound | `from foundry.v2.ontologies.errors import MarketplaceInstallationNotFound` | -**Ontologies** | MarketplaceLinkMappingNotFound | `from foundry.v2.ontologies.errors import MarketplaceLinkMappingNotFound` | -**Ontologies** | MarketplaceObjectMappingNotFound | `from foundry.v2.ontologies.errors import MarketplaceObjectMappingNotFound` | -**Ontologies** | MarketplaceQueryMappingNotFound | `from foundry.v2.ontologies.errors import MarketplaceQueryMappingNotFound` | -**Ontologies** | MissingParameter | `from foundry.v2.ontologies.errors import MissingParameter` | -**Ontologies** | MultipleGroupByOnFieldNotSupported | `from foundry.v2.ontologies.errors import MultipleGroupByOnFieldNotSupported` | -**Ontologies** | MultiplePropertyValuesNotSupported | `from foundry.v2.ontologies.errors import MultiplePropertyValuesNotSupported` | -**Ontologies** | ObjectAlreadyExists | `from foundry.v2.ontologies.errors import ObjectAlreadyExists` | -**Ontologies** | ObjectChanged | `from foundry.v2.ontologies.errors import ObjectChanged` | -**Ontologies** | ObjectNotFound | `from foundry.v2.ontologies.errors import ObjectNotFound` | -**Ontologies** | ObjectSetNotFound | `from foundry.v2.ontologies.errors import ObjectSetNotFound` | -**Ontologies** | ObjectsExceededLimit | `from foundry.v2.ontologies.errors import ObjectsExceededLimit` | -**Ontologies** | ObjectTypeNotFound | `from foundry.v2.ontologies.errors import ObjectTypeNotFound` | -**Ontologies** | ObjectTypeNotSynced | `from foundry.v2.ontologies.errors import ObjectTypeNotSynced` | -**Ontologies** | ObjectTypesNotSynced | `from foundry.v2.ontologies.errors import ObjectTypesNotSynced` | -**Ontologies** | OntologyApiNameNotUnique | `from foundry.v2.ontologies.errors import OntologyApiNameNotUnique` | -**Ontologies** | OntologyEditsExceededLimit | `from foundry.v2.ontologies.errors import OntologyEditsExceededLimit` | -**Ontologies** | OntologyNotFound | `from foundry.v2.ontologies.errors import OntologyNotFound` | -**Ontologies** | OntologySyncing | `from foundry.v2.ontologies.errors import OntologySyncing` | -**Ontologies** | OntologySyncingObjectTypes | `from foundry.v2.ontologies.errors import OntologySyncingObjectTypes` | -**Ontologies** | ParameterObjectNotFound | `from foundry.v2.ontologies.errors import ParameterObjectNotFound` | -**Ontologies** | ParameterObjectSetRidNotFound | `from foundry.v2.ontologies.errors import ParameterObjectSetRidNotFound` | -**Ontologies** | ParametersNotFound | `from foundry.v2.ontologies.errors import ParametersNotFound` | -**Ontologies** | ParameterTypeNotSupported | `from foundry.v2.ontologies.errors import ParameterTypeNotSupported` | -**Ontologies** | ParentAttachmentPermissionDenied | `from foundry.v2.ontologies.errors import ParentAttachmentPermissionDenied` | -**Ontologies** | PropertiesHaveDifferentIds | `from foundry.v2.ontologies.errors import PropertiesHaveDifferentIds` | -**Ontologies** | PropertiesNotFilterable | `from foundry.v2.ontologies.errors import PropertiesNotFilterable` | -**Ontologies** | PropertiesNotFound | `from foundry.v2.ontologies.errors import PropertiesNotFound` | -**Ontologies** | PropertiesNotSearchable | `from foundry.v2.ontologies.errors import PropertiesNotSearchable` | -**Ontologies** | PropertiesNotSortable | `from foundry.v2.ontologies.errors import PropertiesNotSortable` | -**Ontologies** | PropertyApiNameNotFound | `from foundry.v2.ontologies.errors import PropertyApiNameNotFound` | -**Ontologies** | PropertyBaseTypeNotSupported | `from foundry.v2.ontologies.errors import PropertyBaseTypeNotSupported` | -**Ontologies** | PropertyFiltersNotSupported | `from foundry.v2.ontologies.errors import PropertyFiltersNotSupported` | -**Ontologies** | PropertyNotFound | `from foundry.v2.ontologies.errors import PropertyNotFound` | -**Ontologies** | PropertyTypeDoesNotSupportNearestNeighbors | `from foundry.v2.ontologies.errors import PropertyTypeDoesNotSupportNearestNeighbors` | -**Ontologies** | PropertyTypeNotFound | `from foundry.v2.ontologies.errors import PropertyTypeNotFound` | -**Ontologies** | PropertyTypesSearchNotSupported | `from foundry.v2.ontologies.errors import PropertyTypesSearchNotSupported` | -**Ontologies** | QueryEncounteredUserFacingError | `from foundry.v2.ontologies.errors import QueryEncounteredUserFacingError` | -**Ontologies** | QueryMemoryExceededLimit | `from foundry.v2.ontologies.errors import QueryMemoryExceededLimit` | -**Ontologies** | QueryNotFound | `from foundry.v2.ontologies.errors import QueryNotFound` | -**Ontologies** | QueryRuntimeError | `from foundry.v2.ontologies.errors import QueryRuntimeError` | -**Ontologies** | QueryTimeExceededLimit | `from foundry.v2.ontologies.errors import QueryTimeExceededLimit` | -**Ontologies** | SearchVectorDimensionsDiffer | `from foundry.v2.ontologies.errors import SearchVectorDimensionsDiffer` | -**Ontologies** | SharedPropertiesNotFound | `from foundry.v2.ontologies.errors import SharedPropertiesNotFound` | -**Ontologies** | SharedPropertyTypeNotFound | `from foundry.v2.ontologies.errors import SharedPropertyTypeNotFound` | -**Ontologies** | TooManyNearestNeighborsRequested | `from foundry.v2.ontologies.errors import TooManyNearestNeighborsRequested` | -**Ontologies** | UnknownParameter | `from foundry.v2.ontologies.errors import UnknownParameter` | -**Ontologies** | UnsupportedObjectSet | `from foundry.v2.ontologies.errors import UnsupportedObjectSet` | -**Ontologies** | ViewObjectPermissionDenied | `from foundry.v2.ontologies.errors import ViewObjectPermissionDenied` | -**Orchestration** | BuildInputsNotFound | `from foundry.v2.orchestration.errors import BuildInputsNotFound` | -**Orchestration** | BuildInputsPermissionDenied | `from foundry.v2.orchestration.errors import BuildInputsPermissionDenied` | -**Orchestration** | BuildNotFound | `from foundry.v2.orchestration.errors import BuildNotFound` | -**Orchestration** | BuildTargetsMissingJobSpecs | `from foundry.v2.orchestration.errors import BuildTargetsMissingJobSpecs` | -**Orchestration** | BuildTargetsNotFound | `from foundry.v2.orchestration.errors import BuildTargetsNotFound` | -**Orchestration** | BuildTargetsPermissionDenied | `from foundry.v2.orchestration.errors import BuildTargetsPermissionDenied` | -**Orchestration** | BuildTargetsResolutionError | `from foundry.v2.orchestration.errors import BuildTargetsResolutionError` | -**Orchestration** | BuildTargetsUpToDate | `from foundry.v2.orchestration.errors import BuildTargetsUpToDate` | -**Orchestration** | CancelBuildPermissionDenied | `from foundry.v2.orchestration.errors import CancelBuildPermissionDenied` | -**Orchestration** | CreateBuildPermissionDenied | `from foundry.v2.orchestration.errors import CreateBuildPermissionDenied` | -**Orchestration** | CreateSchedulePermissionDenied | `from foundry.v2.orchestration.errors import CreateSchedulePermissionDenied` | -**Orchestration** | DeleteSchedulePermissionDenied | `from foundry.v2.orchestration.errors import DeleteSchedulePermissionDenied` | -**Orchestration** | InvalidAndTrigger | `from foundry.v2.orchestration.errors import InvalidAndTrigger` | -**Orchestration** | InvalidMediaSetTrigger | `from foundry.v2.orchestration.errors import InvalidMediaSetTrigger` | -**Orchestration** | InvalidOrTrigger | `from foundry.v2.orchestration.errors import InvalidOrTrigger` | -**Orchestration** | InvalidScheduleDescription | `from foundry.v2.orchestration.errors import InvalidScheduleDescription` | -**Orchestration** | InvalidScheduleName | `from foundry.v2.orchestration.errors import InvalidScheduleName` | -**Orchestration** | InvalidTimeTrigger | `from foundry.v2.orchestration.errors import InvalidTimeTrigger` | -**Orchestration** | JobNotFound | `from foundry.v2.orchestration.errors import JobNotFound` | -**Orchestration** | MissingBuildTargets | `from foundry.v2.orchestration.errors import MissingBuildTargets` | -**Orchestration** | MissingConnectingBuildInputs | `from foundry.v2.orchestration.errors import MissingConnectingBuildInputs` | -**Orchestration** | MissingTrigger | `from foundry.v2.orchestration.errors import MissingTrigger` | -**Orchestration** | PauseSchedulePermissionDenied | `from foundry.v2.orchestration.errors import PauseSchedulePermissionDenied` | -**Orchestration** | ReplaceSchedulePermissionDenied | `from foundry.v2.orchestration.errors import ReplaceSchedulePermissionDenied` | -**Orchestration** | RunSchedulePermissionDenied | `from foundry.v2.orchestration.errors import RunSchedulePermissionDenied` | -**Orchestration** | ScheduleNotFound | `from foundry.v2.orchestration.errors import ScheduleNotFound` | -**Orchestration** | ScheduleTriggerResourcesNotFound | `from foundry.v2.orchestration.errors import ScheduleTriggerResourcesNotFound` | -**Orchestration** | ScheduleTriggerResourcesPermissionDenied | `from foundry.v2.orchestration.errors import ScheduleTriggerResourcesPermissionDenied` | -**Orchestration** | ScheduleVersionNotFound | `from foundry.v2.orchestration.errors import ScheduleVersionNotFound` | -**Orchestration** | SearchBuildsPermissionDenied | `from foundry.v2.orchestration.errors import SearchBuildsPermissionDenied` | -**Orchestration** | TargetNotSupported | `from foundry.v2.orchestration.errors import TargetNotSupported` | -**Orchestration** | UnpauseSchedulePermissionDenied | `from foundry.v2.orchestration.errors import UnpauseSchedulePermissionDenied` | -**SqlQueries** | CancelQueryPermissionDenied | `from foundry.v2.sql_queries.errors import CancelQueryPermissionDenied` | -**SqlQueries** | ExecuteQueryPermissionDenied | `from foundry.v2.sql_queries.errors import ExecuteQueryPermissionDenied` | -**SqlQueries** | GetResultsPermissionDenied | `from foundry.v2.sql_queries.errors import GetResultsPermissionDenied` | -**SqlQueries** | GetStatusPermissionDenied | `from foundry.v2.sql_queries.errors import GetStatusPermissionDenied` | -**SqlQueries** | QueryCanceled | `from foundry.v2.sql_queries.errors import QueryCanceled` | -**SqlQueries** | QueryFailed | `from foundry.v2.sql_queries.errors import QueryFailed` | -**SqlQueries** | QueryParseError | `from foundry.v2.sql_queries.errors import QueryParseError` | -**SqlQueries** | QueryPermissionDenied | `from foundry.v2.sql_queries.errors import QueryPermissionDenied` | -**SqlQueries** | QueryRunning | `from foundry.v2.sql_queries.errors import QueryRunning` | -**SqlQueries** | ReadQueryInputsPermissionDenied | `from foundry.v2.sql_queries.errors import ReadQueryInputsPermissionDenied` | -**Streams** | CannotCreateStreamingDatasetInUserFolder | `from foundry.v2.streams.errors import CannotCreateStreamingDatasetInUserFolder` | -**Streams** | CannotWriteToTrashedStream | `from foundry.v2.streams.errors import CannotWriteToTrashedStream` | -**Streams** | CreateStreamingDatasetPermissionDenied | `from foundry.v2.streams.errors import CreateStreamingDatasetPermissionDenied` | -**Streams** | CreateStreamPermissionDenied | `from foundry.v2.streams.errors import CreateStreamPermissionDenied` | -**Streams** | FailedToProcessBinaryRecord | `from foundry.v2.streams.errors import FailedToProcessBinaryRecord` | -**Streams** | InvalidStreamNoSchema | `from foundry.v2.streams.errors import InvalidStreamNoSchema` | -**Streams** | InvalidStreamType | `from foundry.v2.streams.errors import InvalidStreamType` | -**Streams** | PublishBinaryRecordToStreamPermissionDenied | `from foundry.v2.streams.errors import PublishBinaryRecordToStreamPermissionDenied` | -**Streams** | PublishRecordsToStreamPermissionDenied | `from foundry.v2.streams.errors import PublishRecordsToStreamPermissionDenied` | -**Streams** | PublishRecordToStreamPermissionDenied | `from foundry.v2.streams.errors import PublishRecordToStreamPermissionDenied` | -**Streams** | RecordDoesNotMatchStreamSchema | `from foundry.v2.streams.errors import RecordDoesNotMatchStreamSchema` | -**Streams** | RecordTooLarge | `from foundry.v2.streams.errors import RecordTooLarge` | -**Streams** | ResetStreamPermissionDenied | `from foundry.v2.streams.errors import ResetStreamPermissionDenied` | -**Streams** | StreamNotFound | `from foundry.v2.streams.errors import StreamNotFound` | -**Streams** | ViewNotFound | `from foundry.v2.streams.errors import ViewNotFound` | -**ThirdPartyApplications** | CannotDeleteDeployedVersion | `from foundry.v2.third_party_applications.errors import CannotDeleteDeployedVersion` | -**ThirdPartyApplications** | DeleteVersionPermissionDenied | `from foundry.v2.third_party_applications.errors import DeleteVersionPermissionDenied` | -**ThirdPartyApplications** | DeployWebsitePermissionDenied | `from foundry.v2.third_party_applications.errors import DeployWebsitePermissionDenied` | -**ThirdPartyApplications** | FileCountLimitExceeded | `from foundry.v2.third_party_applications.errors import FileCountLimitExceeded` | -**ThirdPartyApplications** | FileSizeLimitExceeded | `from foundry.v2.third_party_applications.errors import FileSizeLimitExceeded` | -**ThirdPartyApplications** | InvalidVersion | `from foundry.v2.third_party_applications.errors import InvalidVersion` | -**ThirdPartyApplications** | ThirdPartyApplicationNotFound | `from foundry.v2.third_party_applications.errors import ThirdPartyApplicationNotFound` | -**ThirdPartyApplications** | UndeployWebsitePermissionDenied | `from foundry.v2.third_party_applications.errors import UndeployWebsitePermissionDenied` | -**ThirdPartyApplications** | UploadSnapshotVersionPermissionDenied | `from foundry.v2.third_party_applications.errors import UploadSnapshotVersionPermissionDenied` | -**ThirdPartyApplications** | UploadVersionPermissionDenied | `from foundry.v2.third_party_applications.errors import UploadVersionPermissionDenied` | -**ThirdPartyApplications** | VersionAlreadyExists | `from foundry.v2.third_party_applications.errors import VersionAlreadyExists` | -**ThirdPartyApplications** | VersionLimitExceeded | `from foundry.v2.third_party_applications.errors import VersionLimitExceeded` | -**ThirdPartyApplications** | VersionNotFound | `from foundry.v2.third_party_applications.errors import VersionNotFound` | -**ThirdPartyApplications** | WebsiteNotFound | `from foundry.v2.third_party_applications.errors import WebsiteNotFound` | +**Admin** | AddGroupMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import AddGroupMembersPermissionDenied` | +**Admin** | AddMarkingMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import AddMarkingMembersPermissionDenied` | +**Admin** | AddMarkingRoleAssignmentsPermissionDenied | `from foundry_sdk.v2.admin.errors import AddMarkingRoleAssignmentsPermissionDenied` | +**Admin** | AuthenticationProviderNotFound | `from foundry_sdk.v2.admin.errors import AuthenticationProviderNotFound` | +**Admin** | CannotReplaceProviderInfoForPrincipalInProtectedRealm | `from foundry_sdk.v2.admin.errors import CannotReplaceProviderInfoForPrincipalInProtectedRealm` | +**Admin** | CreateGroupPermissionDenied | `from foundry_sdk.v2.admin.errors import CreateGroupPermissionDenied` | +**Admin** | CreateMarkingMissingInitialAdminRole | `from foundry_sdk.v2.admin.errors import CreateMarkingMissingInitialAdminRole` | +**Admin** | CreateMarkingNameInCategoryAlreadyExists | `from foundry_sdk.v2.admin.errors import CreateMarkingNameInCategoryAlreadyExists` | +**Admin** | CreateMarkingPermissionDenied | `from foundry_sdk.v2.admin.errors import CreateMarkingPermissionDenied` | +**Admin** | DeleteGroupPermissionDenied | `from foundry_sdk.v2.admin.errors import DeleteGroupPermissionDenied` | +**Admin** | DeleteUserPermissionDenied | `from foundry_sdk.v2.admin.errors import DeleteUserPermissionDenied` | +**Admin** | EnrollmentNotFound | `from foundry_sdk.v2.admin.errors import EnrollmentNotFound` | +**Admin** | GetCurrentEnrollmentPermissionDenied | `from foundry_sdk.v2.admin.errors import GetCurrentEnrollmentPermissionDenied` | +**Admin** | GetCurrentUserPermissionDenied | `from foundry_sdk.v2.admin.errors import GetCurrentUserPermissionDenied` | +**Admin** | GetGroupProviderInfoPermissionDenied | `from foundry_sdk.v2.admin.errors import GetGroupProviderInfoPermissionDenied` | +**Admin** | GetMarkingCategoryPermissionDenied | `from foundry_sdk.v2.admin.errors import GetMarkingCategoryPermissionDenied` | +**Admin** | GetMarkingPermissionDenied | `from foundry_sdk.v2.admin.errors import GetMarkingPermissionDenied` | +**Admin** | GetMarkingsUserPermissionDenied | `from foundry_sdk.v2.admin.errors import GetMarkingsUserPermissionDenied` | +**Admin** | GetProfilePictureOfUserPermissionDenied | `from foundry_sdk.v2.admin.errors import GetProfilePictureOfUserPermissionDenied` | +**Admin** | GetUserProviderInfoPermissionDenied | `from foundry_sdk.v2.admin.errors import GetUserProviderInfoPermissionDenied` | +**Admin** | GroupNameAlreadyExists | `from foundry_sdk.v2.admin.errors import GroupNameAlreadyExists` | +**Admin** | GroupNotFound | `from foundry_sdk.v2.admin.errors import GroupNotFound` | +**Admin** | GroupProviderInfoNotFound | `from foundry_sdk.v2.admin.errors import GroupProviderInfoNotFound` | +**Admin** | InvalidGroupMembershipExpiration | `from foundry_sdk.v2.admin.errors import InvalidGroupMembershipExpiration` | +**Admin** | InvalidGroupOrganizations | `from foundry_sdk.v2.admin.errors import InvalidGroupOrganizations` | +**Admin** | InvalidHostName | `from foundry_sdk.v2.admin.errors import InvalidHostName` | +**Admin** | InvalidProfilePicture | `from foundry_sdk.v2.admin.errors import InvalidProfilePicture` | +**Admin** | ListHostsPermissionDenied | `from foundry_sdk.v2.admin.errors import ListHostsPermissionDenied` | +**Admin** | ListMarkingMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import ListMarkingMembersPermissionDenied` | +**Admin** | ListMarkingRoleAssignmentsPermissionDenied | `from foundry_sdk.v2.admin.errors import ListMarkingRoleAssignmentsPermissionDenied` | +**Admin** | MarkingCategoryNotFound | `from foundry_sdk.v2.admin.errors import MarkingCategoryNotFound` | +**Admin** | MarkingNotFound | `from foundry_sdk.v2.admin.errors import MarkingNotFound` | +**Admin** | OrganizationNotFound | `from foundry_sdk.v2.admin.errors import OrganizationNotFound` | +**Admin** | PreregisterGroupPermissionDenied | `from foundry_sdk.v2.admin.errors import PreregisterGroupPermissionDenied` | +**Admin** | PreregisterUserPermissionDenied | `from foundry_sdk.v2.admin.errors import PreregisterUserPermissionDenied` | +**Admin** | PrincipalNotFound | `from foundry_sdk.v2.admin.errors import PrincipalNotFound` | +**Admin** | ProfilePictureNotFound | `from foundry_sdk.v2.admin.errors import ProfilePictureNotFound` | +**Admin** | RemoveGroupMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import RemoveGroupMembersPermissionDenied` | +**Admin** | RemoveMarkingMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import RemoveMarkingMembersPermissionDenied` | +**Admin** | RemoveMarkingRoleAssignmentsPermissionDenied | `from foundry_sdk.v2.admin.errors import RemoveMarkingRoleAssignmentsPermissionDenied` | +**Admin** | RemoveMarkingRoleAssignmentsRemoveAllAdministratorsNotAllowed | `from foundry_sdk.v2.admin.errors import RemoveMarkingRoleAssignmentsRemoveAllAdministratorsNotAllowed` | +**Admin** | ReplaceGroupProviderInfoPermissionDenied | `from foundry_sdk.v2.admin.errors import ReplaceGroupProviderInfoPermissionDenied` | +**Admin** | ReplaceOrganizationPermissionDenied | `from foundry_sdk.v2.admin.errors import ReplaceOrganizationPermissionDenied` | +**Admin** | ReplaceUserProviderInfoPermissionDenied | `from foundry_sdk.v2.admin.errors import ReplaceUserProviderInfoPermissionDenied` | +**Admin** | SearchGroupsPermissionDenied | `from foundry_sdk.v2.admin.errors import SearchGroupsPermissionDenied` | +**Admin** | SearchUsersPermissionDenied | `from foundry_sdk.v2.admin.errors import SearchUsersPermissionDenied` | +**Admin** | UserNotFound | `from foundry_sdk.v2.admin.errors import UserNotFound` | +**Admin** | UserProviderInfoNotFound | `from foundry_sdk.v2.admin.errors import UserProviderInfoNotFound` | +**AipAgents** | AgentIterationsExceededLimit | `from foundry_sdk.v2.aip_agents.errors import AgentIterationsExceededLimit` | +**AipAgents** | AgentNotFound | `from foundry_sdk.v2.aip_agents.errors import AgentNotFound` | +**AipAgents** | AgentVersionNotFound | `from foundry_sdk.v2.aip_agents.errors import AgentVersionNotFound` | +**AipAgents** | BlockingContinueSessionPermissionDenied | `from foundry_sdk.v2.aip_agents.errors import BlockingContinueSessionPermissionDenied` | +**AipAgents** | CancelSessionFailedMessageNotInProgress | `from foundry_sdk.v2.aip_agents.errors import CancelSessionFailedMessageNotInProgress` | +**AipAgents** | CancelSessionPermissionDenied | `from foundry_sdk.v2.aip_agents.errors import CancelSessionPermissionDenied` | +**AipAgents** | ContentNotFound | `from foundry_sdk.v2.aip_agents.errors import ContentNotFound` | +**AipAgents** | ContextSizeExceededLimit | `from foundry_sdk.v2.aip_agents.errors import ContextSizeExceededLimit` | +**AipAgents** | CreateSessionPermissionDenied | `from foundry_sdk.v2.aip_agents.errors import CreateSessionPermissionDenied` | +**AipAgents** | FunctionLocatorNotFound | `from foundry_sdk.v2.aip_agents.errors import FunctionLocatorNotFound` | +**AipAgents** | GetAllSessionsAgentsPermissionDenied | `from foundry_sdk.v2.aip_agents.errors import GetAllSessionsAgentsPermissionDenied` | +**AipAgents** | GetRagContextForSessionPermissionDenied | `from foundry_sdk.v2.aip_agents.errors import GetRagContextForSessionPermissionDenied` | +**AipAgents** | InvalidAgentVersion | `from foundry_sdk.v2.aip_agents.errors import InvalidAgentVersion` | +**AipAgents** | InvalidParameter | `from foundry_sdk.v2.aip_agents.errors import InvalidParameter` | +**AipAgents** | InvalidParameterType | `from foundry_sdk.v2.aip_agents.errors import InvalidParameterType` | +**AipAgents** | ListSessionsForAgentsPermissionDenied | `from foundry_sdk.v2.aip_agents.errors import ListSessionsForAgentsPermissionDenied` | +**AipAgents** | NoPublishedAgentVersion | `from foundry_sdk.v2.aip_agents.errors import NoPublishedAgentVersion` | +**AipAgents** | ObjectTypeIdsNotFound | `from foundry_sdk.v2.aip_agents.errors import ObjectTypeIdsNotFound` | +**AipAgents** | ObjectTypeRidsNotFound | `from foundry_sdk.v2.aip_agents.errors import ObjectTypeRidsNotFound` | +**AipAgents** | RateLimitExceeded | `from foundry_sdk.v2.aip_agents.errors import RateLimitExceeded` | +**AipAgents** | SessionExecutionFailed | `from foundry_sdk.v2.aip_agents.errors import SessionExecutionFailed` | +**AipAgents** | SessionNotFound | `from foundry_sdk.v2.aip_agents.errors import SessionNotFound` | +**AipAgents** | StreamingContinueSessionPermissionDenied | `from foundry_sdk.v2.aip_agents.errors import StreamingContinueSessionPermissionDenied` | +**AipAgents** | UpdateSessionTitlePermissionDenied | `from foundry_sdk.v2.aip_agents.errors import UpdateSessionTitlePermissionDenied` | +**Connectivity** | AdditionalSecretsMustBeSpecifiedAsPlaintextValueMap | `from foundry_sdk.v2.connectivity.errors import AdditionalSecretsMustBeSpecifiedAsPlaintextValueMap` | +**Connectivity** | ChangingBranchNameNotSupportedForImports | `from foundry_sdk.v2.connectivity.errors import ChangingBranchNameNotSupportedForImports` | +**Connectivity** | ChangingOutputDatasetNotSupportedForImports | `from foundry_sdk.v2.connectivity.errors import ChangingOutputDatasetNotSupportedForImports` | +**Connectivity** | ConnectionDetailsNotDetermined | `from foundry_sdk.v2.connectivity.errors import ConnectionDetailsNotDetermined` | +**Connectivity** | ConnectionNotFound | `from foundry_sdk.v2.connectivity.errors import ConnectionNotFound` | +**Connectivity** | ConnectionTypeNotSupported | `from foundry_sdk.v2.connectivity.errors import ConnectionTypeNotSupported` | +**Connectivity** | CreateConnectionPermissionDenied | `from foundry_sdk.v2.connectivity.errors import CreateConnectionPermissionDenied` | +**Connectivity** | CreateFileImportPermissionDenied | `from foundry_sdk.v2.connectivity.errors import CreateFileImportPermissionDenied` | +**Connectivity** | CreateTableImportPermissionDenied | `from foundry_sdk.v2.connectivity.errors import CreateTableImportPermissionDenied` | +**Connectivity** | DeleteFileImportPermissionDenied | `from foundry_sdk.v2.connectivity.errors import DeleteFileImportPermissionDenied` | +**Connectivity** | DeleteTableImportPermissionDenied | `from foundry_sdk.v2.connectivity.errors import DeleteTableImportPermissionDenied` | +**Connectivity** | DomainMustUseHttpsWithAuthentication | `from foundry_sdk.v2.connectivity.errors import DomainMustUseHttpsWithAuthentication` | +**Connectivity** | EncryptedPropertyMustBeSpecifiedAsPlaintextValue | `from foundry_sdk.v2.connectivity.errors import EncryptedPropertyMustBeSpecifiedAsPlaintextValue` | +**Connectivity** | ExecuteFileImportPermissionDenied | `from foundry_sdk.v2.connectivity.errors import ExecuteFileImportPermissionDenied` | +**Connectivity** | ExecuteTableImportPermissionDenied | `from foundry_sdk.v2.connectivity.errors import ExecuteTableImportPermissionDenied` | +**Connectivity** | FileAtLeastCountFilterInvalidMinCount | `from foundry_sdk.v2.connectivity.errors import FileAtLeastCountFilterInvalidMinCount` | +**Connectivity** | FileImportCustomFilterCannotBeUsedToCreateOrUpdateFileImports | `from foundry_sdk.v2.connectivity.errors import FileImportCustomFilterCannotBeUsedToCreateOrUpdateFileImports` | +**Connectivity** | FileImportNotFound | `from foundry_sdk.v2.connectivity.errors import FileImportNotFound` | +**Connectivity** | FileImportNotSupportedForConnection | `from foundry_sdk.v2.connectivity.errors import FileImportNotSupportedForConnection` | +**Connectivity** | FilesCountLimitFilterInvalidLimit | `from foundry_sdk.v2.connectivity.errors import FilesCountLimitFilterInvalidLimit` | +**Connectivity** | FileSizeFilterGreaterThanCannotBeNegative | `from foundry_sdk.v2.connectivity.errors import FileSizeFilterGreaterThanCannotBeNegative` | +**Connectivity** | FileSizeFilterInvalidGreaterThanAndLessThanRange | `from foundry_sdk.v2.connectivity.errors import FileSizeFilterInvalidGreaterThanAndLessThanRange` | +**Connectivity** | FileSizeFilterLessThanMustBeOneByteOrLarger | `from foundry_sdk.v2.connectivity.errors import FileSizeFilterLessThanMustBeOneByteOrLarger` | +**Connectivity** | FileSizeFilterMissingGreaterThanAndLessThan | `from foundry_sdk.v2.connectivity.errors import FileSizeFilterMissingGreaterThanAndLessThan` | +**Connectivity** | GetConfigurationPermissionDenied | `from foundry_sdk.v2.connectivity.errors import GetConfigurationPermissionDenied` | +**Connectivity** | ParentFolderNotFoundForConnection | `from foundry_sdk.v2.connectivity.errors import ParentFolderNotFoundForConnection` | +**Connectivity** | PropertyCannotBeBlank | `from foundry_sdk.v2.connectivity.errors import PropertyCannotBeBlank` | +**Connectivity** | PropertyCannotBeEmpty | `from foundry_sdk.v2.connectivity.errors import PropertyCannotBeEmpty` | +**Connectivity** | ReplaceFileImportPermissionDenied | `from foundry_sdk.v2.connectivity.errors import ReplaceFileImportPermissionDenied` | +**Connectivity** | SecretNamesDoNotExist | `from foundry_sdk.v2.connectivity.errors import SecretNamesDoNotExist` | +**Connectivity** | TableImportNotFound | `from foundry_sdk.v2.connectivity.errors import TableImportNotFound` | +**Connectivity** | TableImportNotSupportedForConnection | `from foundry_sdk.v2.connectivity.errors import TableImportNotSupportedForConnection` | +**Connectivity** | TableImportTypeNotSupported | `from foundry_sdk.v2.connectivity.errors import TableImportTypeNotSupported` | +**Connectivity** | UpdateSecretsForConnectionPermissionDenied | `from foundry_sdk.v2.connectivity.errors import UpdateSecretsForConnectionPermissionDenied` | +**Core** | ApiFeaturePreviewUsageOnly | `from foundry_sdk.v2.core.errors import ApiFeaturePreviewUsageOnly` | +**Core** | ApiUsageDenied | `from foundry_sdk.v2.core.errors import ApiUsageDenied` | +**Core** | BatchRequestSizeExceededLimit | `from foundry_sdk.v2.core.errors import BatchRequestSizeExceededLimit` | +**Core** | FolderNotFound | `from foundry_sdk.v2.core.errors import FolderNotFound` | +**Core** | InvalidAndFilter | `from foundry_sdk.v2.core.errors import InvalidAndFilter` | +**Core** | InvalidChangeDataCaptureConfiguration | `from foundry_sdk.v2.core.errors import InvalidChangeDataCaptureConfiguration` | +**Core** | InvalidFieldSchema | `from foundry_sdk.v2.core.errors import InvalidFieldSchema` | +**Core** | InvalidFilterValue | `from foundry_sdk.v2.core.errors import InvalidFilterValue` | +**Core** | InvalidOrFilter | `from foundry_sdk.v2.core.errors import InvalidOrFilter` | +**Core** | InvalidPageSize | `from foundry_sdk.v2.core.errors import InvalidPageSize` | +**Core** | InvalidPageToken | `from foundry_sdk.v2.core.errors import InvalidPageToken` | +**Core** | InvalidParameterCombination | `from foundry_sdk.v2.core.errors import InvalidParameterCombination` | +**Core** | InvalidSchema | `from foundry_sdk.v2.core.errors import InvalidSchema` | +**Core** | InvalidTimeZone | `from foundry_sdk.v2.core.errors import InvalidTimeZone` | +**Core** | MissingBatchRequest | `from foundry_sdk.v2.core.errors import MissingBatchRequest` | +**Core** | MissingPostBody | `from foundry_sdk.v2.core.errors import MissingPostBody` | +**Core** | ResourceNameAlreadyExists | `from foundry_sdk.v2.core.errors import ResourceNameAlreadyExists` | +**Core** | SchemaIsNotStreamSchema | `from foundry_sdk.v2.core.errors import SchemaIsNotStreamSchema` | +**Core** | UnknownDistanceUnit | `from foundry_sdk.v2.core.errors import UnknownDistanceUnit` | +**Datasets** | AbortTransactionPermissionDenied | `from foundry_sdk.v2.datasets.errors import AbortTransactionPermissionDenied` | +**Datasets** | BranchAlreadyExists | `from foundry_sdk.v2.datasets.errors import BranchAlreadyExists` | +**Datasets** | BranchNotFound | `from foundry_sdk.v2.datasets.errors import BranchNotFound` | +**Datasets** | BuildTransactionPermissionDenied | `from foundry_sdk.v2.datasets.errors import BuildTransactionPermissionDenied` | +**Datasets** | ColumnTypesNotSupported | `from foundry_sdk.v2.datasets.errors import ColumnTypesNotSupported` | +**Datasets** | CommitTransactionPermissionDenied | `from foundry_sdk.v2.datasets.errors import CommitTransactionPermissionDenied` | +**Datasets** | CreateBranchPermissionDenied | `from foundry_sdk.v2.datasets.errors import CreateBranchPermissionDenied` | +**Datasets** | CreateDatasetPermissionDenied | `from foundry_sdk.v2.datasets.errors import CreateDatasetPermissionDenied` | +**Datasets** | CreateTransactionPermissionDenied | `from foundry_sdk.v2.datasets.errors import CreateTransactionPermissionDenied` | +**Datasets** | DatasetNotFound | `from foundry_sdk.v2.datasets.errors import DatasetNotFound` | +**Datasets** | DatasetReadNotSupported | `from foundry_sdk.v2.datasets.errors import DatasetReadNotSupported` | +**Datasets** | DeleteBranchPermissionDenied | `from foundry_sdk.v2.datasets.errors import DeleteBranchPermissionDenied` | +**Datasets** | DeleteFilePermissionDenied | `from foundry_sdk.v2.datasets.errors import DeleteFilePermissionDenied` | +**Datasets** | DeleteSchemaPermissionDenied | `from foundry_sdk.v2.datasets.errors import DeleteSchemaPermissionDenied` | +**Datasets** | FileAlreadyExists | `from foundry_sdk.v2.datasets.errors import FileAlreadyExists` | +**Datasets** | FileNotFound | `from foundry_sdk.v2.datasets.errors import FileNotFound` | +**Datasets** | FileNotFoundOnBranch | `from foundry_sdk.v2.datasets.errors import FileNotFoundOnBranch` | +**Datasets** | FileNotFoundOnTransactionRange | `from foundry_sdk.v2.datasets.errors import FileNotFoundOnTransactionRange` | +**Datasets** | GetFileContentPermissionDenied | `from foundry_sdk.v2.datasets.errors import GetFileContentPermissionDenied` | +**Datasets** | InvalidBranchName | `from foundry_sdk.v2.datasets.errors import InvalidBranchName` | +**Datasets** | InvalidTransactionType | `from foundry_sdk.v2.datasets.errors import InvalidTransactionType` | +**Datasets** | JobTransactionPermissionDenied | `from foundry_sdk.v2.datasets.errors import JobTransactionPermissionDenied` | +**Datasets** | OpenTransactionAlreadyExists | `from foundry_sdk.v2.datasets.errors import OpenTransactionAlreadyExists` | +**Datasets** | PutSchemaPermissionDenied | `from foundry_sdk.v2.datasets.errors import PutSchemaPermissionDenied` | +**Datasets** | ReadTableDatasetPermissionDenied | `from foundry_sdk.v2.datasets.errors import ReadTableDatasetPermissionDenied` | +**Datasets** | ReadTableError | `from foundry_sdk.v2.datasets.errors import ReadTableError` | +**Datasets** | ReadTableRowLimitExceeded | `from foundry_sdk.v2.datasets.errors import ReadTableRowLimitExceeded` | +**Datasets** | ReadTableTimeout | `from foundry_sdk.v2.datasets.errors import ReadTableTimeout` | +**Datasets** | SchemaNotFound | `from foundry_sdk.v2.datasets.errors import SchemaNotFound` | +**Datasets** | TransactionNotCommitted | `from foundry_sdk.v2.datasets.errors import TransactionNotCommitted` | +**Datasets** | TransactionNotFound | `from foundry_sdk.v2.datasets.errors import TransactionNotFound` | +**Datasets** | TransactionNotOpen | `from foundry_sdk.v2.datasets.errors import TransactionNotOpen` | +**Datasets** | UploadFilePermissionDenied | `from foundry_sdk.v2.datasets.errors import UploadFilePermissionDenied` | +**Filesystem** | AddGroupToParentGroupPermissionDenied | `from foundry_sdk.v2.filesystem.errors import AddGroupToParentGroupPermissionDenied` | +**Filesystem** | AddMarkingsPermissionDenied | `from foundry_sdk.v2.filesystem.errors import AddMarkingsPermissionDenied` | +**Filesystem** | AddOrganizationsPermissionDenied | `from foundry_sdk.v2.filesystem.errors import AddOrganizationsPermissionDenied` | +**Filesystem** | AddResourceRolesPermissionDenied | `from foundry_sdk.v2.filesystem.errors import AddResourceRolesPermissionDenied` | +**Filesystem** | CreateFolderOutsideProjectNotSupported | `from foundry_sdk.v2.filesystem.errors import CreateFolderOutsideProjectNotSupported` | +**Filesystem** | CreateFolderPermissionDenied | `from foundry_sdk.v2.filesystem.errors import CreateFolderPermissionDenied` | +**Filesystem** | CreateGroupPermissionDenied | `from foundry_sdk.v2.filesystem.errors import CreateGroupPermissionDenied` | +**Filesystem** | CreateProjectFromTemplatePermissionDenied | `from foundry_sdk.v2.filesystem.errors import CreateProjectFromTemplatePermissionDenied` | +**Filesystem** | CreateProjectNoOwnerLikeRoleGrant | `from foundry_sdk.v2.filesystem.errors import CreateProjectNoOwnerLikeRoleGrant` | +**Filesystem** | CreateProjectPermissionDenied | `from foundry_sdk.v2.filesystem.errors import CreateProjectPermissionDenied` | +**Filesystem** | DefaultRolesNotInSpaceRoleSet | `from foundry_sdk.v2.filesystem.errors import DefaultRolesNotInSpaceRoleSet` | +**Filesystem** | DeleteResourcePermissionDenied | `from foundry_sdk.v2.filesystem.errors import DeleteResourcePermissionDenied` | +**Filesystem** | FolderNotFound | `from foundry_sdk.v2.filesystem.errors import FolderNotFound` | +**Filesystem** | ForbiddenOperationOnAutosavedResource | `from foundry_sdk.v2.filesystem.errors import ForbiddenOperationOnAutosavedResource` | +**Filesystem** | ForbiddenOperationOnHiddenResource | `from foundry_sdk.v2.filesystem.errors import ForbiddenOperationOnHiddenResource` | +**Filesystem** | GetAccessRequirementsPermissionDenied | `from foundry_sdk.v2.filesystem.errors import GetAccessRequirementsPermissionDenied` | +**Filesystem** | GetByPathPermissionDenied | `from foundry_sdk.v2.filesystem.errors import GetByPathPermissionDenied` | +**Filesystem** | GetRootFolderNotSupported | `from foundry_sdk.v2.filesystem.errors import GetRootFolderNotSupported` | +**Filesystem** | GetSpaceResourceNotSupported | `from foundry_sdk.v2.filesystem.errors import GetSpaceResourceNotSupported` | +**Filesystem** | InvalidDefaultRoles | `from foundry_sdk.v2.filesystem.errors import InvalidDefaultRoles` | +**Filesystem** | InvalidDescription | `from foundry_sdk.v2.filesystem.errors import InvalidDescription` | +**Filesystem** | InvalidDisplayName | `from foundry_sdk.v2.filesystem.errors import InvalidDisplayName` | +**Filesystem** | InvalidFolder | `from foundry_sdk.v2.filesystem.errors import InvalidFolder` | +**Filesystem** | InvalidOrganizationHierarchy | `from foundry_sdk.v2.filesystem.errors import InvalidOrganizationHierarchy` | +**Filesystem** | InvalidOrganizations | `from foundry_sdk.v2.filesystem.errors import InvalidOrganizations` | +**Filesystem** | InvalidPath | `from foundry_sdk.v2.filesystem.errors import InvalidPath` | +**Filesystem** | InvalidPrincipalIdsForGroupTemplate | `from foundry_sdk.v2.filesystem.errors import InvalidPrincipalIdsForGroupTemplate` | +**Filesystem** | InvalidRoleIds | `from foundry_sdk.v2.filesystem.errors import InvalidRoleIds` | +**Filesystem** | InvalidVariable | `from foundry_sdk.v2.filesystem.errors import InvalidVariable` | +**Filesystem** | InvalidVariableEnumOption | `from foundry_sdk.v2.filesystem.errors import InvalidVariableEnumOption` | +**Filesystem** | MarkingNotFound | `from foundry_sdk.v2.filesystem.errors import MarkingNotFound` | +**Filesystem** | MissingDisplayName | `from foundry_sdk.v2.filesystem.errors import MissingDisplayName` | +**Filesystem** | MissingVariableValue | `from foundry_sdk.v2.filesystem.errors import MissingVariableValue` | +**Filesystem** | NotAuthorizedToApplyOrganization | `from foundry_sdk.v2.filesystem.errors import NotAuthorizedToApplyOrganization` | +**Filesystem** | OrganizationCannotBeRemoved | `from foundry_sdk.v2.filesystem.errors import OrganizationCannotBeRemoved` | +**Filesystem** | OrganizationMarkingNotOnSpace | `from foundry_sdk.v2.filesystem.errors import OrganizationMarkingNotOnSpace` | +**Filesystem** | OrganizationMarkingNotSupported | `from foundry_sdk.v2.filesystem.errors import OrganizationMarkingNotSupported` | +**Filesystem** | OrganizationsNotFound | `from foundry_sdk.v2.filesystem.errors import OrganizationsNotFound` | +**Filesystem** | PathNotFound | `from foundry_sdk.v2.filesystem.errors import PathNotFound` | +**Filesystem** | PermanentlyDeleteResourcePermissionDenied | `from foundry_sdk.v2.filesystem.errors import PermanentlyDeleteResourcePermissionDenied` | +**Filesystem** | ProjectCreationNotSupported | `from foundry_sdk.v2.filesystem.errors import ProjectCreationNotSupported` | +**Filesystem** | ProjectNameAlreadyExists | `from foundry_sdk.v2.filesystem.errors import ProjectNameAlreadyExists` | +**Filesystem** | ProjectNotFound | `from foundry_sdk.v2.filesystem.errors import ProjectNotFound` | +**Filesystem** | ProjectTemplateNotFound | `from foundry_sdk.v2.filesystem.errors import ProjectTemplateNotFound` | +**Filesystem** | RemoveMarkingsPermissionDenied | `from foundry_sdk.v2.filesystem.errors import RemoveMarkingsPermissionDenied` | +**Filesystem** | RemoveOrganizationsPermissionDenied | `from foundry_sdk.v2.filesystem.errors import RemoveOrganizationsPermissionDenied` | +**Filesystem** | RemoveResourceRolesPermissionDenied | `from foundry_sdk.v2.filesystem.errors import RemoveResourceRolesPermissionDenied` | +**Filesystem** | ResourceNameAlreadyExists | `from foundry_sdk.v2.filesystem.errors import ResourceNameAlreadyExists` | +**Filesystem** | ResourceNotDirectlyTrashed | `from foundry_sdk.v2.filesystem.errors import ResourceNotDirectlyTrashed` | +**Filesystem** | ResourceNotFound | `from foundry_sdk.v2.filesystem.errors import ResourceNotFound` | +**Filesystem** | ResourceNotTrashed | `from foundry_sdk.v2.filesystem.errors import ResourceNotTrashed` | +**Filesystem** | RestoreResourcePermissionDenied | `from foundry_sdk.v2.filesystem.errors import RestoreResourcePermissionDenied` | +**Filesystem** | SpaceNotFound | `from foundry_sdk.v2.filesystem.errors import SpaceNotFound` | +**Filesystem** | TemplateGroupNameConflict | `from foundry_sdk.v2.filesystem.errors import TemplateGroupNameConflict` | +**Filesystem** | TemplateMarkingNameConflict | `from foundry_sdk.v2.filesystem.errors import TemplateMarkingNameConflict` | +**Filesystem** | TrashingAutosavedResourcesNotSupported | `from foundry_sdk.v2.filesystem.errors import TrashingAutosavedResourcesNotSupported` | +**Filesystem** | TrashingHiddenResourcesNotSupported | `from foundry_sdk.v2.filesystem.errors import TrashingHiddenResourcesNotSupported` | +**Filesystem** | TrashingSpaceNotSupported | `from foundry_sdk.v2.filesystem.errors import TrashingSpaceNotSupported` | +**Functions** | ExecuteQueryPermissionDenied | `from foundry_sdk.v2.functions.errors import ExecuteQueryPermissionDenied` | +**Functions** | GetByRidQueriesPermissionDenied | `from foundry_sdk.v2.functions.errors import GetByRidQueriesPermissionDenied` | +**Functions** | InvalidQueryParameterValue | `from foundry_sdk.v2.functions.errors import InvalidQueryParameterValue` | +**Functions** | MissingParameter | `from foundry_sdk.v2.functions.errors import MissingParameter` | +**Functions** | QueryEncounteredUserFacingError | `from foundry_sdk.v2.functions.errors import QueryEncounteredUserFacingError` | +**Functions** | QueryMemoryExceededLimit | `from foundry_sdk.v2.functions.errors import QueryMemoryExceededLimit` | +**Functions** | QueryNotFound | `from foundry_sdk.v2.functions.errors import QueryNotFound` | +**Functions** | QueryRuntimeError | `from foundry_sdk.v2.functions.errors import QueryRuntimeError` | +**Functions** | QueryTimeExceededLimit | `from foundry_sdk.v2.functions.errors import QueryTimeExceededLimit` | +**Functions** | UnknownParameter | `from foundry_sdk.v2.functions.errors import UnknownParameter` | +**Functions** | ValueTypeNotFound | `from foundry_sdk.v2.functions.errors import ValueTypeNotFound` | +**Functions** | VersionIdNotFound | `from foundry_sdk.v2.functions.errors import VersionIdNotFound` | +**MediaSets** | ConflictingMediaSetIdentifiers | `from foundry_sdk.v2.media_sets.errors import ConflictingMediaSetIdentifiers` | +**MediaSets** | MediaItemNotFound | `from foundry_sdk.v2.media_sets.errors import MediaItemNotFound` | +**Ontologies** | ActionContainsDuplicateEdits | `from foundry_sdk.v2.ontologies.errors import ActionContainsDuplicateEdits` | +**Ontologies** | ActionEditedPropertiesNotFound | `from foundry_sdk.v2.ontologies.errors import ActionEditedPropertiesNotFound` | +**Ontologies** | ActionEditsReadOnlyEntity | `from foundry_sdk.v2.ontologies.errors import ActionEditsReadOnlyEntity` | +**Ontologies** | ActionNotFound | `from foundry_sdk.v2.ontologies.errors import ActionNotFound` | +**Ontologies** | ActionParameterInterfaceTypeNotFound | `from foundry_sdk.v2.ontologies.errors import ActionParameterInterfaceTypeNotFound` | +**Ontologies** | ActionParameterObjectNotFound | `from foundry_sdk.v2.ontologies.errors import ActionParameterObjectNotFound` | +**Ontologies** | ActionParameterObjectTypeNotFound | `from foundry_sdk.v2.ontologies.errors import ActionParameterObjectTypeNotFound` | +**Ontologies** | ActionTypeNotFound | `from foundry_sdk.v2.ontologies.errors import ActionTypeNotFound` | +**Ontologies** | ActionValidationFailed | `from foundry_sdk.v2.ontologies.errors import ActionValidationFailed` | +**Ontologies** | AggregationGroupCountExceededLimit | `from foundry_sdk.v2.ontologies.errors import AggregationGroupCountExceededLimit` | +**Ontologies** | AggregationMemoryExceededLimit | `from foundry_sdk.v2.ontologies.errors import AggregationMemoryExceededLimit` | +**Ontologies** | AggregationNestedObjectSetSizeExceededLimit | `from foundry_sdk.v2.ontologies.errors import AggregationNestedObjectSetSizeExceededLimit` | +**Ontologies** | ApplyActionFailed | `from foundry_sdk.v2.ontologies.errors import ApplyActionFailed` | +**Ontologies** | AttachmentNotFound | `from foundry_sdk.v2.ontologies.errors import AttachmentNotFound` | +**Ontologies** | AttachmentSizeExceededLimit | `from foundry_sdk.v2.ontologies.errors import AttachmentSizeExceededLimit` | +**Ontologies** | CompositePrimaryKeyNotSupported | `from foundry_sdk.v2.ontologies.errors import CompositePrimaryKeyNotSupported` | +**Ontologies** | DerivedPropertyApiNamesNotUnique | `from foundry_sdk.v2.ontologies.errors import DerivedPropertyApiNamesNotUnique` | +**Ontologies** | DuplicateOrderBy | `from foundry_sdk.v2.ontologies.errors import DuplicateOrderBy` | +**Ontologies** | EditObjectPermissionDenied | `from foundry_sdk.v2.ontologies.errors import EditObjectPermissionDenied` | +**Ontologies** | FunctionEncounteredUserFacingError | `from foundry_sdk.v2.ontologies.errors import FunctionEncounteredUserFacingError` | +**Ontologies** | FunctionExecutionFailed | `from foundry_sdk.v2.ontologies.errors import FunctionExecutionFailed` | +**Ontologies** | FunctionExecutionTimedOut | `from foundry_sdk.v2.ontologies.errors import FunctionExecutionTimedOut` | +**Ontologies** | FunctionInvalidInput | `from foundry_sdk.v2.ontologies.errors import FunctionInvalidInput` | +**Ontologies** | HighScaleComputationNotEnabled | `from foundry_sdk.v2.ontologies.errors import HighScaleComputationNotEnabled` | +**Ontologies** | InterfaceTypeNotFound | `from foundry_sdk.v2.ontologies.errors import InterfaceTypeNotFound` | +**Ontologies** | InterfaceTypesNotFound | `from foundry_sdk.v2.ontologies.errors import InterfaceTypesNotFound` | +**Ontologies** | InvalidAggregationOrdering | `from foundry_sdk.v2.ontologies.errors import InvalidAggregationOrdering` | +**Ontologies** | InvalidAggregationRange | `from foundry_sdk.v2.ontologies.errors import InvalidAggregationRange` | +**Ontologies** | InvalidAggregationRangePropertyType | `from foundry_sdk.v2.ontologies.errors import InvalidAggregationRangePropertyType` | +**Ontologies** | InvalidAggregationRangeValue | `from foundry_sdk.v2.ontologies.errors import InvalidAggregationRangeValue` | +**Ontologies** | InvalidApplyActionOptionCombination | `from foundry_sdk.v2.ontologies.errors import InvalidApplyActionOptionCombination` | +**Ontologies** | InvalidContentLength | `from foundry_sdk.v2.ontologies.errors import InvalidContentLength` | +**Ontologies** | InvalidContentType | `from foundry_sdk.v2.ontologies.errors import InvalidContentType` | +**Ontologies** | InvalidDerivedPropertyDefinition | `from foundry_sdk.v2.ontologies.errors import InvalidDerivedPropertyDefinition` | +**Ontologies** | InvalidDurationGroupByPropertyType | `from foundry_sdk.v2.ontologies.errors import InvalidDurationGroupByPropertyType` | +**Ontologies** | InvalidDurationGroupByValue | `from foundry_sdk.v2.ontologies.errors import InvalidDurationGroupByValue` | +**Ontologies** | InvalidFields | `from foundry_sdk.v2.ontologies.errors import InvalidFields` | +**Ontologies** | InvalidGroupId | `from foundry_sdk.v2.ontologies.errors import InvalidGroupId` | +**Ontologies** | InvalidOrderType | `from foundry_sdk.v2.ontologies.errors import InvalidOrderType` | +**Ontologies** | InvalidParameterValue | `from foundry_sdk.v2.ontologies.errors import InvalidParameterValue` | +**Ontologies** | InvalidPropertyFiltersCombination | `from foundry_sdk.v2.ontologies.errors import InvalidPropertyFiltersCombination` | +**Ontologies** | InvalidPropertyFilterValue | `from foundry_sdk.v2.ontologies.errors import InvalidPropertyFilterValue` | +**Ontologies** | InvalidPropertyType | `from foundry_sdk.v2.ontologies.errors import InvalidPropertyType` | +**Ontologies** | InvalidPropertyValue | `from foundry_sdk.v2.ontologies.errors import InvalidPropertyValue` | +**Ontologies** | InvalidQueryParameterValue | `from foundry_sdk.v2.ontologies.errors import InvalidQueryParameterValue` | +**Ontologies** | InvalidRangeQuery | `from foundry_sdk.v2.ontologies.errors import InvalidRangeQuery` | +**Ontologies** | InvalidSortOrder | `from foundry_sdk.v2.ontologies.errors import InvalidSortOrder` | +**Ontologies** | InvalidSortType | `from foundry_sdk.v2.ontologies.errors import InvalidSortType` | +**Ontologies** | InvalidUserId | `from foundry_sdk.v2.ontologies.errors import InvalidUserId` | +**Ontologies** | LinkAlreadyExists | `from foundry_sdk.v2.ontologies.errors import LinkAlreadyExists` | +**Ontologies** | LinkedObjectNotFound | `from foundry_sdk.v2.ontologies.errors import LinkedObjectNotFound` | +**Ontologies** | LinkTypeNotFound | `from foundry_sdk.v2.ontologies.errors import LinkTypeNotFound` | +**Ontologies** | MalformedPropertyFilters | `from foundry_sdk.v2.ontologies.errors import MalformedPropertyFilters` | +**Ontologies** | MarketplaceActionMappingNotFound | `from foundry_sdk.v2.ontologies.errors import MarketplaceActionMappingNotFound` | +**Ontologies** | MarketplaceInstallationNotFound | `from foundry_sdk.v2.ontologies.errors import MarketplaceInstallationNotFound` | +**Ontologies** | MarketplaceLinkMappingNotFound | `from foundry_sdk.v2.ontologies.errors import MarketplaceLinkMappingNotFound` | +**Ontologies** | MarketplaceObjectMappingNotFound | `from foundry_sdk.v2.ontologies.errors import MarketplaceObjectMappingNotFound` | +**Ontologies** | MarketplaceQueryMappingNotFound | `from foundry_sdk.v2.ontologies.errors import MarketplaceQueryMappingNotFound` | +**Ontologies** | MissingParameter | `from foundry_sdk.v2.ontologies.errors import MissingParameter` | +**Ontologies** | MultipleGroupByOnFieldNotSupported | `from foundry_sdk.v2.ontologies.errors import MultipleGroupByOnFieldNotSupported` | +**Ontologies** | MultiplePropertyValuesNotSupported | `from foundry_sdk.v2.ontologies.errors import MultiplePropertyValuesNotSupported` | +**Ontologies** | ObjectAlreadyExists | `from foundry_sdk.v2.ontologies.errors import ObjectAlreadyExists` | +**Ontologies** | ObjectChanged | `from foundry_sdk.v2.ontologies.errors import ObjectChanged` | +**Ontologies** | ObjectNotFound | `from foundry_sdk.v2.ontologies.errors import ObjectNotFound` | +**Ontologies** | ObjectSetNotFound | `from foundry_sdk.v2.ontologies.errors import ObjectSetNotFound` | +**Ontologies** | ObjectsExceededLimit | `from foundry_sdk.v2.ontologies.errors import ObjectsExceededLimit` | +**Ontologies** | ObjectTypeNotFound | `from foundry_sdk.v2.ontologies.errors import ObjectTypeNotFound` | +**Ontologies** | ObjectTypeNotSynced | `from foundry_sdk.v2.ontologies.errors import ObjectTypeNotSynced` | +**Ontologies** | ObjectTypesNotSynced | `from foundry_sdk.v2.ontologies.errors import ObjectTypesNotSynced` | +**Ontologies** | OntologyApiNameNotUnique | `from foundry_sdk.v2.ontologies.errors import OntologyApiNameNotUnique` | +**Ontologies** | OntologyEditsExceededLimit | `from foundry_sdk.v2.ontologies.errors import OntologyEditsExceededLimit` | +**Ontologies** | OntologyNotFound | `from foundry_sdk.v2.ontologies.errors import OntologyNotFound` | +**Ontologies** | OntologySyncing | `from foundry_sdk.v2.ontologies.errors import OntologySyncing` | +**Ontologies** | OntologySyncingObjectTypes | `from foundry_sdk.v2.ontologies.errors import OntologySyncingObjectTypes` | +**Ontologies** | ParameterObjectNotFound | `from foundry_sdk.v2.ontologies.errors import ParameterObjectNotFound` | +**Ontologies** | ParameterObjectSetRidNotFound | `from foundry_sdk.v2.ontologies.errors import ParameterObjectSetRidNotFound` | +**Ontologies** | ParametersNotFound | `from foundry_sdk.v2.ontologies.errors import ParametersNotFound` | +**Ontologies** | ParameterTypeNotSupported | `from foundry_sdk.v2.ontologies.errors import ParameterTypeNotSupported` | +**Ontologies** | ParentAttachmentPermissionDenied | `from foundry_sdk.v2.ontologies.errors import ParentAttachmentPermissionDenied` | +**Ontologies** | PropertiesHaveDifferentIds | `from foundry_sdk.v2.ontologies.errors import PropertiesHaveDifferentIds` | +**Ontologies** | PropertiesNotFilterable | `from foundry_sdk.v2.ontologies.errors import PropertiesNotFilterable` | +**Ontologies** | PropertiesNotFound | `from foundry_sdk.v2.ontologies.errors import PropertiesNotFound` | +**Ontologies** | PropertiesNotSearchable | `from foundry_sdk.v2.ontologies.errors import PropertiesNotSearchable` | +**Ontologies** | PropertiesNotSortable | `from foundry_sdk.v2.ontologies.errors import PropertiesNotSortable` | +**Ontologies** | PropertyApiNameNotFound | `from foundry_sdk.v2.ontologies.errors import PropertyApiNameNotFound` | +**Ontologies** | PropertyBaseTypeNotSupported | `from foundry_sdk.v2.ontologies.errors import PropertyBaseTypeNotSupported` | +**Ontologies** | PropertyFiltersNotSupported | `from foundry_sdk.v2.ontologies.errors import PropertyFiltersNotSupported` | +**Ontologies** | PropertyNotFound | `from foundry_sdk.v2.ontologies.errors import PropertyNotFound` | +**Ontologies** | PropertyTypeDoesNotSupportNearestNeighbors | `from foundry_sdk.v2.ontologies.errors import PropertyTypeDoesNotSupportNearestNeighbors` | +**Ontologies** | PropertyTypeNotFound | `from foundry_sdk.v2.ontologies.errors import PropertyTypeNotFound` | +**Ontologies** | PropertyTypesSearchNotSupported | `from foundry_sdk.v2.ontologies.errors import PropertyTypesSearchNotSupported` | +**Ontologies** | QueryEncounteredUserFacingError | `from foundry_sdk.v2.ontologies.errors import QueryEncounteredUserFacingError` | +**Ontologies** | QueryMemoryExceededLimit | `from foundry_sdk.v2.ontologies.errors import QueryMemoryExceededLimit` | +**Ontologies** | QueryNotFound | `from foundry_sdk.v2.ontologies.errors import QueryNotFound` | +**Ontologies** | QueryRuntimeError | `from foundry_sdk.v2.ontologies.errors import QueryRuntimeError` | +**Ontologies** | QueryTimeExceededLimit | `from foundry_sdk.v2.ontologies.errors import QueryTimeExceededLimit` | +**Ontologies** | SearchVectorDimensionsDiffer | `from foundry_sdk.v2.ontologies.errors import SearchVectorDimensionsDiffer` | +**Ontologies** | SharedPropertiesNotFound | `from foundry_sdk.v2.ontologies.errors import SharedPropertiesNotFound` | +**Ontologies** | SharedPropertyTypeNotFound | `from foundry_sdk.v2.ontologies.errors import SharedPropertyTypeNotFound` | +**Ontologies** | TooManyNearestNeighborsRequested | `from foundry_sdk.v2.ontologies.errors import TooManyNearestNeighborsRequested` | +**Ontologies** | UnknownParameter | `from foundry_sdk.v2.ontologies.errors import UnknownParameter` | +**Ontologies** | UnsupportedObjectSet | `from foundry_sdk.v2.ontologies.errors import UnsupportedObjectSet` | +**Ontologies** | ViewObjectPermissionDenied | `from foundry_sdk.v2.ontologies.errors import ViewObjectPermissionDenied` | +**Orchestration** | BuildInputsNotFound | `from foundry_sdk.v2.orchestration.errors import BuildInputsNotFound` | +**Orchestration** | BuildInputsPermissionDenied | `from foundry_sdk.v2.orchestration.errors import BuildInputsPermissionDenied` | +**Orchestration** | BuildNotFound | `from foundry_sdk.v2.orchestration.errors import BuildNotFound` | +**Orchestration** | BuildTargetsMissingJobSpecs | `from foundry_sdk.v2.orchestration.errors import BuildTargetsMissingJobSpecs` | +**Orchestration** | BuildTargetsNotFound | `from foundry_sdk.v2.orchestration.errors import BuildTargetsNotFound` | +**Orchestration** | BuildTargetsPermissionDenied | `from foundry_sdk.v2.orchestration.errors import BuildTargetsPermissionDenied` | +**Orchestration** | BuildTargetsResolutionError | `from foundry_sdk.v2.orchestration.errors import BuildTargetsResolutionError` | +**Orchestration** | BuildTargetsUpToDate | `from foundry_sdk.v2.orchestration.errors import BuildTargetsUpToDate` | +**Orchestration** | CancelBuildPermissionDenied | `from foundry_sdk.v2.orchestration.errors import CancelBuildPermissionDenied` | +**Orchestration** | CreateBuildPermissionDenied | `from foundry_sdk.v2.orchestration.errors import CreateBuildPermissionDenied` | +**Orchestration** | CreateSchedulePermissionDenied | `from foundry_sdk.v2.orchestration.errors import CreateSchedulePermissionDenied` | +**Orchestration** | DeleteSchedulePermissionDenied | `from foundry_sdk.v2.orchestration.errors import DeleteSchedulePermissionDenied` | +**Orchestration** | InvalidAndTrigger | `from foundry_sdk.v2.orchestration.errors import InvalidAndTrigger` | +**Orchestration** | InvalidMediaSetTrigger | `from foundry_sdk.v2.orchestration.errors import InvalidMediaSetTrigger` | +**Orchestration** | InvalidOrTrigger | `from foundry_sdk.v2.orchestration.errors import InvalidOrTrigger` | +**Orchestration** | InvalidScheduleDescription | `from foundry_sdk.v2.orchestration.errors import InvalidScheduleDescription` | +**Orchestration** | InvalidScheduleName | `from foundry_sdk.v2.orchestration.errors import InvalidScheduleName` | +**Orchestration** | InvalidTimeTrigger | `from foundry_sdk.v2.orchestration.errors import InvalidTimeTrigger` | +**Orchestration** | JobNotFound | `from foundry_sdk.v2.orchestration.errors import JobNotFound` | +**Orchestration** | MissingBuildTargets | `from foundry_sdk.v2.orchestration.errors import MissingBuildTargets` | +**Orchestration** | MissingConnectingBuildInputs | `from foundry_sdk.v2.orchestration.errors import MissingConnectingBuildInputs` | +**Orchestration** | MissingTrigger | `from foundry_sdk.v2.orchestration.errors import MissingTrigger` | +**Orchestration** | PauseSchedulePermissionDenied | `from foundry_sdk.v2.orchestration.errors import PauseSchedulePermissionDenied` | +**Orchestration** | ReplaceSchedulePermissionDenied | `from foundry_sdk.v2.orchestration.errors import ReplaceSchedulePermissionDenied` | +**Orchestration** | RunSchedulePermissionDenied | `from foundry_sdk.v2.orchestration.errors import RunSchedulePermissionDenied` | +**Orchestration** | ScheduleNotFound | `from foundry_sdk.v2.orchestration.errors import ScheduleNotFound` | +**Orchestration** | ScheduleTriggerResourcesNotFound | `from foundry_sdk.v2.orchestration.errors import ScheduleTriggerResourcesNotFound` | +**Orchestration** | ScheduleTriggerResourcesPermissionDenied | `from foundry_sdk.v2.orchestration.errors import ScheduleTriggerResourcesPermissionDenied` | +**Orchestration** | ScheduleVersionNotFound | `from foundry_sdk.v2.orchestration.errors import ScheduleVersionNotFound` | +**Orchestration** | SearchBuildsPermissionDenied | `from foundry_sdk.v2.orchestration.errors import SearchBuildsPermissionDenied` | +**Orchestration** | TargetNotSupported | `from foundry_sdk.v2.orchestration.errors import TargetNotSupported` | +**Orchestration** | UnpauseSchedulePermissionDenied | `from foundry_sdk.v2.orchestration.errors import UnpauseSchedulePermissionDenied` | +**SqlQueries** | CancelQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import CancelQueryPermissionDenied` | +**SqlQueries** | ExecuteQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import ExecuteQueryPermissionDenied` | +**SqlQueries** | GetResultsPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import GetResultsPermissionDenied` | +**SqlQueries** | GetStatusPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import GetStatusPermissionDenied` | +**SqlQueries** | QueryCanceled | `from foundry_sdk.v2.sql_queries.errors import QueryCanceled` | +**SqlQueries** | QueryFailed | `from foundry_sdk.v2.sql_queries.errors import QueryFailed` | +**SqlQueries** | QueryParseError | `from foundry_sdk.v2.sql_queries.errors import QueryParseError` | +**SqlQueries** | QueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import QueryPermissionDenied` | +**SqlQueries** | QueryRunning | `from foundry_sdk.v2.sql_queries.errors import QueryRunning` | +**SqlQueries** | ReadQueryInputsPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import ReadQueryInputsPermissionDenied` | +**Streams** | CannotCreateStreamingDatasetInUserFolder | `from foundry_sdk.v2.streams.errors import CannotCreateStreamingDatasetInUserFolder` | +**Streams** | CannotWriteToTrashedStream | `from foundry_sdk.v2.streams.errors import CannotWriteToTrashedStream` | +**Streams** | CreateStreamingDatasetPermissionDenied | `from foundry_sdk.v2.streams.errors import CreateStreamingDatasetPermissionDenied` | +**Streams** | CreateStreamPermissionDenied | `from foundry_sdk.v2.streams.errors import CreateStreamPermissionDenied` | +**Streams** | FailedToProcessBinaryRecord | `from foundry_sdk.v2.streams.errors import FailedToProcessBinaryRecord` | +**Streams** | InvalidStreamNoSchema | `from foundry_sdk.v2.streams.errors import InvalidStreamNoSchema` | +**Streams** | InvalidStreamType | `from foundry_sdk.v2.streams.errors import InvalidStreamType` | +**Streams** | PublishBinaryRecordToStreamPermissionDenied | `from foundry_sdk.v2.streams.errors import PublishBinaryRecordToStreamPermissionDenied` | +**Streams** | PublishRecordsToStreamPermissionDenied | `from foundry_sdk.v2.streams.errors import PublishRecordsToStreamPermissionDenied` | +**Streams** | PublishRecordToStreamPermissionDenied | `from foundry_sdk.v2.streams.errors import PublishRecordToStreamPermissionDenied` | +**Streams** | RecordDoesNotMatchStreamSchema | `from foundry_sdk.v2.streams.errors import RecordDoesNotMatchStreamSchema` | +**Streams** | RecordTooLarge | `from foundry_sdk.v2.streams.errors import RecordTooLarge` | +**Streams** | ResetStreamPermissionDenied | `from foundry_sdk.v2.streams.errors import ResetStreamPermissionDenied` | +**Streams** | StreamNotFound | `from foundry_sdk.v2.streams.errors import StreamNotFound` | +**Streams** | ViewNotFound | `from foundry_sdk.v2.streams.errors import ViewNotFound` | +**ThirdPartyApplications** | CannotDeleteDeployedVersion | `from foundry_sdk.v2.third_party_applications.errors import CannotDeleteDeployedVersion` | +**ThirdPartyApplications** | DeleteVersionPermissionDenied | `from foundry_sdk.v2.third_party_applications.errors import DeleteVersionPermissionDenied` | +**ThirdPartyApplications** | DeployWebsitePermissionDenied | `from foundry_sdk.v2.third_party_applications.errors import DeployWebsitePermissionDenied` | +**ThirdPartyApplications** | FileCountLimitExceeded | `from foundry_sdk.v2.third_party_applications.errors import FileCountLimitExceeded` | +**ThirdPartyApplications** | FileSizeLimitExceeded | `from foundry_sdk.v2.third_party_applications.errors import FileSizeLimitExceeded` | +**ThirdPartyApplications** | InvalidVersion | `from foundry_sdk.v2.third_party_applications.errors import InvalidVersion` | +**ThirdPartyApplications** | ThirdPartyApplicationNotFound | `from foundry_sdk.v2.third_party_applications.errors import ThirdPartyApplicationNotFound` | +**ThirdPartyApplications** | UndeployWebsitePermissionDenied | `from foundry_sdk.v2.third_party_applications.errors import UndeployWebsitePermissionDenied` | +**ThirdPartyApplications** | UploadSnapshotVersionPermissionDenied | `from foundry_sdk.v2.third_party_applications.errors import UploadSnapshotVersionPermissionDenied` | +**ThirdPartyApplications** | UploadVersionPermissionDenied | `from foundry_sdk.v2.third_party_applications.errors import UploadVersionPermissionDenied` | +**ThirdPartyApplications** | VersionAlreadyExists | `from foundry_sdk.v2.third_party_applications.errors import VersionAlreadyExists` | +**ThirdPartyApplications** | VersionLimitExceeded | `from foundry_sdk.v2.third_party_applications.errors import VersionLimitExceeded` | +**ThirdPartyApplications** | VersionNotFound | `from foundry_sdk.v2.third_party_applications.errors import VersionNotFound` | +**ThirdPartyApplications** | WebsiteNotFound | `from foundry_sdk.v2.third_party_applications.errors import WebsiteNotFound` | ## Documentation for V1 errors Namespace | Name | Import | --------- | ---- | ------ | -**Core** | ApiFeaturePreviewUsageOnly | `from foundry.v1.core.errors import ApiFeaturePreviewUsageOnly` | -**Core** | ApiUsageDenied | `from foundry.v1.core.errors import ApiUsageDenied` | -**Core** | FolderNotFound | `from foundry.v1.core.errors import FolderNotFound` | -**Core** | InvalidPageSize | `from foundry.v1.core.errors import InvalidPageSize` | -**Core** | InvalidPageToken | `from foundry.v1.core.errors import InvalidPageToken` | -**Core** | InvalidParameterCombination | `from foundry.v1.core.errors import InvalidParameterCombination` | -**Core** | MissingPostBody | `from foundry.v1.core.errors import MissingPostBody` | -**Core** | ResourceNameAlreadyExists | `from foundry.v1.core.errors import ResourceNameAlreadyExists` | -**Core** | UnknownDistanceUnit | `from foundry.v1.core.errors import UnknownDistanceUnit` | -**Datasets** | AbortTransactionPermissionDenied | `from foundry.v1.datasets.errors import AbortTransactionPermissionDenied` | -**Datasets** | BranchAlreadyExists | `from foundry.v1.datasets.errors import BranchAlreadyExists` | -**Datasets** | BranchNotFound | `from foundry.v1.datasets.errors import BranchNotFound` | -**Datasets** | ColumnTypesNotSupported | `from foundry.v1.datasets.errors import ColumnTypesNotSupported` | -**Datasets** | CommitTransactionPermissionDenied | `from foundry.v1.datasets.errors import CommitTransactionPermissionDenied` | -**Datasets** | CreateBranchPermissionDenied | `from foundry.v1.datasets.errors import CreateBranchPermissionDenied` | -**Datasets** | CreateDatasetPermissionDenied | `from foundry.v1.datasets.errors import CreateDatasetPermissionDenied` | -**Datasets** | CreateTransactionPermissionDenied | `from foundry.v1.datasets.errors import CreateTransactionPermissionDenied` | -**Datasets** | DatasetNotFound | `from foundry.v1.datasets.errors import DatasetNotFound` | -**Datasets** | DatasetReadNotSupported | `from foundry.v1.datasets.errors import DatasetReadNotSupported` | -**Datasets** | DeleteBranchPermissionDenied | `from foundry.v1.datasets.errors import DeleteBranchPermissionDenied` | -**Datasets** | DeleteSchemaPermissionDenied | `from foundry.v1.datasets.errors import DeleteSchemaPermissionDenied` | -**Datasets** | FileAlreadyExists | `from foundry.v1.datasets.errors import FileAlreadyExists` | -**Datasets** | FileNotFoundOnBranch | `from foundry.v1.datasets.errors import FileNotFoundOnBranch` | -**Datasets** | FileNotFoundOnTransactionRange | `from foundry.v1.datasets.errors import FileNotFoundOnTransactionRange` | -**Datasets** | InvalidBranchId | `from foundry.v1.datasets.errors import InvalidBranchId` | -**Datasets** | InvalidTransactionType | `from foundry.v1.datasets.errors import InvalidTransactionType` | -**Datasets** | OpenTransactionAlreadyExists | `from foundry.v1.datasets.errors import OpenTransactionAlreadyExists` | -**Datasets** | PutSchemaPermissionDenied | `from foundry.v1.datasets.errors import PutSchemaPermissionDenied` | -**Datasets** | ReadTablePermissionDenied | `from foundry.v1.datasets.errors import ReadTablePermissionDenied` | -**Datasets** | SchemaNotFound | `from foundry.v1.datasets.errors import SchemaNotFound` | -**Datasets** | TransactionNotCommitted | `from foundry.v1.datasets.errors import TransactionNotCommitted` | -**Datasets** | TransactionNotFound | `from foundry.v1.datasets.errors import TransactionNotFound` | -**Datasets** | TransactionNotOpen | `from foundry.v1.datasets.errors import TransactionNotOpen` | -**Datasets** | UploadFilePermissionDenied | `from foundry.v1.datasets.errors import UploadFilePermissionDenied` | -**Ontologies** | ActionContainsDuplicateEdits | `from foundry.v1.ontologies.errors import ActionContainsDuplicateEdits` | -**Ontologies** | ActionEditedPropertiesNotFound | `from foundry.v1.ontologies.errors import ActionEditedPropertiesNotFound` | -**Ontologies** | ActionEditsReadOnlyEntity | `from foundry.v1.ontologies.errors import ActionEditsReadOnlyEntity` | -**Ontologies** | ActionNotFound | `from foundry.v1.ontologies.errors import ActionNotFound` | -**Ontologies** | ActionParameterInterfaceTypeNotFound | `from foundry.v1.ontologies.errors import ActionParameterInterfaceTypeNotFound` | -**Ontologies** | ActionParameterObjectNotFound | `from foundry.v1.ontologies.errors import ActionParameterObjectNotFound` | -**Ontologies** | ActionParameterObjectTypeNotFound | `from foundry.v1.ontologies.errors import ActionParameterObjectTypeNotFound` | -**Ontologies** | ActionTypeNotFound | `from foundry.v1.ontologies.errors import ActionTypeNotFound` | -**Ontologies** | ActionValidationFailed | `from foundry.v1.ontologies.errors import ActionValidationFailed` | -**Ontologies** | AggregationGroupCountExceededLimit | `from foundry.v1.ontologies.errors import AggregationGroupCountExceededLimit` | -**Ontologies** | AggregationMemoryExceededLimit | `from foundry.v1.ontologies.errors import AggregationMemoryExceededLimit` | -**Ontologies** | AggregationNestedObjectSetSizeExceededLimit | `from foundry.v1.ontologies.errors import AggregationNestedObjectSetSizeExceededLimit` | -**Ontologies** | ApplyActionFailed | `from foundry.v1.ontologies.errors import ApplyActionFailed` | -**Ontologies** | AttachmentNotFound | `from foundry.v1.ontologies.errors import AttachmentNotFound` | -**Ontologies** | AttachmentSizeExceededLimit | `from foundry.v1.ontologies.errors import AttachmentSizeExceededLimit` | -**Ontologies** | CompositePrimaryKeyNotSupported | `from foundry.v1.ontologies.errors import CompositePrimaryKeyNotSupported` | -**Ontologies** | DerivedPropertyApiNamesNotUnique | `from foundry.v1.ontologies.errors import DerivedPropertyApiNamesNotUnique` | -**Ontologies** | DuplicateOrderBy | `from foundry.v1.ontologies.errors import DuplicateOrderBy` | -**Ontologies** | EditObjectPermissionDenied | `from foundry.v1.ontologies.errors import EditObjectPermissionDenied` | -**Ontologies** | FunctionEncounteredUserFacingError | `from foundry.v1.ontologies.errors import FunctionEncounteredUserFacingError` | -**Ontologies** | FunctionExecutionFailed | `from foundry.v1.ontologies.errors import FunctionExecutionFailed` | -**Ontologies** | FunctionExecutionTimedOut | `from foundry.v1.ontologies.errors import FunctionExecutionTimedOut` | -**Ontologies** | FunctionInvalidInput | `from foundry.v1.ontologies.errors import FunctionInvalidInput` | -**Ontologies** | HighScaleComputationNotEnabled | `from foundry.v1.ontologies.errors import HighScaleComputationNotEnabled` | -**Ontologies** | InterfaceTypeNotFound | `from foundry.v1.ontologies.errors import InterfaceTypeNotFound` | -**Ontologies** | InterfaceTypesNotFound | `from foundry.v1.ontologies.errors import InterfaceTypesNotFound` | -**Ontologies** | InvalidAggregationOrdering | `from foundry.v1.ontologies.errors import InvalidAggregationOrdering` | -**Ontologies** | InvalidAggregationRange | `from foundry.v1.ontologies.errors import InvalidAggregationRange` | -**Ontologies** | InvalidAggregationRangePropertyType | `from foundry.v1.ontologies.errors import InvalidAggregationRangePropertyType` | -**Ontologies** | InvalidAggregationRangeValue | `from foundry.v1.ontologies.errors import InvalidAggregationRangeValue` | -**Ontologies** | InvalidApplyActionOptionCombination | `from foundry.v1.ontologies.errors import InvalidApplyActionOptionCombination` | -**Ontologies** | InvalidContentLength | `from foundry.v1.ontologies.errors import InvalidContentLength` | -**Ontologies** | InvalidContentType | `from foundry.v1.ontologies.errors import InvalidContentType` | -**Ontologies** | InvalidDerivedPropertyDefinition | `from foundry.v1.ontologies.errors import InvalidDerivedPropertyDefinition` | -**Ontologies** | InvalidDurationGroupByPropertyType | `from foundry.v1.ontologies.errors import InvalidDurationGroupByPropertyType` | -**Ontologies** | InvalidDurationGroupByValue | `from foundry.v1.ontologies.errors import InvalidDurationGroupByValue` | -**Ontologies** | InvalidFields | `from foundry.v1.ontologies.errors import InvalidFields` | -**Ontologies** | InvalidGroupId | `from foundry.v1.ontologies.errors import InvalidGroupId` | -**Ontologies** | InvalidOrderType | `from foundry.v1.ontologies.errors import InvalidOrderType` | -**Ontologies** | InvalidParameterValue | `from foundry.v1.ontologies.errors import InvalidParameterValue` | -**Ontologies** | InvalidPropertyFiltersCombination | `from foundry.v1.ontologies.errors import InvalidPropertyFiltersCombination` | -**Ontologies** | InvalidPropertyFilterValue | `from foundry.v1.ontologies.errors import InvalidPropertyFilterValue` | -**Ontologies** | InvalidPropertyType | `from foundry.v1.ontologies.errors import InvalidPropertyType` | -**Ontologies** | InvalidPropertyValue | `from foundry.v1.ontologies.errors import InvalidPropertyValue` | -**Ontologies** | InvalidQueryParameterValue | `from foundry.v1.ontologies.errors import InvalidQueryParameterValue` | -**Ontologies** | InvalidRangeQuery | `from foundry.v1.ontologies.errors import InvalidRangeQuery` | -**Ontologies** | InvalidSortOrder | `from foundry.v1.ontologies.errors import InvalidSortOrder` | -**Ontologies** | InvalidSortType | `from foundry.v1.ontologies.errors import InvalidSortType` | -**Ontologies** | InvalidUserId | `from foundry.v1.ontologies.errors import InvalidUserId` | -**Ontologies** | LinkAlreadyExists | `from foundry.v1.ontologies.errors import LinkAlreadyExists` | -**Ontologies** | LinkedObjectNotFound | `from foundry.v1.ontologies.errors import LinkedObjectNotFound` | -**Ontologies** | LinkTypeNotFound | `from foundry.v1.ontologies.errors import LinkTypeNotFound` | -**Ontologies** | MalformedPropertyFilters | `from foundry.v1.ontologies.errors import MalformedPropertyFilters` | -**Ontologies** | MarketplaceActionMappingNotFound | `from foundry.v1.ontologies.errors import MarketplaceActionMappingNotFound` | -**Ontologies** | MarketplaceInstallationNotFound | `from foundry.v1.ontologies.errors import MarketplaceInstallationNotFound` | -**Ontologies** | MarketplaceLinkMappingNotFound | `from foundry.v1.ontologies.errors import MarketplaceLinkMappingNotFound` | -**Ontologies** | MarketplaceObjectMappingNotFound | `from foundry.v1.ontologies.errors import MarketplaceObjectMappingNotFound` | -**Ontologies** | MarketplaceQueryMappingNotFound | `from foundry.v1.ontologies.errors import MarketplaceQueryMappingNotFound` | -**Ontologies** | MissingParameter | `from foundry.v1.ontologies.errors import MissingParameter` | -**Ontologies** | MultipleGroupByOnFieldNotSupported | `from foundry.v1.ontologies.errors import MultipleGroupByOnFieldNotSupported` | -**Ontologies** | MultiplePropertyValuesNotSupported | `from foundry.v1.ontologies.errors import MultiplePropertyValuesNotSupported` | -**Ontologies** | ObjectAlreadyExists | `from foundry.v1.ontologies.errors import ObjectAlreadyExists` | -**Ontologies** | ObjectChanged | `from foundry.v1.ontologies.errors import ObjectChanged` | -**Ontologies** | ObjectNotFound | `from foundry.v1.ontologies.errors import ObjectNotFound` | -**Ontologies** | ObjectSetNotFound | `from foundry.v1.ontologies.errors import ObjectSetNotFound` | -**Ontologies** | ObjectsExceededLimit | `from foundry.v1.ontologies.errors import ObjectsExceededLimit` | -**Ontologies** | ObjectTypeNotFound | `from foundry.v1.ontologies.errors import ObjectTypeNotFound` | -**Ontologies** | ObjectTypeNotSynced | `from foundry.v1.ontologies.errors import ObjectTypeNotSynced` | -**Ontologies** | ObjectTypesNotSynced | `from foundry.v1.ontologies.errors import ObjectTypesNotSynced` | -**Ontologies** | OntologyApiNameNotUnique | `from foundry.v1.ontologies.errors import OntologyApiNameNotUnique` | -**Ontologies** | OntologyEditsExceededLimit | `from foundry.v1.ontologies.errors import OntologyEditsExceededLimit` | -**Ontologies** | OntologyNotFound | `from foundry.v1.ontologies.errors import OntologyNotFound` | -**Ontologies** | OntologySyncing | `from foundry.v1.ontologies.errors import OntologySyncing` | -**Ontologies** | OntologySyncingObjectTypes | `from foundry.v1.ontologies.errors import OntologySyncingObjectTypes` | -**Ontologies** | ParameterObjectNotFound | `from foundry.v1.ontologies.errors import ParameterObjectNotFound` | -**Ontologies** | ParameterObjectSetRidNotFound | `from foundry.v1.ontologies.errors import ParameterObjectSetRidNotFound` | -**Ontologies** | ParametersNotFound | `from foundry.v1.ontologies.errors import ParametersNotFound` | -**Ontologies** | ParameterTypeNotSupported | `from foundry.v1.ontologies.errors import ParameterTypeNotSupported` | -**Ontologies** | ParentAttachmentPermissionDenied | `from foundry.v1.ontologies.errors import ParentAttachmentPermissionDenied` | -**Ontologies** | PropertiesHaveDifferentIds | `from foundry.v1.ontologies.errors import PropertiesHaveDifferentIds` | -**Ontologies** | PropertiesNotFilterable | `from foundry.v1.ontologies.errors import PropertiesNotFilterable` | -**Ontologies** | PropertiesNotFound | `from foundry.v1.ontologies.errors import PropertiesNotFound` | -**Ontologies** | PropertiesNotSearchable | `from foundry.v1.ontologies.errors import PropertiesNotSearchable` | -**Ontologies** | PropertiesNotSortable | `from foundry.v1.ontologies.errors import PropertiesNotSortable` | -**Ontologies** | PropertyApiNameNotFound | `from foundry.v1.ontologies.errors import PropertyApiNameNotFound` | -**Ontologies** | PropertyBaseTypeNotSupported | `from foundry.v1.ontologies.errors import PropertyBaseTypeNotSupported` | -**Ontologies** | PropertyFiltersNotSupported | `from foundry.v1.ontologies.errors import PropertyFiltersNotSupported` | -**Ontologies** | PropertyNotFound | `from foundry.v1.ontologies.errors import PropertyNotFound` | -**Ontologies** | PropertyTypeDoesNotSupportNearestNeighbors | `from foundry.v1.ontologies.errors import PropertyTypeDoesNotSupportNearestNeighbors` | -**Ontologies** | PropertyTypeNotFound | `from foundry.v1.ontologies.errors import PropertyTypeNotFound` | -**Ontologies** | PropertyTypesSearchNotSupported | `from foundry.v1.ontologies.errors import PropertyTypesSearchNotSupported` | -**Ontologies** | QueryEncounteredUserFacingError | `from foundry.v1.ontologies.errors import QueryEncounteredUserFacingError` | -**Ontologies** | QueryMemoryExceededLimit | `from foundry.v1.ontologies.errors import QueryMemoryExceededLimit` | -**Ontologies** | QueryNotFound | `from foundry.v1.ontologies.errors import QueryNotFound` | -**Ontologies** | QueryRuntimeError | `from foundry.v1.ontologies.errors import QueryRuntimeError` | -**Ontologies** | QueryTimeExceededLimit | `from foundry.v1.ontologies.errors import QueryTimeExceededLimit` | -**Ontologies** | SearchVectorDimensionsDiffer | `from foundry.v1.ontologies.errors import SearchVectorDimensionsDiffer` | -**Ontologies** | SharedPropertiesNotFound | `from foundry.v1.ontologies.errors import SharedPropertiesNotFound` | -**Ontologies** | SharedPropertyTypeNotFound | `from foundry.v1.ontologies.errors import SharedPropertyTypeNotFound` | -**Ontologies** | TooManyNearestNeighborsRequested | `from foundry.v1.ontologies.errors import TooManyNearestNeighborsRequested` | -**Ontologies** | UnknownParameter | `from foundry.v1.ontologies.errors import UnknownParameter` | -**Ontologies** | UnsupportedObjectSet | `from foundry.v1.ontologies.errors import UnsupportedObjectSet` | -**Ontologies** | ViewObjectPermissionDenied | `from foundry.v1.ontologies.errors import ViewObjectPermissionDenied` | +**Core** | ApiFeaturePreviewUsageOnly | `from foundry_sdk.v1.core.errors import ApiFeaturePreviewUsageOnly` | +**Core** | ApiUsageDenied | `from foundry_sdk.v1.core.errors import ApiUsageDenied` | +**Core** | FolderNotFound | `from foundry_sdk.v1.core.errors import FolderNotFound` | +**Core** | InvalidPageSize | `from foundry_sdk.v1.core.errors import InvalidPageSize` | +**Core** | InvalidPageToken | `from foundry_sdk.v1.core.errors import InvalidPageToken` | +**Core** | InvalidParameterCombination | `from foundry_sdk.v1.core.errors import InvalidParameterCombination` | +**Core** | MissingPostBody | `from foundry_sdk.v1.core.errors import MissingPostBody` | +**Core** | ResourceNameAlreadyExists | `from foundry_sdk.v1.core.errors import ResourceNameAlreadyExists` | +**Core** | UnknownDistanceUnit | `from foundry_sdk.v1.core.errors import UnknownDistanceUnit` | +**Datasets** | AbortTransactionPermissionDenied | `from foundry_sdk.v1.datasets.errors import AbortTransactionPermissionDenied` | +**Datasets** | BranchAlreadyExists | `from foundry_sdk.v1.datasets.errors import BranchAlreadyExists` | +**Datasets** | BranchNotFound | `from foundry_sdk.v1.datasets.errors import BranchNotFound` | +**Datasets** | ColumnTypesNotSupported | `from foundry_sdk.v1.datasets.errors import ColumnTypesNotSupported` | +**Datasets** | CommitTransactionPermissionDenied | `from foundry_sdk.v1.datasets.errors import CommitTransactionPermissionDenied` | +**Datasets** | CreateBranchPermissionDenied | `from foundry_sdk.v1.datasets.errors import CreateBranchPermissionDenied` | +**Datasets** | CreateDatasetPermissionDenied | `from foundry_sdk.v1.datasets.errors import CreateDatasetPermissionDenied` | +**Datasets** | CreateTransactionPermissionDenied | `from foundry_sdk.v1.datasets.errors import CreateTransactionPermissionDenied` | +**Datasets** | DatasetNotFound | `from foundry_sdk.v1.datasets.errors import DatasetNotFound` | +**Datasets** | DatasetReadNotSupported | `from foundry_sdk.v1.datasets.errors import DatasetReadNotSupported` | +**Datasets** | DeleteBranchPermissionDenied | `from foundry_sdk.v1.datasets.errors import DeleteBranchPermissionDenied` | +**Datasets** | DeleteSchemaPermissionDenied | `from foundry_sdk.v1.datasets.errors import DeleteSchemaPermissionDenied` | +**Datasets** | FileAlreadyExists | `from foundry_sdk.v1.datasets.errors import FileAlreadyExists` | +**Datasets** | FileNotFoundOnBranch | `from foundry_sdk.v1.datasets.errors import FileNotFoundOnBranch` | +**Datasets** | FileNotFoundOnTransactionRange | `from foundry_sdk.v1.datasets.errors import FileNotFoundOnTransactionRange` | +**Datasets** | InvalidBranchId | `from foundry_sdk.v1.datasets.errors import InvalidBranchId` | +**Datasets** | InvalidTransactionType | `from foundry_sdk.v1.datasets.errors import InvalidTransactionType` | +**Datasets** | OpenTransactionAlreadyExists | `from foundry_sdk.v1.datasets.errors import OpenTransactionAlreadyExists` | +**Datasets** | PutSchemaPermissionDenied | `from foundry_sdk.v1.datasets.errors import PutSchemaPermissionDenied` | +**Datasets** | ReadTablePermissionDenied | `from foundry_sdk.v1.datasets.errors import ReadTablePermissionDenied` | +**Datasets** | SchemaNotFound | `from foundry_sdk.v1.datasets.errors import SchemaNotFound` | +**Datasets** | TransactionNotCommitted | `from foundry_sdk.v1.datasets.errors import TransactionNotCommitted` | +**Datasets** | TransactionNotFound | `from foundry_sdk.v1.datasets.errors import TransactionNotFound` | +**Datasets** | TransactionNotOpen | `from foundry_sdk.v1.datasets.errors import TransactionNotOpen` | +**Datasets** | UploadFilePermissionDenied | `from foundry_sdk.v1.datasets.errors import UploadFilePermissionDenied` | +**Ontologies** | ActionContainsDuplicateEdits | `from foundry_sdk.v1.ontologies.errors import ActionContainsDuplicateEdits` | +**Ontologies** | ActionEditedPropertiesNotFound | `from foundry_sdk.v1.ontologies.errors import ActionEditedPropertiesNotFound` | +**Ontologies** | ActionEditsReadOnlyEntity | `from foundry_sdk.v1.ontologies.errors import ActionEditsReadOnlyEntity` | +**Ontologies** | ActionNotFound | `from foundry_sdk.v1.ontologies.errors import ActionNotFound` | +**Ontologies** | ActionParameterInterfaceTypeNotFound | `from foundry_sdk.v1.ontologies.errors import ActionParameterInterfaceTypeNotFound` | +**Ontologies** | ActionParameterObjectNotFound | `from foundry_sdk.v1.ontologies.errors import ActionParameterObjectNotFound` | +**Ontologies** | ActionParameterObjectTypeNotFound | `from foundry_sdk.v1.ontologies.errors import ActionParameterObjectTypeNotFound` | +**Ontologies** | ActionTypeNotFound | `from foundry_sdk.v1.ontologies.errors import ActionTypeNotFound` | +**Ontologies** | ActionValidationFailed | `from foundry_sdk.v1.ontologies.errors import ActionValidationFailed` | +**Ontologies** | AggregationGroupCountExceededLimit | `from foundry_sdk.v1.ontologies.errors import AggregationGroupCountExceededLimit` | +**Ontologies** | AggregationMemoryExceededLimit | `from foundry_sdk.v1.ontologies.errors import AggregationMemoryExceededLimit` | +**Ontologies** | AggregationNestedObjectSetSizeExceededLimit | `from foundry_sdk.v1.ontologies.errors import AggregationNestedObjectSetSizeExceededLimit` | +**Ontologies** | ApplyActionFailed | `from foundry_sdk.v1.ontologies.errors import ApplyActionFailed` | +**Ontologies** | AttachmentNotFound | `from foundry_sdk.v1.ontologies.errors import AttachmentNotFound` | +**Ontologies** | AttachmentSizeExceededLimit | `from foundry_sdk.v1.ontologies.errors import AttachmentSizeExceededLimit` | +**Ontologies** | CompositePrimaryKeyNotSupported | `from foundry_sdk.v1.ontologies.errors import CompositePrimaryKeyNotSupported` | +**Ontologies** | DerivedPropertyApiNamesNotUnique | `from foundry_sdk.v1.ontologies.errors import DerivedPropertyApiNamesNotUnique` | +**Ontologies** | DuplicateOrderBy | `from foundry_sdk.v1.ontologies.errors import DuplicateOrderBy` | +**Ontologies** | EditObjectPermissionDenied | `from foundry_sdk.v1.ontologies.errors import EditObjectPermissionDenied` | +**Ontologies** | FunctionEncounteredUserFacingError | `from foundry_sdk.v1.ontologies.errors import FunctionEncounteredUserFacingError` | +**Ontologies** | FunctionExecutionFailed | `from foundry_sdk.v1.ontologies.errors import FunctionExecutionFailed` | +**Ontologies** | FunctionExecutionTimedOut | `from foundry_sdk.v1.ontologies.errors import FunctionExecutionTimedOut` | +**Ontologies** | FunctionInvalidInput | `from foundry_sdk.v1.ontologies.errors import FunctionInvalidInput` | +**Ontologies** | HighScaleComputationNotEnabled | `from foundry_sdk.v1.ontologies.errors import HighScaleComputationNotEnabled` | +**Ontologies** | InterfaceTypeNotFound | `from foundry_sdk.v1.ontologies.errors import InterfaceTypeNotFound` | +**Ontologies** | InterfaceTypesNotFound | `from foundry_sdk.v1.ontologies.errors import InterfaceTypesNotFound` | +**Ontologies** | InvalidAggregationOrdering | `from foundry_sdk.v1.ontologies.errors import InvalidAggregationOrdering` | +**Ontologies** | InvalidAggregationRange | `from foundry_sdk.v1.ontologies.errors import InvalidAggregationRange` | +**Ontologies** | InvalidAggregationRangePropertyType | `from foundry_sdk.v1.ontologies.errors import InvalidAggregationRangePropertyType` | +**Ontologies** | InvalidAggregationRangeValue | `from foundry_sdk.v1.ontologies.errors import InvalidAggregationRangeValue` | +**Ontologies** | InvalidApplyActionOptionCombination | `from foundry_sdk.v1.ontologies.errors import InvalidApplyActionOptionCombination` | +**Ontologies** | InvalidContentLength | `from foundry_sdk.v1.ontologies.errors import InvalidContentLength` | +**Ontologies** | InvalidContentType | `from foundry_sdk.v1.ontologies.errors import InvalidContentType` | +**Ontologies** | InvalidDerivedPropertyDefinition | `from foundry_sdk.v1.ontologies.errors import InvalidDerivedPropertyDefinition` | +**Ontologies** | InvalidDurationGroupByPropertyType | `from foundry_sdk.v1.ontologies.errors import InvalidDurationGroupByPropertyType` | +**Ontologies** | InvalidDurationGroupByValue | `from foundry_sdk.v1.ontologies.errors import InvalidDurationGroupByValue` | +**Ontologies** | InvalidFields | `from foundry_sdk.v1.ontologies.errors import InvalidFields` | +**Ontologies** | InvalidGroupId | `from foundry_sdk.v1.ontologies.errors import InvalidGroupId` | +**Ontologies** | InvalidOrderType | `from foundry_sdk.v1.ontologies.errors import InvalidOrderType` | +**Ontologies** | InvalidParameterValue | `from foundry_sdk.v1.ontologies.errors import InvalidParameterValue` | +**Ontologies** | InvalidPropertyFiltersCombination | `from foundry_sdk.v1.ontologies.errors import InvalidPropertyFiltersCombination` | +**Ontologies** | InvalidPropertyFilterValue | `from foundry_sdk.v1.ontologies.errors import InvalidPropertyFilterValue` | +**Ontologies** | InvalidPropertyType | `from foundry_sdk.v1.ontologies.errors import InvalidPropertyType` | +**Ontologies** | InvalidPropertyValue | `from foundry_sdk.v1.ontologies.errors import InvalidPropertyValue` | +**Ontologies** | InvalidQueryParameterValue | `from foundry_sdk.v1.ontologies.errors import InvalidQueryParameterValue` | +**Ontologies** | InvalidRangeQuery | `from foundry_sdk.v1.ontologies.errors import InvalidRangeQuery` | +**Ontologies** | InvalidSortOrder | `from foundry_sdk.v1.ontologies.errors import InvalidSortOrder` | +**Ontologies** | InvalidSortType | `from foundry_sdk.v1.ontologies.errors import InvalidSortType` | +**Ontologies** | InvalidUserId | `from foundry_sdk.v1.ontologies.errors import InvalidUserId` | +**Ontologies** | LinkAlreadyExists | `from foundry_sdk.v1.ontologies.errors import LinkAlreadyExists` | +**Ontologies** | LinkedObjectNotFound | `from foundry_sdk.v1.ontologies.errors import LinkedObjectNotFound` | +**Ontologies** | LinkTypeNotFound | `from foundry_sdk.v1.ontologies.errors import LinkTypeNotFound` | +**Ontologies** | MalformedPropertyFilters | `from foundry_sdk.v1.ontologies.errors import MalformedPropertyFilters` | +**Ontologies** | MarketplaceActionMappingNotFound | `from foundry_sdk.v1.ontologies.errors import MarketplaceActionMappingNotFound` | +**Ontologies** | MarketplaceInstallationNotFound | `from foundry_sdk.v1.ontologies.errors import MarketplaceInstallationNotFound` | +**Ontologies** | MarketplaceLinkMappingNotFound | `from foundry_sdk.v1.ontologies.errors import MarketplaceLinkMappingNotFound` | +**Ontologies** | MarketplaceObjectMappingNotFound | `from foundry_sdk.v1.ontologies.errors import MarketplaceObjectMappingNotFound` | +**Ontologies** | MarketplaceQueryMappingNotFound | `from foundry_sdk.v1.ontologies.errors import MarketplaceQueryMappingNotFound` | +**Ontologies** | MissingParameter | `from foundry_sdk.v1.ontologies.errors import MissingParameter` | +**Ontologies** | MultipleGroupByOnFieldNotSupported | `from foundry_sdk.v1.ontologies.errors import MultipleGroupByOnFieldNotSupported` | +**Ontologies** | MultiplePropertyValuesNotSupported | `from foundry_sdk.v1.ontologies.errors import MultiplePropertyValuesNotSupported` | +**Ontologies** | ObjectAlreadyExists | `from foundry_sdk.v1.ontologies.errors import ObjectAlreadyExists` | +**Ontologies** | ObjectChanged | `from foundry_sdk.v1.ontologies.errors import ObjectChanged` | +**Ontologies** | ObjectNotFound | `from foundry_sdk.v1.ontologies.errors import ObjectNotFound` | +**Ontologies** | ObjectSetNotFound | `from foundry_sdk.v1.ontologies.errors import ObjectSetNotFound` | +**Ontologies** | ObjectsExceededLimit | `from foundry_sdk.v1.ontologies.errors import ObjectsExceededLimit` | +**Ontologies** | ObjectTypeNotFound | `from foundry_sdk.v1.ontologies.errors import ObjectTypeNotFound` | +**Ontologies** | ObjectTypeNotSynced | `from foundry_sdk.v1.ontologies.errors import ObjectTypeNotSynced` | +**Ontologies** | ObjectTypesNotSynced | `from foundry_sdk.v1.ontologies.errors import ObjectTypesNotSynced` | +**Ontologies** | OntologyApiNameNotUnique | `from foundry_sdk.v1.ontologies.errors import OntologyApiNameNotUnique` | +**Ontologies** | OntologyEditsExceededLimit | `from foundry_sdk.v1.ontologies.errors import OntologyEditsExceededLimit` | +**Ontologies** | OntologyNotFound | `from foundry_sdk.v1.ontologies.errors import OntologyNotFound` | +**Ontologies** | OntologySyncing | `from foundry_sdk.v1.ontologies.errors import OntologySyncing` | +**Ontologies** | OntologySyncingObjectTypes | `from foundry_sdk.v1.ontologies.errors import OntologySyncingObjectTypes` | +**Ontologies** | ParameterObjectNotFound | `from foundry_sdk.v1.ontologies.errors import ParameterObjectNotFound` | +**Ontologies** | ParameterObjectSetRidNotFound | `from foundry_sdk.v1.ontologies.errors import ParameterObjectSetRidNotFound` | +**Ontologies** | ParametersNotFound | `from foundry_sdk.v1.ontologies.errors import ParametersNotFound` | +**Ontologies** | ParameterTypeNotSupported | `from foundry_sdk.v1.ontologies.errors import ParameterTypeNotSupported` | +**Ontologies** | ParentAttachmentPermissionDenied | `from foundry_sdk.v1.ontologies.errors import ParentAttachmentPermissionDenied` | +**Ontologies** | PropertiesHaveDifferentIds | `from foundry_sdk.v1.ontologies.errors import PropertiesHaveDifferentIds` | +**Ontologies** | PropertiesNotFilterable | `from foundry_sdk.v1.ontologies.errors import PropertiesNotFilterable` | +**Ontologies** | PropertiesNotFound | `from foundry_sdk.v1.ontologies.errors import PropertiesNotFound` | +**Ontologies** | PropertiesNotSearchable | `from foundry_sdk.v1.ontologies.errors import PropertiesNotSearchable` | +**Ontologies** | PropertiesNotSortable | `from foundry_sdk.v1.ontologies.errors import PropertiesNotSortable` | +**Ontologies** | PropertyApiNameNotFound | `from foundry_sdk.v1.ontologies.errors import PropertyApiNameNotFound` | +**Ontologies** | PropertyBaseTypeNotSupported | `from foundry_sdk.v1.ontologies.errors import PropertyBaseTypeNotSupported` | +**Ontologies** | PropertyFiltersNotSupported | `from foundry_sdk.v1.ontologies.errors import PropertyFiltersNotSupported` | +**Ontologies** | PropertyNotFound | `from foundry_sdk.v1.ontologies.errors import PropertyNotFound` | +**Ontologies** | PropertyTypeDoesNotSupportNearestNeighbors | `from foundry_sdk.v1.ontologies.errors import PropertyTypeDoesNotSupportNearestNeighbors` | +**Ontologies** | PropertyTypeNotFound | `from foundry_sdk.v1.ontologies.errors import PropertyTypeNotFound` | +**Ontologies** | PropertyTypesSearchNotSupported | `from foundry_sdk.v1.ontologies.errors import PropertyTypesSearchNotSupported` | +**Ontologies** | QueryEncounteredUserFacingError | `from foundry_sdk.v1.ontologies.errors import QueryEncounteredUserFacingError` | +**Ontologies** | QueryMemoryExceededLimit | `from foundry_sdk.v1.ontologies.errors import QueryMemoryExceededLimit` | +**Ontologies** | QueryNotFound | `from foundry_sdk.v1.ontologies.errors import QueryNotFound` | +**Ontologies** | QueryRuntimeError | `from foundry_sdk.v1.ontologies.errors import QueryRuntimeError` | +**Ontologies** | QueryTimeExceededLimit | `from foundry_sdk.v1.ontologies.errors import QueryTimeExceededLimit` | +**Ontologies** | SearchVectorDimensionsDiffer | `from foundry_sdk.v1.ontologies.errors import SearchVectorDimensionsDiffer` | +**Ontologies** | SharedPropertiesNotFound | `from foundry_sdk.v1.ontologies.errors import SharedPropertiesNotFound` | +**Ontologies** | SharedPropertyTypeNotFound | `from foundry_sdk.v1.ontologies.errors import SharedPropertyTypeNotFound` | +**Ontologies** | TooManyNearestNeighborsRequested | `from foundry_sdk.v1.ontologies.errors import TooManyNearestNeighborsRequested` | +**Ontologies** | UnknownParameter | `from foundry_sdk.v1.ontologies.errors import UnknownParameter` | +**Ontologies** | UnsupportedObjectSet | `from foundry_sdk.v1.ontologies.errors import UnsupportedObjectSet` | +**Ontologies** | ViewObjectPermissionDenied | `from foundry_sdk.v1.ontologies.errors import ViewObjectPermissionDenied` | ## Contributions diff --git a/config.json b/config.json index 476533022..f3cd8a582 100644 --- a/config.json +++ b/config.json @@ -1,5 +1,5 @@ { - "packageName": "foundry", + "packageName": "foundry_sdk", "packageUrl": "https://github.com/palantir/foundry-platform-python", "projectName": "foundry-platform-sdk", "clientName": "FoundryClient", diff --git a/docs/v1/Datasets/Branch.md b/docs/v1/Datasets/Branch.md index e4440c376..db69d8390 100644 --- a/docs/v1/Datasets/Branch.md +++ b/docs/v1/Datasets/Branch.md @@ -27,11 +27,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The Resource Identifier (RID) of the Dataset on which to create the Branch. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -47,7 +47,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Branch.create: %s\n" % e) ``` @@ -84,11 +84,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The Resource Identifier (RID) of the Dataset that contains the Branch. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -100,7 +100,7 @@ try: api_response = foundry_client.datasets.Dataset.Branch.delete(dataset_rid, branch_id) print("The delete response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Branch.delete: %s\n" % e) ``` @@ -137,11 +137,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The Resource Identifier (RID) of the Dataset that contains the Branch. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -153,7 +153,7 @@ try: api_response = foundry_client.datasets.Dataset.Branch.get(dataset_rid, branch_id) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Branch.get: %s\n" % e) ``` @@ -191,11 +191,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The Resource Identifier (RID) of the Dataset on which to list Branches. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -210,7 +210,7 @@ try: dataset_rid, page_size=page_size, page_token=page_token ): pprint(branch) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Branch.list: %s\n" % e) ``` diff --git a/docs/v1/Datasets/Dataset.md b/docs/v1/Datasets/Dataset.md index 153dc756a..47d50609b 100644 --- a/docs/v1/Datasets/Dataset.md +++ b/docs/v1/Datasets/Dataset.md @@ -28,11 +28,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetName name = "My Dataset" @@ -46,7 +46,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Dataset.create: %s\n" % e) ``` @@ -83,11 +83,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The RID of the Dataset on which to delete the schema. dataset_rid = None @@ -105,7 +105,7 @@ try: ) print("The delete_schema response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Dataset.delete_schema: %s\n" % e) ``` @@ -141,11 +141,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -155,7 +155,7 @@ try: api_response = foundry_client.datasets.Dataset.get(dataset_rid) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Dataset.get: %s\n" % e) ``` @@ -192,11 +192,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The RID of the Dataset. dataset_rid = None @@ -214,7 +214,7 @@ try: ) print("The get_schema response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Dataset.get_schema: %s\n" % e) ``` @@ -258,11 +258,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The RID of the Dataset. dataset_rid = None @@ -292,7 +292,7 @@ try: ) print("The read response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Dataset.read: %s\n" % e) ``` @@ -386,11 +386,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The RID of the Dataset on which to put the Schema. dataset_rid = None @@ -408,7 +408,7 @@ try: ) print("The replace_schema response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Dataset.replace_schema: %s\n" % e) ``` diff --git a/docs/v1/Datasets/File.md b/docs/v1/Datasets/File.md index c1a19a08e..7048b19e1 100644 --- a/docs/v1/Datasets/File.md +++ b/docs/v1/Datasets/File.md @@ -42,11 +42,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The Resource Identifier (RID) of the Dataset on which to delete the File. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -64,7 +64,7 @@ try: ) print("The delete response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling File.delete: %s\n" % e) ``` @@ -125,11 +125,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The Resource Identifier (RID) of the Dataset that contains the File. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -153,7 +153,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling File.get: %s\n" % e) ``` @@ -217,11 +217,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The Resource Identifier (RID) of the Dataset on which to list Files. dataset_rid = None @@ -247,7 +247,7 @@ try: start_transaction_rid=start_transaction_rid, ): pprint(file) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling File.list: %s\n" % e) ``` @@ -329,11 +329,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The Resource Identifier (RID) of the Dataset that contains the File. dataset_rid = None @@ -357,7 +357,7 @@ try: ) print("The read response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling File.read: %s\n" % e) ``` @@ -415,11 +415,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The Resource Identifier (RID) of the Dataset on which to upload the File. dataset_rid = None @@ -446,7 +446,7 @@ try: ) print("The upload response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling File.upload: %s\n" % e) ``` diff --git a/docs/v1/Datasets/Transaction.md b/docs/v1/Datasets/Transaction.md index f1bc0f397..617437c79 100644 --- a/docs/v1/Datasets/Transaction.md +++ b/docs/v1/Datasets/Transaction.md @@ -27,11 +27,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The Resource Identifier (RID) of the Dataset that contains the Transaction. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -43,7 +43,7 @@ try: api_response = foundry_client.datasets.Dataset.Transaction.abort(dataset_rid, transaction_rid) print("The abort response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Transaction.abort: %s\n" % e) ``` @@ -81,11 +81,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The Resource Identifier (RID) of the Dataset that contains the Transaction. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -97,7 +97,7 @@ try: api_response = foundry_client.datasets.Dataset.Transaction.commit(dataset_rid, transaction_rid) print("The commit response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Transaction.commit: %s\n" % e) ``` @@ -135,11 +135,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The Resource Identifier (RID) of the Dataset on which to create the Transaction. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -155,7 +155,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Transaction.create: %s\n" % e) ``` @@ -214,11 +214,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid | The Resource Identifier (RID) of the Dataset that contains the Transaction. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -230,7 +230,7 @@ try: api_response = foundry_client.datasets.Dataset.Transaction.get(dataset_rid, transaction_rid) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Transaction.get: %s\n" % e) ``` diff --git a/docs/v1/Ontologies/Action.md b/docs/v1/Ontologies/Action.md index bfa4aa63d..b3cd2228c 100644 --- a/docs/v1/Ontologies/Action.md +++ b/docs/v1/Ontologies/Action.md @@ -31,11 +31,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -51,7 +51,7 @@ try: ) print("The apply response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Action.apply: %s\n" % e) ``` @@ -97,11 +97,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -120,7 +120,7 @@ try: ) print("The apply_batch response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Action.apply_batch: %s\n" % e) ``` @@ -165,11 +165,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -197,7 +197,7 @@ try: ) print("The validate response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Action.validate: %s\n" % e) ``` diff --git a/docs/v1/Ontologies/ActionType.md b/docs/v1/Ontologies/ActionType.md index f69bcb4a3..e33780544 100644 --- a/docs/v1/Ontologies/ActionType.md +++ b/docs/v1/Ontologies/ActionType.md @@ -24,11 +24,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the action type. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -42,7 +42,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ActionType.get: %s\n" % e) ``` @@ -83,11 +83,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -102,7 +102,7 @@ try: ontology_rid, page_size=page_size, page_token=page_token ): pprint(action_type) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ActionType.list: %s\n" % e) ``` diff --git a/docs/v1/Ontologies/Attachment.md b/docs/v1/Ontologies/Attachment.md index 92fe10fd4..68a055068 100644 --- a/docs/v1/Ontologies/Attachment.md +++ b/docs/v1/Ontologies/Attachment.md @@ -25,11 +25,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AttachmentRid | The RID of the attachment. attachment_rid = "ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f" @@ -39,7 +39,7 @@ try: api_response = foundry_client.ontologies.Attachment.get(attachment_rid) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Attachment.get: %s\n" % e) ``` @@ -76,11 +76,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AttachmentRid | The RID of the attachment. attachment_rid = "ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f" @@ -90,7 +90,7 @@ try: api_response = foundry_client.ontologies.Attachment.read(attachment_rid) print("The read response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Attachment.read: %s\n" % e) ``` @@ -134,11 +134,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # bytes | Body of the request body = None @@ -156,7 +156,7 @@ try: ) print("The upload response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Attachment.upload: %s\n" % e) ``` diff --git a/docs/v1/Ontologies/ObjectType.md b/docs/v1/Ontologies/ObjectType.md index 8bc857312..720772543 100644 --- a/docs/v1/Ontologies/ObjectType.md +++ b/docs/v1/Ontologies/ObjectType.md @@ -26,11 +26,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -42,7 +42,7 @@ try: api_response = foundry_client.ontologies.Ontology.ObjectType.get(ontology_rid, object_type) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ObjectType.get: %s\n" % e) ``` @@ -81,11 +81,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager** application. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -101,7 +101,7 @@ try: ) print("The get_outgoing_link_type response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ObjectType.get_outgoing_link_type: %s\n" % e) ``` @@ -143,11 +143,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -162,7 +162,7 @@ try: ontology_rid, page_size=page_size, page_token=page_token ): pprint(object_type) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ObjectType.list: %s\n" % e) ``` @@ -202,11 +202,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager** application. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -223,7 +223,7 @@ try: ontology_rid, object_type, page_size=page_size, page_token=page_token ): pprint(object_type) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ObjectType.list_outgoing_link_types: %s\n" % e) ``` diff --git a/docs/v1/Ontologies/Ontology.md b/docs/v1/Ontologies/Ontology.md index 5358c7461..a3368c02b 100644 --- a/docs/v1/Ontologies/Ontology.md +++ b/docs/v1/Ontologies/Ontology.md @@ -23,11 +23,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -37,7 +37,7 @@ try: api_response = foundry_client.ontologies.Ontology.get(ontology_rid) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Ontology.get: %s\n" % e) ``` @@ -72,18 +72,18 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") try: api_response = foundry_client.ontologies.Ontology.list() print("The list response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Ontology.list: %s\n" % e) ``` diff --git a/docs/v1/Ontologies/OntologyObject.md b/docs/v1/Ontologies/OntologyObject.md index 1a990aad1..40b3ccf25 100644 --- a/docs/v1/Ontologies/OntologyObject.md +++ b/docs/v1/Ontologies/OntologyObject.md @@ -31,11 +31,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the objects. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -65,7 +65,7 @@ try: ) print("The aggregate response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObject.aggregate: %s\n" % e) ``` @@ -104,11 +104,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -126,7 +126,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObject.get: %s\n" % e) ``` @@ -168,11 +168,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -199,7 +199,7 @@ try: ) print("The get_linked_object response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObject.get_linked_object: %s\n" % e) ``` @@ -255,11 +255,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -285,7 +285,7 @@ try: properties=properties, ): pprint(ontology_object) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObject.list: %s\n" % e) ``` @@ -343,11 +343,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -379,7 +379,7 @@ try: properties=properties, ): pprint(ontology_object) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObject.list_linked_objects: %s\n" % e) ``` @@ -442,11 +442,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the objects. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -476,7 +476,7 @@ try: ) print("The search response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObject.search: %s\n" % e) ``` diff --git a/docs/v1/Ontologies/Query.md b/docs/v1/Ontologies/Query.md index 0eae8cbf5..c3913065c 100644 --- a/docs/v1/Ontologies/Query.md +++ b/docs/v1/Ontologies/Query.md @@ -24,11 +24,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the Query. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -44,7 +44,7 @@ try: ) print("The execute response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Query.execute: %s\n" % e) ``` diff --git a/docs/v1/Ontologies/QueryType.md b/docs/v1/Ontologies/QueryType.md index 0168608ce..19994c0a5 100644 --- a/docs/v1/Ontologies/QueryType.md +++ b/docs/v1/Ontologies/QueryType.md @@ -24,11 +24,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the query type. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -40,7 +40,7 @@ try: api_response = foundry_client.ontologies.Ontology.QueryType.get(ontology_rid, query_api_name) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling QueryType.get: %s\n" % e) ``` @@ -81,11 +81,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v1 import FoundryClient -import foundry +from foundry_sdk.v1 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" @@ -100,7 +100,7 @@ try: ontology_rid, page_size=page_size, page_token=page_token ): pprint(query_type) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling QueryType.list: %s\n" % e) ``` diff --git a/docs/v2/Admin/AuthenticationProvider.md b/docs/v2/Admin/AuthenticationProvider.md index 8ca7bcc30..7f352fb94 100644 --- a/docs/v2/Admin/AuthenticationProvider.md +++ b/docs/v2/Admin/AuthenticationProvider.md @@ -24,11 +24,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # EnrollmentRid enrollment_rid = None @@ -44,7 +44,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling AuthenticationProvider.get: %s\n" % e) ``` @@ -80,11 +80,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # EnrollmentRid enrollment_rid = None @@ -98,7 +98,7 @@ try: ) print("The list response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling AuthenticationProvider.list: %s\n" % e) ``` @@ -137,11 +137,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # EnrollmentRid enrollment_rid = None @@ -165,7 +165,7 @@ try: ) print("The preregister_group response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling AuthenticationProvider.preregister_group: %s\n" % e) ``` @@ -208,11 +208,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # EnrollmentRid enrollment_rid = None @@ -258,7 +258,7 @@ try: ) print("The preregister_user response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling AuthenticationProvider.preregister_user: %s\n" % e) ``` diff --git a/docs/v2/Admin/Enrollment.md b/docs/v2/Admin/Enrollment.md index 5712c035f..939db1f98 100644 --- a/docs/v2/Admin/Enrollment.md +++ b/docs/v2/Admin/Enrollment.md @@ -21,11 +21,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # EnrollmentRid enrollment_rid = None @@ -37,7 +37,7 @@ try: api_response = foundry_client.admin.Enrollment.get(enrollment_rid, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Enrollment.get: %s\n" % e) ``` @@ -71,11 +71,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # Optional[PreviewMode] | Enables the use of preview functionality. preview = None @@ -85,7 +85,7 @@ try: api_response = foundry_client.admin.Enrollment.get_current(preview=preview) print("The get_current response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Enrollment.get_current: %s\n" % e) ``` diff --git a/docs/v2/Admin/Group.md b/docs/v2/Admin/Group.md index 102e2ffac..fd4fec479 100644 --- a/docs/v2/Admin/Group.md +++ b/docs/v2/Admin/Group.md @@ -27,11 +27,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # Dict[AttributeName, AttributeValues] | A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. attributes = { @@ -59,7 +59,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Group.create: %s\n" % e) ``` @@ -92,11 +92,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId group_id = None @@ -106,7 +106,7 @@ try: api_response = foundry_client.admin.Group.delete(group_id) print("The delete response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Group.delete: %s\n" % e) ``` @@ -139,11 +139,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId group_id = None @@ -153,7 +153,7 @@ try: api_response = foundry_client.admin.Group.get(group_id) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Group.get: %s\n" % e) ``` @@ -188,11 +188,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # List[GetGroupsBatchRequestElement] | Body of the request body = [{"groupId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"}] @@ -202,7 +202,7 @@ try: api_response = foundry_client.admin.Group.get_batch(body) print("The get_batch response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Group.get_batch: %s\n" % e) ``` @@ -238,11 +238,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # Optional[PageSize] | The page size to use for the endpoint. page_size = None @@ -253,7 +253,7 @@ page_token = None try: for group in client.admin.Group.list(page_size=page_size, page_token=page_token): pprint(group) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Group.list: %s\n" % e) ``` @@ -289,11 +289,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # GroupSearchFilter where = {"type": "queryString"} @@ -309,7 +309,7 @@ try: ) print("The search response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Group.search: %s\n" % e) ``` diff --git a/docs/v2/Admin/GroupMember.md b/docs/v2/Admin/GroupMember.md index 2fd62ba94..b223f163a 100644 --- a/docs/v2/Admin/GroupMember.md +++ b/docs/v2/Admin/GroupMember.md @@ -23,11 +23,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId group_id = None @@ -43,7 +43,7 @@ try: ) print("The add response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling GroupMember.add: %s\n" % e) ``` @@ -86,11 +86,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId group_id = None @@ -107,7 +107,7 @@ try: group_id, page_size=page_size, page_token=page_token, transitive=transitive ): pprint(group_member) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling GroupMember.list: %s\n" % e) ``` @@ -141,11 +141,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId group_id = None @@ -159,7 +159,7 @@ try: ) print("The remove response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling GroupMember.remove: %s\n" % e) ``` diff --git a/docs/v2/Admin/GroupMembership.md b/docs/v2/Admin/GroupMembership.md index cf6684e68..676219967 100644 --- a/docs/v2/Admin/GroupMembership.md +++ b/docs/v2/Admin/GroupMembership.md @@ -29,11 +29,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId user_id = None @@ -50,7 +50,7 @@ try: user_id, page_size=page_size, page_token=page_token, transitive=transitive ): pprint(group_membership) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling GroupMembership.list: %s\n" % e) ``` diff --git a/docs/v2/Admin/GroupProviderInfo.md b/docs/v2/Admin/GroupProviderInfo.md index 5d6e52f62..b65680da3 100644 --- a/docs/v2/Admin/GroupProviderInfo.md +++ b/docs/v2/Admin/GroupProviderInfo.md @@ -21,11 +21,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId group_id = None @@ -37,7 +37,7 @@ try: api_response = foundry_client.admin.Group.ProviderInfo.get(group_id, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ProviderInfo.get: %s\n" % e) ``` @@ -72,11 +72,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId group_id = None @@ -92,7 +92,7 @@ try: ) print("The replace response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ProviderInfo.replace: %s\n" % e) ``` diff --git a/docs/v2/Admin/Host.md b/docs/v2/Admin/Host.md index 4eebb70a9..aa975d339 100644 --- a/docs/v2/Admin/Host.md +++ b/docs/v2/Admin/Host.md @@ -24,11 +24,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # EnrollmentRid enrollment_rid = None @@ -45,7 +45,7 @@ try: enrollment_rid, page_size=page_size, page_token=page_token, preview=preview ): pprint(host) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Host.list: %s\n" % e) ``` diff --git a/docs/v2/Admin/Marking.md b/docs/v2/Admin/Marking.md index 1d3903387..721360213 100644 --- a/docs/v2/Admin/Marking.md +++ b/docs/v2/Admin/Marking.md @@ -27,11 +27,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MarkingCategoryId category_id = "0950264e-01c8-4e83-81a9-1a6b7f77621a" @@ -60,7 +60,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Marking.create: %s\n" % e) ``` @@ -94,11 +94,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MarkingId marking_id = None @@ -110,7 +110,7 @@ try: api_response = foundry_client.admin.Marking.get(marking_id, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Marking.get: %s\n" % e) ``` @@ -146,11 +146,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # List[GetMarkingsBatchRequestElement] | Body of the request body = [{"markingId": "18212f9a-0e63-4b79-96a0-aae04df23336"}] @@ -162,7 +162,7 @@ try: api_response = foundry_client.admin.Marking.get_batch(body, preview=preview) print("The get_batch response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Marking.get_batch: %s\n" % e) ``` @@ -197,11 +197,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # Optional[PageSize] | The page size to use for the endpoint. page_size = None @@ -216,7 +216,7 @@ try: page_size=page_size, page_token=page_token, preview=preview ): pprint(marking) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Marking.list: %s\n" % e) ``` diff --git a/docs/v2/Admin/MarkingCategory.md b/docs/v2/Admin/MarkingCategory.md index 737d89dc1..4a91921f5 100644 --- a/docs/v2/Admin/MarkingCategory.md +++ b/docs/v2/Admin/MarkingCategory.md @@ -21,11 +21,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MarkingCategoryId marking_category_id = None @@ -37,7 +37,7 @@ try: api_response = foundry_client.admin.MarkingCategory.get(marking_category_id, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MarkingCategory.get: %s\n" % e) ``` @@ -72,11 +72,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # Optional[PageSize] | The page size to use for the endpoint. page_size = None @@ -91,7 +91,7 @@ try: page_size=page_size, page_token=page_token, preview=preview ): pprint(marking_category) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MarkingCategory.list: %s\n" % e) ``` diff --git a/docs/v2/Admin/MarkingMember.md b/docs/v2/Admin/MarkingMember.md index 6044262d8..cea239c00 100644 --- a/docs/v2/Admin/MarkingMember.md +++ b/docs/v2/Admin/MarkingMember.md @@ -23,11 +23,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MarkingId marking_id = None @@ -43,7 +43,7 @@ try: ) print("The add response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MarkingMember.add: %s\n" % e) ``` @@ -82,11 +82,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MarkingId marking_id = None @@ -109,7 +109,7 @@ try: transitive=transitive, ): pprint(marking_member) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MarkingMember.list: %s\n" % e) ``` @@ -144,11 +144,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MarkingId marking_id = None @@ -164,7 +164,7 @@ try: ) print("The remove response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MarkingMember.remove: %s\n" % e) ``` diff --git a/docs/v2/Admin/MarkingRoleAssignment.md b/docs/v2/Admin/MarkingRoleAssignment.md index cb19ba4f5..ba78d246e 100644 --- a/docs/v2/Admin/MarkingRoleAssignment.md +++ b/docs/v2/Admin/MarkingRoleAssignment.md @@ -23,11 +23,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MarkingId marking_id = None @@ -43,7 +43,7 @@ try: ) print("The add response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MarkingRoleAssignment.add: %s\n" % e) ``` @@ -80,11 +80,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MarkingId marking_id = None @@ -101,7 +101,7 @@ try: marking_id, page_size=page_size, page_token=page_token, preview=preview ): pprint(marking_role_assignment) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MarkingRoleAssignment.list: %s\n" % e) ``` @@ -136,11 +136,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MarkingId marking_id = None @@ -156,7 +156,7 @@ try: ) print("The remove response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MarkingRoleAssignment.remove: %s\n" % e) ``` diff --git a/docs/v2/Admin/Organization.md b/docs/v2/Admin/Organization.md index 8d763a121..b2fa22dc5 100644 --- a/docs/v2/Admin/Organization.md +++ b/docs/v2/Admin/Organization.md @@ -21,11 +21,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OrganizationRid organization_rid = None @@ -37,7 +37,7 @@ try: api_response = foundry_client.admin.Organization.get(organization_rid, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Organization.get: %s\n" % e) ``` @@ -74,11 +74,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OrganizationRid organization_rid = None @@ -98,7 +98,7 @@ try: ) print("The replace response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Organization.replace: %s\n" % e) ``` diff --git a/docs/v2/Admin/User.md b/docs/v2/Admin/User.md index c8886ea05..7dd1ce2bb 100644 --- a/docs/v2/Admin/User.md +++ b/docs/v2/Admin/User.md @@ -26,11 +26,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId user_id = None @@ -40,7 +40,7 @@ try: api_response = foundry_client.admin.User.delete(user_id) print("The delete response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling User.delete: %s\n" % e) ``` @@ -73,11 +73,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId user_id = None @@ -87,7 +87,7 @@ try: api_response = foundry_client.admin.User.get(user_id) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling User.get: %s\n" % e) ``` @@ -122,11 +122,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # List[GetUsersBatchRequestElement] | Body of the request body = [{"userId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"}] @@ -136,7 +136,7 @@ try: api_response = foundry_client.admin.User.get_batch(body) print("The get_batch response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling User.get_batch: %s\n" % e) ``` @@ -168,18 +168,18 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") try: api_response = foundry_client.admin.User.get_current() print("The get_current response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling User.get_current: %s\n" % e) ``` @@ -213,11 +213,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId user_id = None @@ -229,7 +229,7 @@ try: api_response = foundry_client.admin.User.get_markings(user_id, preview=preview) print("The get_markings response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling User.get_markings: %s\n" % e) ``` @@ -265,11 +265,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # Optional[PageSize] | The page size to use for the endpoint. page_size = None @@ -280,7 +280,7 @@ page_token = None try: for user in client.admin.User.list(page_size=page_size, page_token=page_token): pprint(user) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling User.list: %s\n" % e) ``` @@ -313,11 +313,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId user_id = None @@ -327,7 +327,7 @@ try: api_response = foundry_client.admin.User.profile_picture(user_id) print("The profile_picture response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling User.profile_picture: %s\n" % e) ``` @@ -363,11 +363,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # UserSearchFilter where = {"type": "queryString"} @@ -383,7 +383,7 @@ try: ) print("The search response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling User.search: %s\n" % e) ``` diff --git a/docs/v2/Admin/UserProviderInfo.md b/docs/v2/Admin/UserProviderInfo.md index c65797c7d..534f12eb5 100644 --- a/docs/v2/Admin/UserProviderInfo.md +++ b/docs/v2/Admin/UserProviderInfo.md @@ -21,11 +21,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId user_id = None @@ -37,7 +37,7 @@ try: api_response = foundry_client.admin.User.ProviderInfo.get(user_id, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ProviderInfo.get: %s\n" % e) ``` @@ -72,11 +72,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # PrincipalId user_id = None @@ -92,7 +92,7 @@ try: ) print("The replace response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ProviderInfo.replace: %s\n" % e) ``` diff --git a/docs/v2/AipAgents/Agent.md b/docs/v2/AipAgents/Agent.md index 181fcc61f..158943d23 100644 --- a/docs/v2/AipAgents/Agent.md +++ b/docs/v2/AipAgents/Agent.md @@ -24,11 +24,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # Optional[PageSize] | The maximum number of sessions to return in a single page. The maximum allowed value is 100. Defaults to 100 if not specified. page_size = None @@ -43,7 +43,7 @@ try: page_size=page_size, page_token=page_token, preview=preview ): pprint(agent) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Agent.all_sessions: %s\n" % e) ``` @@ -78,11 +78,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" @@ -96,7 +96,7 @@ try: api_response = foundry_client.aip_agents.Agent.get(agent_rid, preview=preview, version=version) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Agent.get: %s\n" % e) ``` diff --git a/docs/v2/AipAgents/AgentVersion.md b/docs/v2/AipAgents/AgentVersion.md index abb711715..023733b2e 100644 --- a/docs/v2/AipAgents/AgentVersion.md +++ b/docs/v2/AipAgents/AgentVersion.md @@ -22,11 +22,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" @@ -42,7 +42,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling AgentVersion.get: %s\n" % e) ``` @@ -80,11 +80,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" @@ -101,7 +101,7 @@ try: agent_rid, page_size=page_size, page_token=page_token, preview=preview ): pprint(agent_version) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling AgentVersion.list: %s\n" % e) ``` diff --git a/docs/v2/AipAgents/Content.md b/docs/v2/AipAgents/Content.md index 8db052b98..c2f04aa75 100644 --- a/docs/v2/AipAgents/Content.md +++ b/docs/v2/AipAgents/Content.md @@ -21,11 +21,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" @@ -41,7 +41,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Content.get: %s\n" % e) ``` diff --git a/docs/v2/AipAgents/Session.md b/docs/v2/AipAgents/Session.md index 253765226..0e3ab5115 100644 --- a/docs/v2/AipAgents/Session.md +++ b/docs/v2/AipAgents/Session.md @@ -37,11 +37,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" @@ -78,7 +78,7 @@ try: ) print("The blocking_continue response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Session.blocking_continue: %s\n" % e) ``` @@ -118,11 +118,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" @@ -142,7 +142,7 @@ try: ) print("The cancel response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Session.cancel: %s\n" % e) ``` @@ -179,11 +179,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" @@ -199,7 +199,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Session.create: %s\n" % e) ``` @@ -234,11 +234,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" @@ -254,7 +254,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Session.get: %s\n" % e) ``` @@ -294,11 +294,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" @@ -315,7 +315,7 @@ try: agent_rid, page_size=page_size, page_token=page_token, preview=preview ): pprint(session) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Session.list: %s\n" % e) ``` @@ -354,11 +354,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" @@ -382,7 +382,7 @@ try: ) print("The rag_context response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Session.rag_context: %s\n" % e) ``` @@ -428,11 +428,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" @@ -472,7 +472,7 @@ try: ) print("The streaming_continue response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Session.streaming_continue: %s\n" % e) ``` @@ -510,11 +510,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" @@ -532,7 +532,7 @@ try: ) print("The update_title response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Session.update_title: %s\n" % e) ``` diff --git a/docs/v2/Connectivity/Connection.md b/docs/v2/Connectivity/Connection.md index a960b2919..b3f69641d 100644 --- a/docs/v2/Connectivity/Connection.md +++ b/docs/v2/Connectivity/Connection.md @@ -34,11 +34,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # CreateConnectionRequestConnectionConfiguration configuration = None @@ -59,7 +59,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Connection.create: %s\n" % e) ``` @@ -93,11 +93,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -109,7 +109,7 @@ try: api_response = foundry_client.connectivity.Connection.get(connection_rid, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Connection.get: %s\n" % e) ``` @@ -145,11 +145,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -163,7 +163,7 @@ try: ) print("The get_configuration response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Connection.get_configuration: %s\n" % e) ``` @@ -209,11 +209,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -229,7 +229,7 @@ try: ) print("The update_secrets response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Connection.update_secrets: %s\n" % e) ``` diff --git a/docs/v2/Connectivity/FileImport.md b/docs/v2/Connectivity/FileImport.md index 19553b8bc..69d450b5a 100644 --- a/docs/v2/Connectivity/FileImport.md +++ b/docs/v2/Connectivity/FileImport.md @@ -31,11 +31,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -68,7 +68,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling FileImport.create: %s\n" % e) ``` @@ -106,11 +106,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -126,7 +126,7 @@ try: ) print("The delete response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling FileImport.delete: %s\n" % e) ``` @@ -163,11 +163,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -183,7 +183,7 @@ try: ) print("The execute response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling FileImport.execute: %s\n" % e) ``` @@ -218,11 +218,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -238,7 +238,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling FileImport.get: %s\n" % e) ``` @@ -276,11 +276,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -297,7 +297,7 @@ try: connection_rid, page_size=page_size, page_token=page_token, preview=preview ): pprint(file_import) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling FileImport.list: %s\n" % e) ``` @@ -338,11 +338,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -378,7 +378,7 @@ try: ) print("The replace response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling FileImport.replace: %s\n" % e) ``` diff --git a/docs/v2/Connectivity/TableImport.md b/docs/v2/Connectivity/TableImport.md index bfab2a7a8..64d1fccb7 100644 --- a/docs/v2/Connectivity/TableImport.md +++ b/docs/v2/Connectivity/TableImport.md @@ -30,11 +30,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -67,7 +67,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling TableImport.create: %s\n" % e) ``` @@ -105,11 +105,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -125,7 +125,7 @@ try: ) print("The delete response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling TableImport.delete: %s\n" % e) ``` @@ -162,11 +162,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -182,7 +182,7 @@ try: ) print("The execute response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling TableImport.execute: %s\n" % e) ``` @@ -217,11 +217,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -237,7 +237,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling TableImport.get: %s\n" % e) ``` @@ -275,11 +275,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ConnectionRid connection_rid = None @@ -296,7 +296,7 @@ try: connection_rid, page_size=page_size, page_token=page_token, preview=preview ): pprint(table_import) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling TableImport.list: %s\n" % e) ``` diff --git a/docs/v2/Datasets/Branch.md b/docs/v2/Datasets/Branch.md index f1b20c8f5..f07604b0b 100644 --- a/docs/v2/Datasets/Branch.md +++ b/docs/v2/Datasets/Branch.md @@ -25,11 +25,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -45,7 +45,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Branch.create: %s\n" % e) ``` @@ -80,11 +80,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -96,7 +96,7 @@ try: api_response = foundry_client.datasets.Dataset.Branch.delete(dataset_rid, branch_name) print("The delete response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Branch.delete: %s\n" % e) ``` @@ -131,11 +131,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -147,7 +147,7 @@ try: api_response = foundry_client.datasets.Dataset.Branch.get(dataset_rid, branch_name) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Branch.get: %s\n" % e) ``` @@ -183,11 +183,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -202,7 +202,7 @@ try: dataset_rid, page_size=page_size, page_token=page_token ): pprint(branch) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Branch.list: %s\n" % e) ``` diff --git a/docs/v2/Datasets/Dataset.md b/docs/v2/Datasets/Dataset.md index f448519ee..a326160c3 100644 --- a/docs/v2/Datasets/Dataset.md +++ b/docs/v2/Datasets/Dataset.md @@ -23,11 +23,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetName name = "My Dataset" @@ -41,7 +41,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Dataset.create: %s\n" % e) ``` @@ -74,11 +74,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -88,7 +88,7 @@ try: api_response = foundry_client.datasets.Dataset.get(dataset_rid) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Dataset.get: %s\n" % e) ``` @@ -130,11 +130,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -164,7 +164,7 @@ try: ) print("The read_table response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Dataset.read_table: %s\n" % e) ``` diff --git a/docs/v2/Datasets/File.md b/docs/v2/Datasets/File.md index 4d41089c3..ba4adf899 100644 --- a/docs/v2/Datasets/File.md +++ b/docs/v2/Datasets/File.md @@ -44,11 +44,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -72,7 +72,7 @@ try: ) print("The content response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling File.content: %s\n" % e) ``` @@ -118,11 +118,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -140,7 +140,7 @@ try: ) print("The delete response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling File.delete: %s\n" % e) ``` @@ -193,11 +193,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -221,7 +221,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling File.get: %s\n" % e) ``` @@ -277,11 +277,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -307,7 +307,7 @@ try: start_transaction_rid=start_transaction_rid, ): pprint(file) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling File.list: %s\n" % e) ``` @@ -358,11 +358,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -389,7 +389,7 @@ try: ) print("The upload response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling File.upload: %s\n" % e) ``` diff --git a/docs/v2/Datasets/Transaction.md b/docs/v2/Datasets/Transaction.md index 79ebeb0a8..6ebd10bad 100644 --- a/docs/v2/Datasets/Transaction.md +++ b/docs/v2/Datasets/Transaction.md @@ -27,11 +27,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -43,7 +43,7 @@ try: api_response = foundry_client.datasets.Dataset.Transaction.abort(dataset_rid, transaction_rid) print("The abort response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Transaction.abort: %s\n" % e) ``` @@ -81,11 +81,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -101,7 +101,7 @@ try: ) print("The build response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Transaction.build: %s\n" % e) ``` @@ -137,11 +137,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -153,7 +153,7 @@ try: api_response = foundry_client.datasets.Dataset.Transaction.commit(dataset_rid, transaction_rid) print("The commit response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Transaction.commit: %s\n" % e) ``` @@ -189,11 +189,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -209,7 +209,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Transaction.create: %s\n" % e) ``` @@ -266,11 +266,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -282,7 +282,7 @@ try: api_response = foundry_client.datasets.Dataset.Transaction.get(dataset_rid, transaction_rid) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Transaction.get: %s\n" % e) ``` @@ -320,11 +320,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -340,7 +340,7 @@ try: ) print("The job response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Transaction.job: %s\n" % e) ``` diff --git a/docs/v2/Filesystem/Folder.md b/docs/v2/Filesystem/Folder.md index b633e8193..649e3a08a 100644 --- a/docs/v2/Filesystem/Folder.md +++ b/docs/v2/Filesystem/Folder.md @@ -28,11 +28,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # FolderRid folder_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8" @@ -49,7 +49,7 @@ try: folder_rid, page_size=page_size, page_token=page_token, preview=preview ): pprint(folder) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Folder.children: %s\n" % e) ``` @@ -84,11 +84,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ResourceDisplayName display_name = "My Folder" @@ -104,7 +104,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Folder.create: %s\n" % e) ``` @@ -138,11 +138,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # FolderRid folder_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8" @@ -154,7 +154,7 @@ try: api_response = foundry_client.filesystem.Folder.get(folder_rid, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Folder.get: %s\n" % e) ``` diff --git a/docs/v2/Filesystem/Project.md b/docs/v2/Filesystem/Project.md index 83c4af598..0b385c6c6 100644 --- a/docs/v2/Filesystem/Project.md +++ b/docs/v2/Filesystem/Project.md @@ -26,11 +26,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ProjectRid project_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8" @@ -46,7 +46,7 @@ try: ) print("The add_organizations response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Project.add_organizations: %s\n" % e) ``` @@ -90,11 +90,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # List[RoleId] default_roles = ["8bf49052-dc37-4528-8bf0-b551cfb71268"] @@ -128,7 +128,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Project.create: %s\n" % e) ``` @@ -166,11 +166,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ProjectTemplateRid template_rid = "ri.compass.main.template.c410f510-2937-420e-8ea3-8c9bcb3c1791" @@ -197,7 +197,7 @@ try: ) print("The create_from_template response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Project.create_from_template: %s\n" % e) ``` @@ -231,11 +231,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ProjectRid project_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8" @@ -247,7 +247,7 @@ try: api_response = foundry_client.filesystem.Project.get(project_rid, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Project.get: %s\n" % e) ``` @@ -285,11 +285,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ProjectRid project_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8" @@ -306,7 +306,7 @@ try: project_rid, page_size=page_size, page_token=page_token, preview=preview ): pprint(project) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Project.organizations: %s\n" % e) ``` @@ -341,11 +341,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ProjectRid project_rid = "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8" @@ -361,7 +361,7 @@ try: ) print("The remove_organizations response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Project.remove_organizations: %s\n" % e) ``` diff --git a/docs/v2/Filesystem/Resource.md b/docs/v2/Filesystem/Resource.md index f7df93a8a..123929862 100644 --- a/docs/v2/Filesystem/Resource.md +++ b/docs/v2/Filesystem/Resource.md @@ -29,11 +29,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ResourceRid resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -49,7 +49,7 @@ try: ) print("The add_markings response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Resource.add_markings: %s\n" % e) ``` @@ -85,11 +85,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ResourceRid resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -101,7 +101,7 @@ try: api_response = foundry_client.filesystem.Resource.delete(resource_rid, preview=preview) print("The delete response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Resource.delete: %s\n" % e) ``` @@ -135,11 +135,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ResourceRid resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -151,7 +151,7 @@ try: api_response = foundry_client.filesystem.Resource.get(resource_rid, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Resource.get: %s\n" % e) ``` @@ -187,11 +187,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ResourceRid resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -205,7 +205,7 @@ try: ) print("The get_access_requirements response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Resource.get_access_requirements: %s\n" % e) ``` @@ -239,11 +239,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ResourcePath | The path to the Resource. The leading slash is optional. path = "/My Organization-abcd/My Important Project/My Dataset" @@ -255,7 +255,7 @@ try: api_response = foundry_client.filesystem.Resource.get_by_path(path=path, preview=preview) print("The get_by_path response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Resource.get_by_path: %s\n" % e) ``` @@ -293,11 +293,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ResourceRid resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -314,7 +314,7 @@ try: resource_rid, page_size=page_size, page_token=page_token, preview=preview ): pprint(resource) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Resource.markings: %s\n" % e) ``` @@ -350,11 +350,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ResourceRid resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -368,7 +368,7 @@ try: ) print("The permanently_delete response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Resource.permanently_delete: %s\n" % e) ``` @@ -403,11 +403,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ResourceRid resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -423,7 +423,7 @@ try: ) print("The remove_markings response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Resource.remove_markings: %s\n" % e) ``` @@ -459,11 +459,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ResourceRid resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -475,7 +475,7 @@ try: api_response = foundry_client.filesystem.Resource.restore(resource_rid, preview=preview) print("The restore response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Resource.restore: %s\n" % e) ``` diff --git a/docs/v2/Filesystem/ResourceRole.md b/docs/v2/Filesystem/ResourceRole.md index 928faace1..09a85c91c 100644 --- a/docs/v2/Filesystem/ResourceRole.md +++ b/docs/v2/Filesystem/ResourceRole.md @@ -23,11 +23,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ResourceRid resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -43,7 +43,7 @@ try: ) print("The add response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Role.add: %s\n" % e) ``` @@ -81,11 +81,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ResourceRid resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -108,7 +108,7 @@ try: preview=preview, ): pprint(resource_role) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Role.list: %s\n" % e) ``` @@ -143,11 +143,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ResourceRid resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" @@ -163,7 +163,7 @@ try: ) print("The remove response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Role.remove: %s\n" % e) ``` diff --git a/docs/v2/Filesystem/Space.md b/docs/v2/Filesystem/Space.md index 873a8a68a..d01d41311 100644 --- a/docs/v2/Filesystem/Space.md +++ b/docs/v2/Filesystem/Space.md @@ -23,11 +23,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # Optional[PageSize] | The page size to use for the endpoint. page_size = None @@ -42,7 +42,7 @@ try: page_size=page_size, page_token=page_token, preview=preview ): pprint(space) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Space.list: %s\n" % e) ``` diff --git a/docs/v2/Functions/Query.md b/docs/v2/Functions/Query.md index 14e0a0f70..8f8fb4a8d 100644 --- a/docs/v2/Functions/Query.md +++ b/docs/v2/Functions/Query.md @@ -26,11 +26,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # QueryApiName query_api_name = None @@ -46,7 +46,7 @@ try: ) print("The execute response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Query.execute: %s\n" % e) ``` @@ -81,11 +81,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # QueryApiName query_api_name = None @@ -97,7 +97,7 @@ try: api_response = foundry_client.functions.Query.get(query_api_name, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Query.get: %s\n" % e) ``` @@ -132,11 +132,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # FunctionRid rid = None @@ -148,7 +148,7 @@ try: api_response = foundry_client.functions.Query.get_by_rid(rid=rid, preview=preview) print("The get_by_rid response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Query.get_by_rid: %s\n" % e) ``` diff --git a/docs/v2/Functions/ValueType.md b/docs/v2/Functions/ValueType.md index 71410cd44..1e32d1916 100644 --- a/docs/v2/Functions/ValueType.md +++ b/docs/v2/Functions/ValueType.md @@ -21,11 +21,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ValueTypeRid value_type_rid = None @@ -37,7 +37,7 @@ try: api_response = foundry_client.functions.ValueType.get(value_type_rid, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ValueType.get: %s\n" % e) ``` diff --git a/docs/v2/Functions/VersionId.md b/docs/v2/Functions/VersionId.md index e700bb370..1659c90a0 100644 --- a/docs/v2/Functions/VersionId.md +++ b/docs/v2/Functions/VersionId.md @@ -22,11 +22,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ValueTypeRid value_type_rid = None @@ -42,7 +42,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling VersionId.get: %s\n" % e) ``` diff --git a/docs/v2/MediaSets/MediaSet.md b/docs/v2/MediaSets/MediaSet.md index 0c9f1e3a3..7d5f8da39 100644 --- a/docs/v2/MediaSets/MediaSet.md +++ b/docs/v2/MediaSets/MediaSet.md @@ -31,11 +31,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MediaSetRid media_set_rid = None @@ -51,7 +51,7 @@ try: ) print("The abort response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MediaSet.abort: %s\n" % e) ``` @@ -89,11 +89,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MediaSetRid media_set_rid = None @@ -109,7 +109,7 @@ try: ) print("The commit response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MediaSet.commit: %s\n" % e) ``` @@ -147,11 +147,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MediaSetRid media_set_rid = None @@ -167,7 +167,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MediaSet.create: %s\n" % e) ``` @@ -206,11 +206,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MediaSetRid | The RID of the media set. media_set_rid = None @@ -228,7 +228,7 @@ try: ) print("The info response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MediaSet.info: %s\n" % e) ``` @@ -267,11 +267,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MediaSetRid media_set_rid = None @@ -289,7 +289,7 @@ try: ) print("The read response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MediaSet.read: %s\n" % e) ``` @@ -328,11 +328,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MediaSetRid media_set_rid = None @@ -350,7 +350,7 @@ try: ) print("The read_original response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MediaSet.read_original: %s\n" % e) ``` @@ -389,11 +389,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MediaSetRid | The RID of the media set. media_set_rid = None @@ -411,7 +411,7 @@ try: ) print("The reference response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MediaSet.reference: %s\n" % e) ``` @@ -456,11 +456,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # MediaSetRid media_set_rid = None @@ -493,7 +493,7 @@ try: ) print("The upload response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MediaSet.upload: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/Action.md b/docs/v2/Ontologies/Action.md index 2e041ddf9..25a716984 100644 --- a/docs/v2/Ontologies/Action.md +++ b/docs/v2/Ontologies/Action.md @@ -34,11 +34,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -65,7 +65,7 @@ try: ) print("The apply response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Action.apply: %s\n" % e) ``` @@ -113,11 +113,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -147,7 +147,7 @@ try: ) print("The apply_batch response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Action.apply_batch: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/ActionType.md b/docs/v2/Ontologies/ActionType.md index 6081ece55..afaffcec0 100644 --- a/docs/v2/Ontologies/ActionType.md +++ b/docs/v2/Ontologies/ActionType.md @@ -25,11 +25,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -41,7 +41,7 @@ try: api_response = foundry_client.ontologies.Ontology.ActionType.get(ontology, action_type) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ActionType.get: %s\n" % e) ``` @@ -78,11 +78,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -96,7 +96,7 @@ try: ) print("The get_by_rid response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ActionType.get_by_rid: %s\n" % e) ``` @@ -137,11 +137,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -156,7 +156,7 @@ try: ontology, page_size=page_size, page_token=page_token ): pprint(action_type) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ActionType.list: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/Attachment.md b/docs/v2/Ontologies/Attachment.md index 9db09e01a..ae50d6794 100644 --- a/docs/v2/Ontologies/Attachment.md +++ b/docs/v2/Ontologies/Attachment.md @@ -25,11 +25,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AttachmentRid | The RID of the attachment. attachment_rid = "ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f" @@ -39,7 +39,7 @@ try: api_response = foundry_client.ontologies.Attachment.get(attachment_rid) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Attachment.get: %s\n" % e) ``` @@ -76,11 +76,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # AttachmentRid | The RID of the attachment. attachment_rid = "ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f" @@ -90,7 +90,7 @@ try: api_response = foundry_client.ontologies.Attachment.read(attachment_rid) print("The read response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Attachment.read: %s\n" % e) ``` @@ -134,11 +134,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # bytes | Body of the request body = None @@ -156,7 +156,7 @@ try: ) print("The upload response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Attachment.upload: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/AttachmentProperty.md b/docs/v2/Ontologies/AttachmentProperty.md index 027095e68..17c38a1d8 100644 --- a/docs/v2/Ontologies/AttachmentProperty.md +++ b/docs/v2/Ontologies/AttachmentProperty.md @@ -31,11 +31,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -62,7 +62,7 @@ try: ) print("The get_attachment response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling AttachmentProperty.get_attachment: %s\n" % e) ``` @@ -105,11 +105,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -139,7 +139,7 @@ try: ) print("The get_attachment_by_rid response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling AttachmentProperty.get_attachment_by_rid: %s\n" % e) ``` @@ -181,11 +181,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -212,7 +212,7 @@ try: ) print("The read_attachment response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling AttachmentProperty.read_attachment: %s\n" % e) ``` @@ -257,11 +257,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -291,7 +291,7 @@ try: ) print("The read_attachment_by_rid response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling AttachmentProperty.read_attachment_by_rid: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/LinkedObject.md b/docs/v2/Ontologies/LinkedObject.md index 032bbba5f..8d1f90eb1 100644 --- a/docs/v2/Ontologies/LinkedObject.md +++ b/docs/v2/Ontologies/LinkedObject.md @@ -33,11 +33,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -73,7 +73,7 @@ try: ) print("The get_linked_object response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling LinkedObject.get_linked_object: %s\n" % e) ``` @@ -131,11 +131,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -176,7 +176,7 @@ try: select=select, ): pprint(linked_object) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling LinkedObject.list_linked_objects: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/MediaReferenceProperty.md b/docs/v2/Ontologies/MediaReferenceProperty.md index 6d35386d3..f6b822c19 100644 --- a/docs/v2/Ontologies/MediaReferenceProperty.md +++ b/docs/v2/Ontologies/MediaReferenceProperty.md @@ -30,11 +30,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -64,7 +64,7 @@ try: ) print("The get_media_content response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MediaReferenceProperty.get_media_content: %s\n" % e) ``` @@ -106,11 +106,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -140,7 +140,7 @@ try: ) print("The get_media_metadata response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MediaReferenceProperty.get_media_metadata: %s\n" % e) ``` @@ -182,11 +182,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -208,7 +208,7 @@ try: ) print("The upload response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling MediaReferenceProperty.upload: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/ObjectType.md b/docs/v2/Ontologies/ObjectType.md index 1ebc39470..bbeeb4bbb 100644 --- a/docs/v2/Ontologies/ObjectType.md +++ b/docs/v2/Ontologies/ObjectType.md @@ -27,11 +27,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -43,7 +43,7 @@ try: api_response = foundry_client.ontologies.Ontology.ObjectType.get(ontology, object_type) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ObjectType.get: %s\n" % e) ``` @@ -81,11 +81,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -101,7 +101,7 @@ try: ) print("The get_full_metadata response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ObjectType.get_full_metadata: %s\n" % e) ``` @@ -140,11 +140,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -160,7 +160,7 @@ try: ) print("The get_outgoing_link_type response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ObjectType.get_outgoing_link_type: %s\n" % e) ``` @@ -202,11 +202,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -221,7 +221,7 @@ try: ontology, page_size=page_size, page_token=page_token ): pprint(object_type) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ObjectType.list: %s\n" % e) ``` @@ -261,11 +261,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -282,7 +282,7 @@ try: ontology, object_type, page_size=page_size, page_token=page_token ): pprint(object_type) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ObjectType.list_outgoing_link_types: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/Ontology.md b/docs/v2/Ontologies/Ontology.md index 0ff5ca293..3554d66d3 100644 --- a/docs/v2/Ontologies/Ontology.md +++ b/docs/v2/Ontologies/Ontology.md @@ -24,11 +24,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -38,7 +38,7 @@ try: api_response = foundry_client.ontologies.Ontology.get(ontology) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Ontology.get: %s\n" % e) ``` @@ -72,11 +72,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -86,7 +86,7 @@ try: api_response = foundry_client.ontologies.Ontology.get_full_metadata(ontology) print("The get_full_metadata response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Ontology.get_full_metadata: %s\n" % e) ``` @@ -121,18 +121,18 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") try: api_response = foundry_client.ontologies.Ontology.list() print("The list response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Ontology.list: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/OntologyInterface.md b/docs/v2/Ontologies/OntologyInterface.md index f6c41b9ee..6adb58a00 100644 --- a/docs/v2/Ontologies/OntologyInterface.md +++ b/docs/v2/Ontologies/OntologyInterface.md @@ -41,11 +41,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -85,7 +85,7 @@ try: ) print("The aggregate response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyInterface.aggregate: %s\n" % e) ``` @@ -128,11 +128,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -148,7 +148,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyInterface.get: %s\n" % e) ``` @@ -195,11 +195,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -216,7 +216,7 @@ try: ontology, page_size=page_size, page_token=page_token, preview=preview ): pprint(ontology_interface) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyInterface.list: %s\n" % e) ``` @@ -296,11 +296,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -345,7 +345,7 @@ try: ) print("The search response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyInterface.search: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/OntologyObject.md b/docs/v2/Ontologies/OntologyObject.md index 8a4003b19..9671551f3 100644 --- a/docs/v2/Ontologies/OntologyObject.md +++ b/docs/v2/Ontologies/OntologyObject.md @@ -33,11 +33,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -80,7 +80,7 @@ try: ) print("The aggregate response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObject.aggregate: %s\n" % e) ``` @@ -119,11 +119,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -141,7 +141,7 @@ try: ) print("The count response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObject.count: %s\n" % e) ``` @@ -183,11 +183,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -217,7 +217,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObject.get: %s\n" % e) ``` @@ -273,11 +273,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -312,7 +312,7 @@ try: select=select, ): pprint(ontology_object) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObject.list: %s\n" % e) ``` @@ -379,11 +379,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -422,7 +422,7 @@ try: ) print("The search response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObject.search: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/OntologyObjectSet.md b/docs/v2/Ontologies/OntologyObjectSet.md index 2a0b594d6..9c2455cb3 100644 --- a/docs/v2/Ontologies/OntologyObjectSet.md +++ b/docs/v2/Ontologies/OntologyObjectSet.md @@ -33,11 +33,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -67,7 +67,7 @@ try: ) print("The aggregate response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObjectSet.aggregate: %s\n" % e) ``` @@ -105,11 +105,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -123,7 +123,7 @@ try: ) print("The create_temporary response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObjectSet.create_temporary: %s\n" % e) ``` @@ -160,11 +160,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -176,7 +176,7 @@ try: api_response = foundry_client.ontologies.OntologyObjectSet.get(ontology, object_set_rid) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObjectSet.get: %s\n" % e) ``` @@ -225,11 +225,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -265,7 +265,7 @@ try: ) print("The load response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObjectSet.load: %s\n" % e) ``` @@ -320,11 +320,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -363,7 +363,7 @@ try: ) print("The load_multiple_object_types response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObjectSet.load_multiple_object_types: %s\n" % e) ``` @@ -420,11 +420,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -463,7 +463,7 @@ try: ) print("The load_objects_or_interfaces response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling OntologyObjectSet.load_objects_or_interfaces: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/Query.md b/docs/v2/Ontologies/Query.md index 40ecc8f92..e878aa025 100644 --- a/docs/v2/Ontologies/Query.md +++ b/docs/v2/Ontologies/Query.md @@ -29,11 +29,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -57,7 +57,7 @@ try: ) print("The execute response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Query.execute: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/QueryType.md b/docs/v2/Ontologies/QueryType.md index e867292df..6958594c7 100644 --- a/docs/v2/Ontologies/QueryType.md +++ b/docs/v2/Ontologies/QueryType.md @@ -24,11 +24,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -40,7 +40,7 @@ try: api_response = foundry_client.ontologies.Ontology.QueryType.get(ontology, query_api_name) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling QueryType.get: %s\n" % e) ``` @@ -81,11 +81,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -100,7 +100,7 @@ try: ontology, page_size=page_size, page_token=page_token ): pprint(query_type) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling QueryType.list: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/TimeSeriesPropertyV2.md b/docs/v2/Ontologies/TimeSeriesPropertyV2.md index 9e14f857f..9ba6588f1 100644 --- a/docs/v2/Ontologies/TimeSeriesPropertyV2.md +++ b/docs/v2/Ontologies/TimeSeriesPropertyV2.md @@ -30,11 +30,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -61,7 +61,7 @@ try: ) print("The get_first_point response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling TimeSeriesPropertyV2.get_first_point: %s\n" % e) ``` @@ -103,11 +103,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -134,7 +134,7 @@ try: ) print("The get_last_point response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling TimeSeriesPropertyV2.get_last_point: %s\n" % e) ``` @@ -179,11 +179,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -223,7 +223,7 @@ try: ) print("The stream_points response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling TimeSeriesPropertyV2.stream_points: %s\n" % e) ``` diff --git a/docs/v2/Ontologies/TimeSeriesValueBankProperty.md b/docs/v2/Ontologies/TimeSeriesValueBankProperty.md index ef138c4c9..f62876ca0 100644 --- a/docs/v2/Ontologies/TimeSeriesValueBankProperty.md +++ b/docs/v2/Ontologies/TimeSeriesValueBankProperty.md @@ -29,11 +29,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -60,7 +60,7 @@ try: ) print("The get_latest_value response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling TimeSeriesValueBankProperty.get_latest_value: %s\n" % e) ``` @@ -103,11 +103,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" @@ -141,7 +141,7 @@ try: ) print("The stream_values response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling TimeSeriesValueBankProperty.stream_values: %s\n" % e) ``` diff --git a/docs/v2/Orchestration/Build.md b/docs/v2/Orchestration/Build.md index 51dbb958f..50f81b75a 100644 --- a/docs/v2/Orchestration/Build.md +++ b/docs/v2/Orchestration/Build.md @@ -26,11 +26,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # BuildRid | The RID of a Build. build_rid = "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58" @@ -42,7 +42,7 @@ try: api_response = foundry_client.orchestration.Build.cancel(build_rid, preview=preview) print("The cancel response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Build.cancel: %s\n" % e) ``` @@ -83,11 +83,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # FallbackBranches fallback_branches = ["master"] @@ -129,7 +129,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Build.create: %s\n" % e) ``` @@ -163,11 +163,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # BuildRid | The RID of a Build. build_rid = "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58" @@ -179,7 +179,7 @@ try: api_response = foundry_client.orchestration.Build.get(build_rid, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Build.get: %s\n" % e) ``` @@ -215,11 +215,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # List[GetBuildsBatchRequestElement] | Body of the request body = [{"buildRid": "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58"}] @@ -231,7 +231,7 @@ try: api_response = foundry_client.orchestration.Build.get_batch(body, preview=preview) print("The get_batch response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Build.get_batch: %s\n" % e) ``` @@ -267,11 +267,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # BuildRid | The RID of a Build. build_rid = "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58" @@ -288,7 +288,7 @@ try: build_rid, page_size=page_size, page_token=page_token, preview=preview ): pprint(build) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Build.jobs: %s\n" % e) ``` @@ -325,11 +325,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # SearchBuildsFilter where = None @@ -349,7 +349,7 @@ try: ) print("The search response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Build.search: %s\n" % e) ``` diff --git a/docs/v2/Orchestration/Job.md b/docs/v2/Orchestration/Job.md index 2b633c718..aac54bda2 100644 --- a/docs/v2/Orchestration/Job.md +++ b/docs/v2/Orchestration/Job.md @@ -21,11 +21,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # JobRid | The RID of a Job. job_rid = "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448" @@ -37,7 +37,7 @@ try: api_response = foundry_client.orchestration.Job.get(job_rid, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Job.get: %s\n" % e) ``` @@ -73,11 +73,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # List[GetJobsBatchRequestElement] | Body of the request body = [{"jobRid": "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448"}] @@ -89,7 +89,7 @@ try: api_response = foundry_client.orchestration.Job.get_batch(body, preview=preview) print("The get_batch response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Job.get_batch: %s\n" % e) ``` diff --git a/docs/v2/Orchestration/Schedule.md b/docs/v2/Orchestration/Schedule.md index 0aa440543..379a436f3 100644 --- a/docs/v2/Orchestration/Schedule.md +++ b/docs/v2/Orchestration/Schedule.md @@ -31,11 +31,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # CreateScheduleRequestAction action = { @@ -77,7 +77,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Schedule.create: %s\n" % e) ``` @@ -111,11 +111,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ScheduleRid schedule_rid = None @@ -127,7 +127,7 @@ try: api_response = foundry_client.orchestration.Schedule.delete(schedule_rid, preview=preview) print("The delete response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Schedule.delete: %s\n" % e) ``` @@ -161,11 +161,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ScheduleRid schedule_rid = None @@ -177,7 +177,7 @@ try: api_response = foundry_client.orchestration.Schedule.get(schedule_rid, preview=preview) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Schedule.get: %s\n" % e) ``` @@ -211,11 +211,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ScheduleRid schedule_rid = None @@ -227,7 +227,7 @@ try: api_response = foundry_client.orchestration.Schedule.pause(schedule_rid, preview=preview) print("The pause response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Schedule.pause: %s\n" % e) ``` @@ -266,11 +266,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ScheduleRid schedule_rid = None @@ -315,7 +315,7 @@ try: ) print("The replace response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Schedule.replace: %s\n" % e) ``` @@ -349,11 +349,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ScheduleRid schedule_rid = None @@ -365,7 +365,7 @@ try: api_response = foundry_client.orchestration.Schedule.run(schedule_rid, preview=preview) print("The run response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Schedule.run: %s\n" % e) ``` @@ -402,11 +402,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ScheduleRid schedule_rid = None @@ -423,7 +423,7 @@ try: schedule_rid, page_size=page_size, page_token=page_token, preview=preview ): pprint(schedule) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Schedule.runs: %s\n" % e) ``` @@ -457,11 +457,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ScheduleRid schedule_rid = None @@ -473,7 +473,7 @@ try: api_response = foundry_client.orchestration.Schedule.unpause(schedule_rid, preview=preview) print("The unpause response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Schedule.unpause: %s\n" % e) ``` diff --git a/docs/v2/Orchestration/ScheduleVersion.md b/docs/v2/Orchestration/ScheduleVersion.md index 555c9c634..125cbcbaa 100644 --- a/docs/v2/Orchestration/ScheduleVersion.md +++ b/docs/v2/Orchestration/ScheduleVersion.md @@ -21,11 +21,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ScheduleVersionRid | The RID of a schedule version schedule_version_rid = "ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017" @@ -39,7 +39,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ScheduleVersion.get: %s\n" % e) ``` @@ -73,11 +73,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ScheduleVersionRid | The RID of a schedule version schedule_version_rid = "ri.scheduler.main.schedule-version.4d1eb55f-6c13-411c-a911-5d84e08d8017" @@ -91,7 +91,7 @@ try: ) print("The schedule response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ScheduleVersion.schedule: %s\n" % e) ``` diff --git a/docs/v2/SqlQueries/Query.md b/docs/v2/SqlQueries/Query.md index 330997e95..8683e5f77 100644 --- a/docs/v2/SqlQueries/Query.md +++ b/docs/v2/SqlQueries/Query.md @@ -24,11 +24,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # QueryId | The id of a query. query_id = None @@ -40,7 +40,7 @@ try: api_response = foundry_client.sql_queries.Query.cancel(query_id, preview=preview) print("The cancel response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Query.cancel: %s\n" % e) ``` @@ -76,11 +76,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # str | The SQL query to execute. Queries should confirm to the [Spark SQL dialect](https://spark.apache.org/docs/latest/sql-ref.html). This supports SELECT queries only. query = None @@ -96,7 +96,7 @@ try: ) print("The execute response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Query.execute: %s\n" % e) ``` @@ -132,11 +132,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # QueryId | The id of a query. query_id = None @@ -148,7 +148,7 @@ try: api_response = foundry_client.sql_queries.Query.get_results(query_id, preview=preview) print("The get_results response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Query.get_results: %s\n" % e) ``` @@ -183,11 +183,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # QueryId | The id of a query. query_id = None @@ -199,7 +199,7 @@ try: api_response = foundry_client.sql_queries.Query.get_status(query_id, preview=preview) print("The get_status response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Query.get_status: %s\n" % e) ``` diff --git a/docs/v2/Streams/Dataset.md b/docs/v2/Streams/Dataset.md index 59dd603e7..bba55a97b 100644 --- a/docs/v2/Streams/Dataset.md +++ b/docs/v2/Streams/Dataset.md @@ -29,11 +29,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetName name = "My Dataset" @@ -66,7 +66,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Dataset.create: %s\n" % e) ``` diff --git a/docs/v2/Streams/Stream.md b/docs/v2/Streams/Stream.md index 20f68e699..440ffe75b 100644 --- a/docs/v2/Streams/Stream.md +++ b/docs/v2/Streams/Stream.md @@ -31,11 +31,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -65,7 +65,7 @@ try: ) print("The create response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Stream.create: %s\n" % e) ``` @@ -102,11 +102,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -122,7 +122,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Stream.get: %s\n" % e) ``` @@ -160,11 +160,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -184,7 +184,7 @@ try: ) print("The publish_binary_record response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Stream.publish_binary_record: %s\n" % e) ``` @@ -223,11 +223,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -247,7 +247,7 @@ try: ) print("The publish_record response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Stream.publish_record: %s\n" % e) ``` @@ -286,11 +286,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -310,7 +310,7 @@ try: ) print("The publish_records response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Stream.publish_records: %s\n" % e) ``` @@ -356,11 +356,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # DatasetRid dataset_rid = None @@ -390,7 +390,7 @@ try: ) print("The reset response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Stream.reset: %s\n" % e) ``` diff --git a/docs/v2/ThirdPartyApplications/ThirdPartyApplication.md b/docs/v2/ThirdPartyApplications/ThirdPartyApplication.md index f101d7ba0..7917b7d08 100644 --- a/docs/v2/ThirdPartyApplications/ThirdPartyApplication.md +++ b/docs/v2/ThirdPartyApplications/ThirdPartyApplication.md @@ -20,11 +20,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ThirdPartyApplicationRid | An RID identifying a third-party application created in Developer Console. third_party_application_rid = ( @@ -40,7 +40,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling ThirdPartyApplication.get: %s\n" % e) ``` diff --git a/docs/v2/ThirdPartyApplications/Version.md b/docs/v2/ThirdPartyApplications/Version.md index 7ff0f9999..b931c8f4e 100644 --- a/docs/v2/ThirdPartyApplications/Version.md +++ b/docs/v2/ThirdPartyApplications/Version.md @@ -24,11 +24,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ThirdPartyApplicationRid | An RID identifying a third-party application created in Developer Console. third_party_application_rid = ( @@ -46,7 +46,7 @@ try: ) print("The delete response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Version.delete: %s\n" % e) ``` @@ -80,11 +80,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ThirdPartyApplicationRid | An RID identifying a third-party application created in Developer Console. third_party_application_rid = ( @@ -102,7 +102,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Version.get: %s\n" % e) ``` @@ -139,11 +139,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ThirdPartyApplicationRid | An RID identifying a third-party application created in Developer Console. third_party_application_rid = ( @@ -160,7 +160,7 @@ try: third_party_application_rid, page_size=page_size, page_token=page_token ): pprint(version) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Version.list: %s\n" % e) ``` @@ -195,11 +195,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ThirdPartyApplicationRid | An RID identifying a third-party application created in Developer Console. third_party_application_rid = ( @@ -219,7 +219,7 @@ try: ) print("The upload response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Version.upload: %s\n" % e) ``` @@ -257,11 +257,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ThirdPartyApplicationRid | An RID identifying a third-party application created in Developer Console. third_party_application_rid = ( @@ -289,7 +289,7 @@ try: ) print("The upload_snapshot response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Version.upload_snapshot: %s\n" % e) ``` diff --git a/docs/v2/ThirdPartyApplications/Website.md b/docs/v2/ThirdPartyApplications/Website.md index f4d19f669..f91d29201 100644 --- a/docs/v2/ThirdPartyApplications/Website.md +++ b/docs/v2/ThirdPartyApplications/Website.md @@ -22,11 +22,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ThirdPartyApplicationRid | An RID identifying a third-party application created in Developer Console. third_party_application_rid = ( @@ -42,7 +42,7 @@ try: ) print("The deploy response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Website.deploy: %s\n" % e) ``` @@ -75,11 +75,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ThirdPartyApplicationRid | An RID identifying a third-party application created in Developer Console. third_party_application_rid = ( @@ -93,7 +93,7 @@ try: ) print("The get response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Website.get: %s\n" % e) ``` @@ -126,11 +126,11 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryClient -import foundry +from foundry_sdk.v2 import FoundryClient +import foundry_sdk from pprint import pprint -client = FoundryClient(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # ThirdPartyApplicationRid | An RID identifying a third-party application created in Developer Console. third_party_application_rid = ( @@ -144,7 +144,7 @@ try: ) print("The undeploy response:\n") pprint(api_response) -except foundry.PalantirRPCException as e: +except foundry_sdk.PalantirRPCException as e: print("HTTP error when calling Website.undeploy: %s\n" % e) ``` diff --git a/foundry/__init__.py b/foundry/__init__.py deleted file mode 100644 index 0d319c2cb..000000000 --- a/foundry/__init__.py +++ /dev/null @@ -1,88 +0,0 @@ -# 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. - - -from foundry._core import ApiResponse -from foundry._core import Auth -from foundry._core import ConfidentialClientAuth -from foundry._core import Config -from foundry._core import PublicClientAuth -from foundry._core import ResourceIterator -from foundry._core import StreamedApiResponse -from foundry._core import StreamingContextManager -from foundry._core import UserTokenAuth -from foundry._errors import ApiNotFoundError -from foundry._errors import BadRequestError -from foundry._errors import ConflictError -from foundry._errors import ConnectionError -from foundry._errors import ConnectTimeout -from foundry._errors import EnvironmentNotConfigured -from foundry._errors import InternalServerError -from foundry._errors import NotAuthenticated -from foundry._errors import NotFoundError -from foundry._errors import PalantirException -from foundry._errors import PalantirRPCException -from foundry._errors import PermissionDeniedError -from foundry._errors import ProxyError -from foundry._errors import RateLimitError -from foundry._errors import ReadTimeout -from foundry._errors import RequestEntityTooLargeError -from foundry._errors import SDKInternalError -from foundry._errors import StreamConsumedError -from foundry._errors import TimeoutError -from foundry._errors import UnauthorizedError -from foundry._errors import UnprocessableEntityError -from foundry._errors import WriteTimeout - -# The OpenAPI document version from the spec information -# See https://swagger.io/specification/#info-object -# The SDK version -from foundry._versions import __openapi_document_version__ -from foundry._versions import __version__ - -# The OpenAPI specification version -# See https://swagger.io/specification/#versions - - -__all__ = [ - "__version__", - "__openapi_document_version__", - "Auth", - "ConfidentialClientAuth", - "PublicClientAuth", - "UserTokenAuth", - "Config", - "PalantirException", - "EnvironmentNotConfigured", - "NotAuthenticated", - "ConnectionError", - "ProxyError", - "PalantirRPCException", - "BadRequestError", - "UnauthorizedError", - "PermissionDeniedError", - "NotFoundError", - "UnprocessableEntityError", - "RateLimitError", - "RequestEntityTooLargeError", - "ConflictError", - "InternalServerError", - "SDKInternalError", - "StreamConsumedError", - "ConnectTimeout", - "ReadTimeout", - "WriteTimeout", - "TimeoutError", - "ApiNotFoundError", -] diff --git a/foundry/_core/__init__.py b/foundry/_core/__init__.py deleted file mode 100644 index 71f41c8ac..000000000 --- a/foundry/_core/__init__.py +++ /dev/null @@ -1,37 +0,0 @@ -# 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. - - -from foundry._core.api_client import ApiClient -from foundry._core.api_client import ApiResponse -from foundry._core.api_client import RequestInfo -from foundry._core.api_client import SdkInternal -from foundry._core.api_client import StreamedApiResponse -from foundry._core.api_client import StreamingContextManager -from foundry._core.api_client import with_raw_response -from foundry._core.api_client import with_streaming_response -from foundry._core.auth_utils import Auth -from foundry._core.binary_stream import BinaryStream -from foundry._core.compute_module_pipeline_auth import ComputeModulePipelineAuth -from foundry._core.confidential_client_auth import ConfidentialClientAuth -from foundry._core.config import Config -from foundry._core.public_client_auth import PublicClientAuth -from foundry._core.resource_iterator import ResourceIterator -from foundry._core.user_token_auth_client import UserTokenAuth -from foundry._core.utils import RID -from foundry._core.utils import UUID -from foundry._core.utils import Long -from foundry._core.utils import Timeout -from foundry._core.utils import maybe_ignore_preview -from foundry._core.utils import resolve_forward_references diff --git a/foundry/_errors/__init__.py b/foundry/_errors/__init__.py deleted file mode 100644 index 20f92f51d..000000000 --- a/foundry/_errors/__init__.py +++ /dev/null @@ -1,39 +0,0 @@ -# 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. - - -from foundry._errors.api_not_found import ApiNotFoundError -from foundry._errors.connection_error import ConnectionError -from foundry._errors.connection_error import ProxyError -from foundry._errors.environment_not_configured import EnvironmentNotConfigured -from foundry._errors.not_authenticated import NotAuthenticated -from foundry._errors.palantir_exception import PalantirException -from foundry._errors.palantir_rpc_exception import BadRequestError -from foundry._errors.palantir_rpc_exception import ConflictError -from foundry._errors.palantir_rpc_exception import InternalServerError -from foundry._errors.palantir_rpc_exception import NotFoundError -from foundry._errors.palantir_rpc_exception import PalantirRPCException -from foundry._errors.palantir_rpc_exception import PermissionDeniedError -from foundry._errors.palantir_rpc_exception import RateLimitError -from foundry._errors.palantir_rpc_exception import RequestEntityTooLargeError -from foundry._errors.palantir_rpc_exception import UnauthorizedError -from foundry._errors.palantir_rpc_exception import UnprocessableEntityError -from foundry._errors.sdk_internal_error import SDKInternalError -from foundry._errors.sdk_internal_error import handle_unexpected -from foundry._errors.stream_error import StreamConsumedError -from foundry._errors.timeout_error import ConnectTimeout -from foundry._errors.timeout_error import ReadTimeout -from foundry._errors.timeout_error import TimeoutError -from foundry._errors.timeout_error import WriteTimeout -from foundry._errors.utils import deserialize_error diff --git a/foundry_sdk/__init__.py b/foundry_sdk/__init__.py new file mode 100644 index 000000000..b04e580ea --- /dev/null +++ b/foundry_sdk/__init__.py @@ -0,0 +1,88 @@ +# 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. + + +from foundry_sdk._core import ApiResponse +from foundry_sdk._core import Auth +from foundry_sdk._core import ConfidentialClientAuth +from foundry_sdk._core import Config +from foundry_sdk._core import PublicClientAuth +from foundry_sdk._core import ResourceIterator +from foundry_sdk._core import StreamedApiResponse +from foundry_sdk._core import StreamingContextManager +from foundry_sdk._core import UserTokenAuth +from foundry_sdk._errors import ApiNotFoundError +from foundry_sdk._errors import BadRequestError +from foundry_sdk._errors import ConflictError +from foundry_sdk._errors import ConnectionError +from foundry_sdk._errors import ConnectTimeout +from foundry_sdk._errors import EnvironmentNotConfigured +from foundry_sdk._errors import InternalServerError +from foundry_sdk._errors import NotAuthenticated +from foundry_sdk._errors import NotFoundError +from foundry_sdk._errors import PalantirException +from foundry_sdk._errors import PalantirRPCException +from foundry_sdk._errors import PermissionDeniedError +from foundry_sdk._errors import ProxyError +from foundry_sdk._errors import RateLimitError +from foundry_sdk._errors import ReadTimeout +from foundry_sdk._errors import RequestEntityTooLargeError +from foundry_sdk._errors import SDKInternalError +from foundry_sdk._errors import StreamConsumedError +from foundry_sdk._errors import TimeoutError +from foundry_sdk._errors import UnauthorizedError +from foundry_sdk._errors import UnprocessableEntityError +from foundry_sdk._errors import WriteTimeout + +# The OpenAPI document version from the spec information +# See https://swagger.io/specification/#info-object +# The SDK version +from foundry_sdk._versions import __openapi_document_version__ +from foundry_sdk._versions import __version__ + +# The OpenAPI specification version +# See https://swagger.io/specification/#versions + + +__all__ = [ + "__version__", + "__openapi_document_version__", + "Auth", + "ConfidentialClientAuth", + "PublicClientAuth", + "UserTokenAuth", + "Config", + "PalantirException", + "EnvironmentNotConfigured", + "NotAuthenticated", + "ConnectionError", + "ProxyError", + "PalantirRPCException", + "BadRequestError", + "UnauthorizedError", + "PermissionDeniedError", + "NotFoundError", + "UnprocessableEntityError", + "RateLimitError", + "RequestEntityTooLargeError", + "ConflictError", + "InternalServerError", + "SDKInternalError", + "StreamConsumedError", + "ConnectTimeout", + "ReadTimeout", + "WriteTimeout", + "TimeoutError", + "ApiNotFoundError", +] diff --git a/foundry_sdk/_core/__init__.py b/foundry_sdk/_core/__init__.py new file mode 100644 index 000000000..d4f4654d3 --- /dev/null +++ b/foundry_sdk/_core/__init__.py @@ -0,0 +1,37 @@ +# 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. + + +from foundry_sdk._core.api_client import ApiClient +from foundry_sdk._core.api_client import ApiResponse +from foundry_sdk._core.api_client import RequestInfo +from foundry_sdk._core.api_client import SdkInternal +from foundry_sdk._core.api_client import StreamedApiResponse +from foundry_sdk._core.api_client import StreamingContextManager +from foundry_sdk._core.api_client import with_raw_response +from foundry_sdk._core.api_client import with_streaming_response +from foundry_sdk._core.auth_utils import Auth +from foundry_sdk._core.binary_stream import BinaryStream +from foundry_sdk._core.compute_module_pipeline_auth import ComputeModulePipelineAuth +from foundry_sdk._core.confidential_client_auth import ConfidentialClientAuth +from foundry_sdk._core.config import Config +from foundry_sdk._core.public_client_auth import PublicClientAuth +from foundry_sdk._core.resource_iterator import ResourceIterator +from foundry_sdk._core.user_token_auth_client import UserTokenAuth +from foundry_sdk._core.utils import RID +from foundry_sdk._core.utils import UUID +from foundry_sdk._core.utils import Long +from foundry_sdk._core.utils import Timeout +from foundry_sdk._core.utils import maybe_ignore_preview +from foundry_sdk._core.utils import resolve_forward_references diff --git a/foundry/_core/api_client.py b/foundry_sdk/_core/api_client.py similarity index 93% rename from foundry/_core/api_client.py rename to foundry_sdk/_core/api_client.py index a6f326bc0..f05aa1c73 100644 --- a/foundry/_core/api_client.py +++ b/foundry_sdk/_core/api_client.py @@ -42,32 +42,32 @@ from typing_extensions import TypedDict from typing_extensions import deprecated -from foundry._core.auth_utils import Auth -from foundry._core.auth_utils import Token -from foundry._core.binary_stream import BinaryStream -from foundry._core.config import Config -from foundry._core.http_client import HttpClient -from foundry._core.resource_iterator import ResourceIterator -from foundry._errors import ApiNotFoundError -from foundry._errors import BadRequestError -from foundry._errors import ConflictError -from foundry._errors import ConnectionError -from foundry._errors import ConnectTimeout -from foundry._errors import InternalServerError -from foundry._errors import NotFoundError -from foundry._errors import PalantirRPCException -from foundry._errors import PermissionDeniedError -from foundry._errors import ProxyError -from foundry._errors import RateLimitError -from foundry._errors import ReadTimeout -from foundry._errors import RequestEntityTooLargeError -from foundry._errors import SDKInternalError -from foundry._errors import StreamConsumedError -from foundry._errors import UnauthorizedError -from foundry._errors import UnprocessableEntityError -from foundry._errors import WriteTimeout -from foundry._errors import deserialize_error -from foundry._versions import __version__ +from foundry_sdk._core.auth_utils import Auth +from foundry_sdk._core.auth_utils import Token +from foundry_sdk._core.binary_stream import BinaryStream +from foundry_sdk._core.config import Config +from foundry_sdk._core.http_client import HttpClient +from foundry_sdk._core.resource_iterator import ResourceIterator +from foundry_sdk._errors import ApiNotFoundError +from foundry_sdk._errors import BadRequestError +from foundry_sdk._errors import ConflictError +from foundry_sdk._errors import ConnectionError +from foundry_sdk._errors import ConnectTimeout +from foundry_sdk._errors import InternalServerError +from foundry_sdk._errors import NotFoundError +from foundry_sdk._errors import PalantirRPCException +from foundry_sdk._errors import PermissionDeniedError +from foundry_sdk._errors import ProxyError +from foundry_sdk._errors import RateLimitError +from foundry_sdk._errors import ReadTimeout +from foundry_sdk._errors import RequestEntityTooLargeError +from foundry_sdk._errors import SDKInternalError +from foundry_sdk._errors import StreamConsumedError +from foundry_sdk._errors import UnauthorizedError +from foundry_sdk._errors import UnprocessableEntityError +from foundry_sdk._errors import WriteTimeout +from foundry_sdk._errors import deserialize_error +from foundry_sdk._versions import __version__ QueryParameters = Dict[str, Union[Any, List[Any]]] diff --git a/foundry/_core/auth_utils.py b/foundry_sdk/_core/auth_utils.py similarity index 96% rename from foundry/_core/auth_utils.py rename to foundry_sdk/_core/auth_utils.py index 7058fb17f..9bd6cbb62 100644 --- a/foundry/_core/auth_utils.py +++ b/foundry_sdk/_core/auth_utils.py @@ -21,7 +21,7 @@ import httpx -from foundry._core.config import Config +from foundry_sdk._core.config import Config class Token(ABC): diff --git a/foundry/_core/binary_stream.py b/foundry_sdk/_core/binary_stream.py similarity index 100% rename from foundry/_core/binary_stream.py rename to foundry_sdk/_core/binary_stream.py diff --git a/foundry/_core/compute_module_pipeline_auth.py b/foundry_sdk/_core/compute_module_pipeline_auth.py similarity index 89% rename from foundry/_core/compute_module_pipeline_auth.py rename to foundry_sdk/_core/compute_module_pipeline_auth.py index 16e2896b4..729a0c781 100644 --- a/foundry/_core/compute_module_pipeline_auth.py +++ b/foundry_sdk/_core/compute_module_pipeline_auth.py @@ -23,10 +23,10 @@ import httpx -from foundry._core.user_token_auth_client import Auth -from foundry._core.user_token_auth_client import Token -from foundry._errors.environment_not_configured import EnvironmentNotConfigured -from foundry._errors.not_authenticated import NotAuthenticated +from foundry_sdk._core.user_token_auth_client import Auth +from foundry_sdk._core.user_token_auth_client import Token +from foundry_sdk._errors.environment_not_configured import EnvironmentNotConfigured +from foundry_sdk._errors.not_authenticated import NotAuthenticated T = TypeVar("T") diff --git a/foundry/_core/confidential_client_auth.py b/foundry_sdk/_core/confidential_client_auth.py similarity index 92% rename from foundry/_core/confidential_client_auth.py rename to foundry_sdk/_core/confidential_client_auth.py index 042b92938..bdfcdebb7 100644 --- a/foundry/_core/confidential_client_auth.py +++ b/foundry_sdk/_core/confidential_client_auth.py @@ -19,12 +19,12 @@ from typing import List from typing import Optional -from foundry._core.config import Config -from foundry._core.oauth_utils import ConfidentialClientOAuthFlowProvider -from foundry._core.oauth_utils import OAuth -from foundry._core.oauth_utils import OAuthToken -from foundry._core.oauth_utils import SignInResponse -from foundry._core.oauth_utils import SignOutResponse +from foundry_sdk._core.config import Config +from foundry_sdk._core.oauth_utils import ConfidentialClientOAuthFlowProvider +from foundry_sdk._core.oauth_utils import OAuth +from foundry_sdk._core.oauth_utils import OAuthToken +from foundry_sdk._core.oauth_utils import SignInResponse +from foundry_sdk._core.oauth_utils import SignOutResponse class ConfidentialClientAuth(OAuth): diff --git a/foundry/_core/config.py b/foundry_sdk/_core/config.py similarity index 100% rename from foundry/_core/config.py rename to foundry_sdk/_core/config.py diff --git a/foundry/_core/http_client.py b/foundry_sdk/_core/http_client.py similarity index 94% rename from foundry/_core/http_client.py rename to foundry_sdk/_core/http_client.py index 9ae30dca4..8d37db5d1 100644 --- a/foundry/_core/http_client.py +++ b/foundry_sdk/_core/http_client.py @@ -7,10 +7,10 @@ import httpx -from foundry._core.config import Config -from foundry._core.utils import AnyCallableT -from foundry._core.utils import remove_prefixes -from foundry._versions import __version__ +from foundry_sdk._core.config import Config +from foundry_sdk._core.utils import AnyCallableT +from foundry_sdk._core.utils import remove_prefixes +from foundry_sdk._versions import __version__ def type_safe_cache(func: AnyCallableT) -> AnyCallableT: diff --git a/foundry/_core/oauth_utils.py b/foundry_sdk/_core/oauth_utils.py similarity index 98% rename from foundry/_core/oauth_utils.py rename to foundry_sdk/_core/oauth_utils.py index e4ea9bbfe..020a4a9ca 100644 --- a/foundry/_core/oauth_utils.py +++ b/foundry_sdk/_core/oauth_utils.py @@ -31,10 +31,10 @@ import httpx import pydantic -from foundry._core.auth_utils import Auth -from foundry._core.auth_utils import Token -from foundry._core.config import Config -from foundry._core.http_client import HttpClient +from foundry_sdk._core.auth_utils import Auth +from foundry_sdk._core.auth_utils import Token +from foundry_sdk._core.config import Config +from foundry_sdk._core.http_client import HttpClient class OAuthUtils: diff --git a/foundry/_core/page_iterator.py b/foundry_sdk/_core/page_iterator.py similarity index 100% rename from foundry/_core/page_iterator.py rename to foundry_sdk/_core/page_iterator.py diff --git a/foundry/_core/public_client_auth.py b/foundry_sdk/_core/public_client_auth.py similarity index 92% rename from foundry/_core/public_client_auth.py rename to foundry_sdk/_core/public_client_auth.py index 3ace5a487..f0c01efe9 100644 --- a/foundry/_core/public_client_auth.py +++ b/foundry_sdk/_core/public_client_auth.py @@ -18,13 +18,13 @@ from typing import List from typing import Optional -from foundry._core.config import Config -from foundry._core.oauth_utils import AuthorizeRequest -from foundry._core.oauth_utils import OAuth -from foundry._core.oauth_utils import OAuthToken -from foundry._core.oauth_utils import PublicClientOAuthFlowProvider -from foundry._core.oauth_utils import SignOutResponse -from foundry._errors.not_authenticated import NotAuthenticated +from foundry_sdk._core.config import Config +from foundry_sdk._core.oauth_utils import AuthorizeRequest +from foundry_sdk._core.oauth_utils import OAuth +from foundry_sdk._core.oauth_utils import OAuthToken +from foundry_sdk._core.oauth_utils import PublicClientOAuthFlowProvider +from foundry_sdk._core.oauth_utils import SignOutResponse +from foundry_sdk._errors.not_authenticated import NotAuthenticated class PublicClientAuth(OAuth): diff --git a/foundry/_core/resource_iterator.py b/foundry_sdk/_core/resource_iterator.py similarity index 100% rename from foundry/_core/resource_iterator.py rename to foundry_sdk/_core/resource_iterator.py diff --git a/foundry/_core/user_token_auth_client.py b/foundry_sdk/_core/user_token_auth_client.py similarity index 89% rename from foundry/_core/user_token_auth_client.py rename to foundry_sdk/_core/user_token_auth_client.py index 26bb1ab03..5e8010033 100644 --- a/foundry/_core/user_token_auth_client.py +++ b/foundry_sdk/_core/user_token_auth_client.py @@ -22,10 +22,10 @@ import httpx -from foundry._core.auth_utils import Auth -from foundry._core.auth_utils import Token -from foundry._errors.environment_not_configured import EnvironmentNotConfigured -from foundry._errors.not_authenticated import NotAuthenticated +from foundry_sdk._core.auth_utils import Auth +from foundry_sdk._core.auth_utils import Token +from foundry_sdk._errors.environment_not_configured import EnvironmentNotConfigured +from foundry_sdk._errors.not_authenticated import NotAuthenticated T = TypeVar("T") diff --git a/foundry/_core/utils.py b/foundry_sdk/_core/utils.py similarity index 100% rename from foundry/_core/utils.py rename to foundry_sdk/_core/utils.py diff --git a/foundry_sdk/_errors/__init__.py b/foundry_sdk/_errors/__init__.py new file mode 100644 index 000000000..0420890c1 --- /dev/null +++ b/foundry_sdk/_errors/__init__.py @@ -0,0 +1,39 @@ +# 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. + + +from foundry_sdk._errors.api_not_found import ApiNotFoundError +from foundry_sdk._errors.connection_error import ConnectionError +from foundry_sdk._errors.connection_error import ProxyError +from foundry_sdk._errors.environment_not_configured import EnvironmentNotConfigured +from foundry_sdk._errors.not_authenticated import NotAuthenticated +from foundry_sdk._errors.palantir_exception import PalantirException +from foundry_sdk._errors.palantir_rpc_exception import BadRequestError +from foundry_sdk._errors.palantir_rpc_exception import ConflictError +from foundry_sdk._errors.palantir_rpc_exception import InternalServerError +from foundry_sdk._errors.palantir_rpc_exception import NotFoundError +from foundry_sdk._errors.palantir_rpc_exception import PalantirRPCException +from foundry_sdk._errors.palantir_rpc_exception import PermissionDeniedError +from foundry_sdk._errors.palantir_rpc_exception import RateLimitError +from foundry_sdk._errors.palantir_rpc_exception import RequestEntityTooLargeError +from foundry_sdk._errors.palantir_rpc_exception import UnauthorizedError +from foundry_sdk._errors.palantir_rpc_exception import UnprocessableEntityError +from foundry_sdk._errors.sdk_internal_error import SDKInternalError +from foundry_sdk._errors.sdk_internal_error import handle_unexpected +from foundry_sdk._errors.stream_error import StreamConsumedError +from foundry_sdk._errors.timeout_error import ConnectTimeout +from foundry_sdk._errors.timeout_error import ReadTimeout +from foundry_sdk._errors.timeout_error import TimeoutError +from foundry_sdk._errors.timeout_error import WriteTimeout +from foundry_sdk._errors.utils import deserialize_error diff --git a/foundry/_errors/api_not_found.py b/foundry_sdk/_errors/api_not_found.py similarity index 91% rename from foundry/_errors/api_not_found.py rename to foundry_sdk/_errors/api_not_found.py index 83a67c9e0..1ae322aa4 100644 --- a/foundry/_errors/api_not_found.py +++ b/foundry_sdk/_errors/api_not_found.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry._errors.palantir_exception import PalantirException +from foundry_sdk._errors.palantir_exception import PalantirException class ApiNotFoundError(PalantirException): diff --git a/foundry/_errors/connection_error.py b/foundry_sdk/_errors/connection_error.py similarity index 92% rename from foundry/_errors/connection_error.py rename to foundry_sdk/_errors/connection_error.py index c62da3eee..67e727188 100644 --- a/foundry/_errors/connection_error.py +++ b/foundry_sdk/_errors/connection_error.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry._errors.palantir_exception import PalantirException +from foundry_sdk._errors.palantir_exception import PalantirException class ConnectionError(PalantirException): diff --git a/foundry/_errors/environment_not_configured.py b/foundry_sdk/_errors/environment_not_configured.py similarity index 91% rename from foundry/_errors/environment_not_configured.py rename to foundry_sdk/_errors/environment_not_configured.py index ca9147085..2bb700053 100644 --- a/foundry/_errors/environment_not_configured.py +++ b/foundry_sdk/_errors/environment_not_configured.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry._errors.palantir_exception import PalantirException +from foundry_sdk._errors.palantir_exception import PalantirException class EnvironmentNotConfigured(PalantirException): diff --git a/foundry/_errors/not_authenticated.py b/foundry_sdk/_errors/not_authenticated.py similarity index 90% rename from foundry/_errors/not_authenticated.py rename to foundry_sdk/_errors/not_authenticated.py index 64d096790..c3b3a6a67 100644 --- a/foundry/_errors/not_authenticated.py +++ b/foundry_sdk/_errors/not_authenticated.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry._errors.palantir_exception import PalantirException +from foundry_sdk._errors.palantir_exception import PalantirException class NotAuthenticated(PalantirException): diff --git a/foundry/_errors/palantir_exception.py b/foundry_sdk/_errors/palantir_exception.py similarity index 100% rename from foundry/_errors/palantir_exception.py rename to foundry_sdk/_errors/palantir_exception.py diff --git a/foundry/_errors/palantir_rpc_exception.py b/foundry_sdk/_errors/palantir_rpc_exception.py similarity index 97% rename from foundry/_errors/palantir_rpc_exception.py rename to foundry_sdk/_errors/palantir_rpc_exception.py index eb1d79d50..805888e54 100644 --- a/foundry/_errors/palantir_rpc_exception.py +++ b/foundry_sdk/_errors/palantir_rpc_exception.py @@ -17,7 +17,7 @@ from typing import Any from typing import Dict -from foundry._errors.palantir_exception import PalantirException +from foundry_sdk._errors.palantir_exception import PalantirException def format_error_message(fields: Dict[str, Any]) -> str: diff --git a/foundry/_errors/sdk_internal_error.py b/foundry_sdk/_errors/sdk_internal_error.py similarity index 92% rename from foundry/_errors/sdk_internal_error.py rename to foundry_sdk/_errors/sdk_internal_error.py index 98ccc7bfa..906c1d681 100644 --- a/foundry/_errors/sdk_internal_error.py +++ b/foundry_sdk/_errors/sdk_internal_error.py @@ -24,9 +24,9 @@ from pydantic import __version__ as __pydantic__version__ from pydantic_core import __version__ as __pydantic_core_version__ -from foundry._errors.palantir_exception import PalantirException -from foundry._versions import __openapi_document_version__ -from foundry._versions import __version__ +from foundry_sdk._errors.palantir_exception import PalantirException +from foundry_sdk._versions import __openapi_document_version__ +from foundry_sdk._versions import __version__ AnyCallableT = TypeVar("AnyCallableT", bound=Callable[..., Any]) diff --git a/foundry/_errors/stream_error.py b/foundry_sdk/_errors/stream_error.py similarity index 91% rename from foundry/_errors/stream_error.py rename to foundry_sdk/_errors/stream_error.py index a2496bbed..ab9effd73 100644 --- a/foundry/_errors/stream_error.py +++ b/foundry_sdk/_errors/stream_error.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry._errors.palantir_exception import PalantirException +from foundry_sdk._errors.palantir_exception import PalantirException class StreamConsumedError(PalantirException): diff --git a/foundry/_errors/timeout_error.py b/foundry_sdk/_errors/timeout_error.py similarity index 89% rename from foundry/_errors/timeout_error.py rename to foundry_sdk/_errors/timeout_error.py index d104410e9..8c9ce9be6 100644 --- a/foundry/_errors/timeout_error.py +++ b/foundry_sdk/_errors/timeout_error.py @@ -13,8 +13,8 @@ # limitations under the License. -from foundry._errors.connection_error import ConnectionError -from foundry._errors.palantir_exception import PalantirException +from foundry_sdk._errors.connection_error import ConnectionError +from foundry_sdk._errors.palantir_exception import PalantirException class TimeoutError(PalantirException): diff --git a/foundry/_errors/utils.py b/foundry_sdk/_errors/utils.py similarity index 93% rename from foundry/_errors/utils.py rename to foundry_sdk/_errors/utils.py index c75ae4d5a..b025ca7b0 100644 --- a/foundry/_errors/utils.py +++ b/foundry_sdk/_errors/utils.py @@ -23,8 +23,8 @@ import pydantic -from foundry._errors.palantir_rpc_exception import PalantirRPCException -from foundry._errors.sdk_internal_error import SDKInternalError +from foundry_sdk._errors.palantir_rpc_exception import PalantirRPCException +from foundry_sdk._errors.sdk_internal_error import SDKInternalError def deserialize_error( diff --git a/foundry/_versions.py b/foundry_sdk/_versions.py similarity index 100% rename from foundry/_versions.py rename to foundry_sdk/_versions.py diff --git a/foundry/py.typed b/foundry_sdk/py.typed similarity index 100% rename from foundry/py.typed rename to foundry_sdk/py.typed diff --git a/foundry/v2/__init__.py b/foundry_sdk/v1/__init__.py similarity index 93% rename from foundry/v2/__init__.py rename to foundry_sdk/v1/__init__.py index 8a5bfcff5..bb1053d81 100644 --- a/foundry/v2/__init__.py +++ b/foundry_sdk/v1/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v2.client import FoundryClient +from foundry_sdk.v1.client import FoundryClient __all__ = [ "FoundryClient", diff --git a/foundry/v1/cli.py b/foundry_sdk/v1/cli.py similarity index 96% rename from foundry/v1/cli.py rename to foundry_sdk/v1/cli.py index 01e117fc3..bf7ee7f35 100644 --- a/foundry/v1/cli.py +++ b/foundry_sdk/v1/cli.py @@ -24,18 +24,18 @@ import click -import foundry.v1 +import foundry_sdk.v1 @dataclasses.dataclass class _Context: - obj: foundry.v1.FoundryClient + obj: foundry_sdk.v1.FoundryClient def get_from_environ(key: str) -> str: value = os.environ.get(key) if value is None: - raise foundry.EnvironmentNotConfigured(f"Please set {key} using `export {key}=<{key}>`") + raise foundry_sdk.EnvironmentNotConfigured(f"Please set {key} using `export {key}=<{key}>`") return value @@ -44,8 +44,8 @@ def get_from_environ(key: str) -> str: @click.pass_context # type: ignore def cli(ctx: _Context): "An experimental CLI for the Foundry API" - ctx.obj = foundry.v1.FoundryClient( - auth=foundry.UserTokenAuth(token=get_from_environ("FOUNDRY_TOKEN")), + ctx.obj = foundry_sdk.v1.FoundryClient( + auth=foundry_sdk.UserTokenAuth(token=get_from_environ("FOUNDRY_TOKEN")), hostname=get_from_environ("FOUNDRY_HOSTNAME"), ) @@ -70,7 +70,7 @@ def datasets_dataset(): @click.option("--parent_folder_rid", type=str, required=True, help="""""") @click.pass_obj def datasets_dataset_create( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, name: str, parent_folder_rid: str, ): @@ -106,7 +106,7 @@ def datasets_dataset_create( ) @click.pass_obj def datasets_dataset_delete_schema( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, branch_id: typing.Optional[str], preview: typing.Optional[bool], @@ -129,7 +129,7 @@ def datasets_dataset_delete_schema( @click.argument("dataset_rid", type=str, required=True) @click.pass_obj def datasets_dataset_get( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, ): """ @@ -163,7 +163,7 @@ def datasets_dataset_get( ) @click.pass_obj def datasets_dataset_get_schema( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, branch_id: typing.Optional[str], preview: typing.Optional[bool], @@ -222,7 +222,7 @@ def datasets_dataset_get_schema( ) @click.pass_obj def datasets_dataset_read( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, format: typing.Literal["ARROW", "CSV"], branch_id: typing.Optional[str], @@ -264,7 +264,7 @@ def datasets_dataset_read( @click.option("--preview", type=bool, required=False, help="""""") @click.pass_obj def datasets_dataset_replace_schema( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, body: str, branch_id: typing.Optional[str], @@ -293,7 +293,7 @@ def datasets_dataset_transaction(): @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_abort( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -316,7 +316,7 @@ def datasets_dataset_transaction_abort( @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_commit( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -351,7 +351,7 @@ def datasets_dataset_transaction_commit( ) @click.pass_obj def datasets_dataset_transaction_create( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, branch_id: typing.Optional[str], transaction_type: typing.Optional[typing.Literal["APPEND", "UPDATE", "SNAPSHOT", "DELETE"]], @@ -375,7 +375,7 @@ def datasets_dataset_transaction_create( @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_get( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -414,7 +414,7 @@ def datasets_dataset_file(): ) @click.pass_obj def datasets_dataset_file_delete( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, file_path: str, branch_id: typing.Optional[str], @@ -471,7 +471,7 @@ def datasets_dataset_file_delete( ) @click.pass_obj def datasets_dataset_file_get( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, file_path: str, branch_id: typing.Optional[str], @@ -546,7 +546,7 @@ def datasets_dataset_file_get( ) @click.pass_obj def datasets_dataset_file_list( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, branch_id: typing.Optional[str], end_transaction_rid: typing.Optional[str], @@ -617,7 +617,7 @@ def datasets_dataset_file_list( ) @click.pass_obj def datasets_dataset_file_read( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, file_path: str, branch_id: typing.Optional[str], @@ -688,7 +688,7 @@ def datasets_dataset_file_read( ) @click.pass_obj def datasets_dataset_file_upload( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, body: io.BufferedReader, file_path: str, @@ -741,7 +741,7 @@ def datasets_dataset_branch(): @click.option("--transaction_rid", type=str, required=False, help="""""") @click.pass_obj def datasets_dataset_branch_create( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, branch_id: str, transaction_rid: typing.Optional[str], @@ -765,7 +765,7 @@ def datasets_dataset_branch_create( @click.argument("branch_id", type=str, required=True) @click.pass_obj def datasets_dataset_branch_delete( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, branch_id: str, ): @@ -787,7 +787,7 @@ def datasets_dataset_branch_delete( @click.argument("branch_id", type=str, required=True) @click.pass_obj def datasets_dataset_branch_get( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, branch_id: str, ): @@ -817,7 +817,7 @@ def datasets_dataset_branch_get( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def datasets_dataset_branch_list( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, dataset_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -857,7 +857,7 @@ def ontologies_query(): @click.option("--parameters", type=str, required=True, help="""""") @click.pass_obj def ontologies_query_execute( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, query_api_name: str, parameters: str, @@ -889,7 +889,7 @@ def ontologies_ontology_object(): @click.option("--query", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_aggregate( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, object_type: str, aggregation: str, @@ -926,7 +926,7 @@ def ontologies_ontology_object_aggregate( ) @click.pass_obj def ontologies_ontology_object_get( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, object_type: str, primary_key: str, @@ -963,7 +963,7 @@ def ontologies_ontology_object_get( ) @click.pass_obj def ontologies_ontology_object_get_linked_object( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, object_type: str, primary_key: str, @@ -1012,7 +1012,7 @@ def ontologies_ontology_object_get_linked_object( ) @click.pass_obj def ontologies_ontology_object_list( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, object_type: str, order_by: typing.Optional[str], @@ -1077,7 +1077,7 @@ def ontologies_ontology_object_list( ) @click.pass_obj def ontologies_ontology_object_list_linked_objects( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, object_type: str, primary_key: str, @@ -1137,7 +1137,7 @@ def ontologies_ontology_object_list_linked_objects( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_search( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, object_type: str, fields: str, @@ -1194,7 +1194,7 @@ def ontologies_ontology(): @click.argument("ontology_rid", type=str, required=True) @click.pass_obj def ontologies_ontology_get( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, ): """ @@ -1212,7 +1212,7 @@ def ontologies_ontology_get( @ontologies_ontology.command("list") @click.pass_obj def ontologies_ontology_list( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ): """ Lists the Ontologies visible to the current user. @@ -1234,7 +1234,7 @@ def ontologies_ontology_query_type(): @click.argument("query_api_name", type=str, required=True) @click.pass_obj def ontologies_ontology_query_type_get( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, query_api_name: str, ): @@ -1264,7 +1264,7 @@ def ontologies_ontology_query_type_get( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_query_type_list( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -1296,7 +1296,7 @@ def ontologies_ontology_object_type(): @click.argument("object_type", type=str, required=True) @click.pass_obj def ontologies_ontology_object_type_get( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, object_type: str, ): @@ -1319,7 +1319,7 @@ def ontologies_ontology_object_type_get( @click.argument("link_type", type=str, required=True) @click.pass_obj def ontologies_ontology_object_type_get_outgoing_link_type( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, object_type: str, link_type: str, @@ -1352,7 +1352,7 @@ def ontologies_ontology_object_type_get_outgoing_link_type( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_type_list( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -1384,7 +1384,7 @@ def ontologies_ontology_object_type_list( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_type_list_outgoing_link_types( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, object_type: str, page_size: typing.Optional[int], @@ -1416,7 +1416,7 @@ def ontologies_ontology_action_type(): @click.argument("action_type_api_name", type=str, required=True) @click.pass_obj def ontologies_ontology_action_type_get( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, action_type_api_name: str, ): @@ -1446,7 +1446,7 @@ def ontologies_ontology_action_type_get( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_action_type_list( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -1477,7 +1477,7 @@ def ontologies_attachment(): @click.argument("attachment_rid", type=str, required=True) @click.pass_obj def ontologies_attachment_get( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, attachment_rid: str, ): """ @@ -1497,7 +1497,7 @@ def ontologies_attachment_get( @click.argument("attachment_rid", type=str, required=True) @click.pass_obj def ontologies_attachment_read( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, attachment_rid: str, ): """ @@ -1529,7 +1529,7 @@ def ontologies_attachment_read( ) @click.pass_obj def ontologies_attachment_upload( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, body: io.BufferedReader, content_length: int, content_type: str, @@ -1566,7 +1566,7 @@ def ontologies_action(): @click.option("--parameters", type=str, required=True, help="""""") @click.pass_obj def ontologies_action_apply( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, action_type: str, parameters: str, @@ -1596,7 +1596,7 @@ def ontologies_action_apply( @click.option("--requests", type=str, required=True, help="""""") @click.pass_obj def ontologies_action_apply_batch( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, action_type: str, requests: str, @@ -1629,7 +1629,7 @@ def ontologies_action_apply_batch( @click.option("--parameters", type=str, required=True, help="""""") @click.pass_obj def ontologies_action_validate( - client: foundry.v1.FoundryClient, + client: foundry_sdk.v1.FoundryClient, ontology_rid: str, action_type: str, parameters: str, diff --git a/foundry/v1/client.py b/foundry_sdk/v1/client.py similarity index 88% rename from foundry/v1/client.py rename to foundry_sdk/v1/client.py index a47d90f4d..7fae2c286 100644 --- a/foundry/v1/client.py +++ b/foundry_sdk/v1/client.py @@ -15,7 +15,7 @@ import typing -from foundry import _core as core +from foundry_sdk import _core as core class FoundryClient: @@ -33,8 +33,8 @@ def __init__( hostname: str, config: typing.Optional[core.Config] = None, ): - from foundry.v1.datasets._client import DatasetsClient - from foundry.v1.ontologies._client import OntologiesClient + from foundry_sdk.v1.datasets._client import DatasetsClient + from foundry_sdk.v1.ontologies._client import OntologiesClient self.datasets = DatasetsClient(auth=auth, hostname=hostname, config=config) self.ontologies = OntologiesClient(auth=auth, hostname=hostname, config=config) diff --git a/foundry/v1/core/errors.py b/foundry_sdk/v1/core/errors.py similarity index 98% rename from foundry/v1/core/errors.py rename to foundry_sdk/v1/core/errors.py index 5da8db24d..e7d881fb5 100644 --- a/foundry/v1/core/errors.py +++ b/foundry_sdk/v1/core/errors.py @@ -18,8 +18,8 @@ import typing_extensions -from foundry import _errors as errors -from foundry.v1.core import models as core_models +from foundry_sdk import _errors as errors +from foundry_sdk.v1.core import models as core_models class ApiFeaturePreviewUsageOnlyParameters(typing_extensions.TypedDict): diff --git a/foundry/v1/core/models.py b/foundry_sdk/v1/core/models.py similarity index 99% rename from foundry/v1/core/models.py rename to foundry_sdk/v1/core/models.py index fcc05d9cd..39c6d900c 100644 --- a/foundry/v1/core/models.py +++ b/foundry_sdk/v1/core/models.py @@ -19,7 +19,7 @@ import pydantic -from foundry import _core as core +from foundry_sdk import _core as core class AnyType(pydantic.BaseModel): diff --git a/foundry/v1/datasets/__init__.py b/foundry_sdk/v1/datasets/__init__.py similarity index 91% rename from foundry/v1/datasets/__init__.py rename to foundry_sdk/v1/datasets/__init__.py index d3734372e..191d36cf7 100644 --- a/foundry/v1/datasets/__init__.py +++ b/foundry_sdk/v1/datasets/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v1.datasets._client import DatasetsClient +from foundry_sdk.v1.datasets._client import DatasetsClient __all__ = [ "DatasetsClient", diff --git a/foundry/v1/datasets/_client.py b/foundry_sdk/v1/datasets/_client.py similarity index 93% rename from foundry/v1/datasets/_client.py rename to foundry_sdk/v1/datasets/_client.py index 76b9fdd5a..e04d4666d 100644 --- a/foundry/v1/datasets/_client.py +++ b/foundry_sdk/v1/datasets/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class DatasetsClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def Dataset(self): - from foundry.v1.datasets.dataset import DatasetClient + from foundry_sdk.v1.datasets.dataset import DatasetClient return DatasetClient( auth=self._auth, diff --git a/foundry/v1/datasets/branch.py b/foundry_sdk/v1/datasets/branch.py similarity index 98% rename from foundry/v1/datasets/branch.py rename to foundry_sdk/v1/datasets/branch.py index e97d5b9d4..03d1f929f 100644 --- a/foundry/v1/datasets/branch.py +++ b/foundry_sdk/v1/datasets/branch.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v1.core import models as core_models -from foundry.v1.datasets import models as datasets_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v1.core import models as core_models +from foundry_sdk.v1.datasets import models as datasets_models class BranchClient: diff --git a/foundry/v1/datasets/dataset.py b/foundry_sdk/v1/datasets/dataset.py similarity index 97% rename from foundry/v1/datasets/dataset.py rename to foundry_sdk/v1/datasets/dataset.py index 1e77ebfa0..0a9efa8e9 100644 --- a/foundry/v1/datasets/dataset.py +++ b/foundry_sdk/v1/datasets/dataset.py @@ -19,10 +19,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v1.core import models as core_models -from foundry.v1.datasets import models as datasets_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v1.core import models as core_models +from foundry_sdk.v1.datasets import models as datasets_models class DatasetClient: @@ -50,7 +50,7 @@ def __init__( @cached_property def Branch(self): - from foundry.v1.datasets.branch import BranchClient + from foundry_sdk.v1.datasets.branch import BranchClient return BranchClient( auth=self._auth, @@ -60,7 +60,7 @@ def Branch(self): @cached_property def File(self): - from foundry.v1.datasets.file import FileClient + from foundry_sdk.v1.datasets.file import FileClient return FileClient( auth=self._auth, @@ -70,7 +70,7 @@ def File(self): @cached_property def Transaction(self): - from foundry.v1.datasets.transaction import TransactionClient + from foundry_sdk.v1.datasets.transaction import TransactionClient return TransactionClient( auth=self._auth, diff --git a/foundry/v1/datasets/errors.py b/foundry_sdk/v1/datasets/errors.py similarity index 98% rename from foundry/v1/datasets/errors.py rename to foundry_sdk/v1/datasets/errors.py index 4a633822f..cd749b82c 100644 --- a/foundry/v1/datasets/errors.py +++ b/foundry_sdk/v1/datasets/errors.py @@ -18,9 +18,9 @@ import typing_extensions -from foundry import _errors as errors -from foundry.v1.core import models as core_models -from foundry.v1.datasets import models as datasets_models +from foundry_sdk import _errors as errors +from foundry_sdk.v1.core import models as core_models +from foundry_sdk.v1.datasets import models as datasets_models class AbortTransactionPermissionDeniedParameters(typing_extensions.TypedDict): diff --git a/foundry/v1/datasets/file.py b/foundry_sdk/v1/datasets/file.py similarity index 99% rename from foundry/v1/datasets/file.py rename to foundry_sdk/v1/datasets/file.py index c60fea941..f48773e53 100644 --- a/foundry/v1/datasets/file.py +++ b/foundry_sdk/v1/datasets/file.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v1.core import models as core_models -from foundry.v1.datasets import models as datasets_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v1.core import models as core_models +from foundry_sdk.v1.datasets import models as datasets_models class FileClient: diff --git a/foundry/v1/datasets/models.py b/foundry_sdk/v1/datasets/models.py similarity index 98% rename from foundry/v1/datasets/models.py rename to foundry_sdk/v1/datasets/models.py index af9335579..0ff472650 100644 --- a/foundry/v1/datasets/models.py +++ b/foundry_sdk/v1/datasets/models.py @@ -20,8 +20,8 @@ import pydantic -from foundry import _core as core -from foundry.v1.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk.v1.core import models as core_models class Branch(pydantic.BaseModel): diff --git a/foundry/v1/datasets/transaction.py b/foundry_sdk/v1/datasets/transaction.py similarity index 98% rename from foundry/v1/datasets/transaction.py rename to foundry_sdk/v1/datasets/transaction.py index e98265f7b..1576322de 100644 --- a/foundry/v1/datasets/transaction.py +++ b/foundry_sdk/v1/datasets/transaction.py @@ -18,9 +18,9 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v1.datasets import models as datasets_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v1.datasets import models as datasets_models class TransactionClient: diff --git a/foundry/v1/geo/errors.py b/foundry_sdk/v1/geo/errors.py similarity index 100% rename from foundry/v1/geo/errors.py rename to foundry_sdk/v1/geo/errors.py diff --git a/foundry/v1/geo/models.py b/foundry_sdk/v1/geo/models.py similarity index 94% rename from foundry/v1/geo/models.py rename to foundry_sdk/v1/geo/models.py index d773dc140..d93955a4b 100644 --- a/foundry/v1/geo/models.py +++ b/foundry_sdk/v1/geo/models.py @@ -15,6 +15,6 @@ from __future__ import annotations -from foundry import _core as core +from foundry_sdk import _core as core __all__ = [] diff --git a/foundry/v2/ontologies/__init__.py b/foundry_sdk/v1/ontologies/__init__.py similarity index 91% rename from foundry/v2/ontologies/__init__.py rename to foundry_sdk/v1/ontologies/__init__.py index f38034bd2..fefbade2b 100644 --- a/foundry/v2/ontologies/__init__.py +++ b/foundry_sdk/v1/ontologies/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v2.ontologies._client import OntologiesClient +from foundry_sdk.v1.ontologies._client import OntologiesClient __all__ = [ "OntologiesClient", diff --git a/foundry/v1/ontologies/_client.py b/foundry_sdk/v1/ontologies/_client.py similarity index 84% rename from foundry/v1/ontologies/_client.py rename to foundry_sdk/v1/ontologies/_client.py index d4f6ffa01..1731dc77e 100644 --- a/foundry/v1/ontologies/_client.py +++ b/foundry_sdk/v1/ontologies/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class OntologiesClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def Action(self): - from foundry.v1.ontologies.action import ActionClient + from foundry_sdk.v1.ontologies.action import ActionClient return ActionClient( auth=self._auth, @@ -50,7 +50,7 @@ def Action(self): @cached_property def Attachment(self): - from foundry.v1.ontologies.attachment import AttachmentClient + from foundry_sdk.v1.ontologies.attachment import AttachmentClient return AttachmentClient( auth=self._auth, @@ -60,7 +60,7 @@ def Attachment(self): @cached_property def Ontology(self): - from foundry.v1.ontologies.ontology import OntologyClient + from foundry_sdk.v1.ontologies.ontology import OntologyClient return OntologyClient( auth=self._auth, @@ -70,7 +70,7 @@ def Ontology(self): @cached_property def OntologyObject(self): - from foundry.v1.ontologies.ontology_object import OntologyObjectClient + from foundry_sdk.v1.ontologies.ontology_object import OntologyObjectClient return OntologyObjectClient( auth=self._auth, @@ -80,7 +80,7 @@ def OntologyObject(self): @cached_property def Query(self): - from foundry.v1.ontologies.query import QueryClient + from foundry_sdk.v1.ontologies.query import QueryClient return QueryClient( auth=self._auth, diff --git a/foundry/v1/ontologies/action.py b/foundry_sdk/v1/ontologies/action.py similarity index 98% rename from foundry/v1/ontologies/action.py rename to foundry_sdk/v1/ontologies/action.py index 3a7000d97..8ec1e75ae 100644 --- a/foundry/v1/ontologies/action.py +++ b/foundry_sdk/v1/ontologies/action.py @@ -18,9 +18,9 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v1.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v1.ontologies import models as ontologies_models class ActionClient: diff --git a/foundry/v1/ontologies/action_type.py b/foundry_sdk/v1/ontologies/action_type.py similarity index 97% rename from foundry/v1/ontologies/action_type.py rename to foundry_sdk/v1/ontologies/action_type.py index 607b37c47..666d33926 100644 --- a/foundry/v1/ontologies/action_type.py +++ b/foundry_sdk/v1/ontologies/action_type.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v1.core import models as core_models -from foundry.v1.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v1.core import models as core_models +from foundry_sdk.v1.ontologies import models as ontologies_models class ActionTypeClient: diff --git a/foundry/v1/ontologies/attachment.py b/foundry_sdk/v1/ontologies/attachment.py similarity index 97% rename from foundry/v1/ontologies/attachment.py rename to foundry_sdk/v1/ontologies/attachment.py index bc685dafd..6fdf965e0 100644 --- a/foundry/v1/ontologies/attachment.py +++ b/foundry_sdk/v1/ontologies/attachment.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v1.core import models as core_models -from foundry.v1.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v1.core import models as core_models +from foundry_sdk.v1.ontologies import models as ontologies_models class AttachmentClient: diff --git a/foundry/v2/ontologies/errors.py b/foundry_sdk/v1/ontologies/errors.py similarity index 99% rename from foundry/v2/ontologies/errors.py rename to foundry_sdk/v1/ontologies/errors.py index 74aa277e6..606753a0f 100644 --- a/foundry/v2/ontologies/errors.py +++ b/foundry_sdk/v1/ontologies/errors.py @@ -18,9 +18,9 @@ import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v1.ontologies import models as ontologies_models class ActionContainsDuplicateEditsParameters(typing_extensions.TypedDict): diff --git a/foundry/v1/ontologies/models.py b/foundry_sdk/v1/ontologies/models.py similarity index 99% rename from foundry/v1/ontologies/models.py rename to foundry_sdk/v1/ontologies/models.py index 4509acc90..717565b70 100644 --- a/foundry/v1/ontologies/models.py +++ b/foundry_sdk/v1/ontologies/models.py @@ -20,8 +20,8 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry.v1.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk.v1.core import models as core_models ActionRid = core.RID """The unique resource identifier for an action.""" diff --git a/foundry/v1/ontologies/object_type.py b/foundry_sdk/v1/ontologies/object_type.py similarity index 98% rename from foundry/v1/ontologies/object_type.py rename to foundry_sdk/v1/ontologies/object_type.py index d1db700c1..2d42b8119 100644 --- a/foundry/v1/ontologies/object_type.py +++ b/foundry_sdk/v1/ontologies/object_type.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v1.core import models as core_models -from foundry.v1.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v1.core import models as core_models +from foundry_sdk.v1.ontologies import models as ontologies_models class ObjectTypeClient: diff --git a/foundry/v1/ontologies/ontology.py b/foundry_sdk/v1/ontologies/ontology.py similarity index 93% rename from foundry/v1/ontologies/ontology.py rename to foundry_sdk/v1/ontologies/ontology.py index 3f0b79296..f223a4eea 100644 --- a/foundry/v1/ontologies/ontology.py +++ b/foundry_sdk/v1/ontologies/ontology.py @@ -19,9 +19,9 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v1.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v1.ontologies import models as ontologies_models class OntologyClient: @@ -49,7 +49,7 @@ def __init__( @cached_property def ActionType(self): - from foundry.v1.ontologies.action_type import ActionTypeClient + from foundry_sdk.v1.ontologies.action_type import ActionTypeClient return ActionTypeClient( auth=self._auth, @@ -59,7 +59,7 @@ def ActionType(self): @cached_property def ObjectType(self): - from foundry.v1.ontologies.object_type import ObjectTypeClient + from foundry_sdk.v1.ontologies.object_type import ObjectTypeClient return ObjectTypeClient( auth=self._auth, @@ -69,7 +69,7 @@ def ObjectType(self): @cached_property def QueryType(self): - from foundry.v1.ontologies.query_type import QueryTypeClient + from foundry_sdk.v1.ontologies.query_type import QueryTypeClient return QueryTypeClient( auth=self._auth, diff --git a/foundry/v1/ontologies/ontology_object.py b/foundry_sdk/v1/ontologies/ontology_object.py similarity index 99% rename from foundry/v1/ontologies/ontology_object.py rename to foundry_sdk/v1/ontologies/ontology_object.py index 0a5804a00..3b8d8d002 100644 --- a/foundry/v1/ontologies/ontology_object.py +++ b/foundry_sdk/v1/ontologies/ontology_object.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v1.core import models as core_models -from foundry.v1.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v1.core import models as core_models +from foundry_sdk.v1.ontologies import models as ontologies_models class OntologyObjectClient: diff --git a/foundry/v1/ontologies/query.py b/foundry_sdk/v1/ontologies/query.py similarity index 96% rename from foundry/v1/ontologies/query.py rename to foundry_sdk/v1/ontologies/query.py index 2fc008d2d..8d48670cc 100644 --- a/foundry/v1/ontologies/query.py +++ b/foundry_sdk/v1/ontologies/query.py @@ -18,9 +18,9 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v1.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v1.ontologies import models as ontologies_models class QueryClient: diff --git a/foundry/v1/ontologies/query_type.py b/foundry_sdk/v1/ontologies/query_type.py similarity index 97% rename from foundry/v1/ontologies/query_type.py rename to foundry_sdk/v1/ontologies/query_type.py index 1d5ef6f57..845e622d4 100644 --- a/foundry/v1/ontologies/query_type.py +++ b/foundry_sdk/v1/ontologies/query_type.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v1.core import models as core_models -from foundry.v1.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v1.core import models as core_models +from foundry_sdk.v1.ontologies import models as ontologies_models class QueryTypeClient: diff --git a/foundry/v1/__init__.py b/foundry_sdk/v2/__init__.py similarity index 93% rename from foundry/v1/__init__.py rename to foundry_sdk/v2/__init__.py index 6a6f8047e..9f4ce4fad 100644 --- a/foundry/v1/__init__.py +++ b/foundry_sdk/v2/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v1.client import FoundryClient +from foundry_sdk.v2.client import FoundryClient __all__ = [ "FoundryClient", diff --git a/foundry/v2/admin/__init__.py b/foundry_sdk/v2/admin/__init__.py similarity index 92% rename from foundry/v2/admin/__init__.py rename to foundry_sdk/v2/admin/__init__.py index e01c24a73..6d2d521a7 100644 --- a/foundry/v2/admin/__init__.py +++ b/foundry_sdk/v2/admin/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v2.admin._client import AdminClient +from foundry_sdk.v2.admin._client import AdminClient __all__ = [ "AdminClient", diff --git a/foundry/v2/admin/_client.py b/foundry_sdk/v2/admin/_client.py similarity index 84% rename from foundry/v2/admin/_client.py rename to foundry_sdk/v2/admin/_client.py index 45ebe5d3c..f86be09f0 100644 --- a/foundry/v2/admin/_client.py +++ b/foundry_sdk/v2/admin/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class AdminClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def Enrollment(self): - from foundry.v2.admin.enrollment import EnrollmentClient + from foundry_sdk.v2.admin.enrollment import EnrollmentClient return EnrollmentClient( auth=self._auth, @@ -50,7 +50,7 @@ def Enrollment(self): @cached_property def Group(self): - from foundry.v2.admin.group import GroupClient + from foundry_sdk.v2.admin.group import GroupClient return GroupClient( auth=self._auth, @@ -60,7 +60,7 @@ def Group(self): @cached_property def Marking(self): - from foundry.v2.admin.marking import MarkingClient + from foundry_sdk.v2.admin.marking import MarkingClient return MarkingClient( auth=self._auth, @@ -70,7 +70,7 @@ def Marking(self): @cached_property def MarkingCategory(self): - from foundry.v2.admin.marking_category import MarkingCategoryClient + from foundry_sdk.v2.admin.marking_category import MarkingCategoryClient return MarkingCategoryClient( auth=self._auth, @@ -80,7 +80,7 @@ def MarkingCategory(self): @cached_property def Organization(self): - from foundry.v2.admin.organization import OrganizationClient + from foundry_sdk.v2.admin.organization import OrganizationClient return OrganizationClient( auth=self._auth, @@ -90,7 +90,7 @@ def Organization(self): @cached_property def User(self): - from foundry.v2.admin.user import UserClient + from foundry_sdk.v2.admin.user import UserClient return UserClient( auth=self._auth, diff --git a/foundry/v2/admin/authentication_provider.py b/foundry_sdk/v2/admin/authentication_provider.py similarity index 98% rename from foundry/v2/admin/authentication_provider.py rename to foundry_sdk/v2/admin/authentication_provider.py index 5dbe273d1..3b1854057 100644 --- a/foundry/v2/admin/authentication_provider.py +++ b/foundry_sdk/v2/admin/authentication_provider.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import errors as admin_errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import errors as admin_errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class AuthenticationProviderClient: diff --git a/foundry/v2/admin/enrollment.py b/foundry_sdk/v2/admin/enrollment.py similarity index 93% rename from foundry/v2/admin/enrollment.py rename to foundry_sdk/v2/admin/enrollment.py index d6f3a7ec7..d210782b5 100644 --- a/foundry/v2/admin/enrollment.py +++ b/foundry_sdk/v2/admin/enrollment.py @@ -19,11 +19,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import errors as admin_errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import errors as admin_errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class EnrollmentClient: @@ -51,7 +51,7 @@ def __init__( @cached_property def Host(self): - from foundry.v2.admin.host import HostClient + from foundry_sdk.v2.admin.host import HostClient return HostClient( auth=self._auth, @@ -61,7 +61,9 @@ def Host(self): @cached_property def AuthenticationProvider(self): - from foundry.v2.admin.authentication_provider import AuthenticationProviderClient # NOQA + from foundry_sdk.v2.admin.authentication_provider import ( + AuthenticationProviderClient, + ) # NOQA return AuthenticationProviderClient( auth=self._auth, diff --git a/foundry/v2/admin/errors.py b/foundry_sdk/v2/admin/errors.py similarity index 99% rename from foundry/v2/admin/errors.py rename to foundry_sdk/v2/admin/errors.py index 47db031c7..2a431e0f2 100644 --- a/foundry/v2/admin/errors.py +++ b/foundry_sdk/v2/admin/errors.py @@ -19,9 +19,9 @@ import typing_extensions -from foundry import _errors as errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class AddGroupMembersPermissionDeniedParameters(typing_extensions.TypedDict): diff --git a/foundry/v2/admin/group.py b/foundry_sdk/v2/admin/group.py similarity index 97% rename from foundry/v2/admin/group.py rename to foundry_sdk/v2/admin/group.py index 161b22c59..a43704183 100644 --- a/foundry/v2/admin/group.py +++ b/foundry_sdk/v2/admin/group.py @@ -20,11 +20,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import errors as admin_errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import errors as admin_errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class GroupClient: @@ -52,7 +52,7 @@ def __init__( @cached_property def ProviderInfo(self): - from foundry.v2.admin.group_provider_info import GroupProviderInfoClient + from foundry_sdk.v2.admin.group_provider_info import GroupProviderInfoClient return GroupProviderInfoClient( auth=self._auth, @@ -62,7 +62,7 @@ def ProviderInfo(self): @cached_property def GroupMember(self): - from foundry.v2.admin.group_member import GroupMemberClient + from foundry_sdk.v2.admin.group_member import GroupMemberClient return GroupMemberClient( auth=self._auth, diff --git a/foundry/v2/admin/group_member.py b/foundry_sdk/v2/admin/group_member.py similarity index 97% rename from foundry/v2/admin/group_member.py rename to foundry_sdk/v2/admin/group_member.py index 112d3f98e..ab44ad67a 100644 --- a/foundry/v2/admin/group_member.py +++ b/foundry_sdk/v2/admin/group_member.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import errors as admin_errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import errors as admin_errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class GroupMemberClient: diff --git a/foundry/v2/admin/group_membership.py b/foundry_sdk/v2/admin/group_membership.py similarity index 96% rename from foundry/v2/admin/group_membership.py rename to foundry_sdk/v2/admin/group_membership.py index d3bef5671..234caea34 100644 --- a/foundry/v2/admin/group_membership.py +++ b/foundry_sdk/v2/admin/group_membership.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class GroupMembershipClient: diff --git a/foundry/v2/admin/group_provider_info.py b/foundry_sdk/v2/admin/group_provider_info.py similarity index 96% rename from foundry/v2/admin/group_provider_info.py rename to foundry_sdk/v2/admin/group_provider_info.py index 27f94312b..58df7f2da 100644 --- a/foundry/v2/admin/group_provider_info.py +++ b/foundry_sdk/v2/admin/group_provider_info.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import errors as admin_errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import errors as admin_errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class GroupProviderInfoClient: diff --git a/foundry/v2/admin/host.py b/foundry_sdk/v2/admin/host.py similarity index 95% rename from foundry/v2/admin/host.py rename to foundry_sdk/v2/admin/host.py index ed66ba390..a7e8a0287 100644 --- a/foundry/v2/admin/host.py +++ b/foundry_sdk/v2/admin/host.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import errors as admin_errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import errors as admin_errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class HostClient: diff --git a/foundry/v2/admin/marking.py b/foundry_sdk/v2/admin/marking.py similarity index 96% rename from foundry/v2/admin/marking.py rename to foundry_sdk/v2/admin/marking.py index c1e78ec68..e238194cb 100644 --- a/foundry/v2/admin/marking.py +++ b/foundry_sdk/v2/admin/marking.py @@ -20,11 +20,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import errors as admin_errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import errors as admin_errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class MarkingClient: @@ -52,7 +52,7 @@ def __init__( @cached_property def MarkingMember(self): - from foundry.v2.admin.marking_member import MarkingMemberClient + from foundry_sdk.v2.admin.marking_member import MarkingMemberClient return MarkingMemberClient( auth=self._auth, @@ -62,7 +62,7 @@ def MarkingMember(self): @cached_property def MarkingRoleAssignment(self): - from foundry.v2.admin.marking_role_assignment import MarkingRoleAssignmentClient + from foundry_sdk.v2.admin.marking_role_assignment import MarkingRoleAssignmentClient # NOQA return MarkingRoleAssignmentClient( auth=self._auth, diff --git a/foundry/v2/admin/marking_category.py b/foundry_sdk/v2/admin/marking_category.py similarity index 96% rename from foundry/v2/admin/marking_category.py rename to foundry_sdk/v2/admin/marking_category.py index e849e1576..8d12e5497 100644 --- a/foundry/v2/admin/marking_category.py +++ b/foundry_sdk/v2/admin/marking_category.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import errors as admin_errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import errors as admin_errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class MarkingCategoryClient: diff --git a/foundry/v2/admin/marking_member.py b/foundry_sdk/v2/admin/marking_member.py similarity index 97% rename from foundry/v2/admin/marking_member.py rename to foundry_sdk/v2/admin/marking_member.py index 43471f5c0..e8a58639f 100644 --- a/foundry/v2/admin/marking_member.py +++ b/foundry_sdk/v2/admin/marking_member.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import errors as admin_errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import errors as admin_errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class MarkingMemberClient: diff --git a/foundry/v2/admin/marking_role_assignment.py b/foundry_sdk/v2/admin/marking_role_assignment.py similarity index 97% rename from foundry/v2/admin/marking_role_assignment.py rename to foundry_sdk/v2/admin/marking_role_assignment.py index 4dd386e0c..d6e46d4c4 100644 --- a/foundry/v2/admin/marking_role_assignment.py +++ b/foundry_sdk/v2/admin/marking_role_assignment.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import errors as admin_errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import errors as admin_errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class MarkingRoleAssignmentClient: diff --git a/foundry/v2/admin/models.py b/foundry_sdk/v2/admin/models.py similarity index 99% rename from foundry/v2/admin/models.py rename to foundry_sdk/v2/admin/models.py index 69a64f64a..17d1f4ec3 100644 --- a/foundry/v2/admin/models.py +++ b/foundry_sdk/v2/admin/models.py @@ -21,8 +21,8 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk.v2.core import models as core_models AttributeName = str """AttributeName""" diff --git a/foundry/v2/admin/organization.py b/foundry_sdk/v2/admin/organization.py similarity index 96% rename from foundry/v2/admin/organization.py rename to foundry_sdk/v2/admin/organization.py index e99d18ca4..e270b70b4 100644 --- a/foundry/v2/admin/organization.py +++ b/foundry_sdk/v2/admin/organization.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import errors as admin_errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import errors as admin_errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class OrganizationClient: diff --git a/foundry/v2/admin/user.py b/foundry_sdk/v2/admin/user.py similarity index 97% rename from foundry/v2/admin/user.py rename to foundry_sdk/v2/admin/user.py index b5907caaf..af77a8b69 100644 --- a/foundry/v2/admin/user.py +++ b/foundry_sdk/v2/admin/user.py @@ -20,11 +20,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import errors as admin_errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import errors as admin_errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class UserClient: @@ -52,7 +52,7 @@ def __init__( @cached_property def ProviderInfo(self): - from foundry.v2.admin.user_provider_info import UserProviderInfoClient + from foundry_sdk.v2.admin.user_provider_info import UserProviderInfoClient return UserProviderInfoClient( auth=self._auth, @@ -62,7 +62,7 @@ def ProviderInfo(self): @cached_property def GroupMembership(self): - from foundry.v2.admin.group_membership import GroupMembershipClient + from foundry_sdk.v2.admin.group_membership import GroupMembershipClient return GroupMembershipClient( auth=self._auth, diff --git a/foundry/v2/admin/user_provider_info.py b/foundry_sdk/v2/admin/user_provider_info.py similarity index 96% rename from foundry/v2/admin/user_provider_info.py rename to foundry_sdk/v2/admin/user_provider_info.py index 8b99aeac2..04d542da9 100644 --- a/foundry/v2/admin/user_provider_info.py +++ b/foundry_sdk/v2/admin/user_provider_info.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.admin import errors as admin_errors -from foundry.v2.admin import models as admin_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.admin import errors as admin_errors +from foundry_sdk.v2.admin import models as admin_models +from foundry_sdk.v2.core import models as core_models class UserProviderInfoClient: diff --git a/foundry/v2/aip_agents/__init__.py b/foundry_sdk/v2/aip_agents/__init__.py similarity index 91% rename from foundry/v2/aip_agents/__init__.py rename to foundry_sdk/v2/aip_agents/__init__.py index 9aa53fc3f..90fdb259c 100644 --- a/foundry/v2/aip_agents/__init__.py +++ b/foundry_sdk/v2/aip_agents/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v2.aip_agents._client import AipAgentsClient +from foundry_sdk.v2.aip_agents._client import AipAgentsClient __all__ = [ "AipAgentsClient", diff --git a/foundry/v2/aip_agents/_client.py b/foundry_sdk/v2/aip_agents/_client.py similarity index 93% rename from foundry/v2/aip_agents/_client.py rename to foundry_sdk/v2/aip_agents/_client.py index 01c5225ea..900e8a957 100644 --- a/foundry/v2/aip_agents/_client.py +++ b/foundry_sdk/v2/aip_agents/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class AipAgentsClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def Agent(self): - from foundry.v2.aip_agents.agent import AgentClient + from foundry_sdk.v2.aip_agents.agent import AgentClient return AgentClient( auth=self._auth, diff --git a/foundry/v2/aip_agents/agent.py b/foundry_sdk/v2/aip_agents/agent.py similarity index 94% rename from foundry/v2/aip_agents/agent.py rename to foundry_sdk/v2/aip_agents/agent.py index 6c639af8e..6966bdc54 100644 --- a/foundry/v2/aip_agents/agent.py +++ b/foundry_sdk/v2/aip_agents/agent.py @@ -19,11 +19,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.aip_agents import errors as aip_agents_errors -from foundry.v2.aip_agents import models as aip_agents_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.aip_agents import errors as aip_agents_errors +from foundry_sdk.v2.aip_agents import models as aip_agents_models +from foundry_sdk.v2.core import models as core_models class AgentClient: @@ -51,7 +51,7 @@ def __init__( @cached_property def AgentVersion(self): - from foundry.v2.aip_agents.agent_version import AgentVersionClient + from foundry_sdk.v2.aip_agents.agent_version import AgentVersionClient return AgentVersionClient( auth=self._auth, @@ -61,7 +61,7 @@ def AgentVersion(self): @cached_property def Session(self): - from foundry.v2.aip_agents.session import SessionClient + from foundry_sdk.v2.aip_agents.session import SessionClient return SessionClient( auth=self._auth, diff --git a/foundry/v2/aip_agents/agent_version.py b/foundry_sdk/v2/aip_agents/agent_version.py similarity index 96% rename from foundry/v2/aip_agents/agent_version.py rename to foundry_sdk/v2/aip_agents/agent_version.py index 1f5f9c612..c9dae3a34 100644 --- a/foundry/v2/aip_agents/agent_version.py +++ b/foundry_sdk/v2/aip_agents/agent_version.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.aip_agents import errors as aip_agents_errors -from foundry.v2.aip_agents import models as aip_agents_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.aip_agents import errors as aip_agents_errors +from foundry_sdk.v2.aip_agents import models as aip_agents_models +from foundry_sdk.v2.core import models as core_models class AgentVersionClient: diff --git a/foundry/v2/aip_agents/content.py b/foundry_sdk/v2/aip_agents/content.py similarity index 93% rename from foundry/v2/aip_agents/content.py rename to foundry_sdk/v2/aip_agents/content.py index 59eea17b0..4c2c362e4 100644 --- a/foundry/v2/aip_agents/content.py +++ b/foundry_sdk/v2/aip_agents/content.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.aip_agents import errors as aip_agents_errors -from foundry.v2.aip_agents import models as aip_agents_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.aip_agents import errors as aip_agents_errors +from foundry_sdk.v2.aip_agents import models as aip_agents_models +from foundry_sdk.v2.core import models as core_models class ContentClient: diff --git a/foundry/v2/aip_agents/errors.py b/foundry_sdk/v2/aip_agents/errors.py similarity index 98% rename from foundry/v2/aip_agents/errors.py rename to foundry_sdk/v2/aip_agents/errors.py index 21be7eb3f..4bc5da9f7 100644 --- a/foundry/v2/aip_agents/errors.py +++ b/foundry_sdk/v2/aip_agents/errors.py @@ -18,10 +18,10 @@ import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.aip_agents import models as aip_agents_models -from foundry.v2.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.aip_agents import models as aip_agents_models +from foundry_sdk.v2.ontologies import models as ontologies_models class AgentIterationsExceededLimitParameters(typing_extensions.TypedDict): diff --git a/foundry/v2/aip_agents/models.py b/foundry_sdk/v2/aip_agents/models.py similarity index 99% rename from foundry/v2/aip_agents/models.py rename to foundry_sdk/v2/aip_agents/models.py index 8658e20c9..96e4514ea 100644 --- a/foundry/v2/aip_agents/models.py +++ b/foundry_sdk/v2/aip_agents/models.py @@ -21,10 +21,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry.v2.core import models as core_models -from foundry.v2.functions import models as functions_models -from foundry.v2.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk.v2.core import models as core_models +from foundry_sdk.v2.functions import models as functions_models +from foundry_sdk.v2.ontologies import models as ontologies_models class Agent(pydantic.BaseModel): diff --git a/foundry/v2/aip_agents/session.py b/foundry_sdk/v2/aip_agents/session.py similarity index 99% rename from foundry/v2/aip_agents/session.py rename to foundry_sdk/v2/aip_agents/session.py index 29b0bacc6..ba9ce69ad 100644 --- a/foundry/v2/aip_agents/session.py +++ b/foundry_sdk/v2/aip_agents/session.py @@ -19,11 +19,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.aip_agents import errors as aip_agents_errors -from foundry.v2.aip_agents import models as aip_agents_models -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.aip_agents import errors as aip_agents_errors +from foundry_sdk.v2.aip_agents import models as aip_agents_models +from foundry_sdk.v2.core import models as core_models class SessionClient: @@ -51,7 +51,7 @@ def __init__( @cached_property def Content(self): - from foundry.v2.aip_agents.content import ContentClient + from foundry_sdk.v2.aip_agents.content import ContentClient return ContentClient( auth=self._auth, diff --git a/foundry/v2/cli.py b/foundry_sdk/v2/cli.py similarity index 96% rename from foundry/v2/cli.py rename to foundry_sdk/v2/cli.py index 1ec9b6998..f1bc256c6 100644 --- a/foundry/v2/cli.py +++ b/foundry_sdk/v2/cli.py @@ -24,18 +24,18 @@ import click -import foundry.v2 +import foundry_sdk.v2 @dataclasses.dataclass class _Context: - obj: foundry.v2.FoundryClient + obj: foundry_sdk.v2.FoundryClient def get_from_environ(key: str) -> str: value = os.environ.get(key) if value is None: - raise foundry.EnvironmentNotConfigured(f"Please set {key} using `export {key}=<{key}>`") + raise foundry_sdk.EnvironmentNotConfigured(f"Please set {key} using `export {key}=<{key}>`") return value @@ -44,8 +44,8 @@ def get_from_environ(key: str) -> str: @click.pass_context # type: ignore def cli(ctx: _Context): "An experimental CLI for the Foundry API" - ctx.obj = foundry.v2.FoundryClient( - auth=foundry.UserTokenAuth(token=get_from_environ("FOUNDRY_TOKEN")), + ctx.obj = foundry_sdk.v2.FoundryClient( + auth=foundry_sdk.UserTokenAuth(token=get_from_environ("FOUNDRY_TOKEN")), hostname=get_from_environ("FOUNDRY_HOSTNAME"), ) @@ -64,7 +64,7 @@ def admin_user(): @click.argument("user_id", type=str, required=True) @click.pass_obj def admin_user_delete( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, user_id: str, ): """ @@ -80,7 +80,7 @@ def admin_user_delete( @click.argument("user_id", type=str, required=True) @click.pass_obj def admin_user_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, user_id: str, ): """ @@ -96,7 +96,7 @@ def admin_user_get( @click.argument("body", type=str, required=True) @click.pass_obj def admin_user_get_batch( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, body: str, ): """ @@ -113,7 +113,7 @@ def admin_user_get_batch( @admin_user.command("get_current") @click.pass_obj def admin_user_get_current( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ): """ """ result = client.admin.User.get_current() @@ -127,7 +127,7 @@ def admin_user_get_current( ) @click.pass_obj def admin_user_get_markings( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, user_id: str, preview: typing.Optional[bool], ): @@ -155,7 +155,7 @@ def admin_user_get_markings( ) @click.pass_obj def admin_user_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, page_size: typing.Optional[int], page_token: typing.Optional[str], ): @@ -175,7 +175,7 @@ def admin_user_list( @click.argument("user_id", type=str, required=True) @click.pass_obj def admin_user_profile_picture( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, user_id: str, ): """ """ @@ -191,7 +191,7 @@ def admin_user_profile_picture( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def admin_user_search( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, where: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -240,7 +240,7 @@ def admin_user_group_membership(): ) @click.pass_obj def admin_user_group_membership_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, user_id: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -277,7 +277,7 @@ def admin_user_user_provider_info(): ) @click.pass_obj def admin_user_user_provider_info_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, user_id: str, preview: typing.Optional[bool], ): @@ -306,7 +306,7 @@ def admin_user_user_provider_info_get( ) @click.pass_obj def admin_user_user_provider_info_replace( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, user_id: str, provider_id: str, preview: typing.Optional[bool], @@ -334,7 +334,7 @@ def admin_organization(): ) @click.pass_obj def admin_organization_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, organization_rid: str, preview: typing.Optional[bool], ): @@ -365,7 +365,7 @@ def admin_organization_get( ) @click.pass_obj def admin_organization_replace( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, organization_rid: str, name: str, description: typing.Optional[str], @@ -397,7 +397,7 @@ def admin_marking_category(): ) @click.pass_obj def admin_marking_category_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, marking_category_id: str, preview: typing.Optional[bool], ): @@ -428,7 +428,7 @@ def admin_marking_category_get( ) @click.pass_obj def admin_marking_category_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, page_size: typing.Optional[int], page_token: typing.Optional[str], preview: typing.Optional[bool], @@ -476,7 +476,7 @@ def admin_marking(): ) @click.pass_obj def admin_marking_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, category_id: str, initial_members: str, initial_role_assignments: str, @@ -505,7 +505,7 @@ def admin_marking_create( ) @click.pass_obj def admin_marking_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, marking_id: str, preview: typing.Optional[bool], ): @@ -526,7 +526,7 @@ def admin_marking_get( ) @click.pass_obj def admin_marking_get_batch( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, body: str, preview: typing.Optional[bool], ): @@ -559,7 +559,7 @@ def admin_marking_get_batch( ) @click.pass_obj def admin_marking_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, page_size: typing.Optional[int], page_token: typing.Optional[str], preview: typing.Optional[bool], @@ -588,7 +588,7 @@ def admin_marking_marking_role_assignment(): ) @click.pass_obj def admin_marking_marking_role_assignment_add( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, marking_id: str, role_assignments: str, preview: typing.Optional[bool], @@ -620,7 +620,7 @@ def admin_marking_marking_role_assignment_add( ) @click.pass_obj def admin_marking_marking_role_assignment_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, marking_id: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -647,7 +647,7 @@ def admin_marking_marking_role_assignment_list( ) @click.pass_obj def admin_marking_marking_role_assignment_remove( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, marking_id: str, role_assignments: str, preview: typing.Optional[bool], @@ -674,7 +674,7 @@ def admin_marking_marking_member(): ) @click.pass_obj def admin_marking_marking_member_add( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, marking_id: str, principal_ids: str, preview: typing.Optional[bool], @@ -718,7 +718,7 @@ def admin_marking_marking_member_add( ) @click.pass_obj def admin_marking_marking_member_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, marking_id: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -748,7 +748,7 @@ def admin_marking_marking_member_list( ) @click.pass_obj def admin_marking_marking_member_remove( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, marking_id: str, principal_ids: str, preview: typing.Optional[bool], @@ -785,7 +785,7 @@ def admin_group(): @click.option("--description", type=str, required=False, help="""A description of the Group.""") @click.pass_obj def admin_group_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, attributes: str, name: str, organizations: str, @@ -807,7 +807,7 @@ def admin_group_create( @click.argument("group_id", type=str, required=True) @click.pass_obj def admin_group_delete( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, group_id: str, ): """ @@ -823,7 +823,7 @@ def admin_group_delete( @click.argument("group_id", type=str, required=True) @click.pass_obj def admin_group_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, group_id: str, ): """ @@ -839,7 +839,7 @@ def admin_group_get( @click.argument("body", type=str, required=True) @click.pass_obj def admin_group_get_batch( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, body: str, ): """ @@ -867,7 +867,7 @@ def admin_group_get_batch( ) @click.pass_obj def admin_group_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, page_size: typing.Optional[int], page_token: typing.Optional[str], ): @@ -889,7 +889,7 @@ def admin_group_list( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def admin_group_search( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, where: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -917,7 +917,7 @@ def admin_group_group_member(): @click.option("--expiration", type=click.DateTime(), required=False, help="""""") @click.pass_obj def admin_group_group_member_add( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, group_id: str, principal_ids: str, expiration: typing.Optional[datetime], @@ -958,7 +958,7 @@ def admin_group_group_member_add( ) @click.pass_obj def admin_group_group_member_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, group_id: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -988,7 +988,7 @@ def admin_group_group_member_list( @click.option("--principal_ids", type=str, required=True, help="""""") @click.pass_obj def admin_group_group_member_remove( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, group_id: str, principal_ids: str, ): @@ -1012,7 +1012,7 @@ def admin_group_group_provider_info(): ) @click.pass_obj def admin_group_group_provider_info_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, group_id: str, preview: typing.Optional[bool], ): @@ -1041,7 +1041,7 @@ def admin_group_group_provider_info_get( ) @click.pass_obj def admin_group_group_provider_info_replace( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, group_id: str, provider_id: str, preview: typing.Optional[bool], @@ -1069,7 +1069,7 @@ def admin_enrollment(): ) @click.pass_obj def admin_enrollment_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, enrollment_rid: str, preview: typing.Optional[bool], ): @@ -1089,7 +1089,7 @@ def admin_enrollment_get( ) @click.pass_obj def admin_enrollment_get_current( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, preview: typing.Optional[bool], ): """ @@ -1115,7 +1115,7 @@ def admin_enrollment_authentication_provider(): ) @click.pass_obj def admin_enrollment_authentication_provider_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, enrollment_rid: str, authentication_provider_rid: str, preview: typing.Optional[bool], @@ -1138,7 +1138,7 @@ def admin_enrollment_authentication_provider_get( ) @click.pass_obj def admin_enrollment_authentication_provider_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, enrollment_rid: str, preview: typing.Optional[bool], ): @@ -1170,7 +1170,7 @@ def admin_enrollment_authentication_provider_list( ) @click.pass_obj def admin_enrollment_authentication_provider_preregister_group( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, enrollment_rid: str, authentication_provider_rid: str, name: str, @@ -1218,7 +1218,7 @@ def admin_enrollment_authentication_provider_preregister_group( ) @click.pass_obj def admin_enrollment_authentication_provider_preregister_user( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, enrollment_rid: str, authentication_provider_rid: str, organization: str, @@ -1271,7 +1271,7 @@ def admin_enrollment_host(): ) @click.pass_obj def admin_enrollment_host_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, enrollment_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -1316,7 +1316,7 @@ def aip_agents_agent(): ) @click.pass_obj def aip_agents_agent_all_sessions( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, page_size: typing.Optional[int], page_token: typing.Optional[str], preview: typing.Optional[bool], @@ -1348,7 +1348,7 @@ def aip_agents_agent_all_sessions( ) @click.pass_obj def aip_agents_agent_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, agent_rid: str, preview: typing.Optional[bool], version: typing.Optional[str], @@ -1398,7 +1398,7 @@ def aip_agents_agent_session(): ) @click.pass_obj def aip_agents_agent_session_blocking_continue( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, agent_rid: str, session_rid: str, parameter_inputs: str, @@ -1450,7 +1450,7 @@ def aip_agents_agent_session_blocking_continue( ) @click.pass_obj def aip_agents_agent_session_cancel( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, agent_rid: str, session_rid: str, message_id: str, @@ -1489,7 +1489,7 @@ def aip_agents_agent_session_cancel( ) @click.pass_obj def aip_agents_agent_session_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, agent_rid: str, agent_version: typing.Optional[str], preview: typing.Optional[bool], @@ -1515,7 +1515,7 @@ def aip_agents_agent_session_create( ) @click.pass_obj def aip_agents_agent_session_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, agent_rid: str, session_rid: str, preview: typing.Optional[bool], @@ -1549,7 +1549,7 @@ def aip_agents_agent_session_get( ) @click.pass_obj def aip_agents_agent_session_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, agent_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -1592,7 +1592,7 @@ def aip_agents_agent_session_list( ) @click.pass_obj def aip_agents_agent_session_rag_context( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, agent_rid: str, session_rid: str, parameter_inputs: str, @@ -1650,7 +1650,7 @@ def aip_agents_agent_session_rag_context( ) @click.pass_obj def aip_agents_agent_session_streaming_continue( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, agent_rid: str, session_rid: str, parameter_inputs: str, @@ -1697,7 +1697,7 @@ def aip_agents_agent_session_streaming_continue( ) @click.pass_obj def aip_agents_agent_session_update_title( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, agent_rid: str, session_rid: str, title: str, @@ -1730,7 +1730,7 @@ def aip_agents_agent_session_content(): ) @click.pass_obj def aip_agents_agent_session_content_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, agent_rid: str, session_rid: str, preview: typing.Optional[bool], @@ -1759,7 +1759,7 @@ def aip_agents_agent_agent_version(): ) @click.pass_obj def aip_agents_agent_agent_version_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, agent_rid: str, agent_version_string: str, preview: typing.Optional[bool], @@ -1793,7 +1793,7 @@ def aip_agents_agent_agent_version_get( ) @click.pass_obj def aip_agents_agent_agent_version_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, agent_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -1837,7 +1837,7 @@ def connectivity_connection(): ) @click.pass_obj def connectivity_connection_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, configuration: str, display_name: str, parent_folder_rid: str, @@ -1871,7 +1871,7 @@ def connectivity_connection_create( ) @click.pass_obj def connectivity_connection_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, preview: typing.Optional[bool], ): @@ -1892,7 +1892,7 @@ def connectivity_connection_get( ) @click.pass_obj def connectivity_connection_get_configuration( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, preview: typing.Optional[bool], ): @@ -1922,7 +1922,7 @@ def connectivity_connection_get_configuration( ) @click.pass_obj def connectivity_connection_update_secrets( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, secrets: str, preview: typing.Optional[bool], @@ -1979,7 +1979,7 @@ def connectivity_connection_table_import(): ) @click.pass_obj def connectivity_connection_table_import_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, config: str, dataset_rid: str, @@ -2013,7 +2013,7 @@ def connectivity_connection_table_import_create( ) @click.pass_obj def connectivity_connection_table_import_delete( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, table_import_rid: str, preview: typing.Optional[bool], @@ -2040,7 +2040,7 @@ def connectivity_connection_table_import_delete( ) @click.pass_obj def connectivity_connection_table_import_execute( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, table_import_rid: str, preview: typing.Optional[bool], @@ -2066,7 +2066,7 @@ def connectivity_connection_table_import_execute( ) @click.pass_obj def connectivity_connection_table_import_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, table_import_rid: str, preview: typing.Optional[bool], @@ -2100,7 +2100,7 @@ def connectivity_connection_table_import_get( ) @click.pass_obj def connectivity_connection_table_import_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -2155,7 +2155,7 @@ def connectivity_connection_file_import(): ) @click.pass_obj def connectivity_connection_file_import_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, dataset_rid: str, display_name: str, @@ -2189,7 +2189,7 @@ def connectivity_connection_file_import_create( ) @click.pass_obj def connectivity_connection_file_import_delete( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, file_import_rid: str, preview: typing.Optional[bool], @@ -2216,7 +2216,7 @@ def connectivity_connection_file_import_delete( ) @click.pass_obj def connectivity_connection_file_import_execute( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, file_import_rid: str, preview: typing.Optional[bool], @@ -2242,7 +2242,7 @@ def connectivity_connection_file_import_execute( ) @click.pass_obj def connectivity_connection_file_import_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, file_import_rid: str, preview: typing.Optional[bool], @@ -2276,7 +2276,7 @@ def connectivity_connection_file_import_get( ) @click.pass_obj def connectivity_connection_file_import_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -2327,7 +2327,7 @@ def connectivity_connection_file_import_list( ) @click.pass_obj def connectivity_connection_file_import_replace( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, connection_rid: str, file_import_rid: str, dataset_rid: str, @@ -2375,7 +2375,7 @@ def datasets_dataset(): @click.option("--parent_folder_rid", type=str, required=True, help="""""") @click.pass_obj def datasets_dataset_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, name: str, parent_folder_rid: str, ): @@ -2394,7 +2394,7 @@ def datasets_dataset_create( @click.argument("dataset_rid", type=str, required=True) @click.pass_obj def datasets_dataset_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, ): """ @@ -2452,7 +2452,7 @@ def datasets_dataset_get( ) @click.pass_obj def datasets_dataset_read_table( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, format: typing.Literal["ARROW", "CSV"], branch_name: typing.Optional[str], @@ -2510,7 +2510,7 @@ def datasets_dataset_file(): ) @click.pass_obj def datasets_dataset_file_content( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, file_path: str, branch_name: typing.Optional[str], @@ -2566,7 +2566,7 @@ def datasets_dataset_file_content( ) @click.pass_obj def datasets_dataset_file_delete( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, file_path: str, branch_name: typing.Optional[str], @@ -2620,7 +2620,7 @@ def datasets_dataset_file_delete( ) @click.pass_obj def datasets_dataset_file_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, file_path: str, branch_name: typing.Optional[str], @@ -2692,7 +2692,7 @@ def datasets_dataset_file_get( ) @click.pass_obj def datasets_dataset_file_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, branch_name: typing.Optional[str], end_transaction_rid: typing.Optional[str], @@ -2759,7 +2759,7 @@ def datasets_dataset_file_list( ) @click.pass_obj def datasets_dataset_file_upload( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, file_path: str, body: io.BufferedReader, @@ -2804,7 +2804,7 @@ def datasets_dataset_transaction(): @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_abort( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -2828,7 +2828,7 @@ def datasets_dataset_transaction_abort( ) @click.pass_obj def datasets_dataset_transaction_build( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, transaction_rid: str, preview: typing.Optional[bool], @@ -2852,7 +2852,7 @@ def datasets_dataset_transaction_build( @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_commit( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -2885,7 +2885,7 @@ def datasets_dataset_transaction_commit( ) @click.pass_obj def datasets_dataset_transaction_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, transaction_type: typing.Literal["APPEND", "UPDATE", "SNAPSHOT", "DELETE"], branch_name: typing.Optional[str], @@ -2907,7 +2907,7 @@ def datasets_dataset_transaction_create( @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -2930,7 +2930,7 @@ def datasets_dataset_transaction_get( ) @click.pass_obj def datasets_dataset_transaction_job( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, transaction_rid: str, preview: typing.Optional[bool], @@ -2965,7 +2965,7 @@ def datasets_dataset_branch(): ) @click.pass_obj def datasets_dataset_branch_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, name: str, transaction_rid: typing.Optional[str], @@ -2987,7 +2987,7 @@ def datasets_dataset_branch_create( @click.argument("branch_name", type=str, required=True) @click.pass_obj def datasets_dataset_branch_delete( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, branch_name: str, ): @@ -3007,7 +3007,7 @@ def datasets_dataset_branch_delete( @click.argument("branch_name", type=str, required=True) @click.pass_obj def datasets_dataset_branch_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, branch_name: str, ): @@ -3037,7 +3037,7 @@ def datasets_dataset_branch_get( ) @click.pass_obj def datasets_dataset_branch_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -3081,7 +3081,7 @@ def filesystem_space(): ) @click.pass_obj def filesystem_space_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, page_size: typing.Optional[int], page_token: typing.Optional[str], preview: typing.Optional[bool], @@ -3112,7 +3112,7 @@ def filesystem_resource(): ) @click.pass_obj def filesystem_resource_add_markings( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, resource_rid: str, marking_ids: str, preview: typing.Optional[bool], @@ -3135,7 +3135,7 @@ def filesystem_resource_add_markings( ) @click.pass_obj def filesystem_resource_delete( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, resource_rid: str, preview: typing.Optional[bool], ): @@ -3158,7 +3158,7 @@ def filesystem_resource_delete( ) @click.pass_obj def filesystem_resource_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, resource_rid: str, preview: typing.Optional[bool], ): @@ -3179,7 +3179,7 @@ def filesystem_resource_get( ) @click.pass_obj def filesystem_resource_get_access_requirements( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, resource_rid: str, preview: typing.Optional[bool], ): @@ -3207,7 +3207,7 @@ def filesystem_resource_get_access_requirements( ) @click.pass_obj def filesystem_resource_get_by_path( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, path: str, preview: typing.Optional[bool], ): @@ -3239,7 +3239,7 @@ def filesystem_resource_get_by_path( ) @click.pass_obj def filesystem_resource_markings( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, resource_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -3266,7 +3266,7 @@ def filesystem_resource_markings( ) @click.pass_obj def filesystem_resource_permanently_delete( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, resource_rid: str, preview: typing.Optional[bool], ): @@ -3290,7 +3290,7 @@ def filesystem_resource_permanently_delete( ) @click.pass_obj def filesystem_resource_remove_markings( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, resource_rid: str, marking_ids: str, preview: typing.Optional[bool], @@ -3313,7 +3313,7 @@ def filesystem_resource_remove_markings( ) @click.pass_obj def filesystem_resource_restore( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, resource_rid: str, preview: typing.Optional[bool], ): @@ -3342,7 +3342,7 @@ def filesystem_resource_resource_role(): ) @click.pass_obj def filesystem_resource_resource_role_add( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, resource_rid: str, roles: str, preview: typing.Optional[bool], @@ -3380,7 +3380,7 @@ def filesystem_resource_resource_role_add( ) @click.pass_obj def filesystem_resource_resource_role_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, resource_rid: str, include_inherited: typing.Optional[bool], page_size: typing.Optional[int], @@ -3409,7 +3409,7 @@ def filesystem_resource_resource_role_list( ) @click.pass_obj def filesystem_resource_resource_role_remove( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, resource_rid: str, roles: str, preview: typing.Optional[bool], @@ -3436,7 +3436,7 @@ def filesystem_project(): ) @click.pass_obj def filesystem_project_add_organizations( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, project_rid: str, organization_rids: str, preview: typing.Optional[bool], @@ -3464,7 +3464,7 @@ def filesystem_project_add_organizations( ) @click.pass_obj def filesystem_project_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, default_roles: str, display_name: str, organization_rids: str, @@ -3504,7 +3504,7 @@ def filesystem_project_create( @click.option("--project_description", type=str, required=False, help="""""") @click.pass_obj def filesystem_project_create_from_template( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, template_rid: str, variable_values: str, default_roles: typing.Optional[str], @@ -3533,7 +3533,7 @@ def filesystem_project_create_from_template( ) @click.pass_obj def filesystem_project_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, project_rid: str, preview: typing.Optional[bool], ): @@ -3565,7 +3565,7 @@ def filesystem_project_get( ) @click.pass_obj def filesystem_project_organizations( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, project_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -3593,7 +3593,7 @@ def filesystem_project_organizations( ) @click.pass_obj def filesystem_project_remove_organizations( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, project_rid: str, organization_rids: str, preview: typing.Optional[bool], @@ -3632,7 +3632,7 @@ def filesystem_folder(): ) @click.pass_obj def filesystem_folder_children( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, folder_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -3669,7 +3669,7 @@ def filesystem_folder_children( ) @click.pass_obj def filesystem_folder_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, display_name: str, parent_folder_rid: str, preview: typing.Optional[bool], @@ -3692,7 +3692,7 @@ def filesystem_folder_create( ) @click.pass_obj def filesystem_folder_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, folder_rid: str, preview: typing.Optional[bool], ): @@ -3723,7 +3723,7 @@ def functions_value_type(): ) @click.pass_obj def functions_value_type_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, value_type_rid: str, preview: typing.Optional[bool], ): @@ -3751,7 +3751,7 @@ def functions_value_type_version_id(): ) @click.pass_obj def functions_value_type_version_id_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, value_type_rid: str, version_id_version_id: str, preview: typing.Optional[bool], @@ -3781,7 +3781,7 @@ def functions_query(): ) @click.pass_obj def functions_query_execute( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, query_api_name: str, parameters: str, preview: typing.Optional[bool], @@ -3807,7 +3807,7 @@ def functions_query_execute( ) @click.pass_obj def functions_query_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, query_api_name: str, preview: typing.Optional[bool], ): @@ -3829,7 +3829,7 @@ def functions_query_get( ) @click.pass_obj def functions_query_get_by_rid( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, rid: str, preview: typing.Optional[bool], ): @@ -3871,7 +3871,7 @@ def media_sets_media_set(): ) @click.pass_obj def media_sets_media_set_abort( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, media_set_rid: str, transaction_id: str, preview: typing.Optional[bool], @@ -3902,7 +3902,7 @@ def media_sets_media_set_abort( ) @click.pass_obj def media_sets_media_set_commit( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, media_set_rid: str, transaction_id: str, preview: typing.Optional[bool], @@ -3939,7 +3939,7 @@ def media_sets_media_set_commit( ) @click.pass_obj def media_sets_media_set_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, media_set_rid: str, branch_name: typing.Optional[str], preview: typing.Optional[bool], @@ -3971,7 +3971,7 @@ def media_sets_media_set_create( @click.option("--read_token", type=str, required=False, help="""""") @click.pass_obj def media_sets_media_set_info( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, media_set_rid: str, media_item_rid: str, preview: typing.Optional[bool], @@ -4005,7 +4005,7 @@ def media_sets_media_set_info( @click.option("--read_token", type=str, required=False, help="""""") @click.pass_obj def media_sets_media_set_read( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, media_set_rid: str, media_item_rid: str, preview: typing.Optional[bool], @@ -4039,7 +4039,7 @@ def media_sets_media_set_read( @click.option("--read_token", type=str, required=False, help="""""") @click.pass_obj def media_sets_media_set_read_original( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, media_set_rid: str, media_item_rid: str, preview: typing.Optional[bool], @@ -4073,7 +4073,7 @@ def media_sets_media_set_read_original( @click.option("--read_token", type=str, required=False, help="""""") @click.pass_obj def media_sets_media_set_reference( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, media_set_rid: str, media_item_rid: str, preview: typing.Optional[bool], @@ -4137,7 +4137,7 @@ def media_sets_media_set_reference( ) @click.pass_obj def media_sets_media_set_upload( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, media_set_rid: str, body: io.BufferedReader, branch_name: typing.Optional[str], @@ -4199,7 +4199,7 @@ def ontologies_time_series_value_bank_property(): ) @click.pass_obj def ontologies_time_series_value_bank_property_get_latest_value( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -4247,7 +4247,7 @@ def ontologies_time_series_value_bank_property_get_latest_value( @click.option("--range", type=str, required=False, help="""""") @click.pass_obj def ontologies_time_series_value_bank_property_stream_values( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -4301,7 +4301,7 @@ def ontologies_time_series_property_v2(): ) @click.pass_obj def ontologies_time_series_property_v2_get_first_point( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -4348,7 +4348,7 @@ def ontologies_time_series_property_v2_get_first_point( ) @click.pass_obj def ontologies_time_series_property_v2_get_last_point( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -4405,7 +4405,7 @@ def ontologies_time_series_property_v2_get_last_point( @click.option("--range", type=str, required=False, help="""""") @click.pass_obj def ontologies_time_series_property_v2_stream_points( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -4462,7 +4462,7 @@ def ontologies_query(): ) @click.pass_obj def ontologies_query_execute( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, query_api_name: str, parameters: str, @@ -4520,7 +4520,7 @@ def ontologies_ontology_object_set(): ) @click.pass_obj def ontologies_ontology_object_set_aggregate( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, aggregation: str, group_by: str, @@ -4552,7 +4552,7 @@ def ontologies_ontology_object_set_aggregate( @click.option("--object_set", type=str, required=True, help="""""") @click.pass_obj def ontologies_ontology_object_set_create_temporary( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_set: str, ): @@ -4575,7 +4575,7 @@ def ontologies_ontology_object_set_create_temporary( @click.argument("object_set_rid", type=str, required=True) @click.pass_obj def ontologies_ontology_object_set_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_set_rid: str, ): @@ -4623,7 +4623,7 @@ def ontologies_ontology_object_set_get( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_set_load( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_set: str, select: str, @@ -4697,7 +4697,7 @@ def ontologies_ontology_object_set_load( ) @click.pass_obj def ontologies_ontology_object_set_load_multiple_object_types( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_set: str, select: str, @@ -4778,7 +4778,7 @@ def ontologies_ontology_object_set_load_multiple_object_types( ) @click.pass_obj def ontologies_ontology_object_set_load_objects_or_interfaces( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_set: str, select: str, @@ -4856,7 +4856,7 @@ def ontologies_ontology_object(): @click.option("--where", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_aggregate( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, aggregation: str, @@ -4904,7 +4904,7 @@ def ontologies_ontology_object_aggregate( ) @click.pass_obj def ontologies_ontology_object_count( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, artifact_repository: typing.Optional[str], @@ -4961,7 +4961,7 @@ def ontologies_ontology_object_count( ) @click.pass_obj def ontologies_ontology_object_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -5033,7 +5033,7 @@ def ontologies_ontology_object_get( ) @click.pass_obj def ontologies_ontology_object_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, artifact_repository: typing.Optional[str], @@ -5114,7 +5114,7 @@ def ontologies_ontology_object_list( @click.option("--where", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_search( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, select: str, @@ -5195,7 +5195,7 @@ def ontologies_ontology_interface(): @click.option("--where", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_interface_aggregate( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, interface_type: str, aggregation: str, @@ -5244,7 +5244,7 @@ def ontologies_ontology_interface_aggregate( ) @click.pass_obj def ontologies_ontology_interface_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, interface_type: str, preview: typing.Optional[bool], @@ -5288,7 +5288,7 @@ def ontologies_ontology_interface_get( ) @click.pass_obj def ontologies_ontology_interface_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -5376,7 +5376,7 @@ def ontologies_ontology_interface_list( @click.option("--where", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_interface_search( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, interface_type: str, augmented_properties: str, @@ -5455,7 +5455,7 @@ def ontologies_ontology(): @click.argument("ontology", type=str, required=True) @click.pass_obj def ontologies_ontology_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, ): """ @@ -5474,7 +5474,7 @@ def ontologies_ontology_get( @click.argument("ontology", type=str, required=True) @click.pass_obj def ontologies_ontology_get_full_metadata( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, ): """ @@ -5490,7 +5490,7 @@ def ontologies_ontology_get_full_metadata( @ontologies_ontology.command("list") @click.pass_obj def ontologies_ontology_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ): """ Lists the Ontologies visible to the current user. @@ -5512,7 +5512,7 @@ def ontologies_ontology_query_type(): @click.argument("query_api_name", type=str, required=True) @click.pass_obj def ontologies_ontology_query_type_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, query_api_name: str, ): @@ -5542,7 +5542,7 @@ def ontologies_ontology_query_type_get( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_query_type_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -5574,7 +5574,7 @@ def ontologies_ontology_object_type(): @click.argument("object_type", type=str, required=True) @click.pass_obj def ontologies_ontology_object_type_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, ): @@ -5603,7 +5603,7 @@ def ontologies_ontology_object_type_get( ) @click.pass_obj def ontologies_ontology_object_type_get_full_metadata( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, preview: typing.Optional[bool], @@ -5628,7 +5628,7 @@ def ontologies_ontology_object_type_get_full_metadata( @click.argument("link_type", type=str, required=True) @click.pass_obj def ontologies_ontology_object_type_get_outgoing_link_type( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, link_type: str, @@ -5661,7 +5661,7 @@ def ontologies_ontology_object_type_get_outgoing_link_type( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_type_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -5693,7 +5693,7 @@ def ontologies_ontology_object_type_list( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_type_list_outgoing_link_types( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, page_size: typing.Optional[int], @@ -5725,7 +5725,7 @@ def ontologies_ontology_action_type(): @click.argument("action_type", type=str, required=True) @click.pass_obj def ontologies_ontology_action_type_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, action_type: str, ): @@ -5747,7 +5747,7 @@ def ontologies_ontology_action_type_get( @click.argument("action_type_rid", type=str, required=True) @click.pass_obj def ontologies_ontology_action_type_get_by_rid( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, action_type_rid: str, ): @@ -5777,7 +5777,7 @@ def ontologies_ontology_action_type_get_by_rid( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_action_type_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -5832,7 +5832,7 @@ def ontologies_media_reference_property(): ) @click.pass_obj def ontologies_media_reference_property_get_media_content( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -5887,7 +5887,7 @@ def ontologies_media_reference_property_get_media_content( ) @click.pass_obj def ontologies_media_reference_property_get_media_metadata( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -5935,7 +5935,7 @@ def ontologies_media_reference_property_get_media_metadata( ) @click.pass_obj def ontologies_media_reference_property_upload( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, property: str, @@ -6004,7 +6004,7 @@ def ontologies_linked_object(): ) @click.pass_obj def ontologies_linked_object_get_linked_object( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6084,7 +6084,7 @@ def ontologies_linked_object_get_linked_object( ) @click.pass_obj def ontologies_linked_object_list_linked_objects( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6157,7 +6157,7 @@ def ontologies_attachment_property(): ) @click.pass_obj def ontologies_attachment_property_get_attachment( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6205,7 +6205,7 @@ def ontologies_attachment_property_get_attachment( ) @click.pass_obj def ontologies_attachment_property_get_attachment_by_rid( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6254,7 +6254,7 @@ def ontologies_attachment_property_get_attachment_by_rid( ) @click.pass_obj def ontologies_attachment_property_read_attachment( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6302,7 +6302,7 @@ def ontologies_attachment_property_read_attachment( ) @click.pass_obj def ontologies_attachment_property_read_attachment_by_rid( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6341,7 +6341,7 @@ def ontologies_attachment(): @click.argument("attachment_rid", type=str, required=True) @click.pass_obj def ontologies_attachment_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, attachment_rid: str, ): """ @@ -6361,7 +6361,7 @@ def ontologies_attachment_get( @click.argument("attachment_rid", type=str, required=True) @click.pass_obj def ontologies_attachment_read( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, attachment_rid: str, ): """ @@ -6393,7 +6393,7 @@ def ontologies_attachment_read( ) @click.pass_obj def ontologies_attachment_upload( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, body: io.BufferedReader, content_length: int, content_type: str, @@ -6445,7 +6445,7 @@ def ontologies_action(): ) @click.pass_obj def ontologies_action_apply( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, action: str, parameters: str, @@ -6497,7 +6497,7 @@ def ontologies_action_apply( ) @click.pass_obj def ontologies_action_apply_batch( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, ontology: str, action: str, requests: str, @@ -6546,7 +6546,7 @@ def orchestration_schedule_version(): ) @click.pass_obj def orchestration_schedule_version_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, schedule_version_rid: str, preview: typing.Optional[bool], ): @@ -6567,7 +6567,7 @@ def orchestration_schedule_version_get( ) @click.pass_obj def orchestration_schedule_version_schedule( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, schedule_version_rid: str, preview: typing.Optional[bool], ): @@ -6602,7 +6602,7 @@ def orchestration_schedule(): ) @click.pass_obj def orchestration_schedule_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, action: str, description: typing.Optional[str], display_name: typing.Optional[str], @@ -6631,7 +6631,7 @@ def orchestration_schedule_create( ) @click.pass_obj def orchestration_schedule_delete( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, schedule_rid: str, preview: typing.Optional[bool], ): @@ -6652,7 +6652,7 @@ def orchestration_schedule_delete( ) @click.pass_obj def orchestration_schedule_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, schedule_rid: str, preview: typing.Optional[bool], ): @@ -6673,7 +6673,7 @@ def orchestration_schedule_get( ) @click.pass_obj def orchestration_schedule_pause( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, schedule_rid: str, preview: typing.Optional[bool], ): @@ -6704,7 +6704,7 @@ def orchestration_schedule_pause( ) @click.pass_obj def orchestration_schedule_replace( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, schedule_rid: str, action: str, description: typing.Optional[str], @@ -6735,7 +6735,7 @@ def orchestration_schedule_replace( ) @click.pass_obj def orchestration_schedule_run( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, schedule_rid: str, preview: typing.Optional[bool], ): @@ -6765,7 +6765,7 @@ def orchestration_schedule_run( ) @click.pass_obj def orchestration_schedule_runs( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, schedule_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -6791,7 +6791,7 @@ def orchestration_schedule_runs( ) @click.pass_obj def orchestration_schedule_unpause( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, schedule_rid: str, preview: typing.Optional[bool], ): @@ -6815,7 +6815,7 @@ def orchestration_job(): ) @click.pass_obj def orchestration_job_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, job_rid: str, preview: typing.Optional[bool], ): @@ -6836,7 +6836,7 @@ def orchestration_job_get( ) @click.pass_obj def orchestration_job_get_batch( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, body: str, preview: typing.Optional[bool], ): @@ -6864,7 +6864,7 @@ def orchestration_build(): ) @click.pass_obj def orchestration_build_cancel( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, build_rid: str, preview: typing.Optional[bool], ): @@ -6906,7 +6906,7 @@ def orchestration_build_cancel( ) @click.pass_obj def orchestration_build_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, fallback_branches: str, target: str, abort_on_failure: typing.Optional[bool], @@ -6941,7 +6941,7 @@ def orchestration_build_create( ) @click.pass_obj def orchestration_build_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, build_rid: str, preview: typing.Optional[bool], ): @@ -6962,7 +6962,7 @@ def orchestration_build_get( ) @click.pass_obj def orchestration_build_get_batch( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, body: str, preview: typing.Optional[bool], ): @@ -6996,7 +6996,7 @@ def orchestration_build_get_batch( ) @click.pass_obj def orchestration_build_jobs( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, build_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -7030,7 +7030,7 @@ def orchestration_build_jobs( ) @click.pass_obj def orchestration_build_search( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, where: str, order_by: typing.Optional[str], page_size: typing.Optional[int], @@ -7067,7 +7067,7 @@ def sql_queries_query(): ) @click.pass_obj def sql_queries_query_cancel( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, query_id: str, preview: typing.Optional[bool], ): @@ -7107,7 +7107,7 @@ def sql_queries_query_cancel( ) @click.pass_obj def sql_queries_query_execute( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, query: str, fallback_branch_ids: typing.Optional[str], preview: typing.Optional[bool], @@ -7133,7 +7133,7 @@ def sql_queries_query_execute( ) @click.pass_obj def sql_queries_query_get_results( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, query_id: str, preview: typing.Optional[bool], ): @@ -7156,7 +7156,7 @@ def sql_queries_query_get_results( ) @click.pass_obj def sql_queries_query_get_status( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, query_id: str, preview: typing.Optional[bool], ): @@ -7233,7 +7233,7 @@ def streams_dataset(): ) @click.pass_obj def streams_dataset_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, name: str, parent_folder_rid: str, schema: str, @@ -7301,7 +7301,7 @@ def streams_dataset_stream(): ) @click.pass_obj def streams_dataset_stream_create( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, branch_name: str, schema: str, @@ -7334,7 +7334,7 @@ def streams_dataset_stream_create( ) @click.pass_obj def streams_dataset_stream_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, stream_branch_name: str, preview: typing.Optional[bool], @@ -7372,7 +7372,7 @@ def streams_dataset_stream_get( ) @click.pass_obj def streams_dataset_stream_publish_binary_record( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, stream_branch_name: str, body: io.BufferedReader, @@ -7419,7 +7419,7 @@ def streams_dataset_stream_publish_binary_record( ) @click.pass_obj def streams_dataset_stream_publish_record( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, stream_branch_name: str, record: str, @@ -7467,7 +7467,7 @@ def streams_dataset_stream_publish_record( ) @click.pass_obj def streams_dataset_stream_publish_records( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, stream_branch_name: str, records: str, @@ -7536,7 +7536,7 @@ def streams_dataset_stream_publish_records( ) @click.pass_obj def streams_dataset_stream_reset( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, dataset_rid: str, stream_branch_name: str, compressed: typing.Optional[bool], @@ -7584,7 +7584,7 @@ def third_party_applications_third_party_application(): ) @click.pass_obj def third_party_applications_third_party_application_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, third_party_application_rid: str, preview: typing.Optional[bool], ): @@ -7608,7 +7608,7 @@ def third_party_applications_third_party_application_website(): @click.option("--version", type=str, required=True, help="""""") @click.pass_obj def third_party_applications_third_party_application_website_deploy( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, third_party_application_rid: str, version: str, ): @@ -7626,7 +7626,7 @@ def third_party_applications_third_party_application_website_deploy( @click.argument("third_party_application_rid", type=str, required=True) @click.pass_obj def third_party_applications_third_party_application_website_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, third_party_application_rid: str, ): """ @@ -7642,7 +7642,7 @@ def third_party_applications_third_party_application_website_get( @click.argument("third_party_application_rid", type=str, required=True) @click.pass_obj def third_party_applications_third_party_application_website_undeploy( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, third_party_application_rid: str, ): """ @@ -7664,7 +7664,7 @@ def third_party_applications_third_party_application_website_version(): @click.argument("version_version", type=str, required=True) @click.pass_obj def third_party_applications_third_party_application_website_version_delete( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, third_party_application_rid: str, version_version: str, ): @@ -7683,7 +7683,7 @@ def third_party_applications_third_party_application_website_version_delete( @click.argument("version_version", type=str, required=True) @click.pass_obj def third_party_applications_third_party_application_website_version_get( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, third_party_application_rid: str, version_version: str, ): @@ -7712,7 +7712,7 @@ def third_party_applications_third_party_application_website_version_get( ) @click.pass_obj def third_party_applications_third_party_application_website_version_list( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, third_party_application_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -7736,7 +7736,7 @@ def third_party_applications_third_party_application_website_version_list( @click.option("--version", type=str, required=True, help="""""") @click.pass_obj def third_party_applications_third_party_application_website_version_upload( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, third_party_application_rid: str, body: io.BufferedReader, version: str, @@ -7770,7 +7770,7 @@ def third_party_applications_third_party_application_website_version_upload( ) @click.pass_obj def third_party_applications_third_party_application_website_version_upload_snapshot( - client: foundry.v2.FoundryClient, + client: foundry_sdk.v2.FoundryClient, third_party_application_rid: str, body: io.BufferedReader, version: str, diff --git a/foundry/v2/client.py b/foundry_sdk/v2/client.py similarity index 70% rename from foundry/v2/client.py rename to foundry_sdk/v2/client.py index cd9ba16b0..bf03bbf8c 100644 --- a/foundry/v2/client.py +++ b/foundry_sdk/v2/client.py @@ -15,7 +15,7 @@ import typing -from foundry import _core as core +from foundry_sdk import _core as core class FoundryClient: @@ -33,18 +33,20 @@ def __init__( hostname: str, config: typing.Optional[core.Config] = None, ): - from foundry.v2.admin._client import AdminClient - from foundry.v2.aip_agents._client import AipAgentsClient - from foundry.v2.connectivity._client import ConnectivityClient - from foundry.v2.datasets._client import DatasetsClient - from foundry.v2.filesystem._client import FilesystemClient - from foundry.v2.functions._client import FunctionsClient - from foundry.v2.media_sets._client import MediaSetsClient - from foundry.v2.ontologies._client import OntologiesClient - from foundry.v2.orchestration._client import OrchestrationClient - from foundry.v2.sql_queries._client import SqlQueriesClient - from foundry.v2.streams._client import StreamsClient - from foundry.v2.third_party_applications._client import ThirdPartyApplicationsClient # NOQA + from foundry_sdk.v2.admin._client import AdminClient + from foundry_sdk.v2.aip_agents._client import AipAgentsClient + from foundry_sdk.v2.connectivity._client import ConnectivityClient + from foundry_sdk.v2.datasets._client import DatasetsClient + from foundry_sdk.v2.filesystem._client import FilesystemClient + from foundry_sdk.v2.functions._client import FunctionsClient + from foundry_sdk.v2.media_sets._client import MediaSetsClient + from foundry_sdk.v2.ontologies._client import OntologiesClient + from foundry_sdk.v2.orchestration._client import OrchestrationClient + from foundry_sdk.v2.sql_queries._client import SqlQueriesClient + from foundry_sdk.v2.streams._client import StreamsClient + from foundry_sdk.v2.third_party_applications._client import ( + ThirdPartyApplicationsClient, + ) # NOQA self.admin = AdminClient(auth=auth, hostname=hostname, config=config) self.aip_agents = AipAgentsClient(auth=auth, hostname=hostname, config=config) diff --git a/foundry/v2/connectivity/__init__.py b/foundry_sdk/v2/connectivity/__init__.py similarity index 90% rename from foundry/v2/connectivity/__init__.py rename to foundry_sdk/v2/connectivity/__init__.py index bd777168b..aeb6f0273 100644 --- a/foundry/v2/connectivity/__init__.py +++ b/foundry_sdk/v2/connectivity/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v2.connectivity._client import ConnectivityClient +from foundry_sdk.v2.connectivity._client import ConnectivityClient __all__ = [ "ConnectivityClient", diff --git a/foundry/v2/connectivity/_client.py b/foundry_sdk/v2/connectivity/_client.py similarity index 92% rename from foundry/v2/connectivity/_client.py rename to foundry_sdk/v2/connectivity/_client.py index 7a5058695..b99d67e85 100644 --- a/foundry/v2/connectivity/_client.py +++ b/foundry_sdk/v2/connectivity/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class ConnectivityClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def Connection(self): - from foundry.v2.connectivity.connection import ConnectionClient + from foundry_sdk.v2.connectivity.connection import ConnectionClient return ConnectionClient( auth=self._auth, diff --git a/foundry/v2/connectivity/connection.py b/foundry_sdk/v2/connectivity/connection.py similarity index 96% rename from foundry/v2/connectivity/connection.py rename to foundry_sdk/v2/connectivity/connection.py index 35ff5299e..8f8a88c0d 100644 --- a/foundry/v2/connectivity/connection.py +++ b/foundry_sdk/v2/connectivity/connection.py @@ -19,12 +19,12 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.connectivity import errors as connectivity_errors -from foundry.v2.connectivity import models as connectivity_models -from foundry.v2.core import models as core_models -from foundry.v2.filesystem import models as filesystem_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.connectivity import errors as connectivity_errors +from foundry_sdk.v2.connectivity import models as connectivity_models +from foundry_sdk.v2.core import models as core_models +from foundry_sdk.v2.filesystem import models as filesystem_models class ConnectionClient: @@ -52,7 +52,7 @@ def __init__( @cached_property def FileImport(self): - from foundry.v2.connectivity.file_import import FileImportClient + from foundry_sdk.v2.connectivity.file_import import FileImportClient return FileImportClient( auth=self._auth, @@ -62,7 +62,7 @@ def FileImport(self): @cached_property def TableImport(self): - from foundry.v2.connectivity.table_import import TableImportClient + from foundry_sdk.v2.connectivity.table_import import TableImportClient return TableImportClient( auth=self._auth, diff --git a/foundry/v2/connectivity/errors.py b/foundry_sdk/v2/connectivity/errors.py similarity index 98% rename from foundry/v2/connectivity/errors.py rename to foundry_sdk/v2/connectivity/errors.py index acedfcd84..32febae35 100644 --- a/foundry/v2/connectivity/errors.py +++ b/foundry_sdk/v2/connectivity/errors.py @@ -18,10 +18,10 @@ import typing_extensions -from foundry import _errors as errors -from foundry.v2.connectivity import models as connectivity_models -from foundry.v2.core import models as core_models -from foundry.v2.datasets import models as datasets_models +from foundry_sdk import _errors as errors +from foundry_sdk.v2.connectivity import models as connectivity_models +from foundry_sdk.v2.core import models as core_models +from foundry_sdk.v2.datasets import models as datasets_models class AdditionalSecretsMustBeSpecifiedAsPlaintextValueMapParameters(typing_extensions.TypedDict): diff --git a/foundry/v2/connectivity/file_import.py b/foundry_sdk/v2/connectivity/file_import.py similarity index 98% rename from foundry/v2/connectivity/file_import.py rename to foundry_sdk/v2/connectivity/file_import.py index 16ee6011d..3c127aa54 100644 --- a/foundry/v2/connectivity/file_import.py +++ b/foundry_sdk/v2/connectivity/file_import.py @@ -18,13 +18,13 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.connectivity import errors as connectivity_errors -from foundry.v2.connectivity import models as connectivity_models -from foundry.v2.core import models as core_models -from foundry.v2.datasets import errors as datasets_errors -from foundry.v2.datasets import models as datasets_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.connectivity import errors as connectivity_errors +from foundry_sdk.v2.connectivity import models as connectivity_models +from foundry_sdk.v2.core import models as core_models +from foundry_sdk.v2.datasets import errors as datasets_errors +from foundry_sdk.v2.datasets import models as datasets_models class FileImportClient: diff --git a/foundry/v2/connectivity/models.py b/foundry_sdk/v2/connectivity/models.py similarity index 99% rename from foundry/v2/connectivity/models.py rename to foundry_sdk/v2/connectivity/models.py index 2fbe34443..ff984b2dd 100644 --- a/foundry/v2/connectivity/models.py +++ b/foundry_sdk/v2/connectivity/models.py @@ -21,10 +21,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry.v2.core import models as core_models -from foundry.v2.datasets import models as datasets_models -from foundry.v2.filesystem import models as filesystem_models +from foundry_sdk import _core as core +from foundry_sdk.v2.core import models as core_models +from foundry_sdk.v2.datasets import models as datasets_models +from foundry_sdk.v2.filesystem import models as filesystem_models class ApiKeyAuthentication(pydantic.BaseModel): diff --git a/foundry/v2/connectivity/table_import.py b/foundry_sdk/v2/connectivity/table_import.py similarity index 97% rename from foundry/v2/connectivity/table_import.py rename to foundry_sdk/v2/connectivity/table_import.py index a176813d0..76582fae8 100644 --- a/foundry/v2/connectivity/table_import.py +++ b/foundry_sdk/v2/connectivity/table_import.py @@ -18,13 +18,13 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.connectivity import errors as connectivity_errors -from foundry.v2.connectivity import models as connectivity_models -from foundry.v2.core import models as core_models -from foundry.v2.datasets import errors as datasets_errors -from foundry.v2.datasets import models as datasets_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.connectivity import errors as connectivity_errors +from foundry_sdk.v2.connectivity import models as connectivity_models +from foundry_sdk.v2.core import models as core_models +from foundry_sdk.v2.datasets import errors as datasets_errors +from foundry_sdk.v2.datasets import models as datasets_models class TableImportClient: diff --git a/foundry/v2/core/errors.py b/foundry_sdk/v2/core/errors.py similarity index 99% rename from foundry/v2/core/errors.py rename to foundry_sdk/v2/core/errors.py index 1c4f596d1..8a3fe8f2f 100644 --- a/foundry/v2/core/errors.py +++ b/foundry_sdk/v2/core/errors.py @@ -18,8 +18,8 @@ import typing_extensions -from foundry import _errors as errors -from foundry.v2.core import models as core_models +from foundry_sdk import _errors as errors +from foundry_sdk.v2.core import models as core_models class ApiFeaturePreviewUsageOnlyParameters(typing_extensions.TypedDict): diff --git a/foundry/v2/core/models.py b/foundry_sdk/v2/core/models.py similarity index 99% rename from foundry/v2/core/models.py rename to foundry_sdk/v2/core/models.py index f0c79a80a..bb9c4ac00 100644 --- a/foundry/v2/core/models.py +++ b/foundry_sdk/v2/core/models.py @@ -21,7 +21,7 @@ import pydantic import typing_extensions -from foundry import _core as core +from foundry_sdk import _core as core class AnyType(pydantic.BaseModel): diff --git a/foundry/v2/datasets/__init__.py b/foundry_sdk/v2/datasets/__init__.py similarity index 91% rename from foundry/v2/datasets/__init__.py rename to foundry_sdk/v2/datasets/__init__.py index 3bef47542..d53d0e1f6 100644 --- a/foundry/v2/datasets/__init__.py +++ b/foundry_sdk/v2/datasets/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v2.datasets._client import DatasetsClient +from foundry_sdk.v2.datasets._client import DatasetsClient __all__ = [ "DatasetsClient", diff --git a/foundry/v2/datasets/_client.py b/foundry_sdk/v2/datasets/_client.py similarity index 93% rename from foundry/v2/datasets/_client.py rename to foundry_sdk/v2/datasets/_client.py index d98515907..b10f88ac8 100644 --- a/foundry/v2/datasets/_client.py +++ b/foundry_sdk/v2/datasets/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class DatasetsClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def Dataset(self): - from foundry.v2.datasets.dataset import DatasetClient + from foundry_sdk.v2.datasets.dataset import DatasetClient return DatasetClient( auth=self._auth, diff --git a/foundry/v2/datasets/branch.py b/foundry_sdk/v2/datasets/branch.py similarity index 97% rename from foundry/v2/datasets/branch.py rename to foundry_sdk/v2/datasets/branch.py index eb79b339d..d3d788a0d 100644 --- a/foundry/v2/datasets/branch.py +++ b/foundry_sdk/v2/datasets/branch.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.datasets import errors as datasets_errors -from foundry.v2.datasets import models as datasets_models +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.datasets import errors as datasets_errors +from foundry_sdk.v2.datasets import models as datasets_models class BranchClient: diff --git a/foundry/v2/datasets/dataset.py b/foundry_sdk/v2/datasets/dataset.py similarity index 95% rename from foundry/v2/datasets/dataset.py rename to foundry_sdk/v2/datasets/dataset.py index 6a70a41d9..e17b011c4 100644 --- a/foundry/v2/datasets/dataset.py +++ b/foundry_sdk/v2/datasets/dataset.py @@ -19,12 +19,12 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.datasets import errors as datasets_errors -from foundry.v2.datasets import models as datasets_models -from foundry.v2.filesystem import errors as filesystem_errors -from foundry.v2.filesystem import models as filesystem_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.datasets import errors as datasets_errors +from foundry_sdk.v2.datasets import models as datasets_models +from foundry_sdk.v2.filesystem import errors as filesystem_errors +from foundry_sdk.v2.filesystem import models as filesystem_models class DatasetClient: @@ -52,7 +52,7 @@ def __init__( @cached_property def Branch(self): - from foundry.v2.datasets.branch import BranchClient + from foundry_sdk.v2.datasets.branch import BranchClient return BranchClient( auth=self._auth, @@ -62,7 +62,7 @@ def Branch(self): @cached_property def Transaction(self): - from foundry.v2.datasets.transaction import TransactionClient + from foundry_sdk.v2.datasets.transaction import TransactionClient return TransactionClient( auth=self._auth, @@ -72,7 +72,7 @@ def Transaction(self): @cached_property def File(self): - from foundry.v2.datasets.file import FileClient + from foundry_sdk.v2.datasets.file import FileClient return FileClient( auth=self._auth, diff --git a/foundry/v2/datasets/errors.py b/foundry_sdk/v2/datasets/errors.py similarity index 98% rename from foundry/v2/datasets/errors.py rename to foundry_sdk/v2/datasets/errors.py index 045b485bc..b3cc184cb 100644 --- a/foundry/v2/datasets/errors.py +++ b/foundry_sdk/v2/datasets/errors.py @@ -18,10 +18,10 @@ import typing_extensions -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.datasets import models as datasets_models -from foundry.v2.filesystem import models as filesystem_models +from foundry_sdk import _errors as errors +from foundry_sdk.v2.core import models as core_models +from foundry_sdk.v2.datasets import models as datasets_models +from foundry_sdk.v2.filesystem import models as filesystem_models class AbortTransactionPermissionDeniedParameters(typing_extensions.TypedDict): diff --git a/foundry/v2/datasets/file.py b/foundry_sdk/v2/datasets/file.py similarity index 99% rename from foundry/v2/datasets/file.py rename to foundry_sdk/v2/datasets/file.py index fe289e616..5e7a2b9fa 100644 --- a/foundry/v2/datasets/file.py +++ b/foundry_sdk/v2/datasets/file.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.datasets import errors as datasets_errors -from foundry.v2.datasets import models as datasets_models +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.datasets import errors as datasets_errors +from foundry_sdk.v2.datasets import models as datasets_models class FileClient: diff --git a/foundry/v2/datasets/models.py b/foundry_sdk/v2/datasets/models.py similarity index 97% rename from foundry/v2/datasets/models.py rename to foundry_sdk/v2/datasets/models.py index fe844dcd0..70b5aeb97 100644 --- a/foundry/v2/datasets/models.py +++ b/foundry_sdk/v2/datasets/models.py @@ -20,9 +20,9 @@ import pydantic -from foundry import _core as core -from foundry.v2.core import models as core_models -from foundry.v2.filesystem import models as filesystem_models +from foundry_sdk import _core as core +from foundry_sdk.v2.core import models as core_models +from foundry_sdk.v2.filesystem import models as filesystem_models class Branch(pydantic.BaseModel): diff --git a/foundry/v2/datasets/transaction.py b/foundry_sdk/v2/datasets/transaction.py similarity index 98% rename from foundry/v2/datasets/transaction.py rename to foundry_sdk/v2/datasets/transaction.py index 22a65b5ab..df3fc6306 100644 --- a/foundry/v2/datasets/transaction.py +++ b/foundry_sdk/v2/datasets/transaction.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.datasets import errors as datasets_errors -from foundry.v2.datasets import models as datasets_models +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.datasets import errors as datasets_errors +from foundry_sdk.v2.datasets import models as datasets_models class TransactionClient: diff --git a/foundry/v2/filesystem/__init__.py b/foundry_sdk/v2/filesystem/__init__.py similarity index 91% rename from foundry/v2/filesystem/__init__.py rename to foundry_sdk/v2/filesystem/__init__.py index bb1f17843..73ac47193 100644 --- a/foundry/v2/filesystem/__init__.py +++ b/foundry_sdk/v2/filesystem/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v2.filesystem._client import FilesystemClient +from foundry_sdk.v2.filesystem._client import FilesystemClient __all__ = [ "FilesystemClient", diff --git a/foundry/v2/filesystem/_client.py b/foundry_sdk/v2/filesystem/_client.py similarity index 86% rename from foundry/v2/filesystem/_client.py rename to foundry_sdk/v2/filesystem/_client.py index d018f24c3..924bf56b3 100644 --- a/foundry/v2/filesystem/_client.py +++ b/foundry_sdk/v2/filesystem/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class FilesystemClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def Folder(self): - from foundry.v2.filesystem.folder import FolderClient + from foundry_sdk.v2.filesystem.folder import FolderClient return FolderClient( auth=self._auth, @@ -50,7 +50,7 @@ def Folder(self): @cached_property def Project(self): - from foundry.v2.filesystem.project import ProjectClient + from foundry_sdk.v2.filesystem.project import ProjectClient return ProjectClient( auth=self._auth, @@ -60,7 +60,7 @@ def Project(self): @cached_property def Resource(self): - from foundry.v2.filesystem.resource import ResourceClient + from foundry_sdk.v2.filesystem.resource import ResourceClient return ResourceClient( auth=self._auth, @@ -70,7 +70,7 @@ def Resource(self): @cached_property def Space(self): - from foundry.v2.filesystem.space import SpaceClient + from foundry_sdk.v2.filesystem.space import SpaceClient return SpaceClient( auth=self._auth, diff --git a/foundry/v2/filesystem/errors.py b/foundry_sdk/v2/filesystem/errors.py similarity index 99% rename from foundry/v2/filesystem/errors.py rename to foundry_sdk/v2/filesystem/errors.py index 1961667f3..83d2892aa 100644 --- a/foundry/v2/filesystem/errors.py +++ b/foundry_sdk/v2/filesystem/errors.py @@ -18,9 +18,9 @@ import typing_extensions -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.filesystem import models as filesystem_models +from foundry_sdk import _errors as errors +from foundry_sdk.v2.core import models as core_models +from foundry_sdk.v2.filesystem import models as filesystem_models class AddGroupToParentGroupPermissionDeniedParameters(typing_extensions.TypedDict): diff --git a/foundry/v2/filesystem/folder.py b/foundry_sdk/v2/filesystem/folder.py similarity index 97% rename from foundry/v2/filesystem/folder.py rename to foundry_sdk/v2/filesystem/folder.py index 1c11d4d2a..47e9acd2a 100644 --- a/foundry/v2/filesystem/folder.py +++ b/foundry_sdk/v2/filesystem/folder.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.filesystem import errors as filesystem_errors -from foundry.v2.filesystem import models as filesystem_models +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.filesystem import errors as filesystem_errors +from foundry_sdk.v2.filesystem import models as filesystem_models class FolderClient: diff --git a/foundry/v2/filesystem/models.py b/foundry_sdk/v2/filesystem/models.py similarity index 99% rename from foundry/v2/filesystem/models.py rename to foundry_sdk/v2/filesystem/models.py index a42cf17b8..76f1cc9d5 100644 --- a/foundry/v2/filesystem/models.py +++ b/foundry_sdk/v2/filesystem/models.py @@ -20,8 +20,8 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk.v2.core import models as core_models class AccessRequirements(pydantic.BaseModel): diff --git a/foundry/v2/filesystem/project.py b/foundry_sdk/v2/filesystem/project.py similarity index 98% rename from foundry/v2/filesystem/project.py rename to foundry_sdk/v2/filesystem/project.py index 4e079faea..09ca15b84 100644 --- a/foundry/v2/filesystem/project.py +++ b/foundry_sdk/v2/filesystem/project.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.filesystem import errors as filesystem_errors -from foundry.v2.filesystem import models as filesystem_models +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.filesystem import errors as filesystem_errors +from foundry_sdk.v2.filesystem import models as filesystem_models class ProjectClient: diff --git a/foundry/v2/filesystem/resource.py b/foundry_sdk/v2/filesystem/resource.py similarity index 98% rename from foundry/v2/filesystem/resource.py rename to foundry_sdk/v2/filesystem/resource.py index 56a48480a..44c8b4799 100644 --- a/foundry/v2/filesystem/resource.py +++ b/foundry_sdk/v2/filesystem/resource.py @@ -19,11 +19,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.filesystem import errors as filesystem_errors -from foundry.v2.filesystem import models as filesystem_models +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.filesystem import errors as filesystem_errors +from foundry_sdk.v2.filesystem import models as filesystem_models class ResourceClient: @@ -51,7 +51,7 @@ def __init__( @cached_property def Role(self): - from foundry.v2.filesystem.resource_role import ResourceRoleClient + from foundry_sdk.v2.filesystem.resource_role import ResourceRoleClient return ResourceRoleClient( auth=self._auth, diff --git a/foundry/v2/filesystem/resource_role.py b/foundry_sdk/v2/filesystem/resource_role.py similarity index 97% rename from foundry/v2/filesystem/resource_role.py rename to foundry_sdk/v2/filesystem/resource_role.py index 794bfa660..4e2eca520 100644 --- a/foundry/v2/filesystem/resource_role.py +++ b/foundry_sdk/v2/filesystem/resource_role.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.filesystem import errors as filesystem_errors -from foundry.v2.filesystem import models as filesystem_models +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.filesystem import errors as filesystem_errors +from foundry_sdk.v2.filesystem import models as filesystem_models class ResourceRoleClient: diff --git a/foundry/v2/filesystem/space.py b/foundry_sdk/v2/filesystem/space.py similarity index 95% rename from foundry/v2/filesystem/space.py rename to foundry_sdk/v2/filesystem/space.py index 4aa84ef7c..6ee214a58 100644 --- a/foundry/v2/filesystem/space.py +++ b/foundry_sdk/v2/filesystem/space.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.filesystem import models as filesystem_models +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.filesystem import models as filesystem_models class SpaceClient: diff --git a/foundry/v2/functions/__init__.py b/foundry_sdk/v2/functions/__init__.py similarity index 91% rename from foundry/v2/functions/__init__.py rename to foundry_sdk/v2/functions/__init__.py index 92c828262..97795e1d3 100644 --- a/foundry/v2/functions/__init__.py +++ b/foundry_sdk/v2/functions/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v2.functions._client import FunctionsClient +from foundry_sdk.v2.functions._client import FunctionsClient __all__ = [ "FunctionsClient", diff --git a/foundry/v2/functions/_client.py b/foundry_sdk/v2/functions/_client.py similarity index 90% rename from foundry/v2/functions/_client.py rename to foundry_sdk/v2/functions/_client.py index 128878345..0e11c921a 100644 --- a/foundry/v2/functions/_client.py +++ b/foundry_sdk/v2/functions/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class FunctionsClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def Query(self): - from foundry.v2.functions.query import QueryClient + from foundry_sdk.v2.functions.query import QueryClient return QueryClient( auth=self._auth, @@ -50,7 +50,7 @@ def Query(self): @cached_property def ValueType(self): - from foundry.v2.functions.value_type import ValueTypeClient + from foundry_sdk.v2.functions.value_type import ValueTypeClient return ValueTypeClient( auth=self._auth, diff --git a/foundry/v2/functions/errors.py b/foundry_sdk/v2/functions/errors.py similarity index 98% rename from foundry/v2/functions/errors.py rename to foundry_sdk/v2/functions/errors.py index dc28c21da..4455dfd7b 100644 --- a/foundry/v2/functions/errors.py +++ b/foundry_sdk/v2/functions/errors.py @@ -18,8 +18,8 @@ import typing_extensions -from foundry import _errors as errors -from foundry.v2.functions import models as functions_models +from foundry_sdk import _errors as errors +from foundry_sdk.v2.functions import models as functions_models class ExecuteQueryPermissionDeniedParameters(typing_extensions.TypedDict): diff --git a/foundry/v2/functions/models.py b/foundry_sdk/v2/functions/models.py similarity index 99% rename from foundry/v2/functions/models.py rename to foundry_sdk/v2/functions/models.py index 04c2b7b69..5a3e4a6c0 100644 --- a/foundry/v2/functions/models.py +++ b/foundry_sdk/v2/functions/models.py @@ -20,8 +20,8 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk.v2.core import models as core_models DataValue = typing.Any """ diff --git a/foundry/v2/functions/query.py b/foundry_sdk/v2/functions/query.py similarity index 97% rename from foundry/v2/functions/query.py rename to foundry_sdk/v2/functions/query.py index 89dd103a4..664c6ceb2 100644 --- a/foundry/v2/functions/query.py +++ b/foundry_sdk/v2/functions/query.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.functions import errors as functions_errors -from foundry.v2.functions import models as functions_models +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.functions import errors as functions_errors +from foundry_sdk.v2.functions import models as functions_models class QueryClient: diff --git a/foundry/v2/functions/value_type.py b/foundry_sdk/v2/functions/value_type.py similarity index 92% rename from foundry/v2/functions/value_type.py rename to foundry_sdk/v2/functions/value_type.py index f01879ab9..93ad4dedc 100644 --- a/foundry/v2/functions/value_type.py +++ b/foundry_sdk/v2/functions/value_type.py @@ -19,11 +19,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.functions import errors as functions_errors -from foundry.v2.functions import models as functions_models +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.functions import errors as functions_errors +from foundry_sdk.v2.functions import models as functions_models class ValueTypeClient: @@ -51,7 +51,7 @@ def __init__( @cached_property def VersionId(self): - from foundry.v2.functions.version_id import VersionIdClient + from foundry_sdk.v2.functions.version_id import VersionIdClient return VersionIdClient( auth=self._auth, diff --git a/foundry/v2/functions/version_id.py b/foundry_sdk/v2/functions/version_id.py similarity index 93% rename from foundry/v2/functions/version_id.py rename to foundry_sdk/v2/functions/version_id.py index 407563ae4..1dbffcd6e 100644 --- a/foundry/v2/functions/version_id.py +++ b/foundry_sdk/v2/functions/version_id.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.functions import errors as functions_errors -from foundry.v2.functions import models as functions_models +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.functions import errors as functions_errors +from foundry_sdk.v2.functions import models as functions_models class VersionIdClient: diff --git a/foundry/v2/geo/errors.py b/foundry_sdk/v2/geo/errors.py similarity index 100% rename from foundry/v2/geo/errors.py rename to foundry_sdk/v2/geo/errors.py diff --git a/foundry/v2/geo/models.py b/foundry_sdk/v2/geo/models.py similarity index 99% rename from foundry/v2/geo/models.py rename to foundry_sdk/v2/geo/models.py index 248b47eb6..afe6ff8d3 100644 --- a/foundry/v2/geo/models.py +++ b/foundry_sdk/v2/geo/models.py @@ -21,7 +21,7 @@ import pydantic import typing_extensions -from foundry import _core as core +from foundry_sdk import _core as core BBox = typing.List["Coordinate"] """ diff --git a/foundry/v2/media_sets/__init__.py b/foundry_sdk/v2/media_sets/__init__.py similarity index 91% rename from foundry/v2/media_sets/__init__.py rename to foundry_sdk/v2/media_sets/__init__.py index b85f2d9a7..433908662 100644 --- a/foundry/v2/media_sets/__init__.py +++ b/foundry_sdk/v2/media_sets/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v2.media_sets._client import MediaSetsClient +from foundry_sdk.v2.media_sets._client import MediaSetsClient __all__ = [ "MediaSetsClient", diff --git a/foundry/v2/media_sets/_client.py b/foundry_sdk/v2/media_sets/_client.py similarity index 92% rename from foundry/v2/media_sets/_client.py rename to foundry_sdk/v2/media_sets/_client.py index 304b72323..51d62275a 100644 --- a/foundry/v2/media_sets/_client.py +++ b/foundry_sdk/v2/media_sets/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class MediaSetsClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def MediaSet(self): - from foundry.v2.media_sets.media_set import MediaSetClient + from foundry_sdk.v2.media_sets.media_set import MediaSetClient return MediaSetClient( auth=self._auth, diff --git a/foundry/v2/media_sets/errors.py b/foundry_sdk/v2/media_sets/errors.py similarity index 94% rename from foundry/v2/media_sets/errors.py rename to foundry_sdk/v2/media_sets/errors.py index 3a0939bc0..e81f76630 100644 --- a/foundry/v2/media_sets/errors.py +++ b/foundry_sdk/v2/media_sets/errors.py @@ -18,8 +18,8 @@ import typing_extensions -from foundry import _errors as errors -from foundry.v2.core import models as core_models +from foundry_sdk import _errors as errors +from foundry_sdk.v2.core import models as core_models class ConflictingMediaSetIdentifiersParameters(typing_extensions.TypedDict): diff --git a/foundry/v2/media_sets/media_set.py b/foundry_sdk/v2/media_sets/media_set.py similarity index 99% rename from foundry/v2/media_sets/media_set.py rename to foundry_sdk/v2/media_sets/media_set.py index 24f4d4cc4..c5aa74188 100644 --- a/foundry/v2/media_sets/media_set.py +++ b/foundry_sdk/v2/media_sets/media_set.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.media_sets import models as media_sets_models +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.media_sets import models as media_sets_models class MediaSetClient: diff --git a/foundry/v2/media_sets/models.py b/foundry_sdk/v2/media_sets/models.py similarity index 97% rename from foundry/v2/media_sets/models.py rename to foundry_sdk/v2/media_sets/models.py index b81f24d1a..458293fea 100644 --- a/foundry/v2/media_sets/models.py +++ b/foundry_sdk/v2/media_sets/models.py @@ -20,8 +20,8 @@ import pydantic -from foundry import _core as core -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk.v2.core import models as core_models BranchName = str """ diff --git a/foundry/v1/ontologies/__init__.py b/foundry_sdk/v2/ontologies/__init__.py similarity index 91% rename from foundry/v1/ontologies/__init__.py rename to foundry_sdk/v2/ontologies/__init__.py index e7dd28d33..b3a58c712 100644 --- a/foundry/v1/ontologies/__init__.py +++ b/foundry_sdk/v2/ontologies/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v1.ontologies._client import OntologiesClient +from foundry_sdk.v2.ontologies._client import OntologiesClient __all__ = [ "OntologiesClient", diff --git a/foundry/v2/ontologies/_client.py b/foundry_sdk/v2/ontologies/_client.py similarity index 78% rename from foundry/v2/ontologies/_client.py rename to foundry_sdk/v2/ontologies/_client.py index 31b577a28..0e8688b0c 100644 --- a/foundry/v2/ontologies/_client.py +++ b/foundry_sdk/v2/ontologies/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class OntologiesClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def Action(self): - from foundry.v2.ontologies.action import ActionClient + from foundry_sdk.v2.ontologies.action import ActionClient return ActionClient( auth=self._auth, @@ -50,7 +50,7 @@ def Action(self): @cached_property def Attachment(self): - from foundry.v2.ontologies.attachment import AttachmentClient + from foundry_sdk.v2.ontologies.attachment import AttachmentClient return AttachmentClient( auth=self._auth, @@ -60,7 +60,7 @@ def Attachment(self): @cached_property def AttachmentProperty(self): - from foundry.v2.ontologies.attachment_property import AttachmentPropertyClient + from foundry_sdk.v2.ontologies.attachment_property import AttachmentPropertyClient # NOQA return AttachmentPropertyClient( auth=self._auth, @@ -70,7 +70,7 @@ def AttachmentProperty(self): @cached_property def LinkedObject(self): - from foundry.v2.ontologies.linked_object import LinkedObjectClient + from foundry_sdk.v2.ontologies.linked_object import LinkedObjectClient return LinkedObjectClient( auth=self._auth, @@ -80,7 +80,7 @@ def LinkedObject(self): @cached_property def MediaReferenceProperty(self): - from foundry.v2.ontologies.media_reference_property import ( + from foundry_sdk.v2.ontologies.media_reference_property import ( MediaReferencePropertyClient, ) # NOQA @@ -92,7 +92,7 @@ def MediaReferenceProperty(self): @cached_property def Ontology(self): - from foundry.v2.ontologies.ontology import OntologyClient + from foundry_sdk.v2.ontologies.ontology import OntologyClient return OntologyClient( auth=self._auth, @@ -102,7 +102,7 @@ def Ontology(self): @cached_property def OntologyInterface(self): - from foundry.v2.ontologies.ontology_interface import OntologyInterfaceClient + from foundry_sdk.v2.ontologies.ontology_interface import OntologyInterfaceClient return OntologyInterfaceClient( auth=self._auth, @@ -112,7 +112,7 @@ def OntologyInterface(self): @cached_property def OntologyObject(self): - from foundry.v2.ontologies.ontology_object import OntologyObjectClient + from foundry_sdk.v2.ontologies.ontology_object import OntologyObjectClient return OntologyObjectClient( auth=self._auth, @@ -122,7 +122,7 @@ def OntologyObject(self): @cached_property def OntologyObjectSet(self): - from foundry.v2.ontologies.ontology_object_set import OntologyObjectSetClient + from foundry_sdk.v2.ontologies.ontology_object_set import OntologyObjectSetClient # NOQA return OntologyObjectSetClient( auth=self._auth, @@ -132,7 +132,7 @@ def OntologyObjectSet(self): @cached_property def Query(self): - from foundry.v2.ontologies.query import QueryClient + from foundry_sdk.v2.ontologies.query import QueryClient return QueryClient( auth=self._auth, @@ -142,7 +142,9 @@ def Query(self): @cached_property def TimeSeriesPropertyV2(self): - from foundry.v2.ontologies.time_series_property_v2 import TimeSeriesPropertyV2Client # NOQA + from foundry_sdk.v2.ontologies.time_series_property_v2 import ( + TimeSeriesPropertyV2Client, + ) # NOQA return TimeSeriesPropertyV2Client( auth=self._auth, @@ -152,7 +154,7 @@ def TimeSeriesPropertyV2(self): @cached_property def TimeSeriesValueBankProperty(self): - from foundry.v2.ontologies.time_series_value_bank_property import ( + from foundry_sdk.v2.ontologies.time_series_value_bank_property import ( TimeSeriesValueBankPropertyClient, ) # NOQA diff --git a/foundry/v2/ontologies/action.py b/foundry_sdk/v2/ontologies/action.py similarity index 98% rename from foundry/v2/ontologies/action.py rename to foundry_sdk/v2/ontologies/action.py index 055d2430a..76abb4201 100644 --- a/foundry/v2/ontologies/action.py +++ b/foundry_sdk/v2/ontologies/action.py @@ -18,9 +18,9 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.ontologies import models as ontologies_models class ActionClient: diff --git a/foundry/v2/ontologies/action_type.py b/foundry_sdk/v2/ontologies/action_type.py similarity index 97% rename from foundry/v2/ontologies/action_type.py rename to foundry_sdk/v2/ontologies/action_type.py index 3d1e622f6..2647563af 100644 --- a/foundry/v2/ontologies/action_type.py +++ b/foundry_sdk/v2/ontologies/action_type.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.ontologies import models as ontologies_models +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.ontologies import models as ontologies_models class ActionTypeClient: diff --git a/foundry/v2/ontologies/attachment.py b/foundry_sdk/v2/ontologies/attachment.py similarity index 97% rename from foundry/v2/ontologies/attachment.py rename to foundry_sdk/v2/ontologies/attachment.py index fe06ddcd1..2b8fe588c 100644 --- a/foundry/v2/ontologies/attachment.py +++ b/foundry_sdk/v2/ontologies/attachment.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.ontologies import models as ontologies_models +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.ontologies import models as ontologies_models class AttachmentClient: diff --git a/foundry/v2/ontologies/attachment_property.py b/foundry_sdk/v2/ontologies/attachment_property.py similarity index 99% rename from foundry/v2/ontologies/attachment_property.py rename to foundry_sdk/v2/ontologies/attachment_property.py index 999ab73c1..d8ef77f2a 100644 --- a/foundry/v2/ontologies/attachment_property.py +++ b/foundry_sdk/v2/ontologies/attachment_property.py @@ -18,9 +18,9 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.ontologies import models as ontologies_models class AttachmentPropertyClient: diff --git a/foundry/v1/ontologies/errors.py b/foundry_sdk/v2/ontologies/errors.py similarity index 99% rename from foundry/v1/ontologies/errors.py rename to foundry_sdk/v2/ontologies/errors.py index e38305e32..508a64a18 100644 --- a/foundry/v1/ontologies/errors.py +++ b/foundry_sdk/v2/ontologies/errors.py @@ -18,9 +18,9 @@ import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v1.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.ontologies import models as ontologies_models class ActionContainsDuplicateEditsParameters(typing_extensions.TypedDict): diff --git a/foundry/v2/ontologies/linked_object.py b/foundry_sdk/v2/ontologies/linked_object.py similarity index 98% rename from foundry/v2/ontologies/linked_object.py rename to foundry_sdk/v2/ontologies/linked_object.py index d4f7bfc44..97b34d603 100644 --- a/foundry/v2/ontologies/linked_object.py +++ b/foundry_sdk/v2/ontologies/linked_object.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.ontologies import models as ontologies_models +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.ontologies import models as ontologies_models class LinkedObjectClient: diff --git a/foundry/v2/ontologies/media_reference_property.py b/foundry_sdk/v2/ontologies/media_reference_property.py similarity index 98% rename from foundry/v2/ontologies/media_reference_property.py rename to foundry_sdk/v2/ontologies/media_reference_property.py index 394ac52f5..9c8ff745d 100644 --- a/foundry/v2/ontologies/media_reference_property.py +++ b/foundry_sdk/v2/ontologies/media_reference_property.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.ontologies import models as ontologies_models +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.ontologies import models as ontologies_models class MediaReferencePropertyClient: diff --git a/foundry/v2/ontologies/models.py b/foundry_sdk/v2/ontologies/models.py similarity index 99% rename from foundry/v2/ontologies/models.py rename to foundry_sdk/v2/ontologies/models.py index 713aea62f..da314876b 100644 --- a/foundry/v2/ontologies/models.py +++ b/foundry_sdk/v2/ontologies/models.py @@ -21,9 +21,9 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry.v2.core import models as core_models -from foundry.v2.geo import models as geo_models +from foundry_sdk import _core as core +from foundry_sdk.v2.core import models as core_models +from foundry_sdk.v2.geo import models as geo_models class AbsoluteTimeRange(pydantic.BaseModel): diff --git a/foundry/v2/ontologies/object_type.py b/foundry_sdk/v2/ontologies/object_type.py similarity index 98% rename from foundry/v2/ontologies/object_type.py rename to foundry_sdk/v2/ontologies/object_type.py index 5a042b19d..324553cf1 100644 --- a/foundry/v2/ontologies/object_type.py +++ b/foundry_sdk/v2/ontologies/object_type.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.ontologies import models as ontologies_models +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.ontologies import models as ontologies_models class ObjectTypeClient: diff --git a/foundry/v2/ontologies/ontology.py b/foundry_sdk/v2/ontologies/ontology.py similarity index 95% rename from foundry/v2/ontologies/ontology.py rename to foundry_sdk/v2/ontologies/ontology.py index 76861a28d..025b4315a 100644 --- a/foundry/v2/ontologies/ontology.py +++ b/foundry_sdk/v2/ontologies/ontology.py @@ -19,9 +19,9 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.ontologies import models as ontologies_models class OntologyClient: @@ -49,7 +49,7 @@ def __init__( @cached_property def ActionType(self): - from foundry.v2.ontologies.action_type import ActionTypeClient + from foundry_sdk.v2.ontologies.action_type import ActionTypeClient return ActionTypeClient( auth=self._auth, @@ -59,7 +59,7 @@ def ActionType(self): @cached_property def ObjectType(self): - from foundry.v2.ontologies.object_type import ObjectTypeClient + from foundry_sdk.v2.ontologies.object_type import ObjectTypeClient return ObjectTypeClient( auth=self._auth, @@ -69,7 +69,7 @@ def ObjectType(self): @cached_property def QueryType(self): - from foundry.v2.ontologies.query_type import QueryTypeClient + from foundry_sdk.v2.ontologies.query_type import QueryTypeClient return QueryTypeClient( auth=self._auth, diff --git a/foundry/v2/ontologies/ontology_interface.py b/foundry_sdk/v2/ontologies/ontology_interface.py similarity index 99% rename from foundry/v2/ontologies/ontology_interface.py rename to foundry_sdk/v2/ontologies/ontology_interface.py index 10e006e75..05d3a0195 100644 --- a/foundry/v2/ontologies/ontology_interface.py +++ b/foundry_sdk/v2/ontologies/ontology_interface.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.ontologies import models as ontologies_models +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.ontologies import models as ontologies_models class OntologyInterfaceClient: diff --git a/foundry/v2/ontologies/ontology_object.py b/foundry_sdk/v2/ontologies/ontology_object.py similarity index 99% rename from foundry/v2/ontologies/ontology_object.py rename to foundry_sdk/v2/ontologies/ontology_object.py index e9aeb17fa..fb4ccbe9b 100644 --- a/foundry/v2/ontologies/ontology_object.py +++ b/foundry_sdk/v2/ontologies/ontology_object.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.ontologies import models as ontologies_models +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.ontologies import models as ontologies_models class OntologyObjectClient: diff --git a/foundry/v2/ontologies/ontology_object_set.py b/foundry_sdk/v2/ontologies/ontology_object_set.py similarity index 99% rename from foundry/v2/ontologies/ontology_object_set.py rename to foundry_sdk/v2/ontologies/ontology_object_set.py index d8c97ac70..137187d31 100644 --- a/foundry/v2/ontologies/ontology_object_set.py +++ b/foundry_sdk/v2/ontologies/ontology_object_set.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.ontologies import models as ontologies_models +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.ontologies import models as ontologies_models class OntologyObjectSetClient: diff --git a/foundry/v2/ontologies/query.py b/foundry_sdk/v2/ontologies/query.py similarity index 97% rename from foundry/v2/ontologies/query.py rename to foundry_sdk/v2/ontologies/query.py index d6c8b8ecd..a5397c0f8 100644 --- a/foundry/v2/ontologies/query.py +++ b/foundry_sdk/v2/ontologies/query.py @@ -18,9 +18,9 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.ontologies import models as ontologies_models class QueryClient: diff --git a/foundry/v2/ontologies/query_type.py b/foundry_sdk/v2/ontologies/query_type.py similarity index 97% rename from foundry/v2/ontologies/query_type.py rename to foundry_sdk/v2/ontologies/query_type.py index 5245e70c6..0d94fec7e 100644 --- a/foundry/v2/ontologies/query_type.py +++ b/foundry_sdk/v2/ontologies/query_type.py @@ -18,10 +18,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.ontologies import models as ontologies_models +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.ontologies import models as ontologies_models class QueryTypeClient: diff --git a/foundry/v2/ontologies/time_series_property_v2.py b/foundry_sdk/v2/ontologies/time_series_property_v2.py similarity index 98% rename from foundry/v2/ontologies/time_series_property_v2.py rename to foundry_sdk/v2/ontologies/time_series_property_v2.py index a1c6e72d4..6e3b56768 100644 --- a/foundry/v2/ontologies/time_series_property_v2.py +++ b/foundry_sdk/v2/ontologies/time_series_property_v2.py @@ -18,9 +18,9 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.ontologies import models as ontologies_models class TimeSeriesPropertyV2Client: diff --git a/foundry/v2/ontologies/time_series_value_bank_property.py b/foundry_sdk/v2/ontologies/time_series_value_bank_property.py similarity index 98% rename from foundry/v2/ontologies/time_series_value_bank_property.py rename to foundry_sdk/v2/ontologies/time_series_value_bank_property.py index 433cafaa7..a49e18ae6 100644 --- a/foundry/v2/ontologies/time_series_value_bank_property.py +++ b/foundry_sdk/v2/ontologies/time_series_value_bank_property.py @@ -18,9 +18,9 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.ontologies import models as ontologies_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.ontologies import models as ontologies_models class TimeSeriesValueBankPropertyClient: diff --git a/foundry/v2/orchestration/__init__.py b/foundry_sdk/v2/orchestration/__init__.py similarity index 90% rename from foundry/v2/orchestration/__init__.py rename to foundry_sdk/v2/orchestration/__init__.py index 7e414a73f..090114fe2 100644 --- a/foundry/v2/orchestration/__init__.py +++ b/foundry_sdk/v2/orchestration/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v2.orchestration._client import OrchestrationClient +from foundry_sdk.v2.orchestration._client import OrchestrationClient __all__ = [ "OrchestrationClient", diff --git a/foundry/v2/orchestration/_client.py b/foundry_sdk/v2/orchestration/_client.py similarity index 85% rename from foundry/v2/orchestration/_client.py rename to foundry_sdk/v2/orchestration/_client.py index f906a61a7..25a1f24dd 100644 --- a/foundry/v2/orchestration/_client.py +++ b/foundry_sdk/v2/orchestration/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class OrchestrationClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def Build(self): - from foundry.v2.orchestration.build import BuildClient + from foundry_sdk.v2.orchestration.build import BuildClient return BuildClient( auth=self._auth, @@ -50,7 +50,7 @@ def Build(self): @cached_property def Job(self): - from foundry.v2.orchestration.job import JobClient + from foundry_sdk.v2.orchestration.job import JobClient return JobClient( auth=self._auth, @@ -60,7 +60,7 @@ def Job(self): @cached_property def Schedule(self): - from foundry.v2.orchestration.schedule import ScheduleClient + from foundry_sdk.v2.orchestration.schedule import ScheduleClient return ScheduleClient( auth=self._auth, @@ -70,7 +70,7 @@ def Schedule(self): @cached_property def ScheduleVersion(self): - from foundry.v2.orchestration.schedule_version import ScheduleVersionClient + from foundry_sdk.v2.orchestration.schedule_version import ScheduleVersionClient return ScheduleVersionClient( auth=self._auth, diff --git a/foundry/v2/orchestration/build.py b/foundry_sdk/v2/orchestration/build.py similarity index 98% rename from foundry/v2/orchestration/build.py rename to foundry_sdk/v2/orchestration/build.py index 493f7ed7d..50946cf9e 100644 --- a/foundry/v2/orchestration/build.py +++ b/foundry_sdk/v2/orchestration/build.py @@ -19,12 +19,12 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.datasets import models as datasets_models -from foundry.v2.orchestration import errors as orchestration_errors -from foundry.v2.orchestration import models as orchestration_models +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.datasets import models as datasets_models +from foundry_sdk.v2.orchestration import errors as orchestration_errors +from foundry_sdk.v2.orchestration import models as orchestration_models class BuildClient: diff --git a/foundry/v2/orchestration/errors.py b/foundry_sdk/v2/orchestration/errors.py similarity index 98% rename from foundry/v2/orchestration/errors.py rename to foundry_sdk/v2/orchestration/errors.py index c18b8d55c..197e870c0 100644 --- a/foundry/v2/orchestration/errors.py +++ b/foundry_sdk/v2/orchestration/errors.py @@ -18,10 +18,10 @@ import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.orchestration import models as orchestration_models +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.orchestration import models as orchestration_models class BuildInputsNotFoundParameters(typing_extensions.TypedDict): diff --git a/foundry/v2/orchestration/job.py b/foundry_sdk/v2/orchestration/job.py similarity index 95% rename from foundry/v2/orchestration/job.py rename to foundry_sdk/v2/orchestration/job.py index 6ad16baec..3d9bddd40 100644 --- a/foundry/v2/orchestration/job.py +++ b/foundry_sdk/v2/orchestration/job.py @@ -19,11 +19,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.orchestration import errors as orchestration_errors -from foundry.v2.orchestration import models as orchestration_models +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.orchestration import errors as orchestration_errors +from foundry_sdk.v2.orchestration import models as orchestration_models class JobClient: diff --git a/foundry/v2/orchestration/models.py b/foundry_sdk/v2/orchestration/models.py similarity index 99% rename from foundry/v2/orchestration/models.py rename to foundry_sdk/v2/orchestration/models.py index 78c42090f..c3ce202f9 100644 --- a/foundry/v2/orchestration/models.py +++ b/foundry_sdk/v2/orchestration/models.py @@ -21,10 +21,10 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry.v2.core import models as core_models -from foundry.v2.datasets import models as datasets_models -from foundry.v2.filesystem import models as filesystem_models +from foundry_sdk import _core as core +from foundry_sdk.v2.core import models as core_models +from foundry_sdk.v2.datasets import models as datasets_models +from foundry_sdk.v2.filesystem import models as filesystem_models AbortOnFailure = bool """ diff --git a/foundry/v2/orchestration/schedule.py b/foundry_sdk/v2/orchestration/schedule.py similarity index 98% rename from foundry/v2/orchestration/schedule.py rename to foundry_sdk/v2/orchestration/schedule.py index 88e8e53da..4d77d12dd 100644 --- a/foundry/v2/orchestration/schedule.py +++ b/foundry_sdk/v2/orchestration/schedule.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.orchestration import errors as orchestration_errors -from foundry.v2.orchestration import models as orchestration_models +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.orchestration import errors as orchestration_errors +from foundry_sdk.v2.orchestration import models as orchestration_models class ScheduleClient: diff --git a/foundry/v2/orchestration/schedule_version.py b/foundry_sdk/v2/orchestration/schedule_version.py similarity index 95% rename from foundry/v2/orchestration/schedule_version.py rename to foundry_sdk/v2/orchestration/schedule_version.py index bb233dcc1..1a502af0d 100644 --- a/foundry/v2/orchestration/schedule_version.py +++ b/foundry_sdk/v2/orchestration/schedule_version.py @@ -18,11 +18,11 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.orchestration import errors as orchestration_errors -from foundry.v2.orchestration import models as orchestration_models +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.orchestration import errors as orchestration_errors +from foundry_sdk.v2.orchestration import models as orchestration_models class ScheduleVersionClient: diff --git a/foundry/v2/sql_queries/__init__.py b/foundry_sdk/v2/sql_queries/__init__.py similarity index 90% rename from foundry/v2/sql_queries/__init__.py rename to foundry_sdk/v2/sql_queries/__init__.py index 18c8b3aba..cad63f717 100644 --- a/foundry/v2/sql_queries/__init__.py +++ b/foundry_sdk/v2/sql_queries/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v2.sql_queries._client import SqlQueriesClient +from foundry_sdk.v2.sql_queries._client import SqlQueriesClient __all__ = [ "SqlQueriesClient", diff --git a/foundry/v2/sql_queries/_client.py b/foundry_sdk/v2/sql_queries/_client.py similarity index 93% rename from foundry/v2/sql_queries/_client.py rename to foundry_sdk/v2/sql_queries/_client.py index 29adee602..a21822f14 100644 --- a/foundry/v2/sql_queries/_client.py +++ b/foundry_sdk/v2/sql_queries/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class SqlQueriesClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def Query(self): - from foundry.v2.sql_queries.query import QueryClient + from foundry_sdk.v2.sql_queries.query import QueryClient return QueryClient( auth=self._auth, diff --git a/foundry/v2/sql_queries/errors.py b/foundry_sdk/v2/sql_queries/errors.py similarity index 97% rename from foundry/v2/sql_queries/errors.py rename to foundry_sdk/v2/sql_queries/errors.py index ce503ae3b..041d6fde7 100644 --- a/foundry/v2/sql_queries/errors.py +++ b/foundry_sdk/v2/sql_queries/errors.py @@ -18,9 +18,9 @@ import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.sql_queries import models as sql_queries_models +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.sql_queries import models as sql_queries_models class CancelQueryPermissionDeniedParameters(typing_extensions.TypedDict): diff --git a/foundry/v2/sql_queries/models.py b/foundry_sdk/v2/sql_queries/models.py similarity index 98% rename from foundry/v2/sql_queries/models.py rename to foundry_sdk/v2/sql_queries/models.py index 142dca380..00c2b753f 100644 --- a/foundry/v2/sql_queries/models.py +++ b/foundry_sdk/v2/sql_queries/models.py @@ -20,7 +20,7 @@ import pydantic import typing_extensions -from foundry import _core as core +from foundry_sdk import _core as core class CanceledQueryStatus(pydantic.BaseModel): diff --git a/foundry/v2/sql_queries/query.py b/foundry_sdk/v2/sql_queries/query.py similarity index 97% rename from foundry/v2/sql_queries/query.py rename to foundry_sdk/v2/sql_queries/query.py index ff33bb0a3..244cedb14 100644 --- a/foundry/v2/sql_queries/query.py +++ b/foundry_sdk/v2/sql_queries/query.py @@ -18,12 +18,12 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.datasets import models as datasets_models -from foundry.v2.sql_queries import errors as sql_queries_errors -from foundry.v2.sql_queries import models as sql_queries_models +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.datasets import models as datasets_models +from foundry_sdk.v2.sql_queries import errors as sql_queries_errors +from foundry_sdk.v2.sql_queries import models as sql_queries_models class QueryClient: diff --git a/foundry/v2/streams/__init__.py b/foundry_sdk/v2/streams/__init__.py similarity index 91% rename from foundry/v2/streams/__init__.py rename to foundry_sdk/v2/streams/__init__.py index 35346cf3c..5b6bff46f 100644 --- a/foundry/v2/streams/__init__.py +++ b/foundry_sdk/v2/streams/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v2.streams._client import StreamsClient +from foundry_sdk.v2.streams._client import StreamsClient __all__ = [ "StreamsClient", diff --git a/foundry/v2/streams/_client.py b/foundry_sdk/v2/streams/_client.py similarity index 93% rename from foundry/v2/streams/_client.py rename to foundry_sdk/v2/streams/_client.py index becf2679c..810114ffd 100644 --- a/foundry/v2/streams/_client.py +++ b/foundry_sdk/v2/streams/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class StreamsClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def Dataset(self): - from foundry.v2.streams.dataset import DatasetClient + from foundry_sdk.v2.streams.dataset import DatasetClient return DatasetClient( auth=self._auth, diff --git a/foundry/v2/streams/dataset.py b/foundry_sdk/v2/streams/dataset.py similarity index 93% rename from foundry/v2/streams/dataset.py rename to foundry_sdk/v2/streams/dataset.py index 61308a018..88a0aae9e 100644 --- a/foundry/v2/streams/dataset.py +++ b/foundry_sdk/v2/streams/dataset.py @@ -19,14 +19,14 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.datasets import models as datasets_models -from foundry.v2.filesystem import errors as filesystem_errors -from foundry.v2.filesystem import models as filesystem_models -from foundry.v2.streams import errors as streams_errors -from foundry.v2.streams import models as streams_models +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.datasets import models as datasets_models +from foundry_sdk.v2.filesystem import errors as filesystem_errors +from foundry_sdk.v2.filesystem import models as filesystem_models +from foundry_sdk.v2.streams import errors as streams_errors +from foundry_sdk.v2.streams import models as streams_models class DatasetClient: @@ -54,7 +54,7 @@ def __init__( @cached_property def Stream(self): - from foundry.v2.streams.stream import StreamClient + from foundry_sdk.v2.streams.stream import StreamClient return StreamClient( auth=self._auth, diff --git a/foundry/v2/streams/errors.py b/foundry_sdk/v2/streams/errors.py similarity index 97% rename from foundry/v2/streams/errors.py rename to foundry_sdk/v2/streams/errors.py index f8487ffe5..e3b13fc25 100644 --- a/foundry/v2/streams/errors.py +++ b/foundry_sdk/v2/streams/errors.py @@ -18,10 +18,10 @@ import typing_extensions -from foundry import _errors as errors -from foundry.v2.datasets import models as datasets_models -from foundry.v2.filesystem import models as filesystem_models -from foundry.v2.streams import models as streams_models +from foundry_sdk import _errors as errors +from foundry_sdk.v2.datasets import models as datasets_models +from foundry_sdk.v2.filesystem import models as filesystem_models +from foundry_sdk.v2.streams import models as streams_models class CannotCreateStreamingDatasetInUserFolderParameters(typing_extensions.TypedDict): diff --git a/foundry/v2/streams/models.py b/foundry_sdk/v2/streams/models.py similarity index 96% rename from foundry/v2/streams/models.py rename to foundry_sdk/v2/streams/models.py index 5c0461067..64c441c16 100644 --- a/foundry/v2/streams/models.py +++ b/foundry_sdk/v2/streams/models.py @@ -19,10 +19,10 @@ import pydantic -from foundry import _core as core -from foundry.v2.core import models as core_models -from foundry.v2.datasets import models as datasets_models -from foundry.v2.filesystem import models as filesystem_models +from foundry_sdk import _core as core +from foundry_sdk.v2.core import models as core_models +from foundry_sdk.v2.datasets import models as datasets_models +from foundry_sdk.v2.filesystem import models as filesystem_models Compressed = bool """ diff --git a/foundry/v2/streams/stream.py b/foundry_sdk/v2/streams/stream.py similarity index 98% rename from foundry/v2/streams/stream.py rename to foundry_sdk/v2/streams/stream.py index 829f1696a..dca747ef0 100644 --- a/foundry/v2/streams/stream.py +++ b/foundry_sdk/v2/streams/stream.py @@ -18,12 +18,12 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.datasets import models as datasets_models -from foundry.v2.streams import errors as streams_errors -from foundry.v2.streams import models as streams_models +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.datasets import models as datasets_models +from foundry_sdk.v2.streams import errors as streams_errors +from foundry_sdk.v2.streams import models as streams_models class StreamClient: diff --git a/foundry/v2/third_party_applications/__init__.py b/foundry_sdk/v2/third_party_applications/__init__.py similarity index 88% rename from foundry/v2/third_party_applications/__init__.py rename to foundry_sdk/v2/third_party_applications/__init__.py index 97ab85d07..2a80d971b 100644 --- a/foundry/v2/third_party_applications/__init__.py +++ b/foundry_sdk/v2/third_party_applications/__init__.py @@ -13,7 +13,7 @@ # limitations under the License. -from foundry.v2.third_party_applications._client import ThirdPartyApplicationsClient +from foundry_sdk.v2.third_party_applications._client import ThirdPartyApplicationsClient __all__ = [ "ThirdPartyApplicationsClient", diff --git a/foundry/v2/third_party_applications/_client.py b/foundry_sdk/v2/third_party_applications/_client.py similarity index 92% rename from foundry/v2/third_party_applications/_client.py rename to foundry_sdk/v2/third_party_applications/_client.py index e646a9446..d39ce3ca7 100644 --- a/foundry/v2/third_party_applications/_client.py +++ b/foundry_sdk/v2/third_party_applications/_client.py @@ -16,7 +16,7 @@ import typing from functools import cached_property -from foundry import _core as core +from foundry_sdk import _core as core class ThirdPartyApplicationsClient: @@ -40,7 +40,7 @@ def __init__( @cached_property def ThirdPartyApplication(self): - from foundry.v2.third_party_applications.third_party_application import ( + from foundry_sdk.v2.third_party_applications.third_party_application import ( ThirdPartyApplicationClient, ) # NOQA diff --git a/foundry/v2/third_party_applications/errors.py b/foundry_sdk/v2/third_party_applications/errors.py similarity index 97% rename from foundry/v2/third_party_applications/errors.py rename to foundry_sdk/v2/third_party_applications/errors.py index 63daaea3c..d025e2705 100644 --- a/foundry/v2/third_party_applications/errors.py +++ b/foundry_sdk/v2/third_party_applications/errors.py @@ -18,9 +18,11 @@ import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.third_party_applications import models as third_party_applications_models # NOQA +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.third_party_applications import ( + models as third_party_applications_models, +) # NOQA class CannotDeleteDeployedVersionParameters(typing_extensions.TypedDict): diff --git a/foundry/v2/third_party_applications/models.py b/foundry_sdk/v2/third_party_applications/models.py similarity index 97% rename from foundry/v2/third_party_applications/models.py rename to foundry_sdk/v2/third_party_applications/models.py index 715780afb..2edb3e762 100644 --- a/foundry/v2/third_party_applications/models.py +++ b/foundry_sdk/v2/third_party_applications/models.py @@ -19,8 +19,8 @@ import pydantic -from foundry import _core as core -from foundry.v2.core import models as core_models +from foundry_sdk import _core as core +from foundry_sdk.v2.core import models as core_models class ListVersionsResponse(pydantic.BaseModel): diff --git a/foundry/v2/third_party_applications/third_party_application.py b/foundry_sdk/v2/third_party_applications/third_party_application.py similarity index 90% rename from foundry/v2/third_party_applications/third_party_application.py rename to foundry_sdk/v2/third_party_applications/third_party_application.py index 679f5126b..d68130bc1 100644 --- a/foundry/v2/third_party_applications/third_party_application.py +++ b/foundry_sdk/v2/third_party_applications/third_party_application.py @@ -19,11 +19,15 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.third_party_applications import errors as third_party_applications_errors # NOQA -from foundry.v2.third_party_applications import models as third_party_applications_models # NOQA +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.third_party_applications import ( + errors as third_party_applications_errors, +) # NOQA +from foundry_sdk.v2.third_party_applications import ( + models as third_party_applications_models, +) # NOQA class ThirdPartyApplicationClient: @@ -51,7 +55,7 @@ def __init__( @cached_property def Website(self): - from foundry.v2.third_party_applications.website import WebsiteClient + from foundry_sdk.v2.third_party_applications.website import WebsiteClient return WebsiteClient( auth=self._auth, diff --git a/foundry/v2/third_party_applications/version.py b/foundry_sdk/v2/third_party_applications/version.py similarity index 97% rename from foundry/v2/third_party_applications/version.py rename to foundry_sdk/v2/third_party_applications/version.py index f9a2687cb..1fa8977db 100644 --- a/foundry/v2/third_party_applications/version.py +++ b/foundry_sdk/v2/third_party_applications/version.py @@ -18,11 +18,15 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.core import models as core_models -from foundry.v2.third_party_applications import errors as third_party_applications_errors # NOQA -from foundry.v2.third_party_applications import models as third_party_applications_models # NOQA +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.third_party_applications import ( + errors as third_party_applications_errors, +) # NOQA +from foundry_sdk.v2.third_party_applications import ( + models as third_party_applications_models, +) # NOQA class VersionClient: diff --git a/foundry/v2/third_party_applications/website.py b/foundry_sdk/v2/third_party_applications/website.py similarity index 95% rename from foundry/v2/third_party_applications/website.py rename to foundry_sdk/v2/third_party_applications/website.py index 10e355478..587b7f694 100644 --- a/foundry/v2/third_party_applications/website.py +++ b/foundry_sdk/v2/third_party_applications/website.py @@ -19,10 +19,14 @@ import pydantic import typing_extensions -from foundry import _core as core -from foundry import _errors as errors -from foundry.v2.third_party_applications import errors as third_party_applications_errors # NOQA -from foundry.v2.third_party_applications import models as third_party_applications_models # NOQA +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.third_party_applications import ( + errors as third_party_applications_errors, +) # NOQA +from foundry_sdk.v2.third_party_applications import ( + models as third_party_applications_models, +) # NOQA class WebsiteClient: @@ -50,7 +54,7 @@ def __init__( @cached_property def Version(self): - from foundry.v2.third_party_applications.version import VersionClient + from foundry_sdk.v2.third_party_applications.version import VersionClient return VersionClient( auth=self._auth, diff --git a/pyproject.toml b/pyproject.toml index 193d4d1c8..329fb59b9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ readme = "README.md" authors = ["Palantir Technologies, Inc."] repository = "https://github.com/palantir/foundry-platform-python" keywords = ["Palantir", "Foundry", "SDK", "Client", "API"] -packages = [{ include = "foundry" }] +packages = [{ include = "foundry_sdk" }] [tool.poetry.dependencies] annotated-types = ">=0.7.0, <1.0.0" @@ -36,5 +36,5 @@ build-backend = "poetry.core.masonry.api" [tool.poetry.scripts] -foundry_v1 = "foundry.v1.cli:cli" -foundry_v2 = "foundry.v2.cli:cli" +foundry_sdk_v1 = "foundry_sdk.v1.cli:cli" +foundry_sdk_v2 = "foundry_sdk.v2.cli:cli" diff --git a/scripts/set_version.py b/scripts/set_version.py index d129ab066..e7b8aca1c 100644 --- a/scripts/set_version.py +++ b/scripts/set_version.py @@ -4,7 +4,7 @@ print(f"Setting version to {gitversion}...") -path = "foundry/_versions.py" +path = "foundry_sdk/_versions.py" with open(path, "r") as f: content = f.read() diff --git a/tests/auth/test_confidential_client.py b/tests/auth/test_confidential_client.py index fcfcbf7fd..d6be54710 100644 --- a/tests/auth/test_confidential_client.py +++ b/tests/auth/test_confidential_client.py @@ -24,8 +24,8 @@ from mockito import verify from mockito import when -from foundry._core.confidential_client_auth import ConfidentialClientAuth -from foundry._core.oauth_utils import SignInResponse +from foundry_sdk._core.confidential_client_auth import ConfidentialClientAuth +from foundry_sdk._core.oauth_utils import SignInResponse RESPONSE = { "access_token": "access_token", diff --git a/tests/auth/test_confidential_client_oauth_flow_provider.py b/tests/auth/test_confidential_client_oauth_flow_provider.py index 7fca4c3a1..467a83da0 100644 --- a/tests/auth/test_confidential_client_oauth_flow_provider.py +++ b/tests/auth/test_confidential_client_oauth_flow_provider.py @@ -21,9 +21,9 @@ from mockito import unstub from mockito import when -from foundry._core.http_client import HttpClient -from foundry._core.oauth_utils import ConfidentialClientOAuthFlowProvider -from foundry._core.oauth_utils import OAuthUtils +from foundry_sdk._core.http_client import HttpClient +from foundry_sdk._core.oauth_utils import ConfidentialClientOAuthFlowProvider +from foundry_sdk._core.oauth_utils import OAuthUtils @pytest.fixture(name="client", scope="module") diff --git a/tests/auth/test_oauth_utils.py b/tests/auth/test_oauth_utils.py index fc18306fe..707ab5998 100644 --- a/tests/auth/test_oauth_utils.py +++ b/tests/auth/test_oauth_utils.py @@ -18,11 +18,11 @@ from mockito import unstub from mockito import when -from foundry._core.oauth_utils import ConfidentialClientOAuthFlowProvider -from foundry._core.oauth_utils import OAuthToken -from foundry._core.oauth_utils import OAuthTokenResponse -from foundry._core.oauth_utils import OAuthUtils -from foundry._core.oauth_utils import PublicClientOAuthFlowProvider +from foundry_sdk._core.oauth_utils import ConfidentialClientOAuthFlowProvider +from foundry_sdk._core.oauth_utils import OAuthToken +from foundry_sdk._core.oauth_utils import OAuthTokenResponse +from foundry_sdk._core.oauth_utils import OAuthUtils +from foundry_sdk._core.oauth_utils import PublicClientOAuthFlowProvider def test_get_token_uri(): @@ -71,7 +71,7 @@ def test_public_client_with_scopes(): def test_token_from_dict(): - import foundry._core.oauth_utils as module_under_test + import foundry_sdk._core.oauth_utils as module_under_test when(module_under_test.time).time().thenReturn(123) token = OAuthToken( diff --git a/tests/auth/test_public_client.py b/tests/auth/test_public_client.py index 3bf74019e..507eb6b18 100644 --- a/tests/auth/test_public_client.py +++ b/tests/auth/test_public_client.py @@ -23,12 +23,12 @@ from mockito import verify from mockito import when -from foundry._core.auth_utils import Token -from foundry._core.oauth_utils import AuthorizeRequest -from foundry._core.oauth_utils import OAuthToken -from foundry._core.oauth_utils import OAuthTokenResponse -from foundry._core.public_client_auth import PublicClientAuth -from foundry._errors.not_authenticated import NotAuthenticated +from foundry_sdk._core.auth_utils import Token +from foundry_sdk._core.oauth_utils import AuthorizeRequest +from foundry_sdk._core.oauth_utils import OAuthToken +from foundry_sdk._core.oauth_utils import OAuthTokenResponse +from foundry_sdk._core.public_client_auth import PublicClientAuth +from foundry_sdk._errors.not_authenticated import NotAuthenticated RESPONSE = { "access_token": "access_token", diff --git a/tests/auth/test_public_client_oauth_flow_provider.py b/tests/auth/test_public_client_oauth_flow_provider.py index 7fee844c6..991df1ee9 100644 --- a/tests/auth/test_public_client_oauth_flow_provider.py +++ b/tests/auth/test_public_client_oauth_flow_provider.py @@ -22,9 +22,9 @@ from mockito import unstub from mockito import when -from foundry._core.http_client import HttpClient -from foundry._core.oauth_utils import OAuthUtils -from foundry._core.oauth_utils import PublicClientOAuthFlowProvider +from foundry_sdk._core.http_client import HttpClient +from foundry_sdk._core.oauth_utils import OAuthUtils +from foundry_sdk._core.oauth_utils import PublicClientOAuthFlowProvider @pytest.fixture(name="client", scope="module") diff --git a/tests/auth/test_user_auth_token_client.py b/tests/auth/test_user_auth_token_client.py index 525ce5242..e0f2164c8 100644 --- a/tests/auth/test_user_auth_token_client.py +++ b/tests/auth/test_user_auth_token_client.py @@ -17,7 +17,7 @@ import pytest -from foundry import UserTokenAuth +from foundry_sdk import UserTokenAuth def test_missing_token_raises_type_error(): diff --git a/tests/test_api_client.py b/tests/test_api_client.py index a00ab6ae4..cb9250632 100644 --- a/tests/test_api_client.py +++ b/tests/test_api_client.py @@ -27,28 +27,28 @@ import httpx import pytest -from foundry import ApiNotFoundError -from foundry import BadRequestError -from foundry import ConfidentialClientAuth -from foundry import Config -from foundry import ConflictError -from foundry import ConnectionError -from foundry import InternalServerError -from foundry import NotFoundError -from foundry import PalantirRPCException -from foundry import PermissionDeniedError -from foundry import ProxyError -from foundry import RateLimitError -from foundry import ReadTimeout -from foundry import RequestEntityTooLargeError -from foundry import StreamConsumedError -from foundry import UnauthorizedError -from foundry import UnprocessableEntityError -from foundry import UserTokenAuth -from foundry import WriteTimeout -from foundry import __version__ -from foundry._core import ApiClient -from foundry._core import RequestInfo +from foundry_sdk import ApiNotFoundError +from foundry_sdk import BadRequestError +from foundry_sdk import ConfidentialClientAuth +from foundry_sdk import Config +from foundry_sdk import ConflictError +from foundry_sdk import ConnectionError +from foundry_sdk import InternalServerError +from foundry_sdk import NotFoundError +from foundry_sdk import PalantirRPCException +from foundry_sdk import PermissionDeniedError +from foundry_sdk import ProxyError +from foundry_sdk import RateLimitError +from foundry_sdk import ReadTimeout +from foundry_sdk import RequestEntityTooLargeError +from foundry_sdk import StreamConsumedError +from foundry_sdk import UnauthorizedError +from foundry_sdk import UnprocessableEntityError +from foundry_sdk import UserTokenAuth +from foundry_sdk import WriteTimeout +from foundry_sdk import __version__ +from foundry_sdk._core import ApiClient +from foundry_sdk._core import RequestInfo from tests.server import FooData HOSTNAME = "localhost:8123" diff --git a/tests/test_discriminators.py b/tests/test_discriminators.py index fcf58c2b4..18561a459 100644 --- a/tests/test_discriminators.py +++ b/tests/test_discriminators.py @@ -16,24 +16,26 @@ import pydantic import pytest -from foundry.v1.core import models as models_core_v1 -from foundry.v1.datasets import models as models_datasets_v1 -from foundry.v1.geo import models as models_geo_v1 -from foundry.v1.ontologies import models as models_ontologies_v1 -from foundry.v2.admin import models as models_admin_v2 -from foundry.v2.aip_agents import models as models_aip_agents_v2 -from foundry.v2.connectivity import models as models_connectivity_v2 -from foundry.v2.core import models as models_core_v2 -from foundry.v2.datasets import models as models_datasets_v2 -from foundry.v2.filesystem import models as models_filesystem_v2 -from foundry.v2.functions import models as models_functions_v2 -from foundry.v2.geo import models as models_geo_v2 -from foundry.v2.media_sets import models as models_media_sets_v2 -from foundry.v2.ontologies import models as models_ontologies_v2 -from foundry.v2.orchestration import models as models_orchestration_v2 -from foundry.v2.sql_queries import models as models_sql_queries_v2 -from foundry.v2.streams import models as models_streams_v2 -from foundry.v2.third_party_applications import models as models_third_party_applications_v2 # NOQA +from foundry_sdk.v1.core import models as models_core_v1 +from foundry_sdk.v1.datasets import models as models_datasets_v1 +from foundry_sdk.v1.geo import models as models_geo_v1 +from foundry_sdk.v1.ontologies import models as models_ontologies_v1 +from foundry_sdk.v2.admin import models as models_admin_v2 +from foundry_sdk.v2.aip_agents import models as models_aip_agents_v2 +from foundry_sdk.v2.connectivity import models as models_connectivity_v2 +from foundry_sdk.v2.core import models as models_core_v2 +from foundry_sdk.v2.datasets import models as models_datasets_v2 +from foundry_sdk.v2.filesystem import models as models_filesystem_v2 +from foundry_sdk.v2.functions import models as models_functions_v2 +from foundry_sdk.v2.geo import models as models_geo_v2 +from foundry_sdk.v2.media_sets import models as models_media_sets_v2 +from foundry_sdk.v2.ontologies import models as models_ontologies_v2 +from foundry_sdk.v2.orchestration import models as models_orchestration_v2 +from foundry_sdk.v2.sql_queries import models as models_sql_queries_v2 +from foundry_sdk.v2.streams import models as models_streams_v2 +from foundry_sdk.v2.third_party_applications import ( + models as models_third_party_applications_v2, +) # NOQA def test_can_validate_types(): diff --git a/tests/test_errors.py b/tests/test_errors.py index 7f224660d..f244833ac 100644 --- a/tests/test_errors.py +++ b/tests/test_errors.py @@ -2,10 +2,10 @@ import pytest -from foundry import PalantirRPCException -from foundry._errors.utils import deserialize_error -from foundry.v1.datasets.errors import AbortTransactionPermissionDenied -from foundry.v1.datasets.errors import BranchNotFound +from foundry_sdk import PalantirRPCException +from foundry_sdk._errors.utils import deserialize_error +from foundry_sdk.v1.datasets.errors import AbortTransactionPermissionDenied +from foundry_sdk.v1.datasets.errors import BranchNotFound ERRORS_MAP = { "AbortTransactionPermissionDenied": AbortTransactionPermissionDenied, diff --git a/tests/test_exception.py b/tests/test_exception.py index 9b785b476..41065a3ec 100644 --- a/tests/test_exception.py +++ b/tests/test_exception.py @@ -24,11 +24,11 @@ import pydantic import pytest -from foundry import _errors -from foundry._errors.palantir_rpc_exception import PalantirRPCException -from foundry._errors.sdk_internal_error import PalantirException -from foundry._errors.sdk_internal_error import SDKInternalError -from foundry._errors.sdk_internal_error import handle_unexpected +from foundry_sdk import _errors +from foundry_sdk._errors.palantir_rpc_exception import PalantirRPCException +from foundry_sdk._errors.sdk_internal_error import PalantirException +from foundry_sdk._errors.sdk_internal_error import SDKInternalError +from foundry_sdk._errors.sdk_internal_error import handle_unexpected def find_exception_subclasses(module: ModuleType) -> List[Type[Exception]]: diff --git a/tests/test_http_client.py b/tests/test_http_client.py index 8b3fce6e9..862c7c21e 100644 --- a/tests/test_http_client.py +++ b/tests/test_http_client.py @@ -27,9 +27,9 @@ import pytest from httpx._utils import URLPattern -from foundry._core.config import Config -from foundry._core.http_client import HttpClient -from foundry._versions import __version__ +from foundry_sdk._core.config import Config +from foundry_sdk._core.http_client import HttpClient +from foundry_sdk._versions import __version__ def assert_http_transport(transport: Optional[httpx.BaseTransport]) -> httpx.HTTPTransport: diff --git a/tests/test_performance.py b/tests/test_performance.py index 4555a7826..178509fbf 100644 --- a/tests/test_performance.py +++ b/tests/test_performance.py @@ -5,7 +5,9 @@ def test_import_v1_client_performance(): import_time = timeit.timeit( - stmt="import foundry.v1", setup="import sys; sys.modules.pop('foundry.v1', None);", number=1 + stmt="import foundry_sdk.v1", + setup="import sys; sys.modules.pop('foundry_sdk.v1', None);", + number=1, ) assert import_time < 0.25 @@ -13,8 +15,8 @@ def test_import_v1_client_performance(): def test_client_v1_initialization_performance(): init_time = timeit.timeit( - stmt="foundry.v1.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost')", - setup="import sys; sys.modules.pop('foundry.v1', None);import foundry; import foundry.v1", + stmt="foundry_sdk.v1.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost')", + setup="import sys; sys.modules.pop('foundry_sdk.v1', None);import foundry_sdk; import foundry_sdk.v1", number=1, ) @@ -23,8 +25,8 @@ def test_client_v1_initialization_performance(): def test_datasets_v1_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v1.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').datasets", - setup="import sys; sys.modules.pop('foundry.v1', None);import foundry; import foundry.v1", + stmt="foundry_sdk.v1.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').datasets", + setup="import sys; sys.modules.pop('foundry_sdk.v1', None);import foundry_sdk; import foundry_sdk.v1", number=1, ) @@ -33,8 +35,8 @@ def test_datasets_v1_client_access_performance(): def test_datasets_v1_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v1.datasets.models", - setup="import sys; sys.modules.pop('foundry.v1.datasets.models', None)", + stmt="import foundry_sdk.v1.datasets.models", + setup="import sys; sys.modules.pop('foundry_sdk.v1.datasets.models', None)", number=1, ) @@ -43,8 +45,8 @@ def test_datasets_v1_models_import_performance(): def test_ontologies_v1_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v1.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').ontologies", - setup="import sys; sys.modules.pop('foundry.v1', None);import foundry; import foundry.v1", + stmt="foundry_sdk.v1.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').ontologies", + setup="import sys; sys.modules.pop('foundry_sdk.v1', None);import foundry_sdk; import foundry_sdk.v1", number=1, ) @@ -53,8 +55,8 @@ def test_ontologies_v1_client_access_performance(): def test_ontologies_v1_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v1.ontologies.models", - setup="import sys; sys.modules.pop('foundry.v1.ontologies.models', None)", + stmt="import foundry_sdk.v1.ontologies.models", + setup="import sys; sys.modules.pop('foundry_sdk.v1.ontologies.models', None)", number=1, ) @@ -63,7 +65,9 @@ def test_ontologies_v1_models_import_performance(): def test_import_v2_client_performance(): import_time = timeit.timeit( - stmt="import foundry.v2", setup="import sys; sys.modules.pop('foundry.v2', None);", number=1 + stmt="import foundry_sdk.v2", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);", + number=1, ) assert import_time < 0.25 @@ -71,8 +75,8 @@ def test_import_v2_client_performance(): def test_client_v2_initialization_performance(): init_time = timeit.timeit( - stmt="foundry.v2.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost')", - setup="import sys; sys.modules.pop('foundry.v2', None);import foundry; import foundry.v2", + stmt="foundry_sdk.v2.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost')", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);import foundry_sdk; import foundry_sdk.v2", number=1, ) @@ -81,8 +85,8 @@ def test_client_v2_initialization_performance(): def test_admin_v2_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v2.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').admin", - setup="import sys; sys.modules.pop('foundry.v2', None);import foundry; import foundry.v2", + stmt="foundry_sdk.v2.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').admin", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);import foundry_sdk; import foundry_sdk.v2", number=1, ) @@ -91,8 +95,8 @@ def test_admin_v2_client_access_performance(): def test_admin_v2_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v2.admin.models", - setup="import sys; sys.modules.pop('foundry.v2.admin.models', None)", + stmt="import foundry_sdk.v2.admin.models", + setup="import sys; sys.modules.pop('foundry_sdk.v2.admin.models', None)", number=1, ) @@ -101,8 +105,8 @@ def test_admin_v2_models_import_performance(): def test_aip_agents_v2_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v2.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').aip_agents", - setup="import sys; sys.modules.pop('foundry.v2', None);import foundry; import foundry.v2", + stmt="foundry_sdk.v2.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').aip_agents", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);import foundry_sdk; import foundry_sdk.v2", number=1, ) @@ -111,8 +115,8 @@ def test_aip_agents_v2_client_access_performance(): def test_aip_agents_v2_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v2.aip_agents.models", - setup="import sys; sys.modules.pop('foundry.v2.aip_agents.models', None)", + stmt="import foundry_sdk.v2.aip_agents.models", + setup="import sys; sys.modules.pop('foundry_sdk.v2.aip_agents.models', None)", number=1, ) @@ -121,8 +125,8 @@ def test_aip_agents_v2_models_import_performance(): def test_connectivity_v2_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v2.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').connectivity", - setup="import sys; sys.modules.pop('foundry.v2', None);import foundry; import foundry.v2", + stmt="foundry_sdk.v2.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').connectivity", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);import foundry_sdk; import foundry_sdk.v2", number=1, ) @@ -131,8 +135,8 @@ def test_connectivity_v2_client_access_performance(): def test_connectivity_v2_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v2.connectivity.models", - setup="import sys; sys.modules.pop('foundry.v2.connectivity.models', None)", + stmt="import foundry_sdk.v2.connectivity.models", + setup="import sys; sys.modules.pop('foundry_sdk.v2.connectivity.models', None)", number=1, ) @@ -141,8 +145,8 @@ def test_connectivity_v2_models_import_performance(): def test_datasets_v2_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v2.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').datasets", - setup="import sys; sys.modules.pop('foundry.v2', None);import foundry; import foundry.v2", + stmt="foundry_sdk.v2.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').datasets", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);import foundry_sdk; import foundry_sdk.v2", number=1, ) @@ -151,8 +155,8 @@ def test_datasets_v2_client_access_performance(): def test_datasets_v2_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v2.datasets.models", - setup="import sys; sys.modules.pop('foundry.v2.datasets.models', None)", + stmt="import foundry_sdk.v2.datasets.models", + setup="import sys; sys.modules.pop('foundry_sdk.v2.datasets.models', None)", number=1, ) @@ -161,8 +165,8 @@ def test_datasets_v2_models_import_performance(): def test_filesystem_v2_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v2.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').filesystem", - setup="import sys; sys.modules.pop('foundry.v2', None);import foundry; import foundry.v2", + stmt="foundry_sdk.v2.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').filesystem", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);import foundry_sdk; import foundry_sdk.v2", number=1, ) @@ -171,8 +175,8 @@ def test_filesystem_v2_client_access_performance(): def test_filesystem_v2_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v2.filesystem.models", - setup="import sys; sys.modules.pop('foundry.v2.filesystem.models', None)", + stmt="import foundry_sdk.v2.filesystem.models", + setup="import sys; sys.modules.pop('foundry_sdk.v2.filesystem.models', None)", number=1, ) @@ -181,8 +185,8 @@ def test_filesystem_v2_models_import_performance(): def test_functions_v2_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v2.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').functions", - setup="import sys; sys.modules.pop('foundry.v2', None);import foundry; import foundry.v2", + stmt="foundry_sdk.v2.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').functions", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);import foundry_sdk; import foundry_sdk.v2", number=1, ) @@ -191,8 +195,8 @@ def test_functions_v2_client_access_performance(): def test_functions_v2_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v2.functions.models", - setup="import sys; sys.modules.pop('foundry.v2.functions.models', None)", + stmt="import foundry_sdk.v2.functions.models", + setup="import sys; sys.modules.pop('foundry_sdk.v2.functions.models', None)", number=1, ) @@ -201,8 +205,8 @@ def test_functions_v2_models_import_performance(): def test_media_sets_v2_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v2.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').media_sets", - setup="import sys; sys.modules.pop('foundry.v2', None);import foundry; import foundry.v2", + stmt="foundry_sdk.v2.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').media_sets", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);import foundry_sdk; import foundry_sdk.v2", number=1, ) @@ -211,8 +215,8 @@ def test_media_sets_v2_client_access_performance(): def test_media_sets_v2_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v2.media_sets.models", - setup="import sys; sys.modules.pop('foundry.v2.media_sets.models', None)", + stmt="import foundry_sdk.v2.media_sets.models", + setup="import sys; sys.modules.pop('foundry_sdk.v2.media_sets.models', None)", number=1, ) @@ -221,8 +225,8 @@ def test_media_sets_v2_models_import_performance(): def test_ontologies_v2_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v2.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').ontologies", - setup="import sys; sys.modules.pop('foundry.v2', None);import foundry; import foundry.v2", + stmt="foundry_sdk.v2.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').ontologies", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);import foundry_sdk; import foundry_sdk.v2", number=1, ) @@ -231,8 +235,8 @@ def test_ontologies_v2_client_access_performance(): def test_ontologies_v2_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v2.ontologies.models", - setup="import sys; sys.modules.pop('foundry.v2.ontologies.models', None)", + stmt="import foundry_sdk.v2.ontologies.models", + setup="import sys; sys.modules.pop('foundry_sdk.v2.ontologies.models', None)", number=1, ) @@ -241,8 +245,8 @@ def test_ontologies_v2_models_import_performance(): def test_orchestration_v2_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v2.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').orchestration", - setup="import sys; sys.modules.pop('foundry.v2', None);import foundry; import foundry.v2", + stmt="foundry_sdk.v2.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').orchestration", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);import foundry_sdk; import foundry_sdk.v2", number=1, ) @@ -251,8 +255,8 @@ def test_orchestration_v2_client_access_performance(): def test_orchestration_v2_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v2.orchestration.models", - setup="import sys; sys.modules.pop('foundry.v2.orchestration.models', None)", + stmt="import foundry_sdk.v2.orchestration.models", + setup="import sys; sys.modules.pop('foundry_sdk.v2.orchestration.models', None)", number=1, ) @@ -261,8 +265,8 @@ def test_orchestration_v2_models_import_performance(): def test_sql_queries_v2_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v2.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').sql_queries", - setup="import sys; sys.modules.pop('foundry.v2', None);import foundry; import foundry.v2", + stmt="foundry_sdk.v2.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').sql_queries", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);import foundry_sdk; import foundry_sdk.v2", number=1, ) @@ -271,8 +275,8 @@ def test_sql_queries_v2_client_access_performance(): def test_sql_queries_v2_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v2.sql_queries.models", - setup="import sys; sys.modules.pop('foundry.v2.sql_queries.models', None)", + stmt="import foundry_sdk.v2.sql_queries.models", + setup="import sys; sys.modules.pop('foundry_sdk.v2.sql_queries.models', None)", number=1, ) @@ -281,8 +285,8 @@ def test_sql_queries_v2_models_import_performance(): def test_streams_v2_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v2.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').streams", - setup="import sys; sys.modules.pop('foundry.v2', None);import foundry; import foundry.v2", + stmt="foundry_sdk.v2.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').streams", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);import foundry_sdk; import foundry_sdk.v2", number=1, ) @@ -291,8 +295,8 @@ def test_streams_v2_client_access_performance(): def test_streams_v2_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v2.streams.models", - setup="import sys; sys.modules.pop('foundry.v2.streams.models', None)", + stmt="import foundry_sdk.v2.streams.models", + setup="import sys; sys.modules.pop('foundry_sdk.v2.streams.models', None)", number=1, ) @@ -301,8 +305,8 @@ def test_streams_v2_models_import_performance(): def test_third_party_applications_v2_client_access_performance(): init_and_access_time = timeit.timeit( - stmt="foundry.v2.FoundryClient(foundry.UserTokenAuth(token='token'), hostname='localhost').third_party_applications", - setup="import sys; sys.modules.pop('foundry.v2', None);import foundry; import foundry.v2", + stmt="foundry_sdk.v2.FoundryClient(foundry_sdk.UserTokenAuth(token='token'), hostname='localhost').third_party_applications", + setup="import sys; sys.modules.pop('foundry_sdk.v2', None);import foundry_sdk; import foundry_sdk.v2", number=1, ) @@ -311,8 +315,8 @@ def test_third_party_applications_v2_client_access_performance(): def test_third_party_applications_v2_models_import_performance(): init_and_access_time = timeit.timeit( - stmt="import foundry.v2.third_party_applications.models", - setup="import sys; sys.modules.pop('foundry.v2.third_party_applications.models', None)", + stmt="import foundry_sdk.v2.third_party_applications.models", + setup="import sys; sys.modules.pop('foundry_sdk.v2.third_party_applications.models', None)", number=1, ) diff --git a/tests/test_resorce_import.py b/tests/test_resorce_import.py index e854195bd..988fa1fdd 100644 --- a/tests/test_resorce_import.py +++ b/tests/test_resorce_import.py @@ -1,365 +1,367 @@ def test_datasets_v1_branch_import(): - from foundry.v1.datasets.branch import BranchClient + from foundry_sdk.v1.datasets.branch import BranchClient assert BranchClient is not None def test_datasets_v1_dataset_import(): - from foundry.v1.datasets.dataset import DatasetClient + from foundry_sdk.v1.datasets.dataset import DatasetClient assert DatasetClient is not None def test_datasets_v1_file_import(): - from foundry.v1.datasets.file import FileClient + from foundry_sdk.v1.datasets.file import FileClient assert FileClient is not None def test_datasets_v1_transaction_import(): - from foundry.v1.datasets.transaction import TransactionClient + from foundry_sdk.v1.datasets.transaction import TransactionClient assert TransactionClient is not None def test_ontologies_v1_action_import(): - from foundry.v1.ontologies.action import ActionClient + from foundry_sdk.v1.ontologies.action import ActionClient assert ActionClient is not None def test_ontologies_v1_action_type_import(): - from foundry.v1.ontologies.action_type import ActionTypeClient + from foundry_sdk.v1.ontologies.action_type import ActionTypeClient assert ActionTypeClient is not None def test_ontologies_v1_attachment_import(): - from foundry.v1.ontologies.attachment import AttachmentClient + from foundry_sdk.v1.ontologies.attachment import AttachmentClient assert AttachmentClient is not None def test_ontologies_v1_object_type_import(): - from foundry.v1.ontologies.object_type import ObjectTypeClient + from foundry_sdk.v1.ontologies.object_type import ObjectTypeClient assert ObjectTypeClient is not None def test_ontologies_v1_ontology_import(): - from foundry.v1.ontologies.ontology import OntologyClient + from foundry_sdk.v1.ontologies.ontology import OntologyClient assert OntologyClient is not None def test_ontologies_v1_ontology_object_import(): - from foundry.v1.ontologies.ontology_object import OntologyObjectClient + from foundry_sdk.v1.ontologies.ontology_object import OntologyObjectClient assert OntologyObjectClient is not None def test_ontologies_v1_query_import(): - from foundry.v1.ontologies.query import QueryClient + from foundry_sdk.v1.ontologies.query import QueryClient assert QueryClient is not None def test_ontologies_v1_query_type_import(): - from foundry.v1.ontologies.query_type import QueryTypeClient + from foundry_sdk.v1.ontologies.query_type import QueryTypeClient assert QueryTypeClient is not None def test_admin_v2_authentication_provider_import(): - from foundry.v2.admin.authentication_provider import AuthenticationProviderClient + from foundry_sdk.v2.admin.authentication_provider import AuthenticationProviderClient # NOQA assert AuthenticationProviderClient is not None def test_admin_v2_enrollment_import(): - from foundry.v2.admin.enrollment import EnrollmentClient + from foundry_sdk.v2.admin.enrollment import EnrollmentClient assert EnrollmentClient is not None def test_admin_v2_group_import(): - from foundry.v2.admin.group import GroupClient + from foundry_sdk.v2.admin.group import GroupClient assert GroupClient is not None def test_admin_v2_group_member_import(): - from foundry.v2.admin.group_member import GroupMemberClient + from foundry_sdk.v2.admin.group_member import GroupMemberClient assert GroupMemberClient is not None def test_admin_v2_group_membership_import(): - from foundry.v2.admin.group_membership import GroupMembershipClient + from foundry_sdk.v2.admin.group_membership import GroupMembershipClient assert GroupMembershipClient is not None def test_admin_v2_group_provider_info_import(): - from foundry.v2.admin.group_provider_info import GroupProviderInfoClient + from foundry_sdk.v2.admin.group_provider_info import GroupProviderInfoClient assert GroupProviderInfoClient is not None def test_admin_v2_host_import(): - from foundry.v2.admin.host import HostClient + from foundry_sdk.v2.admin.host import HostClient assert HostClient is not None def test_admin_v2_marking_import(): - from foundry.v2.admin.marking import MarkingClient + from foundry_sdk.v2.admin.marking import MarkingClient assert MarkingClient is not None def test_admin_v2_marking_category_import(): - from foundry.v2.admin.marking_category import MarkingCategoryClient + from foundry_sdk.v2.admin.marking_category import MarkingCategoryClient assert MarkingCategoryClient is not None def test_admin_v2_marking_member_import(): - from foundry.v2.admin.marking_member import MarkingMemberClient + from foundry_sdk.v2.admin.marking_member import MarkingMemberClient assert MarkingMemberClient is not None def test_admin_v2_marking_role_assignment_import(): - from foundry.v2.admin.marking_role_assignment import MarkingRoleAssignmentClient + from foundry_sdk.v2.admin.marking_role_assignment import MarkingRoleAssignmentClient assert MarkingRoleAssignmentClient is not None def test_admin_v2_organization_import(): - from foundry.v2.admin.organization import OrganizationClient + from foundry_sdk.v2.admin.organization import OrganizationClient assert OrganizationClient is not None def test_admin_v2_user_import(): - from foundry.v2.admin.user import UserClient + from foundry_sdk.v2.admin.user import UserClient assert UserClient is not None def test_admin_v2_user_provider_info_import(): - from foundry.v2.admin.user_provider_info import UserProviderInfoClient + from foundry_sdk.v2.admin.user_provider_info import UserProviderInfoClient assert UserProviderInfoClient is not None def test_aip_agents_v2_agent_import(): - from foundry.v2.aip_agents.agent import AgentClient + from foundry_sdk.v2.aip_agents.agent import AgentClient assert AgentClient is not None def test_aip_agents_v2_agent_version_import(): - from foundry.v2.aip_agents.agent_version import AgentVersionClient + from foundry_sdk.v2.aip_agents.agent_version import AgentVersionClient assert AgentVersionClient is not None def test_aip_agents_v2_content_import(): - from foundry.v2.aip_agents.content import ContentClient + from foundry_sdk.v2.aip_agents.content import ContentClient assert ContentClient is not None def test_aip_agents_v2_session_import(): - from foundry.v2.aip_agents.session import SessionClient + from foundry_sdk.v2.aip_agents.session import SessionClient assert SessionClient is not None def test_connectivity_v2_connection_import(): - from foundry.v2.connectivity.connection import ConnectionClient + from foundry_sdk.v2.connectivity.connection import ConnectionClient assert ConnectionClient is not None def test_connectivity_v2_file_import_import(): - from foundry.v2.connectivity.file_import import FileImportClient + from foundry_sdk.v2.connectivity.file_import import FileImportClient assert FileImportClient is not None def test_connectivity_v2_table_import_import(): - from foundry.v2.connectivity.table_import import TableImportClient + from foundry_sdk.v2.connectivity.table_import import TableImportClient assert TableImportClient is not None def test_datasets_v2_branch_import(): - from foundry.v2.datasets.branch import BranchClient + from foundry_sdk.v2.datasets.branch import BranchClient assert BranchClient is not None def test_datasets_v2_dataset_import(): - from foundry.v2.datasets.dataset import DatasetClient + from foundry_sdk.v2.datasets.dataset import DatasetClient assert DatasetClient is not None def test_datasets_v2_file_import(): - from foundry.v2.datasets.file import FileClient + from foundry_sdk.v2.datasets.file import FileClient assert FileClient is not None def test_datasets_v2_transaction_import(): - from foundry.v2.datasets.transaction import TransactionClient + from foundry_sdk.v2.datasets.transaction import TransactionClient assert TransactionClient is not None def test_filesystem_v2_folder_import(): - from foundry.v2.filesystem.folder import FolderClient + from foundry_sdk.v2.filesystem.folder import FolderClient assert FolderClient is not None def test_filesystem_v2_project_import(): - from foundry.v2.filesystem.project import ProjectClient + from foundry_sdk.v2.filesystem.project import ProjectClient assert ProjectClient is not None def test_filesystem_v2_resource_import(): - from foundry.v2.filesystem.resource import ResourceClient + from foundry_sdk.v2.filesystem.resource import ResourceClient assert ResourceClient is not None def test_filesystem_v2_resource_role_import(): - from foundry.v2.filesystem.resource_role import ResourceRoleClient + from foundry_sdk.v2.filesystem.resource_role import ResourceRoleClient assert ResourceRoleClient is not None def test_filesystem_v2_space_import(): - from foundry.v2.filesystem.space import SpaceClient + from foundry_sdk.v2.filesystem.space import SpaceClient assert SpaceClient is not None def test_functions_v2_query_import(): - from foundry.v2.functions.query import QueryClient + from foundry_sdk.v2.functions.query import QueryClient assert QueryClient is not None def test_functions_v2_value_type_import(): - from foundry.v2.functions.value_type import ValueTypeClient + from foundry_sdk.v2.functions.value_type import ValueTypeClient assert ValueTypeClient is not None def test_functions_v2_version_id_import(): - from foundry.v2.functions.version_id import VersionIdClient + from foundry_sdk.v2.functions.version_id import VersionIdClient assert VersionIdClient is not None def test_media_sets_v2_media_set_import(): - from foundry.v2.media_sets.media_set import MediaSetClient + from foundry_sdk.v2.media_sets.media_set import MediaSetClient assert MediaSetClient is not None def test_ontologies_v2_action_import(): - from foundry.v2.ontologies.action import ActionClient + from foundry_sdk.v2.ontologies.action import ActionClient assert ActionClient is not None def test_ontologies_v2_action_type_import(): - from foundry.v2.ontologies.action_type import ActionTypeClient + from foundry_sdk.v2.ontologies.action_type import ActionTypeClient assert ActionTypeClient is not None def test_ontologies_v2_attachment_import(): - from foundry.v2.ontologies.attachment import AttachmentClient + from foundry_sdk.v2.ontologies.attachment import AttachmentClient assert AttachmentClient is not None def test_ontologies_v2_attachment_property_import(): - from foundry.v2.ontologies.attachment_property import AttachmentPropertyClient + from foundry_sdk.v2.ontologies.attachment_property import AttachmentPropertyClient assert AttachmentPropertyClient is not None def test_ontologies_v2_linked_object_import(): - from foundry.v2.ontologies.linked_object import LinkedObjectClient + from foundry_sdk.v2.ontologies.linked_object import LinkedObjectClient assert LinkedObjectClient is not None def test_ontologies_v2_media_reference_property_import(): - from foundry.v2.ontologies.media_reference_property import MediaReferencePropertyClient # NOQA + from foundry_sdk.v2.ontologies.media_reference_property import ( + MediaReferencePropertyClient, + ) # NOQA assert MediaReferencePropertyClient is not None def test_ontologies_v2_object_type_import(): - from foundry.v2.ontologies.object_type import ObjectTypeClient + from foundry_sdk.v2.ontologies.object_type import ObjectTypeClient assert ObjectTypeClient is not None def test_ontologies_v2_ontology_import(): - from foundry.v2.ontologies.ontology import OntologyClient + from foundry_sdk.v2.ontologies.ontology import OntologyClient assert OntologyClient is not None def test_ontologies_v2_ontology_interface_import(): - from foundry.v2.ontologies.ontology_interface import OntologyInterfaceClient + from foundry_sdk.v2.ontologies.ontology_interface import OntologyInterfaceClient assert OntologyInterfaceClient is not None def test_ontologies_v2_ontology_object_import(): - from foundry.v2.ontologies.ontology_object import OntologyObjectClient + from foundry_sdk.v2.ontologies.ontology_object import OntologyObjectClient assert OntologyObjectClient is not None def test_ontologies_v2_ontology_object_set_import(): - from foundry.v2.ontologies.ontology_object_set import OntologyObjectSetClient + from foundry_sdk.v2.ontologies.ontology_object_set import OntologyObjectSetClient assert OntologyObjectSetClient is not None def test_ontologies_v2_query_import(): - from foundry.v2.ontologies.query import QueryClient + from foundry_sdk.v2.ontologies.query import QueryClient assert QueryClient is not None def test_ontologies_v2_query_type_import(): - from foundry.v2.ontologies.query_type import QueryTypeClient + from foundry_sdk.v2.ontologies.query_type import QueryTypeClient assert QueryTypeClient is not None def test_ontologies_v2_time_series_property_v2_import(): - from foundry.v2.ontologies.time_series_property_v2 import TimeSeriesPropertyV2Client + from foundry_sdk.v2.ontologies.time_series_property_v2 import TimeSeriesPropertyV2Client # NOQA assert TimeSeriesPropertyV2Client is not None def test_ontologies_v2_time_series_value_bank_property_import(): - from foundry.v2.ontologies.time_series_value_bank_property import ( + from foundry_sdk.v2.ontologies.time_series_value_bank_property import ( TimeSeriesValueBankPropertyClient, ) # NOQA @@ -367,49 +369,49 @@ def test_ontologies_v2_time_series_value_bank_property_import(): def test_orchestration_v2_build_import(): - from foundry.v2.orchestration.build import BuildClient + from foundry_sdk.v2.orchestration.build import BuildClient assert BuildClient is not None def test_orchestration_v2_job_import(): - from foundry.v2.orchestration.job import JobClient + from foundry_sdk.v2.orchestration.job import JobClient assert JobClient is not None def test_orchestration_v2_schedule_import(): - from foundry.v2.orchestration.schedule import ScheduleClient + from foundry_sdk.v2.orchestration.schedule import ScheduleClient assert ScheduleClient is not None def test_orchestration_v2_schedule_version_import(): - from foundry.v2.orchestration.schedule_version import ScheduleVersionClient + from foundry_sdk.v2.orchestration.schedule_version import ScheduleVersionClient assert ScheduleVersionClient is not None def test_sql_queries_v2_query_import(): - from foundry.v2.sql_queries.query import QueryClient + from foundry_sdk.v2.sql_queries.query import QueryClient assert QueryClient is not None def test_streams_v2_dataset_import(): - from foundry.v2.streams.dataset import DatasetClient + from foundry_sdk.v2.streams.dataset import DatasetClient assert DatasetClient is not None def test_streams_v2_stream_import(): - from foundry.v2.streams.stream import StreamClient + from foundry_sdk.v2.streams.stream import StreamClient assert StreamClient is not None def test_third_party_applications_v2_third_party_application_import(): - from foundry.v2.third_party_applications.third_party_application import ( + from foundry_sdk.v2.third_party_applications.third_party_application import ( ThirdPartyApplicationClient, ) # NOQA @@ -417,12 +419,12 @@ def test_third_party_applications_v2_third_party_application_import(): def test_third_party_applications_v2_version_import(): - from foundry.v2.third_party_applications.version import VersionClient + from foundry_sdk.v2.third_party_applications.version import VersionClient assert VersionClient is not None def test_third_party_applications_v2_website_import(): - from foundry.v2.third_party_applications.website import WebsiteClient + from foundry_sdk.v2.third_party_applications.website import WebsiteClient assert WebsiteClient is not None diff --git a/tests/test_resource_iterator.py b/tests/test_resource_iterator.py index 9ecc98a35..e83b040e8 100644 --- a/tests/test_resource_iterator.py +++ b/tests/test_resource_iterator.py @@ -18,7 +18,7 @@ import pytest -from foundry._core.resource_iterator import ResourceIterator +from foundry_sdk._core.resource_iterator import ResourceIterator def test_empty_iterator(): diff --git a/tests/test_utils.py b/tests/test_utils.py index bdcfc567b..734c68502 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -6,12 +6,12 @@ from pydantic import BaseModel from pydantic import ValidationError -from foundry._core.utils import RID -from foundry._core.utils import UUID -from foundry._core.utils import Long -from foundry._core.utils import maybe_ignore_preview -from foundry._core.utils import remove_prefixes -from foundry._core.utils import resolve_forward_references +from foundry_sdk._core.utils import RID +from foundry_sdk._core.utils import UUID +from foundry_sdk._core.utils import Long +from foundry_sdk._core.utils import maybe_ignore_preview +from foundry_sdk._core.utils import remove_prefixes +from foundry_sdk._core.utils import resolve_forward_references def test_remove_prefixes(): From 5189a47e2a220e59de00c97c2e36e8e4f51ac1e4 Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Tue, 8 Apr 2025 11:12:37 -0300 Subject: [PATCH 03/11] new --- README.md | 113 +++- docs/v2/Admin/AuthenticationProvider.md | 8 +- docs/v2/Admin/Enrollment.md | 4 +- docs/v2/Admin/Group.md | 12 +- docs/v2/Admin/GroupMember.md | 6 +- docs/v2/Admin/GroupMembership.md | 2 +- docs/v2/Admin/GroupProviderInfo.md | 4 +- docs/v2/Admin/Host.md | 2 +- docs/v2/Admin/Marking.md | 8 +- docs/v2/Admin/MarkingCategory.md | 4 +- docs/v2/Admin/MarkingMember.md | 6 +- docs/v2/Admin/MarkingRoleAssignment.md | 6 +- docs/v2/Admin/Organization.md | 4 +- docs/v2/Admin/User.md | 16 +- docs/v2/Admin/UserProviderInfo.md | 4 +- docs/v2/AipAgents/Agent.md | 4 +- docs/v2/AipAgents/AgentVersion.md | 4 +- docs/v2/AipAgents/Content.md | 2 +- docs/v2/AipAgents/Session.md | 16 +- docs/v2/Connectivity/Connection.md | 18 +- docs/v2/Connectivity/FileImport.md | 16 +- docs/v2/Connectivity/TableImport.md | 12 +- .../models/ConnectionConfiguration.md | 1 + ...CreateConnectionRequestAsPlaintextValue.md | 12 + .../CreateConnectionRequestAsSecretName.md | 12 + ...CreateConnectionRequestBasicCredentials.md | 13 + ...onnectionRequestConnectionConfiguration.md | 1 + ...reateConnectionRequestEncryptedProperty.md | 21 + ...ctionRequestJdbcConnectionConfiguration.md | 2 +- ...ctionRequestSnowflakeAuthenticationMode.md | 17 + ...RequestSnowflakeConnectionConfiguration.md | 18 + ...ConnectionRequestSnowflakeExternalOauth.md | 11 + ...onRequestSnowflakeKeyPairAuthentication.md | 13 + ...reateTableImportRequestJdbcImportConfig.md | 1 + ...mportRequestMicrosoftAccessImportConfig.md | 1 + ...rtRequestMicrosoftSqlServerImportConfig.md | 1 + ...ateTableImportRequestOracleImportConfig.md | 1 + ...ableImportRequestPostgreSqlImportConfig.md | 1 + ...ImportRequestSnowflakeTableImportConfig.md | 13 + ...eateTableImportRequestTableImportConfig.md | 1 + .../DateColumnInitialIncrementalState.md | 14 + .../DecimalColumnInitialIncrementalState.md | 14 + .../IntegerColumnInitialIncrementalState.md | 14 + .../models/JdbcConnectionConfiguration.md | 2 +- .../Connectivity/models/JdbcImportConfig.md | 1 + .../LongColumnInitialIncrementalState.md | 14 + .../models/MicrosoftAccessImportConfig.md | 1 + .../models/MicrosoftSqlServerImportConfig.md | 1 + .../Connectivity/models/OracleImportConfig.md | 1 + .../models/PostgreSqlImportConfig.md | 1 + .../models/SnowflakeAuthenticationMode.md | 17 + .../SnowflakeConnectionConfiguration.md | 19 + .../models/SnowflakeExternalOauth.md | 17 + .../models/SnowflakeKeyPairAuthentication.md | 16 + .../models/SnowflakeTableImportConfig.md | 14 + .../StringColumnInitialIncrementalState.md | 14 + .../Connectivity/models/TableImportConfig.md | 1 + .../TableImportInitialIncrementalState.md | 27 + .../TimestampColumnInitialIncrementalState.md | 13 + docs/v2/Core/models/GeohashType.md | 11 + docs/v2/Datasets/Branch.md | 8 +- docs/v2/Datasets/Dataset.md | 6 +- docs/v2/Datasets/File.md | 10 +- docs/v2/Datasets/Transaction.md | 12 +- docs/v2/Filesystem/Folder.md | 6 +- docs/v2/Filesystem/Project.md | 12 +- docs/v2/Filesystem/Resource.md | 18 +- docs/v2/Filesystem/ResourceRole.md | 6 +- docs/v2/Filesystem/Space.md | 2 +- docs/v2/Functions/Query.md | 6 +- docs/v2/Functions/ValueType.md | 2 +- docs/v2/Functions/VersionId.md | 2 +- docs/v2/MediaSets/MediaSet.md | 16 +- docs/v2/Ontologies/Action.md | 4 +- docs/v2/Ontologies/ActionType.md | 6 +- docs/v2/Ontologies/Attachment.md | 6 +- docs/v2/Ontologies/AttachmentProperty.md | 8 +- docs/v2/Ontologies/CipherTextProperty.md | 68 ++ docs/v2/Ontologies/LinkedObject.md | 4 +- docs/v2/Ontologies/MediaReferenceProperty.md | 6 +- docs/v2/Ontologies/ObjectType.md | 10 +- docs/v2/Ontologies/Ontology.md | 6 +- docs/v2/Ontologies/OntologyInterface.md | 8 +- docs/v2/Ontologies/OntologyObject.md | 10 +- docs/v2/Ontologies/OntologyObjectSet.md | 12 +- docs/v2/Ontologies/Query.md | 2 +- docs/v2/Ontologies/QueryType.md | 4 +- docs/v2/Ontologies/TimeSeriesPropertyV2.md | 6 +- .../Ontologies/TimeSeriesValueBankProperty.md | 4 +- .../Ontologies/models/ActionParameterType.md | 2 + docs/v2/Ontologies/models/DecryptionResult.md | 12 + .../models/Plaintext.md} | 4 +- docs/v2/Orchestration/Build.md | 39 +- docs/v2/Orchestration/Job.md | 4 +- docs/v2/Orchestration/Schedule.md | 16 +- docs/v2/Orchestration/ScheduleVersion.md | 4 +- docs/v2/SqlQueries/{Query.md => SqlQuery.md} | 52 +- .../SqlQueries/models/RunningQueryStatus.md | 2 +- docs/v2/SqlQueries/models/SqlQueryId.md | 11 + .../SqlQueries/models/SucceededQueryStatus.md | 2 +- docs/v2/Streams/Dataset.md | 2 +- docs/v2/Streams/Stream.md | 12 +- .../ThirdPartyApplication.md | 2 +- docs/v2/ThirdPartyApplications/Version.md | 10 +- docs/v2/ThirdPartyApplications/Website.md | 6 +- foundry_sdk/__init__.py | 2 + foundry_sdk/_core/__init__.py | 1 + foundry_sdk/_core/api_client.py | 1 - foundry_sdk/_core/auth_utils.py | 1 - .../_core/compute_module_pipeline_auth.py | 3 - foundry_sdk/_core/confidential_client_auth.py | 13 - foundry_sdk/_core/resource_iterator.py | 9 - foundry_sdk/_core/user_token_auth_client.py | 25 +- foundry_sdk/_core/utils.py | 26 +- foundry_sdk/_versions.py | 2 +- foundry_sdk/v1/core/models.py | 36 +- foundry_sdk/v1/datasets/models.py | 19 +- foundry_sdk/v1/ontologies/errors.py | 90 +++ foundry_sdk/v1/ontologies/models.py | 178 +++--- foundry_sdk/v2/admin/errors.py | 4 +- foundry_sdk/v2/admin/models.py | 85 ++- foundry_sdk/v2/aip_agents/models.py | 55 +- foundry_sdk/v2/cli.py | 100 +-- foundry_sdk/v2/connectivity/models.py | 583 ++++++++++++++++-- foundry_sdk/v2/core/errors.py | 4 +- foundry_sdk/v2/core/models.py | 119 ++-- foundry_sdk/v2/datasets/models.py | 19 +- foundry_sdk/v2/filesystem/models.py | 30 +- foundry_sdk/v2/functions/models.py | 66 +- foundry_sdk/v2/geo/models.py | 18 +- foundry_sdk/v2/media_sets/models.py | 9 +- foundry_sdk/v2/ontologies/_client.py | 10 + .../v2/ontologies/cipher_text_property.py | 117 ++++ foundry_sdk/v2/ontologies/errors.py | 90 +++ foundry_sdk/v2/ontologies/models.py | 412 +++++++------ foundry_sdk/v2/orchestration/build.py | 28 +- foundry_sdk/v2/orchestration/models.py | 107 ++-- foundry_sdk/v2/sql_queries/_client.py | 6 +- foundry_sdk/v2/sql_queries/errors.py | 62 +- foundry_sdk/v2/sql_queries/models.py | 22 +- .../v2/sql_queries/{query.py => sql_query.py} | 64 +- foundry_sdk/v2/streams/models.py | 6 +- .../v2/third_party_applications/models.py | 8 +- tests/auth/test_confidential_client.py | 11 - tests/auth/test_user_auth_token_client.py | 13 +- tests/test_api_client.py | 11 - tests/test_datetime.py | 27 + tests/test_resorce_import.py | 12 +- tests/test_utils.py | 53 ++ 149 files changed, 2477 insertions(+), 1153 deletions(-) create mode 100644 docs/v2/Connectivity/models/CreateConnectionRequestAsPlaintextValue.md create mode 100644 docs/v2/Connectivity/models/CreateConnectionRequestAsSecretName.md create mode 100644 docs/v2/Connectivity/models/CreateConnectionRequestBasicCredentials.md create mode 100644 docs/v2/Connectivity/models/CreateConnectionRequestEncryptedProperty.md create mode 100644 docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeAuthenticationMode.md create mode 100644 docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeConnectionConfiguration.md create mode 100644 docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeExternalOauth.md create mode 100644 docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeKeyPairAuthentication.md create mode 100644 docs/v2/Connectivity/models/CreateTableImportRequestSnowflakeTableImportConfig.md create mode 100644 docs/v2/Connectivity/models/DateColumnInitialIncrementalState.md create mode 100644 docs/v2/Connectivity/models/DecimalColumnInitialIncrementalState.md create mode 100644 docs/v2/Connectivity/models/IntegerColumnInitialIncrementalState.md create mode 100644 docs/v2/Connectivity/models/LongColumnInitialIncrementalState.md create mode 100644 docs/v2/Connectivity/models/SnowflakeAuthenticationMode.md create mode 100644 docs/v2/Connectivity/models/SnowflakeConnectionConfiguration.md create mode 100644 docs/v2/Connectivity/models/SnowflakeExternalOauth.md create mode 100644 docs/v2/Connectivity/models/SnowflakeKeyPairAuthentication.md create mode 100644 docs/v2/Connectivity/models/SnowflakeTableImportConfig.md create mode 100644 docs/v2/Connectivity/models/StringColumnInitialIncrementalState.md create mode 100644 docs/v2/Connectivity/models/TableImportInitialIncrementalState.md create mode 100644 docs/v2/Connectivity/models/TimestampColumnInitialIncrementalState.md create mode 100644 docs/v2/Core/models/GeohashType.md create mode 100644 docs/v2/Ontologies/CipherTextProperty.md create mode 100644 docs/v2/Ontologies/models/DecryptionResult.md rename docs/v2/{SqlQueries/models/QueryId.md => Ontologies/models/Plaintext.md} (83%) rename docs/v2/SqlQueries/{Query.md => SqlQuery.md} (80%) create mode 100644 docs/v2/SqlQueries/models/SqlQueryId.md create mode 100644 foundry_sdk/v2/ontologies/cipher_text_property.py rename foundry_sdk/v2/sql_queries/{query.py => sql_query.py} (84%) create mode 100644 tests/test_datetime.py diff --git a/README.md b/README.md index ec4d8bda8..bb42c8ed5 100644 --- a/README.md +++ b/README.md @@ -52,10 +52,19 @@ v1 endpoints look like this: https:///api/v1/... ``` -This SDK exposes several clients, one for each major version of the API. For example, the latest major version of the +This SDK exposes several clients, one for each major version of the API. The latest major version of the SDK is **v2** and is exposed using the `FoundryClient` located in the -`foundry_sdk.v2` package. To use this SDK, you must choose the specific client (or clients) -you would like to use. +`foundry_sdk` package. + +```python +from foundry_sdk import FoundryClient +``` + +For other major versions, you must import that specific client from a submodule. For example, to +import the **v2** client from a sub-module you would import it like this: + +```python +from foundry_sdk.v2 import FoundryClient More information about how the API is versioned can be found [here](https://www.palantir.com/docs/foundry_sdk/api/general/overview/versioning/). @@ -71,27 +80,13 @@ There are two options for authorizing the SDK. > production applications, you should register an OAuth2 application (see > [OAuth2 Client](#oauth2-client) below for more details). - - -You can pass in the hostname and token as keyword arguments when -initializing the `UserTokenAuth`: +You can pass in a user token as an arguments when initializing the `UserTokenAuth`: ```python import foundry_sdk -import foundry_sdk.v2 -client = foundry_sdk.v2.FoundryClient( - auth=foundry_sdk.UserTokenAuth(token=os.environ["BEARER_TOKEN"]), +client = foundry_sdk.FoundryClient( + auth=foundry_sdk.UserTokenAuth(os.environ["BEARER_TOKEN"]), hostname="example.palantirfoundry.com", ) @@ -127,9 +122,9 @@ auth = foundry_sdk.ConfidentialClientAuth( After creating the `ConfidentialClientAuth` object, pass it in to the `FoundryClient`, ```python -import foundry_sdk.v2 +import foundry_sdk -client = foundry_sdk.v2.FoundryClient(auth=auth, hostname="example.palantirfoundry.com") +client = foundry_sdk.FoundryClient(auth=auth, hostname="example.palantirfoundry.com") ``` @@ -146,7 +141,7 @@ best suited for your instance before following this example. For simplicity, the purposes. ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -373,10 +368,10 @@ All request parameters and responses with nested fields are typed using a Pydant ``` ```python -import foundry_sdk.v2 +import foundry_sdk from foundry_sdk.v2.admin.models import GroupSearchFilter -client = foundry_sdk.v2.FoundryClient(...) +client = foundry_sdk.FoundryClient(...) result = client.admin.Group.search(where=GroupSearchFilter(type="queryString", value="John Doe")) print(result.data) @@ -407,7 +402,7 @@ You can configure various parts of the HTTP session using the `Config` class. ```python from foundry_sdk import Config from foundry_sdk import UserTokenAuth -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient client = FoundryClient( auth=UserTokenAuth(...), @@ -458,6 +453,26 @@ During the first phase of an endpoint's lifecycle, it may be in `Public Preview` state. This indicates that the endpoint is in development and is not intended for production use. +## Input should have timezone info + +```python +# Example error +pydantic_core._pydantic_core.ValidationError: 1 validation error for Model +datetype + Input should have timezone info [type=timezone_aware, input_value=datetime.datetime(2025, 2, 5, 20, 57, 57, 511182), input_type=datetime] +``` + +This error indicates that you are passing a `datetime` object without timezone information to an +endpoint that requires it. To resolve this error, you should pass in a `datetime` object with timezone +information. For example, you can use the `timezone` class in the `datetime` package: + +```python +from datetime import datetime +from datetime import timezone + +datetime_with_tz = datetime(2025, 2, 5, 20, 57, 57, 511182, tzinfo=timezone.utc) +``` + ## Documentation for V2 API endpoints @@ -517,6 +532,8 @@ Namespace | Resource | Operation | HTTP request | **AipAgents** | Session | [**rag_context**](docs/v2/AipAgents/Session.md#rag_context) | **PUT** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/ragContext | **AipAgents** | Session | [**streaming_continue**](docs/v2/AipAgents/Session.md#streaming_continue) | **POST** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/streamingContinue | **AipAgents** | Session | [**update_title**](docs/v2/AipAgents/Session.md#update_title) | **PUT** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/updateTitle | +**Connectivity** | Connection | [**get**](docs/v2/Connectivity/Connection.md#get) | **GET** /v2/connectivity/connections/{connectionRid} | +**Connectivity** | Connection | [**get_configuration**](docs/v2/Connectivity/Connection.md#get_configuration) | **GET** /v2/connectivity/connections/{connectionRid}/getConfiguration | **Connectivity** | Connection | [**update_secrets**](docs/v2/Connectivity/Connection.md#update_secrets) | **POST** /v2/connectivity/connections/{connectionRid}/updateSecrets | **Connectivity** | FileImport | [**create**](docs/v2/Connectivity/FileImport.md#create) | **POST** /v2/connectivity/connections/{connectionRid}/fileImports | **Connectivity** | FileImport | [**delete**](docs/v2/Connectivity/FileImport.md#delete) | **DELETE** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid} | @@ -808,16 +825,27 @@ Namespace | Name | Import | **Connectivity** | [ConnectionConfiguration](docs/v2/Connectivity/models/ConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import ConnectionConfiguration` | **Connectivity** | [ConnectionDisplayName](docs/v2/Connectivity/models/ConnectionDisplayName.md) | `from foundry_sdk.v2.connectivity.models import ConnectionDisplayName` | **Connectivity** | [ConnectionRid](docs/v2/Connectivity/models/ConnectionRid.md) | `from foundry_sdk.v2.connectivity.models import ConnectionRid` | +**Connectivity** | [CreateConnectionRequestAsPlaintextValue](docs/v2/Connectivity/models/CreateConnectionRequestAsPlaintextValue.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestAsPlaintextValue` | +**Connectivity** | [CreateConnectionRequestAsSecretName](docs/v2/Connectivity/models/CreateConnectionRequestAsSecretName.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestAsSecretName` | +**Connectivity** | [CreateConnectionRequestBasicCredentials](docs/v2/Connectivity/models/CreateConnectionRequestBasicCredentials.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestBasicCredentials` | **Connectivity** | [CreateConnectionRequestConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestConnectionConfiguration` | +**Connectivity** | [CreateConnectionRequestEncryptedProperty](docs/v2/Connectivity/models/CreateConnectionRequestEncryptedProperty.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestEncryptedProperty` | **Connectivity** | [CreateConnectionRequestJdbcConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestJdbcConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestJdbcConnectionConfiguration` | **Connectivity** | [CreateConnectionRequestRestConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestRestConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestRestConnectionConfiguration` | **Connectivity** | [CreateConnectionRequestS3ConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestS3ConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestS3ConnectionConfiguration` | +**Connectivity** | [CreateConnectionRequestSnowflakeAuthenticationMode](docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeAuthenticationMode.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestSnowflakeAuthenticationMode` | +**Connectivity** | [CreateConnectionRequestSnowflakeConnectionConfiguration](docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestSnowflakeConnectionConfiguration` | +**Connectivity** | [CreateConnectionRequestSnowflakeExternalOauth](docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeExternalOauth.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestSnowflakeExternalOauth` | +**Connectivity** | [CreateConnectionRequestSnowflakeKeyPairAuthentication](docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeKeyPairAuthentication.md) | `from foundry_sdk.v2.connectivity.models import CreateConnectionRequestSnowflakeKeyPairAuthentication` | **Connectivity** | [CreateTableImportRequestJdbcImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestJdbcImportConfig.md) | `from foundry_sdk.v2.connectivity.models import CreateTableImportRequestJdbcImportConfig` | **Connectivity** | [CreateTableImportRequestMicrosoftAccessImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfig.md) | `from foundry_sdk.v2.connectivity.models import CreateTableImportRequestMicrosoftAccessImportConfig` | **Connectivity** | [CreateTableImportRequestMicrosoftSqlServerImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfig.md) | `from foundry_sdk.v2.connectivity.models import CreateTableImportRequestMicrosoftSqlServerImportConfig` | **Connectivity** | [CreateTableImportRequestOracleImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestOracleImportConfig.md) | `from foundry_sdk.v2.connectivity.models import CreateTableImportRequestOracleImportConfig` | **Connectivity** | [CreateTableImportRequestPostgreSqlImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestPostgreSqlImportConfig.md) | `from foundry_sdk.v2.connectivity.models import CreateTableImportRequestPostgreSqlImportConfig` | +**Connectivity** | [CreateTableImportRequestSnowflakeTableImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestSnowflakeTableImportConfig.md) | `from foundry_sdk.v2.connectivity.models import CreateTableImportRequestSnowflakeTableImportConfig` | **Connectivity** | [CreateTableImportRequestTableImportConfig](docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfig.md) | `from foundry_sdk.v2.connectivity.models import CreateTableImportRequestTableImportConfig` | +**Connectivity** | [DateColumnInitialIncrementalState](docs/v2/Connectivity/models/DateColumnInitialIncrementalState.md) | `from foundry_sdk.v2.connectivity.models import DateColumnInitialIncrementalState` | +**Connectivity** | [DecimalColumnInitialIncrementalState](docs/v2/Connectivity/models/DecimalColumnInitialIncrementalState.md) | `from foundry_sdk.v2.connectivity.models import DecimalColumnInitialIncrementalState` | **Connectivity** | [Domain](docs/v2/Connectivity/models/Domain.md) | `from foundry_sdk.v2.connectivity.models import Domain` | **Connectivity** | [EncryptedProperty](docs/v2/Connectivity/models/EncryptedProperty.md) | `from foundry_sdk.v2.connectivity.models import EncryptedProperty` | **Connectivity** | [FileAnyPathMatchesFilter](docs/v2/Connectivity/models/FileAnyPathMatchesFilter.md) | `from foundry_sdk.v2.connectivity.models import FileAnyPathMatchesFilter` | @@ -836,10 +864,12 @@ Namespace | Name | Import | **Connectivity** | [FilesCountLimitFilter](docs/v2/Connectivity/models/FilesCountLimitFilter.md) | `from foundry_sdk.v2.connectivity.models import FilesCountLimitFilter` | **Connectivity** | [FileSizeFilter](docs/v2/Connectivity/models/FileSizeFilter.md) | `from foundry_sdk.v2.connectivity.models import FileSizeFilter` | **Connectivity** | [HeaderApiKey](docs/v2/Connectivity/models/HeaderApiKey.md) | `from foundry_sdk.v2.connectivity.models import HeaderApiKey` | +**Connectivity** | [IntegerColumnInitialIncrementalState](docs/v2/Connectivity/models/IntegerColumnInitialIncrementalState.md) | `from foundry_sdk.v2.connectivity.models import IntegerColumnInitialIncrementalState` | **Connectivity** | [JdbcConnectionConfiguration](docs/v2/Connectivity/models/JdbcConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import JdbcConnectionConfiguration` | **Connectivity** | [JdbcImportConfig](docs/v2/Connectivity/models/JdbcImportConfig.md) | `from foundry_sdk.v2.connectivity.models import JdbcImportConfig` | **Connectivity** | [ListFileImportsResponse](docs/v2/Connectivity/models/ListFileImportsResponse.md) | `from foundry_sdk.v2.connectivity.models import ListFileImportsResponse` | **Connectivity** | [ListTableImportsResponse](docs/v2/Connectivity/models/ListTableImportsResponse.md) | `from foundry_sdk.v2.connectivity.models import ListTableImportsResponse` | +**Connectivity** | [LongColumnInitialIncrementalState](docs/v2/Connectivity/models/LongColumnInitialIncrementalState.md) | `from foundry_sdk.v2.connectivity.models import LongColumnInitialIncrementalState` | **Connectivity** | [MicrosoftAccessImportConfig](docs/v2/Connectivity/models/MicrosoftAccessImportConfig.md) | `from foundry_sdk.v2.connectivity.models import MicrosoftAccessImportConfig` | **Connectivity** | [MicrosoftSqlServerImportConfig](docs/v2/Connectivity/models/MicrosoftSqlServerImportConfig.md) | `from foundry_sdk.v2.connectivity.models import MicrosoftSqlServerImportConfig` | **Connectivity** | [OracleImportConfig](docs/v2/Connectivity/models/OracleImportConfig.md) | `from foundry_sdk.v2.connectivity.models import OracleImportConfig` | @@ -860,13 +890,21 @@ Namespace | Name | Import | **Connectivity** | [SecretName](docs/v2/Connectivity/models/SecretName.md) | `from foundry_sdk.v2.connectivity.models import SecretName` | **Connectivity** | [SecretsNames](docs/v2/Connectivity/models/SecretsNames.md) | `from foundry_sdk.v2.connectivity.models import SecretsNames` | **Connectivity** | [SecretsWithPlaintextValues](docs/v2/Connectivity/models/SecretsWithPlaintextValues.md) | `from foundry_sdk.v2.connectivity.models import SecretsWithPlaintextValues` | +**Connectivity** | [SnowflakeAuthenticationMode](docs/v2/Connectivity/models/SnowflakeAuthenticationMode.md) | `from foundry_sdk.v2.connectivity.models import SnowflakeAuthenticationMode` | +**Connectivity** | [SnowflakeConnectionConfiguration](docs/v2/Connectivity/models/SnowflakeConnectionConfiguration.md) | `from foundry_sdk.v2.connectivity.models import SnowflakeConnectionConfiguration` | +**Connectivity** | [SnowflakeExternalOauth](docs/v2/Connectivity/models/SnowflakeExternalOauth.md) | `from foundry_sdk.v2.connectivity.models import SnowflakeExternalOauth` | +**Connectivity** | [SnowflakeKeyPairAuthentication](docs/v2/Connectivity/models/SnowflakeKeyPairAuthentication.md) | `from foundry_sdk.v2.connectivity.models import SnowflakeKeyPairAuthentication` | +**Connectivity** | [SnowflakeTableImportConfig](docs/v2/Connectivity/models/SnowflakeTableImportConfig.md) | `from foundry_sdk.v2.connectivity.models import SnowflakeTableImportConfig` | +**Connectivity** | [StringColumnInitialIncrementalState](docs/v2/Connectivity/models/StringColumnInitialIncrementalState.md) | `from foundry_sdk.v2.connectivity.models import StringColumnInitialIncrementalState` | **Connectivity** | [StsRoleConfiguration](docs/v2/Connectivity/models/StsRoleConfiguration.md) | `from foundry_sdk.v2.connectivity.models import StsRoleConfiguration` | **Connectivity** | [TableImport](docs/v2/Connectivity/models/TableImport.md) | `from foundry_sdk.v2.connectivity.models import TableImport` | **Connectivity** | [TableImportAllowSchemaChanges](docs/v2/Connectivity/models/TableImportAllowSchemaChanges.md) | `from foundry_sdk.v2.connectivity.models import TableImportAllowSchemaChanges` | **Connectivity** | [TableImportConfig](docs/v2/Connectivity/models/TableImportConfig.md) | `from foundry_sdk.v2.connectivity.models import TableImportConfig` | **Connectivity** | [TableImportDisplayName](docs/v2/Connectivity/models/TableImportDisplayName.md) | `from foundry_sdk.v2.connectivity.models import TableImportDisplayName` | +**Connectivity** | [TableImportInitialIncrementalState](docs/v2/Connectivity/models/TableImportInitialIncrementalState.md) | `from foundry_sdk.v2.connectivity.models import TableImportInitialIncrementalState` | **Connectivity** | [TableImportMode](docs/v2/Connectivity/models/TableImportMode.md) | `from foundry_sdk.v2.connectivity.models import TableImportMode` | **Connectivity** | [TableImportRid](docs/v2/Connectivity/models/TableImportRid.md) | `from foundry_sdk.v2.connectivity.models import TableImportRid` | +**Connectivity** | [TimestampColumnInitialIncrementalState](docs/v2/Connectivity/models/TimestampColumnInitialIncrementalState.md) | `from foundry_sdk.v2.connectivity.models import TimestampColumnInitialIncrementalState` | **Connectivity** | [UriScheme](docs/v2/Connectivity/models/UriScheme.md) | `from foundry_sdk.v2.connectivity.models import UriScheme` | **Core** | [AnyType](docs/v2/Core/models/AnyType.md) | `from foundry_sdk.v2.core.models import AnyType` | **Core** | [ArrayFieldType](docs/v2/Core/models/ArrayFieldType.md) | `from foundry_sdk.v2.core.models import ArrayFieldType` | @@ -914,6 +952,7 @@ Namespace | Name | Import | **Core** | [FolderRid](docs/v2/Core/models/FolderRid.md) | `from foundry_sdk.v2.core.models import FolderRid` | **Core** | [FoundryLiveDeployment](docs/v2/Core/models/FoundryLiveDeployment.md) | `from foundry_sdk.v2.core.models import FoundryLiveDeployment` | **Core** | [FullRowChangeDataCaptureConfiguration](docs/v2/Core/models/FullRowChangeDataCaptureConfiguration.md) | `from foundry_sdk.v2.core.models import FullRowChangeDataCaptureConfiguration` | +**Core** | [GeohashType](docs/v2/Core/models/GeohashType.md) | `from foundry_sdk.v2.core.models import GeohashType` | **Core** | [GeoPointType](docs/v2/Core/models/GeoPointType.md) | `from foundry_sdk.v2.core.models import GeoPointType` | **Core** | [GeoShapeType](docs/v2/Core/models/GeoShapeType.md) | `from foundry_sdk.v2.core.models import GeoShapeType` | **Core** | [GeotimeSeriesReferenceType](docs/v2/Core/models/GeotimeSeriesReferenceType.md) | `from foundry_sdk.v2.core.models import GeotimeSeriesReferenceType` | @@ -1154,6 +1193,7 @@ Namespace | Name | Import | **Ontologies** | [CreateObjectRule](docs/v2/Ontologies/models/CreateObjectRule.md) | `from foundry_sdk.v2.ontologies.models import CreateObjectRule` | **Ontologies** | [CreateTemporaryObjectSetResponseV2](docs/v2/Ontologies/models/CreateTemporaryObjectSetResponseV2.md) | `from foundry_sdk.v2.ontologies.models import CreateTemporaryObjectSetResponseV2` | **Ontologies** | [DataValue](docs/v2/Ontologies/models/DataValue.md) | `from foundry_sdk.v2.ontologies.models import DataValue` | +**Ontologies** | [DecryptionResult](docs/v2/Ontologies/models/DecryptionResult.md) | `from foundry_sdk.v2.ontologies.models import DecryptionResult` | **Ontologies** | [DeleteInterfaceObjectRule](docs/v2/Ontologies/models/DeleteInterfaceObjectRule.md) | `from foundry_sdk.v2.ontologies.models import DeleteInterfaceObjectRule` | **Ontologies** | [DeleteLink](docs/v2/Ontologies/models/DeleteLink.md) | `from foundry_sdk.v2.ontologies.models import DeleteLink` | **Ontologies** | [DeleteLinkRule](docs/v2/Ontologies/models/DeleteLinkRule.md) | `from foundry_sdk.v2.ontologies.models import DeleteLinkRule` | @@ -1289,6 +1329,7 @@ Namespace | Name | Import | **Ontologies** | [ParameterEvaluationResult](docs/v2/Ontologies/models/ParameterEvaluationResult.md) | `from foundry_sdk.v2.ontologies.models import ParameterEvaluationResult` | **Ontologies** | [ParameterId](docs/v2/Ontologies/models/ParameterId.md) | `from foundry_sdk.v2.ontologies.models import ParameterId` | **Ontologies** | [ParameterOption](docs/v2/Ontologies/models/ParameterOption.md) | `from foundry_sdk.v2.ontologies.models import ParameterOption` | +**Ontologies** | [Plaintext](docs/v2/Ontologies/models/Plaintext.md) | `from foundry_sdk.v2.ontologies.models import Plaintext` | **Ontologies** | [PolygonValue](docs/v2/Ontologies/models/PolygonValue.md) | `from foundry_sdk.v2.ontologies.models import PolygonValue` | **Ontologies** | [PreciseDuration](docs/v2/Ontologies/models/PreciseDuration.md) | `from foundry_sdk.v2.ontologies.models import PreciseDuration` | **Ontologies** | [PreciseTimeUnit](docs/v2/Ontologies/models/PreciseTimeUnit.md) | `from foundry_sdk.v2.ontologies.models import PreciseTimeUnit` | @@ -1463,9 +1504,9 @@ Namespace | Name | Import | **Orchestration** | [UserScope](docs/v2/Orchestration/models/UserScope.md) | `from foundry_sdk.v2.orchestration.models import UserScope` | **SqlQueries** | [CanceledQueryStatus](docs/v2/SqlQueries/models/CanceledQueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import CanceledQueryStatus` | **SqlQueries** | [FailedQueryStatus](docs/v2/SqlQueries/models/FailedQueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import FailedQueryStatus` | -**SqlQueries** | [QueryId](docs/v2/SqlQueries/models/QueryId.md) | `from foundry_sdk.v2.sql_queries.models import QueryId` | **SqlQueries** | [QueryStatus](docs/v2/SqlQueries/models/QueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import QueryStatus` | **SqlQueries** | [RunningQueryStatus](docs/v2/SqlQueries/models/RunningQueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import RunningQueryStatus` | +**SqlQueries** | [SqlQueryId](docs/v2/SqlQueries/models/SqlQueryId.md) | `from foundry_sdk.v2.sql_queries.models import SqlQueryId` | **SqlQueries** | [SucceededQueryStatus](docs/v2/SqlQueries/models/SucceededQueryStatus.md) | `from foundry_sdk.v2.sql_queries.models import SucceededQueryStatus` | **Streams** | [Compressed](docs/v2/Streams/models/Compressed.md) | `from foundry_sdk.v2.streams.models import Compressed` | **Streams** | [CreateStreamRequestStreamSchema](docs/v2/Streams/models/CreateStreamRequestStreamSchema.md) | `from foundry_sdk.v2.streams.models import CreateStreamRequestStreamSchema` | @@ -1934,6 +1975,7 @@ Namespace | Name | Import | **Ontologies** | ApplyActionFailed | `from foundry_sdk.v2.ontologies.errors import ApplyActionFailed` | **Ontologies** | AttachmentNotFound | `from foundry_sdk.v2.ontologies.errors import AttachmentNotFound` | **Ontologies** | AttachmentSizeExceededLimit | `from foundry_sdk.v2.ontologies.errors import AttachmentSizeExceededLimit` | +**Ontologies** | CipherChannelNotFound | `from foundry_sdk.v2.ontologies.errors import CipherChannelNotFound` | **Ontologies** | CompositePrimaryKeyNotSupported | `from foundry_sdk.v2.ontologies.errors import CompositePrimaryKeyNotSupported` | **Ontologies** | DerivedPropertyApiNamesNotUnique | `from foundry_sdk.v2.ontologies.errors import DerivedPropertyApiNamesNotUnique` | **Ontologies** | DuplicateOrderBy | `from foundry_sdk.v2.ontologies.errors import DuplicateOrderBy` | @@ -1980,6 +2022,7 @@ Namespace | Name | Import | **Ontologies** | MissingParameter | `from foundry_sdk.v2.ontologies.errors import MissingParameter` | **Ontologies** | MultipleGroupByOnFieldNotSupported | `from foundry_sdk.v2.ontologies.errors import MultipleGroupByOnFieldNotSupported` | **Ontologies** | MultiplePropertyValuesNotSupported | `from foundry_sdk.v2.ontologies.errors import MultiplePropertyValuesNotSupported` | +**Ontologies** | NotCipherFormatted | `from foundry_sdk.v2.ontologies.errors import NotCipherFormatted` | **Ontologies** | ObjectAlreadyExists | `from foundry_sdk.v2.ontologies.errors import ObjectAlreadyExists` | **Ontologies** | ObjectChanged | `from foundry_sdk.v2.ontologies.errors import ObjectChanged` | **Ontologies** | ObjectNotFound | `from foundry_sdk.v2.ontologies.errors import ObjectNotFound` | @@ -2015,10 +2058,13 @@ Namespace | Name | Import | **Ontologies** | QueryNotFound | `from foundry_sdk.v2.ontologies.errors import QueryNotFound` | **Ontologies** | QueryRuntimeError | `from foundry_sdk.v2.ontologies.errors import QueryRuntimeError` | **Ontologies** | QueryTimeExceededLimit | `from foundry_sdk.v2.ontologies.errors import QueryTimeExceededLimit` | +**Ontologies** | RateLimitReached | `from foundry_sdk.v2.ontologies.errors import RateLimitReached` | **Ontologies** | SearchVectorDimensionsDiffer | `from foundry_sdk.v2.ontologies.errors import SearchVectorDimensionsDiffer` | **Ontologies** | SharedPropertiesNotFound | `from foundry_sdk.v2.ontologies.errors import SharedPropertiesNotFound` | **Ontologies** | SharedPropertyTypeNotFound | `from foundry_sdk.v2.ontologies.errors import SharedPropertyTypeNotFound` | **Ontologies** | TooManyNearestNeighborsRequested | `from foundry_sdk.v2.ontologies.errors import TooManyNearestNeighborsRequested` | +**Ontologies** | UnauthorizedCipherOperation | `from foundry_sdk.v2.ontologies.errors import UnauthorizedCipherOperation` | +**Ontologies** | UndecryptableValue | `from foundry_sdk.v2.ontologies.errors import UndecryptableValue` | **Ontologies** | UnknownParameter | `from foundry_sdk.v2.ontologies.errors import UnknownParameter` | **Ontologies** | UnsupportedObjectSet | `from foundry_sdk.v2.ontologies.errors import UnsupportedObjectSet` | **Ontologies** | ViewObjectPermissionDenied | `from foundry_sdk.v2.ontologies.errors import ViewObjectPermissionDenied` | @@ -2054,10 +2100,10 @@ Namespace | Name | Import | **Orchestration** | SearchBuildsPermissionDenied | `from foundry_sdk.v2.orchestration.errors import SearchBuildsPermissionDenied` | **Orchestration** | TargetNotSupported | `from foundry_sdk.v2.orchestration.errors import TargetNotSupported` | **Orchestration** | UnpauseSchedulePermissionDenied | `from foundry_sdk.v2.orchestration.errors import UnpauseSchedulePermissionDenied` | -**SqlQueries** | CancelQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import CancelQueryPermissionDenied` | -**SqlQueries** | ExecuteQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import ExecuteQueryPermissionDenied` | -**SqlQueries** | GetResultsPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import GetResultsPermissionDenied` | -**SqlQueries** | GetStatusPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import GetStatusPermissionDenied` | +**SqlQueries** | CancelSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import CancelSqlQueryPermissionDenied` | +**SqlQueries** | ExecuteSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import ExecuteSqlQueryPermissionDenied` | +**SqlQueries** | GetResultsSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import GetResultsSqlQueryPermissionDenied` | +**SqlQueries** | GetStatusSqlQueryPermissionDenied | `from foundry_sdk.v2.sql_queries.errors import GetStatusSqlQueryPermissionDenied` | **SqlQueries** | QueryCanceled | `from foundry_sdk.v2.sql_queries.errors import QueryCanceled` | **SqlQueries** | QueryFailed | `from foundry_sdk.v2.sql_queries.errors import QueryFailed` | **SqlQueries** | QueryParseError | `from foundry_sdk.v2.sql_queries.errors import QueryParseError` | @@ -2147,6 +2193,7 @@ Namespace | Name | Import | **Ontologies** | ApplyActionFailed | `from foundry_sdk.v1.ontologies.errors import ApplyActionFailed` | **Ontologies** | AttachmentNotFound | `from foundry_sdk.v1.ontologies.errors import AttachmentNotFound` | **Ontologies** | AttachmentSizeExceededLimit | `from foundry_sdk.v1.ontologies.errors import AttachmentSizeExceededLimit` | +**Ontologies** | CipherChannelNotFound | `from foundry_sdk.v1.ontologies.errors import CipherChannelNotFound` | **Ontologies** | CompositePrimaryKeyNotSupported | `from foundry_sdk.v1.ontologies.errors import CompositePrimaryKeyNotSupported` | **Ontologies** | DerivedPropertyApiNamesNotUnique | `from foundry_sdk.v1.ontologies.errors import DerivedPropertyApiNamesNotUnique` | **Ontologies** | DuplicateOrderBy | `from foundry_sdk.v1.ontologies.errors import DuplicateOrderBy` | @@ -2193,6 +2240,7 @@ Namespace | Name | Import | **Ontologies** | MissingParameter | `from foundry_sdk.v1.ontologies.errors import MissingParameter` | **Ontologies** | MultipleGroupByOnFieldNotSupported | `from foundry_sdk.v1.ontologies.errors import MultipleGroupByOnFieldNotSupported` | **Ontologies** | MultiplePropertyValuesNotSupported | `from foundry_sdk.v1.ontologies.errors import MultiplePropertyValuesNotSupported` | +**Ontologies** | NotCipherFormatted | `from foundry_sdk.v1.ontologies.errors import NotCipherFormatted` | **Ontologies** | ObjectAlreadyExists | `from foundry_sdk.v1.ontologies.errors import ObjectAlreadyExists` | **Ontologies** | ObjectChanged | `from foundry_sdk.v1.ontologies.errors import ObjectChanged` | **Ontologies** | ObjectNotFound | `from foundry_sdk.v1.ontologies.errors import ObjectNotFound` | @@ -2228,10 +2276,13 @@ Namespace | Name | Import | **Ontologies** | QueryNotFound | `from foundry_sdk.v1.ontologies.errors import QueryNotFound` | **Ontologies** | QueryRuntimeError | `from foundry_sdk.v1.ontologies.errors import QueryRuntimeError` | **Ontologies** | QueryTimeExceededLimit | `from foundry_sdk.v1.ontologies.errors import QueryTimeExceededLimit` | +**Ontologies** | RateLimitReached | `from foundry_sdk.v1.ontologies.errors import RateLimitReached` | **Ontologies** | SearchVectorDimensionsDiffer | `from foundry_sdk.v1.ontologies.errors import SearchVectorDimensionsDiffer` | **Ontologies** | SharedPropertiesNotFound | `from foundry_sdk.v1.ontologies.errors import SharedPropertiesNotFound` | **Ontologies** | SharedPropertyTypeNotFound | `from foundry_sdk.v1.ontologies.errors import SharedPropertyTypeNotFound` | **Ontologies** | TooManyNearestNeighborsRequested | `from foundry_sdk.v1.ontologies.errors import TooManyNearestNeighborsRequested` | +**Ontologies** | UnauthorizedCipherOperation | `from foundry_sdk.v1.ontologies.errors import UnauthorizedCipherOperation` | +**Ontologies** | UndecryptableValue | `from foundry_sdk.v1.ontologies.errors import UndecryptableValue` | **Ontologies** | UnknownParameter | `from foundry_sdk.v1.ontologies.errors import UnknownParameter` | **Ontologies** | UnsupportedObjectSet | `from foundry_sdk.v1.ontologies.errors import UnsupportedObjectSet` | **Ontologies** | ViewObjectPermissionDenied | `from foundry_sdk.v1.ontologies.errors import ViewObjectPermissionDenied` | diff --git a/docs/v2/Admin/AuthenticationProvider.md b/docs/v2/Admin/AuthenticationProvider.md index 7f352fb94..99e59260b 100644 --- a/docs/v2/Admin/AuthenticationProvider.md +++ b/docs/v2/Admin/AuthenticationProvider.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -80,7 +80,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -137,7 +137,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -208,7 +208,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Admin/Enrollment.md b/docs/v2/Admin/Enrollment.md index 939db1f98..7899e10ac 100644 --- a/docs/v2/Admin/Enrollment.md +++ b/docs/v2/Admin/Enrollment.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -71,7 +71,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Admin/Group.md b/docs/v2/Admin/Group.md index fd4fec479..aa3cb5331 100644 --- a/docs/v2/Admin/Group.md +++ b/docs/v2/Admin/Group.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -92,7 +92,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -139,7 +139,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -188,7 +188,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -238,7 +238,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -289,7 +289,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Admin/GroupMember.md b/docs/v2/Admin/GroupMember.md index b223f163a..10cfe8404 100644 --- a/docs/v2/Admin/GroupMember.md +++ b/docs/v2/Admin/GroupMember.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -86,7 +86,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -141,7 +141,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Admin/GroupMembership.md b/docs/v2/Admin/GroupMembership.md index 676219967..c512659eb 100644 --- a/docs/v2/Admin/GroupMembership.md +++ b/docs/v2/Admin/GroupMembership.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Admin/GroupProviderInfo.md b/docs/v2/Admin/GroupProviderInfo.md index b65680da3..580278835 100644 --- a/docs/v2/Admin/GroupProviderInfo.md +++ b/docs/v2/Admin/GroupProviderInfo.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -72,7 +72,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Admin/Host.md b/docs/v2/Admin/Host.md index aa975d339..051da92c4 100644 --- a/docs/v2/Admin/Host.md +++ b/docs/v2/Admin/Host.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Admin/Marking.md b/docs/v2/Admin/Marking.md index 721360213..0f49d2149 100644 --- a/docs/v2/Admin/Marking.md +++ b/docs/v2/Admin/Marking.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -94,7 +94,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -146,7 +146,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -197,7 +197,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Admin/MarkingCategory.md b/docs/v2/Admin/MarkingCategory.md index 4a91921f5..c51598737 100644 --- a/docs/v2/Admin/MarkingCategory.md +++ b/docs/v2/Admin/MarkingCategory.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -72,7 +72,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Admin/MarkingMember.md b/docs/v2/Admin/MarkingMember.md index cea239c00..70b7a631d 100644 --- a/docs/v2/Admin/MarkingMember.md +++ b/docs/v2/Admin/MarkingMember.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -82,7 +82,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -144,7 +144,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Admin/MarkingRoleAssignment.md b/docs/v2/Admin/MarkingRoleAssignment.md index ba78d246e..66e643115 100644 --- a/docs/v2/Admin/MarkingRoleAssignment.md +++ b/docs/v2/Admin/MarkingRoleAssignment.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -80,7 +80,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -136,7 +136,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Admin/Organization.md b/docs/v2/Admin/Organization.md index b2fa22dc5..126d6a5ab 100644 --- a/docs/v2/Admin/Organization.md +++ b/docs/v2/Admin/Organization.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -74,7 +74,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Admin/User.md b/docs/v2/Admin/User.md index 7dd1ce2bb..2996c5878 100644 --- a/docs/v2/Admin/User.md +++ b/docs/v2/Admin/User.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -73,7 +73,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -122,7 +122,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -168,7 +168,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -213,7 +213,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -265,7 +265,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -313,7 +313,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -363,7 +363,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Admin/UserProviderInfo.md b/docs/v2/Admin/UserProviderInfo.md index 534f12eb5..5c0610829 100644 --- a/docs/v2/Admin/UserProviderInfo.md +++ b/docs/v2/Admin/UserProviderInfo.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -72,7 +72,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/AipAgents/Agent.md b/docs/v2/AipAgents/Agent.md index 158943d23..e59b93ddc 100644 --- a/docs/v2/AipAgents/Agent.md +++ b/docs/v2/AipAgents/Agent.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -78,7 +78,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/AipAgents/AgentVersion.md b/docs/v2/AipAgents/AgentVersion.md index 023733b2e..b1a5fd703 100644 --- a/docs/v2/AipAgents/AgentVersion.md +++ b/docs/v2/AipAgents/AgentVersion.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -80,7 +80,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/AipAgents/Content.md b/docs/v2/AipAgents/Content.md index c2f04aa75..1bc4ae1e0 100644 --- a/docs/v2/AipAgents/Content.md +++ b/docs/v2/AipAgents/Content.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/AipAgents/Session.md b/docs/v2/AipAgents/Session.md index 0e3ab5115..0342452ac 100644 --- a/docs/v2/AipAgents/Session.md +++ b/docs/v2/AipAgents/Session.md @@ -37,7 +37,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -118,7 +118,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -179,7 +179,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -234,7 +234,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -294,7 +294,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -354,7 +354,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -428,7 +428,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -510,7 +510,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Connectivity/Connection.md b/docs/v2/Connectivity/Connection.md index b3f69641d..79301908d 100644 --- a/docs/v2/Connectivity/Connection.md +++ b/docs/v2/Connectivity/Connection.md @@ -3,8 +3,8 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | [**create**](#create) | **POST** /v2/connectivity/connections | Private Beta | -[**get**](#get) | **GET** /v2/connectivity/connections/{connectionRid} | Private Beta | -[**get_configuration**](#get_configuration) | **GET** /v2/connectivity/connections/{connectionRid}/getConfiguration | Private Beta | +[**get**](#get) | **GET** /v2/connectivity/connections/{connectionRid} | Public Beta | +[**get_configuration**](#get_configuration) | **GET** /v2/connectivity/connections/{connectionRid}/getConfiguration | Public Beta | [**update_secrets**](#update_secrets) | **POST** /v2/connectivity/connections/{connectionRid}/updateSecrets | Public Beta | # **create** @@ -34,14 +34,18 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") # CreateConnectionRequestConnectionConfiguration -configuration = None +configuration = { + "type": "jdbc", + "url": "jdbc:postgresql://localhost:5432/test", + "driverClass": "org.postgresql.Driver", +} # ConnectionDisplayName | The display name of the Connection. The display name must not be blank. display_name = "Connection to my external system" # FolderRid @@ -93,7 +97,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -145,7 +149,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -209,7 +213,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Connectivity/FileImport.md b/docs/v2/Connectivity/FileImport.md index 69d450b5a..540004e86 100644 --- a/docs/v2/Connectivity/FileImport.md +++ b/docs/v2/Connectivity/FileImport.md @@ -31,7 +31,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -44,7 +44,7 @@ dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" # FileImportDisplayName display_name = "My file import" # List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) -file_import_filters = None +file_import_filters = [{"type": "pathMatchesFilter", "regex": "my-subfolder"}] # FileImportMode import_mode = "SNAPSHOT" # Optional[BranchName] | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. @@ -106,7 +106,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -163,7 +163,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -218,7 +218,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -276,7 +276,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -338,7 +338,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -353,7 +353,7 @@ dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" # FileImportDisplayName display_name = "My file import" # List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) -file_import_filters = None +file_import_filters = [{"type": "pathMatchesFilter", "regex": "my-subfolder"}] # FileImportMode import_mode = "SNAPSHOT" # Optional[BranchName] | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. diff --git a/docs/v2/Connectivity/TableImport.md b/docs/v2/Connectivity/TableImport.md index 64d1fccb7..c47f8ebec 100644 --- a/docs/v2/Connectivity/TableImport.md +++ b/docs/v2/Connectivity/TableImport.md @@ -30,7 +30,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -39,7 +39,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # ConnectionRid connection_rid = None # CreateTableImportRequestTableImportConfig -config = None +config = {"type": "jdbcImportConfig", "query": "SELECT * FROM table"} # DatasetRid | The RID of the output dataset. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" # TableImportDisplayName @@ -105,7 +105,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -162,7 +162,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -217,7 +217,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -275,7 +275,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Connectivity/models/ConnectionConfiguration.md b/docs/v2/Connectivity/models/ConnectionConfiguration.md index f1f7787de..93820e9a6 100644 --- a/docs/v2/Connectivity/models/ConnectionConfiguration.md +++ b/docs/v2/Connectivity/models/ConnectionConfiguration.md @@ -11,6 +11,7 @@ This discriminator class uses the `type` field to differentiate between classes. | ------------ | ------------- S3ConnectionConfiguration | s3 RestConnectionConfiguration | rest +SnowflakeConnectionConfiguration | snowflake JdbcConnectionConfiguration | jdbc diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestAsPlaintextValue.md b/docs/v2/Connectivity/models/CreateConnectionRequestAsPlaintextValue.md new file mode 100644 index 000000000..5531cf785 --- /dev/null +++ b/docs/v2/Connectivity/models/CreateConnectionRequestAsPlaintextValue.md @@ -0,0 +1,12 @@ +# CreateConnectionRequestAsPlaintextValue + +CreateConnectionRequestAsPlaintextValue + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | PlaintextValue | Yes | | +**type** | Literal["asPlaintextValue"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestAsSecretName.md b/docs/v2/Connectivity/models/CreateConnectionRequestAsSecretName.md new file mode 100644 index 000000000..e1ffb6efb --- /dev/null +++ b/docs/v2/Connectivity/models/CreateConnectionRequestAsSecretName.md @@ -0,0 +1,12 @@ +# CreateConnectionRequestAsSecretName + +CreateConnectionRequestAsSecretName + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | SecretName | Yes | | +**type** | Literal["asSecretName"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestBasicCredentials.md b/docs/v2/Connectivity/models/CreateConnectionRequestBasicCredentials.md new file mode 100644 index 000000000..1f7285d6f --- /dev/null +++ b/docs/v2/Connectivity/models/CreateConnectionRequestBasicCredentials.md @@ -0,0 +1,13 @@ +# CreateConnectionRequestBasicCredentials + +CreateConnectionRequestBasicCredentials + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**password** | CreateConnectionRequestEncryptedProperty | Yes | | +**username** | str | Yes | | +**type** | Literal["basic"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestConnectionConfiguration.md b/docs/v2/Connectivity/models/CreateConnectionRequestConnectionConfiguration.md index cd6beefc2..b623b28f3 100644 --- a/docs/v2/Connectivity/models/CreateConnectionRequestConnectionConfiguration.md +++ b/docs/v2/Connectivity/models/CreateConnectionRequestConnectionConfiguration.md @@ -11,6 +11,7 @@ This discriminator class uses the `type` field to differentiate between classes. | ------------ | ------------- CreateConnectionRequestS3ConnectionConfiguration | s3 CreateConnectionRequestRestConnectionConfiguration | rest +CreateConnectionRequestSnowflakeConnectionConfiguration | snowflake CreateConnectionRequestJdbcConnectionConfiguration | jdbc diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestEncryptedProperty.md b/docs/v2/Connectivity/models/CreateConnectionRequestEncryptedProperty.md new file mode 100644 index 000000000..3ccaa14ba --- /dev/null +++ b/docs/v2/Connectivity/models/CreateConnectionRequestEncryptedProperty.md @@ -0,0 +1,21 @@ +# CreateConnectionRequestEncryptedProperty + +When reading an encrypted property, the secret name representing the encrypted value will be returned. +When writing to an encrypted property: +- If a plaintext value is passed as an input, the plaintext value will be encrypted and saved to the property. +- If a secret name is passed as an input, the secret name must match the existing secret name of the property + and the property will retain its previously encrypted value. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +CreateConnectionRequestAsSecretName | asSecretName +CreateConnectionRequestAsPlaintextValue | asPlaintextValue + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestJdbcConnectionConfiguration.md b/docs/v2/Connectivity/models/CreateConnectionRequestJdbcConnectionConfiguration.md index eb2d99875..aedf6ae3e 100644 --- a/docs/v2/Connectivity/models/CreateConnectionRequestJdbcConnectionConfiguration.md +++ b/docs/v2/Connectivity/models/CreateConnectionRequestJdbcConnectionConfiguration.md @@ -7,7 +7,7 @@ CreateConnectionRequestJdbcConnectionConfiguration | ------------ | ------------- | ------------- | ------------- | **credentials** | Optional[BasicCredentials] | No | | **driver_class** | str | Yes | The fully-qualified driver class name that is used to connect to the database. | -**jdbc_properties** | Dict[str, str] | Yes | The list of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed to the JDBC driver to configure behavior. Refer to the documentation of your specific connection for additional available JDBC properties to add to your connection configuration. | +**jdbc_properties** | Dict[str, str] | Yes | A map of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed to the JDBC driver to configure behavior. Refer to the documentation of your specific connection type for additional available JDBC properties to add to your connection configuration. | **url** | str | Yes | The URL that the JDBC driver uses to connect to a database. | **type** | Literal["jdbc"] | Yes | None | diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeAuthenticationMode.md b/docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeAuthenticationMode.md new file mode 100644 index 000000000..77e53f401 --- /dev/null +++ b/docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeAuthenticationMode.md @@ -0,0 +1,17 @@ +# CreateConnectionRequestSnowflakeAuthenticationMode + +CreateConnectionRequestSnowflakeAuthenticationMode + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +CreateConnectionRequestSnowflakeExternalOauth | externalOauth +CreateConnectionRequestSnowflakeKeyPairAuthentication | keyPair +CreateConnectionRequestBasicCredentials | basic + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeConnectionConfiguration.md b/docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeConnectionConfiguration.md new file mode 100644 index 000000000..31ad6d9e3 --- /dev/null +++ b/docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeConnectionConfiguration.md @@ -0,0 +1,18 @@ +# CreateConnectionRequestSnowflakeConnectionConfiguration + +CreateConnectionRequestSnowflakeConnectionConfiguration + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**schema_** | Optional[str] | No | Specifies the default schema to use for the specified database once connected. If unspecified, defaults to the empty string. The specified schema should be an existing schema for which the specified default role has privileges. See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#schema | +**database** | Optional[str] | No | Specifies the default database to use once connected. If unspecified, defaults to the empty string. The specified database should be an existing database for which the specified default role has privileges. See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#db | +**role** | Optional[str] | No | Specifies the default access control role to use in the Snowflake session initiated by the driver. If unspecified, no role will be used when the session is initiated by the driver. The specified role should be an existing role that has already been assigned to the specified user for the driver. If the specified role has not already been assigned to the user, the role is not used when the session is initiated by the driver. See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#role | +**account_identifier** | str | Yes | An [account identifier](https://docs.snowflake.com/en/user-guide/admin-account-identifier) uniquely identifies a Snowflake account within your organization, as well as throughout the global network of Snowflake-supported cloud platforms and cloud regions. The URL for an account uses the following format: .snowflakecomputing.com. An example URL is https://acme-test_aws_us_east_2.snowflakecomputing.com. | +**jdbc_properties** | Dict[str, str] | Yes | A map of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed to the JDBC driver to configure behavior. Refer to the documentation of your specific connection type for additional available JDBC properties to add to your connection configuration. | +**warehouse** | Optional[str] | No | Specifies the virtual warehouse to use once connected. If unspecified, defaults to the empty string. The specified warehouse should be an existing warehouse for which the specified default role has privileges. See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#warehouse | +**authentication_mode** | CreateConnectionRequestSnowflakeAuthenticationMode | Yes | The authentication mode to use to connect to the Snowflake database. | +**type** | Literal["snowflake"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeExternalOauth.md b/docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeExternalOauth.md new file mode 100644 index 000000000..d3296205b --- /dev/null +++ b/docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeExternalOauth.md @@ -0,0 +1,11 @@ +# CreateConnectionRequestSnowflakeExternalOauth + +CreateConnectionRequestSnowflakeExternalOauth + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["externalOauth"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeKeyPairAuthentication.md b/docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeKeyPairAuthentication.md new file mode 100644 index 000000000..50b7ef5a9 --- /dev/null +++ b/docs/v2/Connectivity/models/CreateConnectionRequestSnowflakeKeyPairAuthentication.md @@ -0,0 +1,13 @@ +# CreateConnectionRequestSnowflakeKeyPairAuthentication + +CreateConnectionRequestSnowflakeKeyPairAuthentication + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**private_key** | CreateConnectionRequestEncryptedProperty | Yes | | +**user** | str | Yes | | +**type** | Literal["keyPair"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestJdbcImportConfig.md b/docs/v2/Connectivity/models/CreateTableImportRequestJdbcImportConfig.md index d5dc59702..f30db0e58 100644 --- a/docs/v2/Connectivity/models/CreateTableImportRequestJdbcImportConfig.md +++ b/docs/v2/Connectivity/models/CreateTableImportRequestJdbcImportConfig.md @@ -5,6 +5,7 @@ CreateTableImportRequestJdbcImportConfig ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | +**initial_incremental_state** | Optional[TableImportInitialIncrementalState] | No | | **query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | **type** | Literal["jdbcImportConfig"] | Yes | None | diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfig.md b/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfig.md index 0ab30e411..26da2dbf4 100644 --- a/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfig.md +++ b/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfig.md @@ -5,6 +5,7 @@ CreateTableImportRequestMicrosoftAccessImportConfig ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | +**initial_incremental_state** | Optional[TableImportInitialIncrementalState] | No | | **query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | **type** | Literal["microsoftAccessImportConfig"] | Yes | None | diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfig.md b/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfig.md index b57c89c99..ac01eee70 100644 --- a/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfig.md +++ b/docs/v2/Connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfig.md @@ -5,6 +5,7 @@ CreateTableImportRequestMicrosoftSqlServerImportConfig ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | +**initial_incremental_state** | Optional[TableImportInitialIncrementalState] | No | | **query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | **type** | Literal["microsoftSqlServerImportConfig"] | Yes | None | diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestOracleImportConfig.md b/docs/v2/Connectivity/models/CreateTableImportRequestOracleImportConfig.md index aad6deb35..6da4f560f 100644 --- a/docs/v2/Connectivity/models/CreateTableImportRequestOracleImportConfig.md +++ b/docs/v2/Connectivity/models/CreateTableImportRequestOracleImportConfig.md @@ -5,6 +5,7 @@ CreateTableImportRequestOracleImportConfig ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | +**initial_incremental_state** | Optional[TableImportInitialIncrementalState] | No | | **query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | **type** | Literal["oracleImportConfig"] | Yes | None | diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestPostgreSqlImportConfig.md b/docs/v2/Connectivity/models/CreateTableImportRequestPostgreSqlImportConfig.md index 957a5a799..2e295ed7e 100644 --- a/docs/v2/Connectivity/models/CreateTableImportRequestPostgreSqlImportConfig.md +++ b/docs/v2/Connectivity/models/CreateTableImportRequestPostgreSqlImportConfig.md @@ -5,6 +5,7 @@ CreateTableImportRequestPostgreSqlImportConfig ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | +**initial_incremental_state** | Optional[TableImportInitialIncrementalState] | No | | **query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | **type** | Literal["postgreSqlImportConfig"] | Yes | None | diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestSnowflakeTableImportConfig.md b/docs/v2/Connectivity/models/CreateTableImportRequestSnowflakeTableImportConfig.md new file mode 100644 index 000000000..69952562c --- /dev/null +++ b/docs/v2/Connectivity/models/CreateTableImportRequestSnowflakeTableImportConfig.md @@ -0,0 +1,13 @@ +# CreateTableImportRequestSnowflakeTableImportConfig + +CreateTableImportRequestSnowflakeTableImportConfig + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**initial_incremental_state** | Optional[TableImportInitialIncrementalState] | No | | +**query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["snowflakeImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfig.md b/docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfig.md index 0afc77558..3ff658c30 100644 --- a/docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfig.md +++ b/docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfig.md @@ -14,6 +14,7 @@ CreateTableImportRequestJdbcImportConfig | jdbcImportConfig CreateTableImportRequestMicrosoftSqlServerImportConfig | microsoftSqlServerImportConfig CreateTableImportRequestPostgreSqlImportConfig | postgreSqlImportConfig CreateTableImportRequestMicrosoftAccessImportConfig | microsoftAccessImportConfig +CreateTableImportRequestSnowflakeTableImportConfig | snowflakeImportConfig CreateTableImportRequestOracleImportConfig | oracleImportConfig diff --git a/docs/v2/Connectivity/models/DateColumnInitialIncrementalState.md b/docs/v2/Connectivity/models/DateColumnInitialIncrementalState.md new file mode 100644 index 000000000..47aa9604c --- /dev/null +++ b/docs/v2/Connectivity/models/DateColumnInitialIncrementalState.md @@ -0,0 +1,14 @@ +# DateColumnInitialIncrementalState + +The state for an incremental table import using a column with a date type. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**column_name** | str | Yes | | +**current_value** | date | Yes | The initial incremental state value for the date column to reference in the query. | +**type** | Literal["dateColumnInitialIncrementalState"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/DecimalColumnInitialIncrementalState.md b/docs/v2/Connectivity/models/DecimalColumnInitialIncrementalState.md new file mode 100644 index 000000000..e71cd4d31 --- /dev/null +++ b/docs/v2/Connectivity/models/DecimalColumnInitialIncrementalState.md @@ -0,0 +1,14 @@ +# DecimalColumnInitialIncrementalState + +The state for an incremental table import using a column with a decimal data type. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**column_name** | str | Yes | | +**current_value** | decimal.Decimal | Yes | The initial incremental state value for the decimal column to reference in the query. | +**type** | Literal["decimalColumnInitialIncrementalState"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/IntegerColumnInitialIncrementalState.md b/docs/v2/Connectivity/models/IntegerColumnInitialIncrementalState.md new file mode 100644 index 000000000..d2511f2fe --- /dev/null +++ b/docs/v2/Connectivity/models/IntegerColumnInitialIncrementalState.md @@ -0,0 +1,14 @@ +# IntegerColumnInitialIncrementalState + +The state for an incremental table import using a numeric integer datatype. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**column_name** | str | Yes | | +**current_value** | int | Yes | The initial incremental state value for the integer column to reference in the query. | +**type** | Literal["integerColumnInitialIncrementalState"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/JdbcConnectionConfiguration.md b/docs/v2/Connectivity/models/JdbcConnectionConfiguration.md index 4af6cd075..9f0a0f7fb 100644 --- a/docs/v2/Connectivity/models/JdbcConnectionConfiguration.md +++ b/docs/v2/Connectivity/models/JdbcConnectionConfiguration.md @@ -8,7 +8,7 @@ The configuration needed to connect to an external system using the JDBC protoco | ------------ | ------------- | ------------- | ------------- | **url** | str | Yes | The URL that the JDBC driver uses to connect to a database. | **driver_class** | str | Yes | The fully-qualified driver class name that is used to connect to the database. | -**jdbc_properties** | Dict[str, str] | Yes | The list of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed to the JDBC driver to configure behavior. Refer to the documentation of your specific connection for additional available JDBC properties to add to your connection configuration. | +**jdbc_properties** | Dict[str, str] | Yes | A map of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed to the JDBC driver to configure behavior. Refer to the documentation of your specific connection type for additional available JDBC properties to add to your connection configuration. | **credentials** | Optional[BasicCredentials] | No | | **type** | Literal["jdbc"] | Yes | None | diff --git a/docs/v2/Connectivity/models/JdbcImportConfig.md b/docs/v2/Connectivity/models/JdbcImportConfig.md index 8b7f6ae74..958de65bc 100644 --- a/docs/v2/Connectivity/models/JdbcImportConfig.md +++ b/docs/v2/Connectivity/models/JdbcImportConfig.md @@ -7,6 +7,7 @@ The import configuration for a [custom JDBC connection](/docs/foundry/available- | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**initial_incremental_state** | Optional[TableImportInitialIncrementalState] | No | | **type** | Literal["jdbcImportConfig"] | Yes | None | diff --git a/docs/v2/Connectivity/models/LongColumnInitialIncrementalState.md b/docs/v2/Connectivity/models/LongColumnInitialIncrementalState.md new file mode 100644 index 000000000..8ba71010e --- /dev/null +++ b/docs/v2/Connectivity/models/LongColumnInitialIncrementalState.md @@ -0,0 +1,14 @@ +# LongColumnInitialIncrementalState + +The state for an incremental table import using a column with a numeric long datatype. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**column_name** | str | Yes | | +**current_value** | Long | Yes | The initial incremental state value for the long column to reference in the query. | +**type** | Literal["longColumnInitialIncrementalState"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/MicrosoftAccessImportConfig.md b/docs/v2/Connectivity/models/MicrosoftAccessImportConfig.md index 8c5730dde..b5a2798d0 100644 --- a/docs/v2/Connectivity/models/MicrosoftAccessImportConfig.md +++ b/docs/v2/Connectivity/models/MicrosoftAccessImportConfig.md @@ -7,6 +7,7 @@ The import configuration for a [Microsoft Access connection](/docs/foundry/avail | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**initial_incremental_state** | Optional[TableImportInitialIncrementalState] | No | | **type** | Literal["microsoftAccessImportConfig"] | Yes | None | diff --git a/docs/v2/Connectivity/models/MicrosoftSqlServerImportConfig.md b/docs/v2/Connectivity/models/MicrosoftSqlServerImportConfig.md index 58c00053f..8d0e13375 100644 --- a/docs/v2/Connectivity/models/MicrosoftSqlServerImportConfig.md +++ b/docs/v2/Connectivity/models/MicrosoftSqlServerImportConfig.md @@ -7,6 +7,7 @@ The import configuration for a [Microsoft SQL Server connection](/docs/foundry/a | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**initial_incremental_state** | Optional[TableImportInitialIncrementalState] | No | | **type** | Literal["microsoftSqlServerImportConfig"] | Yes | None | diff --git a/docs/v2/Connectivity/models/OracleImportConfig.md b/docs/v2/Connectivity/models/OracleImportConfig.md index 31c3b27cb..7840f0c51 100644 --- a/docs/v2/Connectivity/models/OracleImportConfig.md +++ b/docs/v2/Connectivity/models/OracleImportConfig.md @@ -7,6 +7,7 @@ The import configuration for an Oracle Database 21 connection. | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**initial_incremental_state** | Optional[TableImportInitialIncrementalState] | No | | **type** | Literal["oracleImportConfig"] | Yes | None | diff --git a/docs/v2/Connectivity/models/PostgreSqlImportConfig.md b/docs/v2/Connectivity/models/PostgreSqlImportConfig.md index 02f125781..5fdde38de 100644 --- a/docs/v2/Connectivity/models/PostgreSqlImportConfig.md +++ b/docs/v2/Connectivity/models/PostgreSqlImportConfig.md @@ -7,6 +7,7 @@ The import configuration for a [PostgreSQL connection](/docs/foundry/available-c | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**initial_incremental_state** | Optional[TableImportInitialIncrementalState] | No | | **type** | Literal["postgreSqlImportConfig"] | Yes | None | diff --git a/docs/v2/Connectivity/models/SnowflakeAuthenticationMode.md b/docs/v2/Connectivity/models/SnowflakeAuthenticationMode.md new file mode 100644 index 000000000..249017248 --- /dev/null +++ b/docs/v2/Connectivity/models/SnowflakeAuthenticationMode.md @@ -0,0 +1,17 @@ +# SnowflakeAuthenticationMode + +SnowflakeAuthenticationMode + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +SnowflakeExternalOauth | externalOauth +SnowflakeKeyPairAuthentication | keyPair +BasicCredentials | basic + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/SnowflakeConnectionConfiguration.md b/docs/v2/Connectivity/models/SnowflakeConnectionConfiguration.md new file mode 100644 index 000000000..a4fb6280c --- /dev/null +++ b/docs/v2/Connectivity/models/SnowflakeConnectionConfiguration.md @@ -0,0 +1,19 @@ +# SnowflakeConnectionConfiguration + +The configuration needed to connect to a Snowflake database. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**account_identifier** | str | Yes | An [account identifier](https://docs.snowflake.com/en/user-guide/admin-account-identifier) uniquely identifies a Snowflake account within your organization, as well as throughout the global network of Snowflake-supported cloud platforms and cloud regions. The URL for an account uses the following format: .snowflakecomputing.com. An example URL is https://acme-test_aws_us_east_2.snowflakecomputing.com. | +**database** | Optional[str] | No | Specifies the default database to use once connected. If unspecified, defaults to the empty string. The specified database should be an existing database for which the specified default role has privileges. See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#db | +**role** | Optional[str] | No | Specifies the default access control role to use in the Snowflake session initiated by the driver. If unspecified, no role will be used when the session is initiated by the driver. The specified role should be an existing role that has already been assigned to the specified user for the driver. If the specified role has not already been assigned to the user, the role is not used when the session is initiated by the driver. See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#role | +**schema_** | Optional[str] | No | Specifies the default schema to use for the specified database once connected. If unspecified, defaults to the empty string. The specified schema should be an existing schema for which the specified default role has privileges. See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#schema | +**warehouse** | Optional[str] | No | Specifies the virtual warehouse to use once connected. If unspecified, defaults to the empty string. The specified warehouse should be an existing warehouse for which the specified default role has privileges. See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#warehouse | +**authentication_mode** | SnowflakeAuthenticationMode | Yes | The authentication mode to use to connect to the Snowflake database. | +**jdbc_properties** | Dict[str, str] | Yes | A map of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed to the JDBC driver to configure behavior. Refer to the documentation of your specific connection type for additional available JDBC properties to add to your connection configuration. | +**type** | Literal["snowflake"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/SnowflakeExternalOauth.md b/docs/v2/Connectivity/models/SnowflakeExternalOauth.md new file mode 100644 index 000000000..a0b1e5a5d --- /dev/null +++ b/docs/v2/Connectivity/models/SnowflakeExternalOauth.md @@ -0,0 +1,17 @@ +# SnowflakeExternalOauth + +Use an External OAuth security integration to connect and authenticate to Snowflake. + +See https://docs.snowflake.com/en/user-guide/oauth-ext-custom + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**audience** | str | Yes | Identifies the recipients that the access token is intended for as a string URI. | +**issuer_url** | str | Yes | Identifies the principal that issued the access token as a string URI. | +**subject** | ConnectionRid | Yes | The RID of the Connection that is connecting to the external system. | +**type** | Literal["externalOauth"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/SnowflakeKeyPairAuthentication.md b/docs/v2/Connectivity/models/SnowflakeKeyPairAuthentication.md new file mode 100644 index 000000000..59a76dae0 --- /dev/null +++ b/docs/v2/Connectivity/models/SnowflakeKeyPairAuthentication.md @@ -0,0 +1,16 @@ +# SnowflakeKeyPairAuthentication + +Use a key-pair to connect and authenticate to Snowflake. + +See https://docs.snowflake.com/en/user-guide/key-pair-auth + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**user** | str | Yes | | +**private_key** | EncryptedProperty | Yes | | +**type** | Literal["keyPair"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/SnowflakeTableImportConfig.md b/docs/v2/Connectivity/models/SnowflakeTableImportConfig.md new file mode 100644 index 000000000..66061ed56 --- /dev/null +++ b/docs/v2/Connectivity/models/SnowflakeTableImportConfig.md @@ -0,0 +1,14 @@ +# SnowflakeTableImportConfig + +The table import configuration for a [Snowflake connection](/docs/foundry/available-connectors/snowflake). + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | str | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**initial_incremental_state** | Optional[TableImportInitialIncrementalState] | No | | +**type** | Literal["snowflakeImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/StringColumnInitialIncrementalState.md b/docs/v2/Connectivity/models/StringColumnInitialIncrementalState.md new file mode 100644 index 000000000..9dc81155f --- /dev/null +++ b/docs/v2/Connectivity/models/StringColumnInitialIncrementalState.md @@ -0,0 +1,14 @@ +# StringColumnInitialIncrementalState + +The state for an incremental table import using a column with a string data type. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**column_name** | str | Yes | | +**current_value** | str | Yes | The initial incremental state value for the string column to reference in the query. | +**type** | Literal["stringColumnInitialIncrementalState"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/TableImportConfig.md b/docs/v2/Connectivity/models/TableImportConfig.md index 3074a8840..f6c840aa9 100644 --- a/docs/v2/Connectivity/models/TableImportConfig.md +++ b/docs/v2/Connectivity/models/TableImportConfig.md @@ -14,6 +14,7 @@ JdbcImportConfig | jdbcImportConfig MicrosoftSqlServerImportConfig | microsoftSqlServerImportConfig PostgreSqlImportConfig | postgreSqlImportConfig MicrosoftAccessImportConfig | microsoftAccessImportConfig +SnowflakeTableImportConfig | snowflakeImportConfig OracleImportConfig | oracleImportConfig diff --git a/docs/v2/Connectivity/models/TableImportInitialIncrementalState.md b/docs/v2/Connectivity/models/TableImportInitialIncrementalState.md new file mode 100644 index 000000000..bd5ec44b3 --- /dev/null +++ b/docs/v2/Connectivity/models/TableImportInitialIncrementalState.md @@ -0,0 +1,27 @@ +# TableImportInitialIncrementalState + +The incremental configuration for a table import enables append-style transactions from the same table without duplication of data. +You must provide a monotonically increasing column such as a timestamp or id and an initial value for this column. +An incremental table import will import rows where the value is greater than the largest already imported. + +You can use the '?' character to reference the incremental state value when constructing your query. +Normally this would be used in a WHERE clause or similar filter applied in order to only sync data with an incremental column value +larger than the previously observed maximum value stored in the incremental state. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +StringColumnInitialIncrementalState | stringColumnInitialIncrementalState +DateColumnInitialIncrementalState | dateColumnInitialIncrementalState +IntegerColumnInitialIncrementalState | integerColumnInitialIncrementalState +TimestampColumnInitialIncrementalState | timestampColumnInitialIncrementalState +LongColumnInitialIncrementalState | longColumnInitialIncrementalState +DecimalColumnInitialIncrementalState | decimalColumnInitialIncrementalState + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Connectivity/models/TimestampColumnInitialIncrementalState.md b/docs/v2/Connectivity/models/TimestampColumnInitialIncrementalState.md new file mode 100644 index 000000000..af7bbba39 --- /dev/null +++ b/docs/v2/Connectivity/models/TimestampColumnInitialIncrementalState.md @@ -0,0 +1,13 @@ +# TimestampColumnInitialIncrementalState + +TimestampColumnInitialIncrementalState + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**column_name** | str | Yes | | +**current_value** | datetime | Yes | The initial incremental state value for the timestamp column in UTC to reference in the query. | +**type** | Literal["timestampColumnInitialIncrementalState"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Core/models/GeohashType.md b/docs/v2/Core/models/GeohashType.md new file mode 100644 index 000000000..c2f116092 --- /dev/null +++ b/docs/v2/Core/models/GeohashType.md @@ -0,0 +1,11 @@ +# GeohashType + +GeohashType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["geohash"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Datasets/Branch.md b/docs/v2/Datasets/Branch.md index f07604b0b..251f961a5 100644 --- a/docs/v2/Datasets/Branch.md +++ b/docs/v2/Datasets/Branch.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -80,7 +80,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -131,7 +131,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -183,7 +183,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Datasets/Dataset.md b/docs/v2/Datasets/Dataset.md index a326160c3..f9c0c7153 100644 --- a/docs/v2/Datasets/Dataset.md +++ b/docs/v2/Datasets/Dataset.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -74,7 +74,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -130,7 +130,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Datasets/File.md b/docs/v2/Datasets/File.md index ba4adf899..a2d6696a7 100644 --- a/docs/v2/Datasets/File.md +++ b/docs/v2/Datasets/File.md @@ -44,7 +44,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -118,7 +118,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -193,7 +193,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -277,7 +277,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -358,7 +358,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Datasets/Transaction.md b/docs/v2/Datasets/Transaction.md index 6ebd10bad..dccc40795 100644 --- a/docs/v2/Datasets/Transaction.md +++ b/docs/v2/Datasets/Transaction.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -81,7 +81,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -137,7 +137,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -189,7 +189,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -266,7 +266,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -320,7 +320,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Filesystem/Folder.md b/docs/v2/Filesystem/Folder.md index 649e3a08a..304497fda 100644 --- a/docs/v2/Filesystem/Folder.md +++ b/docs/v2/Filesystem/Folder.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -84,7 +84,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -138,7 +138,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Filesystem/Project.md b/docs/v2/Filesystem/Project.md index 0b385c6c6..17c8f52cd 100644 --- a/docs/v2/Filesystem/Project.md +++ b/docs/v2/Filesystem/Project.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -90,7 +90,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -166,7 +166,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -231,7 +231,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -285,7 +285,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -341,7 +341,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Filesystem/Resource.md b/docs/v2/Filesystem/Resource.md index 123929862..79d49ff18 100644 --- a/docs/v2/Filesystem/Resource.md +++ b/docs/v2/Filesystem/Resource.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -85,7 +85,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -135,7 +135,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -187,7 +187,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -239,7 +239,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -293,7 +293,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -350,7 +350,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -403,7 +403,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -459,7 +459,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Filesystem/ResourceRole.md b/docs/v2/Filesystem/ResourceRole.md index 09a85c91c..90efd0d3a 100644 --- a/docs/v2/Filesystem/ResourceRole.md +++ b/docs/v2/Filesystem/ResourceRole.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -81,7 +81,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -143,7 +143,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Filesystem/Space.md b/docs/v2/Filesystem/Space.md index d01d41311..34d4e370b 100644 --- a/docs/v2/Filesystem/Space.md +++ b/docs/v2/Filesystem/Space.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Functions/Query.md b/docs/v2/Functions/Query.md index 8f8fb4a8d..164f8de9a 100644 --- a/docs/v2/Functions/Query.md +++ b/docs/v2/Functions/Query.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -81,7 +81,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -132,7 +132,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Functions/ValueType.md b/docs/v2/Functions/ValueType.md index 1e32d1916..8335d8933 100644 --- a/docs/v2/Functions/ValueType.md +++ b/docs/v2/Functions/ValueType.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Functions/VersionId.md b/docs/v2/Functions/VersionId.md index 1659c90a0..0b0d7d16d 100644 --- a/docs/v2/Functions/VersionId.md +++ b/docs/v2/Functions/VersionId.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/MediaSets/MediaSet.md b/docs/v2/MediaSets/MediaSet.md index 7d5f8da39..5a241a3a8 100644 --- a/docs/v2/MediaSets/MediaSet.md +++ b/docs/v2/MediaSets/MediaSet.md @@ -31,7 +31,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -89,7 +89,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -147,7 +147,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -206,7 +206,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -267,7 +267,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -328,7 +328,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -389,7 +389,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -456,7 +456,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/Action.md b/docs/v2/Ontologies/Action.md index 25a716984..d595496e0 100644 --- a/docs/v2/Ontologies/Action.md +++ b/docs/v2/Ontologies/Action.md @@ -34,7 +34,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -113,7 +113,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/ActionType.md b/docs/v2/Ontologies/ActionType.md index afaffcec0..b2de8952f 100644 --- a/docs/v2/Ontologies/ActionType.md +++ b/docs/v2/Ontologies/ActionType.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -78,7 +78,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -137,7 +137,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/Attachment.md b/docs/v2/Ontologies/Attachment.md index ae50d6794..b1ba8e56e 100644 --- a/docs/v2/Ontologies/Attachment.md +++ b/docs/v2/Ontologies/Attachment.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -76,7 +76,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -134,7 +134,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/AttachmentProperty.md b/docs/v2/Ontologies/AttachmentProperty.md index 17c38a1d8..2fe7e3506 100644 --- a/docs/v2/Ontologies/AttachmentProperty.md +++ b/docs/v2/Ontologies/AttachmentProperty.md @@ -31,7 +31,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -105,7 +105,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -181,7 +181,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -257,7 +257,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/CipherTextProperty.md b/docs/v2/Ontologies/CipherTextProperty.md new file mode 100644 index 000000000..99d399c4e --- /dev/null +++ b/docs/v2/Ontologies/CipherTextProperty.md @@ -0,0 +1,68 @@ +# CipherTextProperty + +Method | HTTP request | Release Stage | +------------- | ------------- | ----- | +[**decrypt**](#decrypt) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/ciphertexts/{property}/decrypt | Private Beta | + +# **decrypt** +Decrypt the value of a ciphertext property. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read api:ontologies-decrypt-ciphertext`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | +**object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | | +**primary_key** | PropertyValueEscapedString | The primary key of the object with the CipherText property. | | +**property** | PropertyApiName | The API name of the CipherText property. To find the API name for your CipherText property, check the **Ontology Manager** or use the **Get object type** endpoint. | | + +### Return type +**DecryptionResult** + +### Example + +```python +from foundry_sdk import FoundryClient +import foundry_sdk +from pprint import pprint + +client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") + +# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. +ontology = "palantir" +# ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. +object_type = "employee" +# PropertyValueEscapedString | The primary key of the object with the CipherText property. +primary_key = 50030 +# PropertyApiName | The API name of the CipherText property. To find the API name for your CipherText property, check the **Ontology Manager** or use the **Get object type** endpoint. +property = "performance" + + +try: + api_response = foundry_client.ontologies.CipherTextProperty.decrypt( + ontology, object_type, primary_key, property + ) + print("The decrypt response:\n") + pprint(api_response) +except foundry_sdk.PalantirRPCException as e: + print("HTTP error when calling CipherTextProperty.decrypt: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | DecryptionResult | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/Ontologies/LinkedObject.md b/docs/v2/Ontologies/LinkedObject.md index 8d1f90eb1..4165edc4d 100644 --- a/docs/v2/Ontologies/LinkedObject.md +++ b/docs/v2/Ontologies/LinkedObject.md @@ -33,7 +33,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -131,7 +131,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/MediaReferenceProperty.md b/docs/v2/Ontologies/MediaReferenceProperty.md index f6b822c19..98673e020 100644 --- a/docs/v2/Ontologies/MediaReferenceProperty.md +++ b/docs/v2/Ontologies/MediaReferenceProperty.md @@ -30,7 +30,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -106,7 +106,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -182,7 +182,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/ObjectType.md b/docs/v2/Ontologies/ObjectType.md index bbeeb4bbb..9572cc0ca 100644 --- a/docs/v2/Ontologies/ObjectType.md +++ b/docs/v2/Ontologies/ObjectType.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -81,7 +81,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -140,7 +140,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -202,7 +202,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -261,7 +261,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/Ontology.md b/docs/v2/Ontologies/Ontology.md index 3554d66d3..3a24f6bc4 100644 --- a/docs/v2/Ontologies/Ontology.md +++ b/docs/v2/Ontologies/Ontology.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -72,7 +72,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -121,7 +121,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/OntologyInterface.md b/docs/v2/Ontologies/OntologyInterface.md index 6adb58a00..59c87f854 100644 --- a/docs/v2/Ontologies/OntologyInterface.md +++ b/docs/v2/Ontologies/OntologyInterface.md @@ -41,7 +41,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -128,7 +128,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -195,7 +195,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -296,7 +296,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/OntologyObject.md b/docs/v2/Ontologies/OntologyObject.md index 9671551f3..eadcf66df 100644 --- a/docs/v2/Ontologies/OntologyObject.md +++ b/docs/v2/Ontologies/OntologyObject.md @@ -33,7 +33,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -119,7 +119,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -183,7 +183,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -273,7 +273,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -379,7 +379,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/OntologyObjectSet.md b/docs/v2/Ontologies/OntologyObjectSet.md index 9c2455cb3..cd9201e03 100644 --- a/docs/v2/Ontologies/OntologyObjectSet.md +++ b/docs/v2/Ontologies/OntologyObjectSet.md @@ -33,7 +33,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -105,7 +105,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -160,7 +160,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -225,7 +225,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -320,7 +320,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -420,7 +420,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/Query.md b/docs/v2/Ontologies/Query.md index e878aa025..13145e6a3 100644 --- a/docs/v2/Ontologies/Query.md +++ b/docs/v2/Ontologies/Query.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/QueryType.md b/docs/v2/Ontologies/QueryType.md index 6958594c7..47a57ad74 100644 --- a/docs/v2/Ontologies/QueryType.md +++ b/docs/v2/Ontologies/QueryType.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -81,7 +81,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/TimeSeriesPropertyV2.md b/docs/v2/Ontologies/TimeSeriesPropertyV2.md index 9ba6588f1..76ca692fb 100644 --- a/docs/v2/Ontologies/TimeSeriesPropertyV2.md +++ b/docs/v2/Ontologies/TimeSeriesPropertyV2.md @@ -30,7 +30,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -103,7 +103,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -179,7 +179,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/TimeSeriesValueBankProperty.md b/docs/v2/Ontologies/TimeSeriesValueBankProperty.md index f62876ca0..10160d558 100644 --- a/docs/v2/Ontologies/TimeSeriesValueBankProperty.md +++ b/docs/v2/Ontologies/TimeSeriesValueBankProperty.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -103,7 +103,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Ontologies/models/ActionParameterType.md b/docs/v2/Ontologies/models/ActionParameterType.md index b88437992..94e460e10 100644 --- a/docs/v2/Ontologies/models/ActionParameterType.md +++ b/docs/v2/Ontologies/models/ActionParameterType.md @@ -16,6 +16,7 @@ OntologyStructType | struct StringType | string DoubleType | double IntegerType | integer +GeoShapeType | geoshape LongType | long OntologyObjectTypeReferenceType | objectType BooleanType | boolean @@ -24,6 +25,7 @@ AttachmentType | attachment MediaReferenceType | mediaReference ActionParameterArrayType | array OntologyObjectSetType | objectSet +GeohashType | geohash OntologyObjectType | object TimestampType | timestamp diff --git a/docs/v2/Ontologies/models/DecryptionResult.md b/docs/v2/Ontologies/models/DecryptionResult.md new file mode 100644 index 000000000..365b0cd0b --- /dev/null +++ b/docs/v2/Ontologies/models/DecryptionResult.md @@ -0,0 +1,12 @@ +# DecryptionResult + +The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**plaintext** | Optional[Plaintext] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/SqlQueries/models/QueryId.md b/docs/v2/Ontologies/models/Plaintext.md similarity index 83% rename from docs/v2/SqlQueries/models/QueryId.md rename to docs/v2/Ontologies/models/Plaintext.md index 4d1f3f061..2172fbe85 100644 --- a/docs/v2/SqlQueries/models/QueryId.md +++ b/docs/v2/Ontologies/models/Plaintext.md @@ -1,6 +1,6 @@ -# QueryId +# Plaintext -The identifier of a Query. +Plaintext ## Type ```python diff --git a/docs/v2/Orchestration/Build.md b/docs/v2/Orchestration/Build.md index 50f81b75a..0bd6cf25b 100644 --- a/docs/v2/Orchestration/Build.md +++ b/docs/v2/Orchestration/Build.md @@ -2,10 +2,10 @@ Method | HTTP request | Release Stage | ------------- | ------------- | ----- | -[**cancel**](#cancel) | **POST** /v2/orchestration/builds/{buildRid}/cancel | Public Beta | -[**create**](#create) | **POST** /v2/orchestration/builds/create | Public Beta | -[**get**](#get) | **GET** /v2/orchestration/builds/{buildRid} | Public Beta | -[**get_batch**](#get_batch) | **POST** /v2/orchestration/builds/getBatch | Public Beta | +[**cancel**](#cancel) | **POST** /v2/orchestration/builds/{buildRid}/cancel | Stable | +[**create**](#create) | **POST** /v2/orchestration/builds/create | Stable | +[**get**](#get) | **GET** /v2/orchestration/builds/{buildRid} | Stable | +[**get_batch**](#get_batch) | **POST** /v2/orchestration/builds/getBatch | Stable | [**jobs**](#jobs) | **GET** /v2/orchestration/builds/{buildRid}/jobs | Public Beta | [**search**](#search) | **POST** /v2/orchestration/builds/search | Private Beta | @@ -18,7 +18,6 @@ Request a cancellation for all unfinished jobs in a build. The build's status wi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **build_rid** | BuildRid | The RID of a Build. | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type **None** @@ -26,7 +25,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -34,12 +33,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # BuildRid | The RID of a Build. build_rid = "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58" -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None try: - api_response = foundry_client.orchestration.Build.cancel(build_rid, preview=preview) + api_response = foundry_client.orchestration.Build.cancel(build_rid) print("The cancel response:\n") pprint(api_response) except foundry_sdk.PalantirRPCException as e: @@ -73,7 +70,6 @@ Name | Type | Description | Notes | **branch_name** | Optional[BranchName] | The target branch the build should run on. | [optional] | **force_build** | Optional[ForceBuild] | | [optional] | **notifications_enabled** | Optional[NotificationsEnabled] | The notification will be sent to the user that has most recently edited the schedule. No notification will be sent if the schedule has `scopeMode` set to `ProjectScope`. | [optional] | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | **retry_backoff_duration** | Optional[RetryBackoffDuration] | | [optional] | **retry_count** | Optional[RetryCount] | The number of retry attempts for failed jobs. | [optional] | @@ -83,7 +79,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -107,8 +103,6 @@ branch_name = "master" force_build = None # Optional[NotificationsEnabled] | The notification will be sent to the user that has most recently edited the schedule. No notification will be sent if the schedule has `scopeMode` set to `ProjectScope`. notifications_enabled = None -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None # Optional[RetryBackoffDuration] retry_backoff_duration = {"unit": "SECONDS", "value": 30} # Optional[RetryCount] | The number of retry attempts for failed jobs. @@ -123,7 +117,6 @@ try: branch_name=branch_name, force_build=force_build, notifications_enabled=notifications_enabled, - preview=preview, retry_backoff_duration=retry_backoff_duration, retry_count=retry_count, ) @@ -155,7 +148,6 @@ Get the Build with the specified rid. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **build_rid** | BuildRid | The RID of a Build. | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type **Build** @@ -163,7 +155,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -171,12 +163,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # BuildRid | The RID of a Build. build_rid = "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58" -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None try: - api_response = foundry_client.orchestration.Build.get(build_rid, preview=preview) + api_response = foundry_client.orchestration.Build.get(build_rid) print("The get response:\n") pprint(api_response) except foundry_sdk.PalantirRPCException as e: @@ -207,7 +197,6 @@ The maximum batch size for this endpoint is 100. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **body** | List[GetBuildsBatchRequestElement] | Body of the request | | -**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type **GetBuildsBatchResponse** @@ -215,7 +204,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -223,12 +212,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # List[GetBuildsBatchRequestElement] | Body of the request body = [{"buildRid": "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58"}] -# Optional[PreviewMode] | Enables the use of preview functionality. -preview = None try: - api_response = foundry_client.orchestration.Build.get_batch(body, preview=preview) + api_response = foundry_client.orchestration.Build.get_batch(body) print("The get_batch response:\n") pprint(api_response) except foundry_sdk.PalantirRPCException as e: @@ -267,7 +254,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -325,7 +312,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Orchestration/Job.md b/docs/v2/Orchestration/Job.md index aac54bda2..c87003e0e 100644 --- a/docs/v2/Orchestration/Job.md +++ b/docs/v2/Orchestration/Job.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -73,7 +73,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Orchestration/Schedule.md b/docs/v2/Orchestration/Schedule.md index 379a436f3..6a7b9b9a7 100644 --- a/docs/v2/Orchestration/Schedule.md +++ b/docs/v2/Orchestration/Schedule.md @@ -31,7 +31,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -111,7 +111,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -161,7 +161,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -211,7 +211,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -266,7 +266,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -349,7 +349,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -402,7 +402,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -457,7 +457,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Orchestration/ScheduleVersion.md b/docs/v2/Orchestration/ScheduleVersion.md index 125cbcbaa..abf26f7e5 100644 --- a/docs/v2/Orchestration/ScheduleVersion.md +++ b/docs/v2/Orchestration/ScheduleVersion.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -73,7 +73,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/SqlQueries/Query.md b/docs/v2/SqlQueries/SqlQuery.md similarity index 80% rename from docs/v2/SqlQueries/Query.md rename to docs/v2/SqlQueries/SqlQuery.md index 8683e5f77..568263a38 100644 --- a/docs/v2/SqlQueries/Query.md +++ b/docs/v2/SqlQueries/SqlQuery.md @@ -1,11 +1,11 @@ -# Query +# SqlQuery Method | HTTP request | Release Stage | ------------- | ------------- | ----- | -[**cancel**](#cancel) | **POST** /v2/sqlQueries/queries/{queryId}/cancel | Private Beta | -[**execute**](#execute) | **POST** /v2/sqlQueries/queries/execute | Private Beta | -[**get_results**](#get_results) | **GET** /v2/sqlQueries/queries/{queryId}/getResults | Private Beta | -[**get_status**](#get_status) | **GET** /v2/sqlQueries/queries/{queryId}/getStatus | Private Beta | +[**cancel**](#cancel) | **POST** /v2/sqlQueries/{sqlQueryId}/cancel | Private Beta | +[**execute**](#execute) | **POST** /v2/sqlQueries/execute | Private Beta | +[**get_results**](#get_results) | **GET** /v2/sqlQueries/{sqlQueryId}/getResults | Private Beta | +[**get_status**](#get_status) | **GET** /v2/sqlQueries/{sqlQueryId}/getStatus | Private Beta | # **cancel** Cancels a query. If the query is no longer running this is effectively a no-op. @@ -15,7 +15,7 @@ Cancels a query. If the query is no longer running this is effectively a no-op. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**query_id** | QueryId | The id of a query. | | +**sql_query_id** | SqlQueryId | The id of a query. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -24,24 +24,24 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# QueryId | The id of a query. -query_id = None +# SqlQueryId | The id of a query. +sql_query_id = None # Optional[PreviewMode] | Enables the use of preview functionality. preview = None try: - api_response = foundry_client.sql_queries.Query.cancel(query_id, preview=preview) + api_response = foundry_client.sql_queries.SqlQuery.cancel(sql_query_id, preview=preview) print("The cancel response:\n") pprint(api_response) except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Query.cancel: %s\n" % e) + print("HTTP error when calling SqlQuery.cancel: %s\n" % e) ``` @@ -76,7 +76,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -91,13 +91,13 @@ preview = None try: - api_response = foundry_client.sql_queries.Query.execute( + api_response = foundry_client.sql_queries.SqlQuery.execute( query=query, fallback_branch_ids=fallback_branch_ids, preview=preview ) print("The execute response:\n") pprint(api_response) except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Query.execute: %s\n" % e) + print("HTTP error when calling SqlQuery.execute: %s\n" % e) ``` @@ -123,7 +123,7 @@ one minute. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**query_id** | QueryId | The id of a query. | | +**sql_query_id** | SqlQueryId | The id of a query. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -132,24 +132,24 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# QueryId | The id of a query. -query_id = None +# SqlQueryId | The id of a query. +sql_query_id = None # Optional[PreviewMode] | Enables the use of preview functionality. preview = None try: - api_response = foundry_client.sql_queries.Query.get_results(query_id, preview=preview) + api_response = foundry_client.sql_queries.SqlQuery.get_results(sql_query_id, preview=preview) print("The get_results response:\n") pprint(api_response) except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Query.get_results: %s\n" % e) + print("HTTP error when calling SqlQuery.get_results: %s\n" % e) ``` @@ -174,7 +174,7 @@ Gets the status of a query. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**query_id** | QueryId | The id of a query. | | +**sql_query_id** | SqlQueryId | The id of a query. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -183,24 +183,24 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# QueryId | The id of a query. -query_id = None +# SqlQueryId | The id of a query. +sql_query_id = None # Optional[PreviewMode] | Enables the use of preview functionality. preview = None try: - api_response = foundry_client.sql_queries.Query.get_status(query_id, preview=preview) + api_response = foundry_client.sql_queries.SqlQuery.get_status(sql_query_id, preview=preview) print("The get_status response:\n") pprint(api_response) except foundry_sdk.PalantirRPCException as e: - print("HTTP error when calling Query.get_status: %s\n" % e) + print("HTTP error when calling SqlQuery.get_status: %s\n" % e) ``` diff --git a/docs/v2/SqlQueries/models/RunningQueryStatus.md b/docs/v2/SqlQueries/models/RunningQueryStatus.md index 403cba08f..8953d9b68 100644 --- a/docs/v2/SqlQueries/models/RunningQueryStatus.md +++ b/docs/v2/SqlQueries/models/RunningQueryStatus.md @@ -5,7 +5,7 @@ RunningQueryStatus ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**query_id** | QueryId | Yes | | +**query_id** | SqlQueryId | Yes | | **type** | Literal["running"] | Yes | None | diff --git a/docs/v2/SqlQueries/models/SqlQueryId.md b/docs/v2/SqlQueries/models/SqlQueryId.md new file mode 100644 index 000000000..d0e8c3808 --- /dev/null +++ b/docs/v2/SqlQueries/models/SqlQueryId.md @@ -0,0 +1,11 @@ +# SqlQueryId + +The identifier of a SQL Query. + +## Type +```python +str +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/SqlQueries/models/SucceededQueryStatus.md b/docs/v2/SqlQueries/models/SucceededQueryStatus.md index c0fb523dd..422a40fdf 100644 --- a/docs/v2/SqlQueries/models/SucceededQueryStatus.md +++ b/docs/v2/SqlQueries/models/SucceededQueryStatus.md @@ -5,7 +5,7 @@ SucceededQueryStatus ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**query_id** | QueryId | Yes | | +**query_id** | SqlQueryId | Yes | | **type** | Literal["succeeded"] | Yes | None | diff --git a/docs/v2/Streams/Dataset.md b/docs/v2/Streams/Dataset.md index bba55a97b..e8a0437e0 100644 --- a/docs/v2/Streams/Dataset.md +++ b/docs/v2/Streams/Dataset.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/Streams/Stream.md b/docs/v2/Streams/Stream.md index 440ffe75b..e54c9f8ac 100644 --- a/docs/v2/Streams/Stream.md +++ b/docs/v2/Streams/Stream.md @@ -31,7 +31,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -102,7 +102,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -160,7 +160,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -223,7 +223,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -286,7 +286,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -356,7 +356,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/ThirdPartyApplications/ThirdPartyApplication.md b/docs/v2/ThirdPartyApplications/ThirdPartyApplication.md index 7917b7d08..5f160f41d 100644 --- a/docs/v2/ThirdPartyApplications/ThirdPartyApplication.md +++ b/docs/v2/ThirdPartyApplications/ThirdPartyApplication.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/ThirdPartyApplications/Version.md b/docs/v2/ThirdPartyApplications/Version.md index b931c8f4e..e8c236ded 100644 --- a/docs/v2/ThirdPartyApplications/Version.md +++ b/docs/v2/ThirdPartyApplications/Version.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -80,7 +80,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -139,7 +139,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -195,7 +195,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -257,7 +257,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/docs/v2/ThirdPartyApplications/Website.md b/docs/v2/ThirdPartyApplications/Website.md index f91d29201..9968ffcd1 100644 --- a/docs/v2/ThirdPartyApplications/Website.md +++ b/docs/v2/ThirdPartyApplications/Website.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -75,7 +75,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint @@ -126,7 +126,7 @@ Name | Type | Description | Notes | ### Example ```python -from foundry_sdk.v2 import FoundryClient +from foundry_sdk import FoundryClient import foundry_sdk from pprint import pprint diff --git a/foundry_sdk/__init__.py b/foundry_sdk/__init__.py index b04e580ea..3bd174af3 100644 --- a/foundry_sdk/__init__.py +++ b/foundry_sdk/__init__.py @@ -50,6 +50,7 @@ # The SDK version from foundry_sdk._versions import __openapi_document_version__ from foundry_sdk._versions import __version__ +from foundry_sdk.v2 import FoundryClient # The OpenAPI specification version # See https://swagger.io/specification/#versions @@ -85,4 +86,5 @@ "WriteTimeout", "TimeoutError", "ApiNotFoundError", + "FoundryClient", ] diff --git a/foundry_sdk/_core/__init__.py b/foundry_sdk/_core/__init__.py index d4f4654d3..79677c64b 100644 --- a/foundry_sdk/_core/__init__.py +++ b/foundry_sdk/_core/__init__.py @@ -31,6 +31,7 @@ from foundry_sdk._core.user_token_auth_client import UserTokenAuth from foundry_sdk._core.utils import RID from foundry_sdk._core.utils import UUID +from foundry_sdk._core.utils import AwareDatetime from foundry_sdk._core.utils import Long from foundry_sdk._core.utils import Timeout from foundry_sdk._core.utils import maybe_ignore_preview diff --git a/foundry_sdk/_core/api_client.py b/foundry_sdk/_core/api_client.py index f05aa1c73..b99d60751 100644 --- a/foundry_sdk/_core/api_client.py +++ b/foundry_sdk/_core/api_client.py @@ -40,7 +40,6 @@ from typing_extensions import NotRequired from typing_extensions import ParamSpec from typing_extensions import TypedDict -from typing_extensions import deprecated from foundry_sdk._core.auth_utils import Auth from foundry_sdk._core.auth_utils import Token diff --git a/foundry_sdk/_core/auth_utils.py b/foundry_sdk/_core/auth_utils.py index 9bd6cbb62..3c9b18539 100644 --- a/foundry_sdk/_core/auth_utils.py +++ b/foundry_sdk/_core/auth_utils.py @@ -13,7 +13,6 @@ # limitations under the License. -import warnings from abc import ABC from abc import abstractmethod from typing import Callable diff --git a/foundry_sdk/_core/compute_module_pipeline_auth.py b/foundry_sdk/_core/compute_module_pipeline_auth.py index 729a0c781..ede1db0dd 100644 --- a/foundry_sdk/_core/compute_module_pipeline_auth.py +++ b/foundry_sdk/_core/compute_module_pipeline_auth.py @@ -14,10 +14,7 @@ import os -import warnings from typing import Callable -from typing import Optional -from typing import Tuple from typing import TypeVar from typing import Union diff --git a/foundry_sdk/_core/confidential_client_auth.py b/foundry_sdk/_core/confidential_client_auth.py index bdfcdebb7..c927a0ca5 100644 --- a/foundry_sdk/_core/confidential_client_auth.py +++ b/foundry_sdk/_core/confidential_client_auth.py @@ -15,7 +15,6 @@ import threading import time -import warnings from typing import List from typing import Optional @@ -95,18 +94,6 @@ def _auto_refresh_token() -> None: refresh_thread = threading.Thread(target=_auto_refresh_token, daemon=True) refresh_thread.start() - def sign_in_as_service_user(self) -> SignInResponse: - warnings.warn( - "sign_in_as_service_user() is deprecated. Use get_token() instead.", - DeprecationWarning, - stacklevel=2, - ) - - token = self.get_token() - return SignInResponse( - session={"accessToken": token.access_token, "expiresIn": token.expires_in} - ) - def sign_out(self) -> SignOutResponse: if self._token: self._server_oauth_flow_provider.revoke_token( diff --git a/foundry_sdk/_core/resource_iterator.py b/foundry_sdk/_core/resource_iterator.py index 6eaff7c74..b2fb1de9f 100644 --- a/foundry_sdk/_core/resource_iterator.py +++ b/foundry_sdk/_core/resource_iterator.py @@ -13,7 +13,6 @@ # limitations under the License. -import warnings from typing import Generic from typing import List from typing import Optional @@ -40,14 +39,6 @@ def data(self) -> List[T]: def next_page_token(self) -> Optional[str]: return self._page_iterator.next_page_token - @property - def page_iterator(self): - warnings.warn( - "Accessing the page_iterator directly is deprecated. You can now access data and next_page_token directly on the ResourceIterator.", - DeprecationWarning, - ) - return self._page_iterator - def __iter__(self): return self diff --git a/foundry_sdk/_core/user_token_auth_client.py b/foundry_sdk/_core/user_token_auth_client.py index 5e8010033..c421c214c 100644 --- a/foundry_sdk/_core/user_token_auth_client.py +++ b/foundry_sdk/_core/user_token_auth_client.py @@ -14,10 +14,7 @@ import os -import warnings from typing import Callable -from typing import Optional -from typing import Tuple from typing import TypeVar import httpx @@ -41,22 +38,14 @@ def access_token(self) -> str: class UserTokenAuth(Auth): - def __init__(self, hostname: Optional[str] = None, token: str = "") -> None: - if hostname is not None: - warnings.warn( - "The 'hostname' parameter is deprecated and will be removed in the next major version.", - DeprecationWarning, - stacklevel=2, - ) - - if token == "": - raise TypeError( - "UserTokenAuth.__init__() missing 1 required keyword-only argument: 'token'" - ) - - self._hostname = hostname + def __init__(self, token: str) -> None: + if not isinstance(token, str): + raise TypeError(f"The token must be a string, not {type(token)}.") + + if not token: + raise ValueError("The token cannot be empty.") + self._token = _UserToken(token) - super().__init__() def get_token(self) -> Token: if self._token is None: diff --git a/foundry_sdk/_core/utils.py b/foundry_sdk/_core/utils.py index 5a59c735e..49b9f60dc 100644 --- a/foundry_sdk/_core/utils.py +++ b/foundry_sdk/_core/utils.py @@ -16,9 +16,11 @@ import inspect import typing import warnings +from datetime import timezone from functools import wraps from typing import Any from typing import Callable +from typing import ForwardRef from typing import List from typing import TypeVar @@ -40,6 +42,7 @@ ), ] + Long = Annotated[ int, pydantic.PlainSerializer( @@ -50,6 +53,20 @@ when_used="json", ), ] +"""A long integer that is serialized to a string in JSON.""" + + +AwareDatetime = Annotated[ + pydantic.AwareDatetime, + pydantic.PlainSerializer( + lambda value: value.astimezone(timezone.utc).isoformat(), + return_type=str, + # Important: This ensures the value is not serialized when using to_dict() + # We only want to serialize when dumping to a JSON string + when_used="json", + ), +] +"""A datetime object that enforces timezones and is always serialized to UTC.""" Timeout = Annotated[int, pydantic.Field(gt=0)] @@ -81,17 +98,18 @@ def wrapper(*args: Any, **kwargs: Any) -> Any: return wrapper # type: ignore -def resolve_forward_references(type_obj: Any, globalns, localns): - if not hasattr(type_obj, "__origin__") or not hasattr(type_obj, "__args__"): +def resolve_forward_references(type_obj: Any, globalns: dict, localns: dict) -> Any: + if typing.get_origin(type_obj) is None: return type_obj args = tuple( ( typing._eval_type(arg, globalns, localns) # type: ignore - if isinstance(arg, typing.ForwardRef) + if isinstance(arg, ForwardRef) else resolve_forward_references(arg, globalns, localns) ) - for arg in type_obj.__args__ # type: ignore + for arg in typing.get_args(type_obj) # type: ignore ) setattr(type_obj, "__args__", args) + return type_obj diff --git a/foundry_sdk/_versions.py b/foundry_sdk/_versions.py index 128b18684..d6cf3842a 100644 --- a/foundry_sdk/_versions.py +++ b/foundry_sdk/_versions.py @@ -17,4 +17,4 @@ # using the autorelease bot __version__ = "0.0.0" -__openapi_document_version__ = "1.1126.0" +__openapi_document_version__ = "1.1135.0" diff --git a/foundry_sdk/v1/core/models.py b/foundry_sdk/v1/core/models.py index 39c6d900c..c6b7c7855 100644 --- a/foundry_sdk/v1/core/models.py +++ b/foundry_sdk/v1/core/models.py @@ -28,7 +28,7 @@ class AnyType(pydantic.BaseModel): type: typing.Literal["any"] = "any" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -39,7 +39,7 @@ class AttachmentType(pydantic.BaseModel): type: typing.Literal["attachment"] = "attachment" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -50,7 +50,7 @@ class BinaryType(pydantic.BaseModel): type: typing.Literal["binary"] = "binary" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -61,7 +61,7 @@ class BooleanType(pydantic.BaseModel): type: typing.Literal["boolean"] = "boolean" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -72,7 +72,7 @@ class ByteType(pydantic.BaseModel): type: typing.Literal["byte"] = "byte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -86,7 +86,7 @@ class CipherTextType(pydantic.BaseModel): type: typing.Literal["cipherText"] = "cipherText" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -105,7 +105,7 @@ class DateType(pydantic.BaseModel): type: typing.Literal["date"] = "date" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -122,7 +122,7 @@ class DecimalType(pydantic.BaseModel): type: typing.Literal["decimal"] = "decimal" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -151,7 +151,7 @@ class DoubleType(pydantic.BaseModel): type: typing.Literal["double"] = "double" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -170,7 +170,7 @@ class FloatType(pydantic.BaseModel): type: typing.Literal["float"] = "float" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -185,7 +185,7 @@ class IntegerType(pydantic.BaseModel): type: typing.Literal["integer"] = "integer" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -196,7 +196,7 @@ class LongType(pydantic.BaseModel): type: typing.Literal["long"] = "long" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -207,7 +207,7 @@ class MarkingType(pydantic.BaseModel): type: typing.Literal["marking"] = "marking" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -225,7 +225,7 @@ class NullType(pydantic.BaseModel): type: typing.Literal["null"] = "null" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -260,7 +260,7 @@ class ShortType(pydantic.BaseModel): type: typing.Literal["short"] = "short" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -275,7 +275,7 @@ class StringType(pydantic.BaseModel): type: typing.Literal["string"] = "string" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -290,7 +290,7 @@ class TimestampType(pydantic.BaseModel): type: typing.Literal["timestamp"] = "timestamp" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -306,7 +306,7 @@ class UnsupportedType(pydantic.BaseModel): type: typing.Literal["unsupported"] = "unsupported" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) diff --git a/foundry_sdk/v1/datasets/models.py b/foundry_sdk/v1/datasets/models.py index 0ff472650..cf459c632 100644 --- a/foundry_sdk/v1/datasets/models.py +++ b/foundry_sdk/v1/datasets/models.py @@ -16,7 +16,6 @@ from __future__ import annotations import typing -from datetime import datetime import pydantic @@ -31,7 +30,7 @@ class Branch(pydantic.BaseModel): transaction_rid: typing.Optional[TransactionRid] = pydantic.Field(alias=str("transactionRid"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -48,7 +47,7 @@ class Dataset(pydantic.BaseModel): parent_folder_rid: core_models.FolderRid = pydantic.Field(alias=str("parentFolderRid")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -67,10 +66,10 @@ class File(pydantic.BaseModel): path: core_models.FilePath transaction_rid: TransactionRid = pydantic.Field(alias=str("transactionRid")) # type: ignore[literal-required] size_bytes: typing.Optional[core.Long] = pydantic.Field(alias=str("sizeBytes"), default=None) # type: ignore[literal-required] - updated_time: datetime = pydantic.Field(alias=str("updatedTime")) # type: ignore[literal-required] + updated_time: core.AwareDatetime = pydantic.Field(alias=str("updatedTime")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -84,7 +83,7 @@ class ListBranchesResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -96,7 +95,7 @@ class ListFilesResponse(pydantic.BaseModel): data: typing.List[File] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -111,15 +110,15 @@ class Transaction(pydantic.BaseModel): rid: TransactionRid transaction_type: TransactionType = pydantic.Field(alias=str("transactionType")) # type: ignore[literal-required] status: TransactionStatus - created_time: datetime = pydantic.Field(alias=str("createdTime")) # type: ignore[literal-required] + created_time: core.AwareDatetime = pydantic.Field(alias=str("createdTime")) # type: ignore[literal-required] """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" - closed_time: typing.Optional[datetime] = pydantic.Field(alias=str("closedTime"), default=None) # type: ignore[literal-required] + closed_time: typing.Optional[core.AwareDatetime] = pydantic.Field(alias=str("closedTime"), default=None) # type: ignore[literal-required] """The timestamp when the transaction was closed, in ISO 8601 timestamp format.""" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) diff --git a/foundry_sdk/v1/ontologies/errors.py b/foundry_sdk/v1/ontologies/errors.py index 606753a0f..a4d5b0f9a 100644 --- a/foundry_sdk/v1/ontologies/errors.py +++ b/foundry_sdk/v1/ontologies/errors.py @@ -275,6 +275,24 @@ class AttachmentSizeExceededLimit(errors.BadRequestError): error_instance_id: str +class CipherChannelNotFoundParameters(typing_extensions.TypedDict): + """ + The Cipher Channel was not found. + It either does not exist, or you do not have permission to see it. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + cipherChannel: core.RID + + +@dataclass +class CipherChannelNotFound(errors.NotFoundError): + name: typing.Literal["CipherChannelNotFound"] + parameters: CipherChannelNotFoundParameters + error_instance_id: str + + class CompositePrimaryKeyNotSupportedParameters(typing_extensions.TypedDict): """ Primary keys consisting of multiple properties are not supported by this API. If you need support for this, @@ -1039,6 +1057,25 @@ class MultiplePropertyValuesNotSupported(errors.BadRequestError): error_instance_id: str +class NotCipherFormattedParameters(typing_extensions.TypedDict): + """ + The value intended for decryption with Cipher is not formatted correctly. + It may already be a plaintext value and not require decryption. + Ensure it is correctly formatted (CIPHER::::::CIPHER). + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: str + + +@dataclass +class NotCipherFormatted(errors.BadRequestError): + name: typing.Literal["NotCipherFormatted"] + parameters: NotCipherFormattedParameters + error_instance_id: str + + class ObjectAlreadyExistsParameters(typing_extensions.TypedDict): """The object the user is attempting to create already exists.""" @@ -1628,6 +1665,21 @@ class QueryTimeExceededLimit(errors.InternalServerError): error_instance_id: str +class RateLimitReachedParameters(typing_extensions.TypedDict): + """Unable to decrypt this CipherText because the available rate limits in Cipher licenses were reached.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + cipherChannel: core.RID + + +@dataclass +class RateLimitReached(errors.PermissionDeniedError): + name: typing.Literal["RateLimitReached"] + parameters: RateLimitReachedParameters + error_instance_id: str + + class SearchVectorDimensionsDifferParameters(typing_extensions.TypedDict): """The dimensions of the provided vector don't match the dimensions of the embedding model being queried.""" @@ -1686,6 +1738,39 @@ class TooManyNearestNeighborsRequested(errors.BadRequestError): error_instance_id: str +class UnauthorizedCipherOperationParameters(typing_extensions.TypedDict): + """The provided token does not have permission to take a specific Cipher operation.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + cipherChannel: core.RID + + +@dataclass +class UnauthorizedCipherOperation(errors.PermissionDeniedError): + name: typing.Literal["UnauthorizedCipherOperation"] + parameters: UnauthorizedCipherOperationParameters + error_instance_id: str + + +class UndecryptableValueParameters(typing_extensions.TypedDict): + """ + The value intended for decryption with Cipher cannot be decrypted. + Ensure it is correctly formatted (CIPHER:::::CIPHER). + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: str + + +@dataclass +class UndecryptableValue(errors.BadRequestError): + name: typing.Literal["UndecryptableValue"] + parameters: UndecryptableValueParameters + error_instance_id: str + + class UnknownParameterParameters(typing_extensions.TypedDict): """ The provided parameters were not found. Please look at the `knownParameters` field @@ -1752,6 +1837,7 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): "ApplyActionFailed", "AttachmentNotFound", "AttachmentSizeExceededLimit", + "CipherChannelNotFound", "CompositePrimaryKeyNotSupported", "DerivedPropertyApiNamesNotUnique", "DuplicateOrderBy", @@ -1798,6 +1884,7 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): "MissingParameter", "MultipleGroupByOnFieldNotSupported", "MultiplePropertyValuesNotSupported", + "NotCipherFormatted", "ObjectAlreadyExists", "ObjectChanged", "ObjectNotFound", @@ -1833,10 +1920,13 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): "QueryNotFound", "QueryRuntimeError", "QueryTimeExceededLimit", + "RateLimitReached", "SearchVectorDimensionsDiffer", "SharedPropertiesNotFound", "SharedPropertyTypeNotFound", "TooManyNearestNeighborsRequested", + "UnauthorizedCipherOperation", + "UndecryptableValue", "UnknownParameter", "UnsupportedObjectSet", "ViewObjectPermissionDenied", diff --git a/foundry_sdk/v1/ontologies/models.py b/foundry_sdk/v1/ontologies/models.py index 717565b70..7a4689a86 100644 --- a/foundry_sdk/v1/ontologies/models.py +++ b/foundry_sdk/v1/ontologies/models.py @@ -39,7 +39,7 @@ class ActionType(pydantic.BaseModel): operations: typing.List[LogicRule] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -63,7 +63,7 @@ class AggregateObjectsResponse(pydantic.BaseModel): data: typing.List[AggregateObjectsResponseItem] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -75,7 +75,7 @@ class AggregateObjectsResponseItem(pydantic.BaseModel): metrics: typing.List[AggregationMetricResult] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -105,7 +105,7 @@ class AggregationDurationGrouping(pydantic.BaseModel): type: typing.Literal["duration"] = "duration" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -118,7 +118,7 @@ class AggregationExactGrouping(pydantic.BaseModel): type: typing.Literal["exact"] = "exact" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -131,7 +131,7 @@ class AggregationFixedWidthGrouping(pydantic.BaseModel): type: typing.Literal["fixedWidth"] = "fixedWidth" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -169,7 +169,7 @@ class AggregationMetricResult(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -191,7 +191,7 @@ class AggregationRange(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -204,7 +204,7 @@ class AggregationRangesGrouping(pydantic.BaseModel): type: typing.Literal["ranges"] = "ranges" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -221,7 +221,7 @@ class AllTermsQuery(pydantic.BaseModel): type: typing.Literal["allTerms"] = "allTerms" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -233,7 +233,7 @@ class AndQuery(pydantic.BaseModel): type: typing.Literal["and"] = "and" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -250,7 +250,7 @@ class AnyTermQuery(pydantic.BaseModel): type: typing.Literal["anyTerm"] = "anyTerm" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -265,7 +265,7 @@ class ApplyActionRequest(pydantic.BaseModel): parameters: typing.Dict[ParameterId, typing.Optional[DataValue]] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -277,7 +277,7 @@ class ApplyActionRequestOptions(pydantic.BaseModel): return_edits: typing.Optional[ReturnEditsMode] = pydantic.Field(alias=str("returnEdits"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -287,7 +287,7 @@ class ApplyActionResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -300,7 +300,7 @@ class ApproximateDistinctAggregation(pydantic.BaseModel): type: typing.Literal["approximateDistinct"] = "approximateDistinct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -323,7 +323,7 @@ class ArraySizeConstraint(pydantic.BaseModel): type: typing.Literal["arraySize"] = "arraySize" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -341,7 +341,7 @@ class Attachment(pydantic.BaseModel): media_type: core_models.MediaType = pydantic.Field(alias=str("mediaType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -358,7 +358,7 @@ class AvgAggregation(pydantic.BaseModel): type: typing.Literal["avg"] = "avg" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -368,7 +368,7 @@ class BatchApplyActionResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -381,7 +381,7 @@ class ContainsQuery(pydantic.BaseModel): type: typing.Literal["contains"] = "contains" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -393,7 +393,7 @@ class CountAggregation(pydantic.BaseModel): type: typing.Literal["count"] = "count" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -405,7 +405,7 @@ class CreateInterfaceObjectRule(pydantic.BaseModel): type: typing.Literal["createInterfaceObject"] = "createInterfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -420,7 +420,7 @@ class CreateLinkRule(pydantic.BaseModel): type: typing.Literal["createLink"] = "createLink" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -432,7 +432,7 @@ class CreateObjectRule(pydantic.BaseModel): type: typing.Literal["createObject"] = "createObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -477,7 +477,7 @@ class DeleteInterfaceObjectRule(pydantic.BaseModel): type: typing.Literal["deleteInterfaceObject"] = "deleteInterfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -492,7 +492,7 @@ class DeleteLinkRule(pydantic.BaseModel): type: typing.Literal["deleteLink"] = "deleteLink" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -504,7 +504,7 @@ class DeleteObjectRule(pydantic.BaseModel): type: typing.Literal["deleteObject"] = "deleteObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -525,7 +525,7 @@ class EntrySetType(pydantic.BaseModel): type: typing.Literal["entrySet"] = "entrySet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -538,7 +538,7 @@ class EqualsQuery(pydantic.BaseModel): type: typing.Literal["eq"] = "eq" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -549,7 +549,7 @@ class ExecuteQueryResponse(pydantic.BaseModel): value: DataValue model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -586,7 +586,7 @@ class GroupMemberConstraint(pydantic.BaseModel): type: typing.Literal["groupMember"] = "groupMember" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -599,7 +599,7 @@ class GtQuery(pydantic.BaseModel): type: typing.Literal["gt"] = "gt" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -612,7 +612,7 @@ class GteQuery(pydantic.BaseModel): type: typing.Literal["gte"] = "gte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -636,7 +636,7 @@ class IsNullQuery(pydantic.BaseModel): type: typing.Literal["isNull"] = "isNull" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -659,7 +659,7 @@ class LinkTypeSide(pydantic.BaseModel): foreign_key_property_api_name: typing.Optional[PropertyApiName] = pydantic.Field(alias=str("foreignKeyPropertyApiName"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -675,7 +675,7 @@ class ListActionTypesResponse(pydantic.BaseModel): data: typing.List[ActionType] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -687,7 +687,7 @@ class ListLinkedObjectsResponse(pydantic.BaseModel): data: typing.List[OntologyObject] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -701,7 +701,7 @@ class ListObjectTypesResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -716,7 +716,7 @@ class ListObjectsResponse(pydantic.BaseModel): total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -729,7 +729,7 @@ class ListOntologiesResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -743,7 +743,7 @@ class ListOutgoingLinkTypesResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -755,7 +755,7 @@ class ListQueryTypesResponse(pydantic.BaseModel): data: typing.List[QueryType] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -784,7 +784,7 @@ class LtQuery(pydantic.BaseModel): type: typing.Literal["lt"] = "lt" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -797,7 +797,7 @@ class LteQuery(pydantic.BaseModel): type: typing.Literal["lte"] = "lte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -810,7 +810,7 @@ class MaxAggregation(pydantic.BaseModel): type: typing.Literal["max"] = "max" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -823,7 +823,7 @@ class MinAggregation(pydantic.BaseModel): type: typing.Literal["min"] = "min" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -835,7 +835,7 @@ class ModifyInterfaceObjectRule(pydantic.BaseModel): type: typing.Literal["modifyInterfaceObject"] = "modifyInterfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -847,7 +847,7 @@ class ModifyObjectRule(pydantic.BaseModel): type: typing.Literal["modifyObject"] = "modifyObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -859,7 +859,7 @@ class NotQuery(pydantic.BaseModel): type: typing.Literal["not"] = "not" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -870,7 +870,7 @@ class ObjectPropertyValueConstraint(pydantic.BaseModel): type: typing.Literal["objectPropertyValue"] = "objectPropertyValue" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -881,7 +881,7 @@ class ObjectQueryResultConstraint(pydantic.BaseModel): type: typing.Literal["objectQueryResult"] = "objectQueryResult" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -913,7 +913,7 @@ class ObjectType(pydantic.BaseModel): rid: ObjectTypeRid model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -943,7 +943,7 @@ class OneOfConstraint(pydantic.BaseModel): type: typing.Literal["oneOf"] = "oneOf" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -957,7 +957,7 @@ class Ontology(pydantic.BaseModel): rid: OntologyRid model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -973,7 +973,7 @@ class OntologyArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1016,7 +1016,7 @@ class OntologyMapType(pydantic.BaseModel): type: typing.Literal["map"] = "map" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1030,7 +1030,7 @@ class OntologyObject(pydantic.BaseModel): rid: ObjectRid model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1043,7 +1043,7 @@ class OntologyObjectSetType(pydantic.BaseModel): type: typing.Literal["objectSet"] = "objectSet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1056,7 +1056,7 @@ class OntologyObjectType(pydantic.BaseModel): type: typing.Literal["object"] = "object" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1075,7 +1075,7 @@ class OntologySetType(pydantic.BaseModel): type: typing.Literal["set"] = "set" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1088,7 +1088,7 @@ class OntologyStructField(pydantic.BaseModel): required: bool model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1100,7 +1100,7 @@ class OntologyStructType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1112,7 +1112,7 @@ class OrQuery(pydantic.BaseModel): type: typing.Literal["or"] = "or" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1141,7 +1141,7 @@ class Parameter(pydantic.BaseModel): required: bool model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1191,7 +1191,7 @@ class ParameterEvaluationResult(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1212,7 +1212,7 @@ class ParameterOption(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1225,7 +1225,7 @@ class PhraseQuery(pydantic.BaseModel): type: typing.Literal["phrase"] = "phrase" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1238,7 +1238,7 @@ class PrefixQuery(pydantic.BaseModel): type: typing.Literal["prefix"] = "prefix" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1255,7 +1255,7 @@ class Property(pydantic.BaseModel): base_type: ValueType = pydantic.Field(alias=str("baseType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1372,7 +1372,7 @@ class QueryAggregationRangeType(pydantic.BaseModel): type: typing.Literal["range"] = "range" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1395,7 +1395,7 @@ class QueryArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1439,7 +1439,7 @@ class QuerySetType(pydantic.BaseModel): type: typing.Literal["set"] = "set" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1451,7 +1451,7 @@ class QueryStructField(pydantic.BaseModel): field_type: QueryDataType = pydantic.Field(alias=str("fieldType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1463,7 +1463,7 @@ class QueryStructType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1480,7 +1480,7 @@ class QueryType(pydantic.BaseModel): version: FunctionVersion model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1492,7 +1492,7 @@ class QueryUnionType(pydantic.BaseModel): type: typing.Literal["union"] = "union" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1515,7 +1515,7 @@ class RangeConstraint(pydantic.BaseModel): type: typing.Literal["range"] = "range" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1558,7 +1558,7 @@ class SearchObjectsResponse(pydantic.BaseModel): total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1569,7 +1569,7 @@ class SearchOrderBy(pydantic.BaseModel): fields: typing.List[SearchOrdering] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1587,7 +1587,7 @@ class SearchOrdering(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1644,7 +1644,7 @@ class StringLengthConstraint(pydantic.BaseModel): type: typing.Literal["stringLength"] = "stringLength" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1664,7 +1664,7 @@ class StringRegexMatchConstraint(pydantic.BaseModel): type: typing.Literal["stringRegexMatch"] = "stringRegexMatch" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1685,7 +1685,7 @@ class SubmissionCriteriaEvaluation(pydantic.BaseModel): result: ValidationResult model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1698,7 +1698,7 @@ class SumAggregation(pydantic.BaseModel): type: typing.Literal["sum"] = "sum" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1711,7 +1711,7 @@ class ThreeDimensionalAggregation(pydantic.BaseModel): type: typing.Literal["threeDimensionalAggregation"] = "threeDimensionalAggregation" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1724,7 +1724,7 @@ class TwoDimensionalAggregation(pydantic.BaseModel): type: typing.Literal["twoDimensionalAggregation"] = "twoDimensionalAggregation" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1738,7 +1738,7 @@ class UnevaluableConstraint(pydantic.BaseModel): type: typing.Literal["unevaluable"] = "unevaluable" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1751,7 +1751,7 @@ class ValidateActionResponse(pydantic.BaseModel): parameters: typing.Dict[ParameterId, ParameterEvaluationResult] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) diff --git a/foundry_sdk/v2/admin/errors.py b/foundry_sdk/v2/admin/errors.py index 2a431e0f2..6a05814be 100644 --- a/foundry_sdk/v2/admin/errors.py +++ b/foundry_sdk/v2/admin/errors.py @@ -15,10 +15,10 @@ import typing from dataclasses import dataclass -from datetime import datetime import typing_extensions +from foundry_sdk import _core as core from foundry_sdk import _errors as errors from foundry_sdk.v2.admin import models as admin_models from foundry_sdk.v2.core import models as core_models @@ -370,7 +370,7 @@ class InvalidGroupMembershipExpirationParameters(typing_extensions.TypedDict): groupId: core_models.PrincipalId expirationProvided: typing_extensions.NotRequired[admin_models.GroupMembershipExpiration] maximumDuration: typing_extensions.NotRequired[str] - latestExpiration: typing_extensions.NotRequired[datetime] + latestExpiration: typing_extensions.NotRequired[core.AwareDatetime] @dataclass diff --git a/foundry_sdk/v2/admin/models.py b/foundry_sdk/v2/admin/models.py index 17d1f4ec3..fbd20a3bc 100644 --- a/foundry_sdk/v2/admin/models.py +++ b/foundry_sdk/v2/admin/models.py @@ -16,7 +16,6 @@ from __future__ import annotations import typing -from datetime import datetime import pydantic import typing_extensions @@ -61,7 +60,7 @@ class AuthenticationProvider(pydantic.BaseModel): protocol: AuthenticationProtocol model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -85,11 +84,11 @@ class CertificateInfo(pydantic.BaseModel): """The certificate, in PEM format.""" common_name: typing.Optional[str] = pydantic.Field(alias=str("commonName"), default=None) # type: ignore[literal-required] - expiry_date: datetime = pydantic.Field(alias=str("expiryDate")) # type: ignore[literal-required] + expiry_date: core.AwareDatetime = pydantic.Field(alias=str("expiryDate")) # type: ignore[literal-required] usage_type: CertificateUsageType = pydantic.Field(alias=str("usageType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -106,7 +105,7 @@ class Enrollment(pydantic.BaseModel): created_time: typing.Optional[core_models.CreatedTime] = pydantic.Field(alias=str("createdTime"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -121,7 +120,7 @@ class GetGroupsBatchRequestElement(pydantic.BaseModel): group_id: core_models.PrincipalId = pydantic.Field(alias=str("groupId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -132,7 +131,7 @@ class GetGroupsBatchResponse(pydantic.BaseModel): data: typing.Dict[core_models.PrincipalId, Group] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -143,7 +142,7 @@ class GetMarkingsBatchRequestElement(pydantic.BaseModel): marking_id: core_models.MarkingId = pydantic.Field(alias=str("markingId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -154,7 +153,7 @@ class GetMarkingsBatchResponse(pydantic.BaseModel): data: typing.Dict[core_models.MarkingId, Marking] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -170,7 +169,7 @@ class GetUserMarkingsResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -181,7 +180,7 @@ class GetUsersBatchRequestElement(pydantic.BaseModel): user_id: core_models.PrincipalId = pydantic.Field(alias=str("userId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -192,7 +191,7 @@ class GetUsersBatchResponse(pydantic.BaseModel): data: typing.Dict[core_models.PrincipalId, User] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -216,7 +215,7 @@ class Group(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -228,7 +227,7 @@ class GroupMember(pydantic.BaseModel): principal_id: core_models.PrincipalId = pydantic.Field(alias=str("principalId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -239,12 +238,12 @@ class GroupMembership(pydantic.BaseModel): group_id: core_models.PrincipalId = pydantic.Field(alias=str("groupId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) -GroupMembershipExpiration = datetime +GroupMembershipExpiration = core.AwareDatetime """GroupMembershipExpiration""" @@ -263,7 +262,7 @@ class GroupProviderInfo(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -275,7 +274,7 @@ class GroupSearchFilter(pydantic.BaseModel): value: str model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -286,7 +285,7 @@ class Host(pydantic.BaseModel): host_name: HostName = pydantic.Field(alias=str("hostName")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -302,7 +301,7 @@ class ListAuthenticationProvidersResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -314,7 +313,7 @@ class ListGroupMembersResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -326,7 +325,7 @@ class ListGroupMembershipsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -338,7 +337,7 @@ class ListGroupsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -350,7 +349,7 @@ class ListHostsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -362,7 +361,7 @@ class ListMarkingCategoriesResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -374,7 +373,7 @@ class ListMarkingMembersResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -386,7 +385,7 @@ class ListMarkingRoleAssignmentsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -398,7 +397,7 @@ class ListMarkingsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -410,7 +409,7 @@ class ListUsersResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -429,7 +428,7 @@ class Marking(pydantic.BaseModel): created_by: typing.Optional[core_models.CreatedBy] = pydantic.Field(alias=str("createdBy"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -447,7 +446,7 @@ class MarkingCategory(pydantic.BaseModel): created_by: typing.Optional[core_models.CreatedBy] = pydantic.Field(alias=str("createdBy"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -474,7 +473,7 @@ class MarkingMember(pydantic.BaseModel): principal_id: core_models.PrincipalId = pydantic.Field(alias=str("principalId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -500,7 +499,7 @@ class MarkingRoleAssignment(pydantic.BaseModel): role: MarkingRole model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -512,7 +511,7 @@ class MarkingRoleUpdate(pydantic.BaseModel): principal_id: core_models.PrincipalId = pydantic.Field(alias=str("principalId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -527,7 +526,7 @@ class OidcAuthenticationProtocol(pydantic.BaseModel): type: typing.Literal["oidc"] = "oidc" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -552,7 +551,7 @@ class Organization(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -576,7 +575,7 @@ class SamlAuthenticationProtocol(pydantic.BaseModel): type: typing.Literal["saml"] = "saml" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -602,7 +601,7 @@ class SamlServiceProviderMetadata(pydantic.BaseModel): certificates: typing.List[CertificateInfo] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -614,7 +613,7 @@ class SearchGroupsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -626,7 +625,7 @@ class SearchUsersResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -660,7 +659,7 @@ class User(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -676,7 +675,7 @@ class UserProviderInfo(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -688,7 +687,7 @@ class UserSearchFilter(pydantic.BaseModel): value: str model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) diff --git a/foundry_sdk/v2/aip_agents/models.py b/foundry_sdk/v2/aip_agents/models.py index 96e4514ea..80248c9c0 100644 --- a/foundry_sdk/v2/aip_agents/models.py +++ b/foundry_sdk/v2/aip_agents/models.py @@ -16,7 +16,6 @@ from __future__ import annotations import typing -from datetime import datetime import pydantic import typing_extensions @@ -45,7 +44,7 @@ class Agent(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -71,7 +70,7 @@ class AgentMetadata(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -87,7 +86,7 @@ class AgentSessionRagContextResponse(pydantic.BaseModel): function_retrieved_contexts: typing.List[FunctionRetrievedContext] = pydantic.Field(alias=str("functionRetrievedContexts")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -103,7 +102,7 @@ class AgentVersion(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -119,7 +118,7 @@ class AgentVersionDetails(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -143,7 +142,7 @@ class AgentsSessionsPage(pydantic.BaseModel): data: typing.List[Session] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -159,7 +158,7 @@ class CancelSessionResponse(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -176,7 +175,7 @@ class Content(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -192,7 +191,7 @@ class FunctionRetrievedContext(pydantic.BaseModel): type: typing.Literal["functionRetrievedContext"] = "functionRetrievedContext" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -210,7 +209,7 @@ class ListAgentVersionsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -222,7 +221,7 @@ class ListSessionsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -246,7 +245,7 @@ class ObjectContext(pydantic.BaseModel): type: typing.Literal["objectContext"] = "objectContext" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -260,7 +259,7 @@ class ObjectSetParameter(pydantic.BaseModel): type: typing.Literal["objectSet"] = "objectSet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -278,7 +277,7 @@ class ObjectSetParameterValue(pydantic.BaseModel): type: typing.Literal["objectSet"] = "objectSet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -290,7 +289,7 @@ class ObjectSetParameterValueUpdate(pydantic.BaseModel): type: typing.Literal["objectSet"] = "objectSet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -312,7 +311,7 @@ class Parameter(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -373,7 +372,7 @@ class Session(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -396,7 +395,7 @@ class SessionExchange(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -409,7 +408,7 @@ class SessionExchangeContexts(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -437,7 +436,7 @@ class SessionExchangeResult(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -448,10 +447,10 @@ class SessionMetadata(pydantic.BaseModel): title: str """The title of the session.""" - created_time: datetime = pydantic.Field(alias=str("createdTime")) # type: ignore[literal-required] + created_time: core.AwareDatetime = pydantic.Field(alias=str("createdTime")) # type: ignore[literal-required] """The time the session was created.""" - updated_time: datetime = pydantic.Field(alias=str("updatedTime")) # type: ignore[literal-required] + updated_time: core.AwareDatetime = pydantic.Field(alias=str("updatedTime")) # type: ignore[literal-required] """The time the session was last updated.""" message_count: int = pydantic.Field(alias=str("messageCount")) # type: ignore[literal-required] @@ -460,7 +459,7 @@ class SessionMetadata(pydantic.BaseModel): Includes both user messages and Agent replies, so each complete exchange counts as two messages. """ - estimated_expires_time: datetime = pydantic.Field(alias=str("estimatedExpiresTime")) # type: ignore[literal-required] + estimated_expires_time: core.AwareDatetime = pydantic.Field(alias=str("estimatedExpiresTime")) # type: ignore[literal-required] """ The estimated time at which the session is due to expire. Once a session has expired, it can no longer be accessed and a new session must be created. @@ -469,7 +468,7 @@ class SessionMetadata(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -487,7 +486,7 @@ class StringParameter(pydantic.BaseModel): type: typing.Literal["string"] = "string" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -499,7 +498,7 @@ class StringParameterValue(pydantic.BaseModel): type: typing.Literal["string"] = "string" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -512,7 +511,7 @@ class UserTextInput(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) diff --git a/foundry_sdk/v2/cli.py b/foundry_sdk/v2/cli.py index f1bc256c6..ecbc79e7a 100644 --- a/foundry_sdk/v2/cli.py +++ b/foundry_sdk/v2/cli.py @@ -6131,6 +6131,40 @@ def ontologies_linked_object_list_linked_objects( click.echo(repr(result)) +@ontologies.group("cipher_text_property") +def ontologies_cipher_text_property(): + pass + + +@ontologies_cipher_text_property.command("decrypt") +@click.argument("ontology", type=str, required=True) +@click.argument("object_type", type=str, required=True) +@click.argument("primary_key", type=str, required=True) +@click.argument("property", type=str, required=True) +@click.pass_obj +def ontologies_cipher_text_property_decrypt( + client: foundry_sdk.v2.FoundryClient, + ontology: str, + object_type: str, + primary_key: str, + property: str, +): + """ + Decrypt the value of a ciphertext property. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read api:ontologies-decrypt-ciphertext`. + + """ + result = client.ontologies.CipherTextProperty.decrypt( + ontology=ontology, + object_type=object_type, + primary_key=primary_key, + property=property, + ) + click.echo(repr(result)) + + @ontologies.group("attachment_property") def ontologies_attachment_property(): pass @@ -6859,14 +6893,10 @@ def orchestration_build(): @orchestration_build.command("cancel") @click.argument("build_rid", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) @click.pass_obj def orchestration_build_cancel( client: foundry_sdk.v2.FoundryClient, build_rid: str, - preview: typing.Optional[bool], ): """ Request a cancellation for all unfinished jobs in a build. The build's status will not update immediately. This endpoint is asynchronous and a success response indicates that the cancellation request has been acknowledged and the build is expected to be canceled soon. If the build has already finished or finishes shortly after the request and before the cancellation, the build will not change. @@ -6874,7 +6904,6 @@ def orchestration_build_cancel( """ result = client.orchestration.Build.cancel( build_rid=build_rid, - preview=preview, ) click.echo(repr(result)) @@ -6894,9 +6923,6 @@ def orchestration_build_cancel( help="""The notification will be sent to the user that has most recently edited the schedule. No notification will be sent if the schedule has `scopeMode` set to `ProjectScope`.""", ) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) @click.option("--retry_backoff_duration", type=str, required=False, help="""""") @click.option( "--retry_count", @@ -6913,7 +6939,6 @@ def orchestration_build_create( branch_name: typing.Optional[str], force_build: typing.Optional[bool], notifications_enabled: typing.Optional[bool], - preview: typing.Optional[bool], retry_backoff_duration: typing.Optional[str], retry_count: typing.Optional[int], ): @@ -6925,7 +6950,6 @@ def orchestration_build_create( branch_name=branch_name, force_build=force_build, notifications_enabled=notifications_enabled, - preview=preview, retry_backoff_duration=( None if retry_backoff_duration is None else json.loads(retry_backoff_duration) ), @@ -6936,35 +6960,26 @@ def orchestration_build_create( @orchestration_build.command("get") @click.argument("build_rid", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) @click.pass_obj def orchestration_build_get( client: foundry_sdk.v2.FoundryClient, build_rid: str, - preview: typing.Optional[bool], ): """ Get the Build with the specified rid. """ result = client.orchestration.Build.get( build_rid=build_rid, - preview=preview, ) click.echo(repr(result)) @orchestration_build.command("get_batch") @click.argument("body", type=str, required=True) -@click.option( - "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" -) @click.pass_obj def orchestration_build_get_batch( client: foundry_sdk.v2.FoundryClient, body: str, - preview: typing.Optional[bool], ): """ Execute multiple get requests on Build. @@ -6973,7 +6988,6 @@ def orchestration_build_get_batch( """ result = client.orchestration.Build.get_batch( body=json.loads(body), - preview=preview, ) click.echo(repr(result)) @@ -7055,34 +7069,34 @@ def sql_queries(): pass -@sql_queries.group("query") -def sql_queries_query(): +@sql_queries.group("sql_query") +def sql_queries_sql_query(): pass -@sql_queries_query.command("cancel") -@click.argument("query_id", type=str, required=True) +@sql_queries_sql_query.command("cancel") +@click.argument("sql_query_id", type=str, required=True) @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def sql_queries_query_cancel( +def sql_queries_sql_query_cancel( client: foundry_sdk.v2.FoundryClient, - query_id: str, + sql_query_id: str, preview: typing.Optional[bool], ): """ Cancels a query. If the query is no longer running this is effectively a no-op. """ - result = client.sql_queries.Query.cancel( - query_id=query_id, + result = client.sql_queries.SqlQuery.cancel( + sql_query_id=sql_query_id, preview=preview, ) click.echo(repr(result)) -@sql_queries_query.command("execute") +@sql_queries_sql_query.command("execute") @click.option( "--query", type=str, @@ -7106,7 +7120,7 @@ def sql_queries_query_cancel( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def sql_queries_query_execute( +def sql_queries_sql_query_execute( client: foundry_sdk.v2.FoundryClient, query: str, fallback_branch_ids: typing.Optional[str], @@ -7116,7 +7130,7 @@ def sql_queries_query_execute( Executes a new query. Only the user that invoked the query can operate on the query. """ - result = client.sql_queries.Query.execute( + result = client.sql_queries.SqlQuery.execute( query=query, fallback_branch_ids=( None if fallback_branch_ids is None else json.loads(fallback_branch_ids) @@ -7126,15 +7140,15 @@ def sql_queries_query_execute( click.echo(repr(result)) -@sql_queries_query.command("get_results") -@click.argument("query_id", type=str, required=True) +@sql_queries_sql_query.command("get_results") +@click.argument("sql_query_id", type=str, required=True) @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def sql_queries_query_get_results( +def sql_queries_sql_query_get_results( client: foundry_sdk.v2.FoundryClient, - query_id: str, + sql_query_id: str, preview: typing.Optional[bool], ): """ @@ -7142,30 +7156,30 @@ def sql_queries_query_get_results( one minute. """ - result = client.sql_queries.Query.get_results( - query_id=query_id, + result = client.sql_queries.SqlQuery.get_results( + sql_query_id=sql_query_id, preview=preview, ) click.echo(result) -@sql_queries_query.command("get_status") -@click.argument("query_id", type=str, required=True) +@sql_queries_sql_query.command("get_status") +@click.argument("sql_query_id", type=str, required=True) @click.option( "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" ) @click.pass_obj -def sql_queries_query_get_status( +def sql_queries_sql_query_get_status( client: foundry_sdk.v2.FoundryClient, - query_id: str, + sql_query_id: str, preview: typing.Optional[bool], ): """ Gets the status of a query. """ - result = client.sql_queries.Query.get_status( - query_id=query_id, + result = client.sql_queries.SqlQuery.get_status( + sql_query_id=sql_query_id, preview=preview, ) click.echo(repr(result)) diff --git a/foundry_sdk/v2/connectivity/models.py b/foundry_sdk/v2/connectivity/models.py index ff984b2dd..ada41cc14 100644 --- a/foundry_sdk/v2/connectivity/models.py +++ b/foundry_sdk/v2/connectivity/models.py @@ -15,8 +15,9 @@ from __future__ import annotations +import decimal import typing -from datetime import datetime +from datetime import date import pydantic import typing_extensions @@ -42,7 +43,7 @@ class ApiKeyAuthentication(pydantic.BaseModel): type: typing.Literal["apiKey"] = "apiKey" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -54,7 +55,7 @@ class AsPlaintextValue(pydantic.BaseModel): type: typing.Literal["asPlaintextValue"] = "asPlaintextValue" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -66,7 +67,7 @@ class AsSecretName(pydantic.BaseModel): type: typing.Literal["asSecretName"] = "asSecretName" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -85,7 +86,7 @@ class AwsAccessKey(pydantic.BaseModel): type: typing.Literal["awsAccessKey"] = "awsAccessKey" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -108,7 +109,7 @@ class AwsOidcAuthentication(pydantic.BaseModel): type: typing.Literal["oidc"] = "oidc" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -121,7 +122,7 @@ class BasicCredentials(pydantic.BaseModel): type: typing.Literal["basic"] = "basic" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -133,7 +134,7 @@ class BearerToken(pydantic.BaseModel): type: typing.Literal["bearerToken"] = "bearerToken" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -148,7 +149,7 @@ class CloudIdentity(pydantic.BaseModel): type: typing.Literal["cloudIdentity"] = "cloudIdentity" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -168,14 +169,17 @@ class Connection(pydantic.BaseModel): configuration: ConnectionConfiguration model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) ConnectionConfiguration = typing_extensions.Annotated[ typing.Union[ - "S3ConnectionConfiguration", "RestConnectionConfiguration", "JdbcConnectionConfiguration" + "S3ConnectionConfiguration", + "RestConnectionConfiguration", + "SnowflakeConnectionConfiguration", + "JdbcConnectionConfiguration", ], pydantic.Field(discriminator="type"), ] @@ -190,10 +194,48 @@ def to_dict(self) -> dict: """The Resource Identifier (RID) of a Connection (also known as a source).""" +class CreateConnectionRequestAsPlaintextValue(pydantic.BaseModel): + """CreateConnectionRequestAsPlaintextValue""" + + value: PlaintextValue + type: typing.Literal["asPlaintextValue"] = "asPlaintextValue" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +class CreateConnectionRequestAsSecretName(pydantic.BaseModel): + """CreateConnectionRequestAsSecretName""" + + value: SecretName + type: typing.Literal["asSecretName"] = "asSecretName" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +class CreateConnectionRequestBasicCredentials(pydantic.BaseModel): + """CreateConnectionRequestBasicCredentials""" + + password: CreateConnectionRequestEncryptedProperty + username: str + type: typing.Literal["basic"] = "basic" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + CreateConnectionRequestConnectionConfiguration = typing_extensions.Annotated[ typing.Union[ "CreateConnectionRequestS3ConnectionConfiguration", "CreateConnectionRequestRestConnectionConfiguration", + "CreateConnectionRequestSnowflakeConnectionConfiguration", "CreateConnectionRequestJdbcConnectionConfiguration", ], pydantic.Field(discriminator="type"), @@ -201,6 +243,19 @@ def to_dict(self) -> dict: """CreateConnectionRequestConnectionConfiguration""" +CreateConnectionRequestEncryptedProperty = typing_extensions.Annotated[ + typing.Union[CreateConnectionRequestAsSecretName, CreateConnectionRequestAsPlaintextValue], + pydantic.Field(discriminator="type"), +] +""" +When reading an encrypted property, the secret name representing the encrypted value will be returned. +When writing to an encrypted property: +- If a plaintext value is passed as an input, the plaintext value will be encrypted and saved to the property. +- If a secret name is passed as an input, the secret name must match the existing secret name of the property + and the property will retain its previously encrypted value. +""" + + class CreateConnectionRequestJdbcConnectionConfiguration(pydantic.BaseModel): """CreateConnectionRequestJdbcConnectionConfiguration""" @@ -210,8 +265,8 @@ class CreateConnectionRequestJdbcConnectionConfiguration(pydantic.BaseModel): jdbc_properties: typing.Dict[str, str] = pydantic.Field(alias=str("jdbcProperties")) # type: ignore[literal-required] """ - The list of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed - to the JDBC driver to configure behavior. Refer to the documentation of your specific connection for additional + A map of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed + to the JDBC driver to configure behavior. Refer to the documentation of your specific connection type for additional available JDBC properties to add to your connection configuration. """ @@ -221,7 +276,7 @@ class CreateConnectionRequestJdbcConnectionConfiguration(pydantic.BaseModel): type: typing.Literal["jdbc"] = "jdbc" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -251,7 +306,7 @@ class CreateConnectionRequestRestConnectionConfiguration(pydantic.BaseModel): type: typing.Literal["rest"] = "rest" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -341,7 +396,110 @@ class CreateConnectionRequestS3ConnectionConfiguration(pydantic.BaseModel): type: typing.Literal["s3"] = "s3" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +CreateConnectionRequestSnowflakeAuthenticationMode = typing_extensions.Annotated[ + typing.Union[ + "CreateConnectionRequestSnowflakeExternalOauth", + "CreateConnectionRequestSnowflakeKeyPairAuthentication", + CreateConnectionRequestBasicCredentials, + ], + pydantic.Field(discriminator="type"), +] +"""CreateConnectionRequestSnowflakeAuthenticationMode""" + + +class CreateConnectionRequestSnowflakeConnectionConfiguration(pydantic.BaseModel): + """CreateConnectionRequestSnowflakeConnectionConfiguration""" + + schema_: typing.Optional[str] = pydantic.Field(alias=str("schema"), default=None) # type: ignore[literal-required] + """ + Specifies the default schema to use for the specified database once connected. If unspecified, + defaults to the empty string. + The specified schema should be an existing schema for which the specified default role has privileges. + + See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#schema + """ + + database: typing.Optional[str] = None + """ + Specifies the default database to use once connected. If unspecified, defaults to the empty string. + The specified database should be an existing database for which the specified default role has privileges. + + See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#db + """ + + role: typing.Optional[str] = None + """ + Specifies the default access control role to use in the Snowflake session initiated by the driver. + If unspecified, no role will be used when the session is initiated by the driver. + + The specified role should be an existing role that has already been assigned to the specified user for + the driver. If the specified role has not already been assigned to the user, the role is not used when + the session is initiated by the driver. + + See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#role + """ + + account_identifier: str = pydantic.Field(alias=str("accountIdentifier")) # type: ignore[literal-required] + """ + An [account identifier](https://docs.snowflake.com/en/user-guide/admin-account-identifier) uniquely + identifies a Snowflake account within your organization, as well as throughout the global network of + Snowflake-supported cloud platforms and cloud regions. + + The URL for an account uses the following format: .snowflakecomputing.com. + An example URL is https://acme-test_aws_us_east_2.snowflakecomputing.com. + """ + + jdbc_properties: typing.Dict[str, str] = pydantic.Field(alias=str("jdbcProperties")) # type: ignore[literal-required] + """ + A map of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed + to the JDBC driver to configure behavior. Refer to the documentation of your specific connection type for additional + available JDBC properties to add to your connection configuration. + """ + + warehouse: typing.Optional[str] = None + """ + Specifies the virtual warehouse to use once connected. If unspecified, defaults to the empty string. + The specified warehouse should be an existing warehouse for which the specified default role has privileges. + + See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#warehouse + """ + + authentication_mode: CreateConnectionRequestSnowflakeAuthenticationMode = pydantic.Field(alias=str("authenticationMode")) # type: ignore[literal-required] + """The authentication mode to use to connect to the Snowflake database.""" + + type: typing.Literal["snowflake"] = "snowflake" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +class CreateConnectionRequestSnowflakeExternalOauth(pydantic.BaseModel): + """CreateConnectionRequestSnowflakeExternalOauth""" + + type: typing.Literal["externalOauth"] = "externalOauth" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +class CreateConnectionRequestSnowflakeKeyPairAuthentication(pydantic.BaseModel): + """CreateConnectionRequestSnowflakeKeyPairAuthentication""" + + private_key: CreateConnectionRequestEncryptedProperty = pydantic.Field(alias=str("privateKey")) # type: ignore[literal-required] + user: str + type: typing.Literal["keyPair"] = "keyPair" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -349,6 +507,7 @@ def to_dict(self) -> dict: class CreateTableImportRequestJdbcImportConfig(pydantic.BaseModel): """CreateTableImportRequestJdbcImportConfig""" + initial_incremental_state: typing.Optional[TableImportInitialIncrementalState] = pydantic.Field(alias=str("initialIncrementalState"), default=None) # type: ignore[literal-required] query: str """ A single SQL query can be executed per sync, which should output a data table @@ -359,7 +518,7 @@ class CreateTableImportRequestJdbcImportConfig(pydantic.BaseModel): type: typing.Literal["jdbcImportConfig"] = "jdbcImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -367,6 +526,7 @@ def to_dict(self) -> dict: class CreateTableImportRequestMicrosoftAccessImportConfig(pydantic.BaseModel): """CreateTableImportRequestMicrosoftAccessImportConfig""" + initial_incremental_state: typing.Optional[TableImportInitialIncrementalState] = pydantic.Field(alias=str("initialIncrementalState"), default=None) # type: ignore[literal-required] query: str """ A single SQL query can be executed per sync, which should output a data table @@ -377,7 +537,7 @@ class CreateTableImportRequestMicrosoftAccessImportConfig(pydantic.BaseModel): type: typing.Literal["microsoftAccessImportConfig"] = "microsoftAccessImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -385,6 +545,7 @@ def to_dict(self) -> dict: class CreateTableImportRequestMicrosoftSqlServerImportConfig(pydantic.BaseModel): """CreateTableImportRequestMicrosoftSqlServerImportConfig""" + initial_incremental_state: typing.Optional[TableImportInitialIncrementalState] = pydantic.Field(alias=str("initialIncrementalState"), default=None) # type: ignore[literal-required] query: str """ A single SQL query can be executed per sync, which should output a data table @@ -395,7 +556,7 @@ class CreateTableImportRequestMicrosoftSqlServerImportConfig(pydantic.BaseModel) type: typing.Literal["microsoftSqlServerImportConfig"] = "microsoftSqlServerImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -403,6 +564,7 @@ def to_dict(self) -> dict: class CreateTableImportRequestOracleImportConfig(pydantic.BaseModel): """CreateTableImportRequestOracleImportConfig""" + initial_incremental_state: typing.Optional[TableImportInitialIncrementalState] = pydantic.Field(alias=str("initialIncrementalState"), default=None) # type: ignore[literal-required] query: str """ A single SQL query can be executed per sync, which should output a data table @@ -413,7 +575,7 @@ class CreateTableImportRequestOracleImportConfig(pydantic.BaseModel): type: typing.Literal["oracleImportConfig"] = "oracleImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -421,6 +583,7 @@ def to_dict(self) -> dict: class CreateTableImportRequestPostgreSqlImportConfig(pydantic.BaseModel): """CreateTableImportRequestPostgreSqlImportConfig""" + initial_incremental_state: typing.Optional[TableImportInitialIncrementalState] = pydantic.Field(alias=str("initialIncrementalState"), default=None) # type: ignore[literal-required] query: str """ A single SQL query can be executed per sync, which should output a data table @@ -431,7 +594,26 @@ class CreateTableImportRequestPostgreSqlImportConfig(pydantic.BaseModel): type: typing.Literal["postgreSqlImportConfig"] = "postgreSqlImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +class CreateTableImportRequestSnowflakeTableImportConfig(pydantic.BaseModel): + """CreateTableImportRequestSnowflakeTableImportConfig""" + + initial_incremental_state: typing.Optional[TableImportInitialIncrementalState] = pydantic.Field(alias=str("initialIncrementalState"), default=None) # type: ignore[literal-required] + query: str + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: typing.Literal["snowflakeImportConfig"] = "snowflakeImportConfig" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -442,6 +624,7 @@ def to_dict(self) -> dict: CreateTableImportRequestMicrosoftSqlServerImportConfig, CreateTableImportRequestPostgreSqlImportConfig, CreateTableImportRequestMicrosoftAccessImportConfig, + CreateTableImportRequestSnowflakeTableImportConfig, CreateTableImportRequestOracleImportConfig, ], pydantic.Field(discriminator="type"), @@ -449,6 +632,38 @@ def to_dict(self) -> dict: """The import configuration for a specific [connector type](/docs/foundry/data-integration/source-type-overview).""" +class DateColumnInitialIncrementalState(pydantic.BaseModel): + """The state for an incremental table import using a column with a date type.""" + + column_name: str = pydantic.Field(alias=str("columnName")) # type: ignore[literal-required] + current_value: date = pydantic.Field(alias=str("currentValue")) # type: ignore[literal-required] + """The initial incremental state value for the date column to reference in the query.""" + + type: typing.Literal["dateColumnInitialIncrementalState"] = "dateColumnInitialIncrementalState" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +class DecimalColumnInitialIncrementalState(pydantic.BaseModel): + """The state for an incremental table import using a column with a decimal data type.""" + + column_name: str = pydantic.Field(alias=str("columnName")) # type: ignore[literal-required] + current_value: decimal.Decimal = pydantic.Field(alias=str("currentValue")) # type: ignore[literal-required] + """The initial incremental state value for the decimal column to reference in the query.""" + + type: typing.Literal["decimalColumnInitialIncrementalState"] = ( + "decimalColumnInitialIncrementalState" + ) + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + class Domain(pydantic.BaseModel): """The domain that the connection is allowed to access.""" @@ -472,7 +687,7 @@ class Domain(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -498,7 +713,7 @@ class FileAnyPathMatchesFilter(pydantic.BaseModel): type: typing.Literal["anyPathMatchesFilter"] = "anyPathMatchesFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -515,7 +730,7 @@ class FileAtLeastCountFilter(pydantic.BaseModel): type: typing.Literal["atLeastCountFilter"] = "atLeastCountFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -540,7 +755,7 @@ class FileChangedSinceLastUploadFilter(pydantic.BaseModel): type: typing.Literal["changedSinceLastUploadFilter"] = "changedSinceLastUploadFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -568,7 +783,7 @@ class FileImport(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -583,7 +798,7 @@ class FileImportCustomFilter(pydantic.BaseModel): type: typing.Literal["customFilter"] = "customFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -629,7 +844,7 @@ def to_dict(self) -> dict: class FileLastModifiedAfterFilter(pydantic.BaseModel): """Only import files that have been modified after a specified timestamp""" - after_timestamp: typing.Optional[datetime] = pydantic.Field(alias=str("afterTimestamp"), default=None) # type: ignore[literal-required] + after_timestamp: typing.Optional[core.AwareDatetime] = pydantic.Field(alias=str("afterTimestamp"), default=None) # type: ignore[literal-required] """ Timestamp threshold, specified in ISO-8601 format. If not specified, defaults to the timestamp the filter is added to the file import. @@ -638,7 +853,7 @@ class FileLastModifiedAfterFilter(pydantic.BaseModel): type: typing.Literal["lastModifiedAfterFilter"] = "lastModifiedAfterFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -663,7 +878,7 @@ class FilePathMatchesFilter(pydantic.BaseModel): type: typing.Literal["pathMatchesFilter"] = "pathMatchesFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -689,7 +904,7 @@ class FilePathNotMatchesFilter(pydantic.BaseModel): type: typing.Literal["pathNotMatchesFilter"] = "pathNotMatchesFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -720,7 +935,7 @@ class FileSizeFilter(pydantic.BaseModel): type: typing.Literal["fileSizeFilter"] = "fileSizeFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -738,7 +953,7 @@ class FilesCountLimitFilter(pydantic.BaseModel): type: typing.Literal["filesCountLimitFilter"] = "filesCountLimitFilter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -752,7 +967,24 @@ class HeaderApiKey(pydantic.BaseModel): type: typing.Literal["header"] = "header" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +class IntegerColumnInitialIncrementalState(pydantic.BaseModel): + """The state for an incremental table import using a numeric integer datatype.""" + + column_name: str = pydantic.Field(alias=str("columnName")) # type: ignore[literal-required] + current_value: int = pydantic.Field(alias=str("currentValue")) # type: ignore[literal-required] + """The initial incremental state value for the integer column to reference in the query.""" + + type: typing.Literal["integerColumnInitialIncrementalState"] = ( + "integerColumnInitialIncrementalState" + ) + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -768,8 +1000,8 @@ class JdbcConnectionConfiguration(pydantic.BaseModel): jdbc_properties: typing.Dict[str, str] = pydantic.Field(alias=str("jdbcProperties")) # type: ignore[literal-required] """ - The list of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed - to the JDBC driver to configure behavior. Refer to the documentation of your specific connection for additional + A map of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed + to the JDBC driver to configure behavior. Refer to the documentation of your specific connection type for additional available JDBC properties to add to your connection configuration. """ @@ -777,7 +1009,7 @@ class JdbcConnectionConfiguration(pydantic.BaseModel): type: typing.Literal["jdbc"] = "jdbc" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -792,10 +1024,11 @@ class JdbcImportConfig(pydantic.BaseModel): The query results are saved to the output dataset in Foundry. """ + initial_incremental_state: typing.Optional[TableImportInitialIncrementalState] = pydantic.Field(alias=str("initialIncrementalState"), default=None) # type: ignore[literal-required] type: typing.Literal["jdbcImportConfig"] = "jdbcImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -807,7 +1040,7 @@ class ListFileImportsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -819,7 +1052,22 @@ class ListTableImportsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +class LongColumnInitialIncrementalState(pydantic.BaseModel): + """The state for an incremental table import using a column with a numeric long datatype.""" + + column_name: str = pydantic.Field(alias=str("columnName")) # type: ignore[literal-required] + current_value: core.Long = pydantic.Field(alias=str("currentValue")) # type: ignore[literal-required] + """The initial incremental state value for the long column to reference in the query.""" + + type: typing.Literal["longColumnInitialIncrementalState"] = "longColumnInitialIncrementalState" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -834,10 +1082,11 @@ class MicrosoftAccessImportConfig(pydantic.BaseModel): The query results are saved to the output dataset in Foundry. """ + initial_incremental_state: typing.Optional[TableImportInitialIncrementalState] = pydantic.Field(alias=str("initialIncrementalState"), default=None) # type: ignore[literal-required] type: typing.Literal["microsoftAccessImportConfig"] = "microsoftAccessImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -852,10 +1101,11 @@ class MicrosoftSqlServerImportConfig(pydantic.BaseModel): The query results are saved to the output dataset in Foundry. """ + initial_incremental_state: typing.Optional[TableImportInitialIncrementalState] = pydantic.Field(alias=str("initialIncrementalState"), default=None) # type: ignore[literal-required] type: typing.Literal["microsoftSqlServerImportConfig"] = "microsoftSqlServerImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -870,10 +1120,11 @@ class OracleImportConfig(pydantic.BaseModel): The query results are saved to the output dataset in Foundry. """ + initial_incremental_state: typing.Optional[TableImportInitialIncrementalState] = pydantic.Field(alias=str("initialIncrementalState"), default=None) # type: ignore[literal-required] type: typing.Literal["oracleImportConfig"] = "oracleImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -892,10 +1143,11 @@ class PostgreSqlImportConfig(pydantic.BaseModel): The query results are saved to the output dataset in Foundry. """ + initial_incremental_state: typing.Optional[TableImportInitialIncrementalState] = pydantic.Field(alias=str("initialIncrementalState"), default=None) # type: ignore[literal-required] type: typing.Literal["postgreSqlImportConfig"] = "postgreSqlImportConfig" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -913,7 +1165,7 @@ class QueryParameterApiKey(pydantic.BaseModel): type: typing.Literal["queryParameter"] = "queryParameter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -963,7 +1215,7 @@ class RestConnectionConfiguration(pydantic.BaseModel): type: typing.Literal["rest"] = "rest" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -977,7 +1229,7 @@ class RestConnectionOAuth2(pydantic.BaseModel): type: typing.Literal["oauth2"] = "oauth2" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1083,7 +1335,7 @@ class S3ConnectionConfiguration(pydantic.BaseModel): type: typing.Literal["s3"] = "s3" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1105,7 +1357,7 @@ class S3KmsConfiguration(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1129,7 +1381,7 @@ class S3ProxyConfiguration(pydantic.BaseModel): credentials: typing.Optional[BasicCredentials] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1150,7 +1402,7 @@ class SecretsNames(pydantic.BaseModel): type: typing.Literal["asSecretsNames"] = "asSecretsNames" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1167,7 +1419,159 @@ class SecretsWithPlaintextValues(pydantic.BaseModel): type: typing.Literal["asSecretsWithPlaintextValues"] = "asSecretsWithPlaintextValues" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +SnowflakeAuthenticationMode = typing_extensions.Annotated[ + typing.Union["SnowflakeExternalOauth", "SnowflakeKeyPairAuthentication", BasicCredentials], + pydantic.Field(discriminator="type"), +] +"""SnowflakeAuthenticationMode""" + + +class SnowflakeConnectionConfiguration(pydantic.BaseModel): + """The configuration needed to connect to a Snowflake database.""" + + account_identifier: str = pydantic.Field(alias=str("accountIdentifier")) # type: ignore[literal-required] + """ + An [account identifier](https://docs.snowflake.com/en/user-guide/admin-account-identifier) uniquely + identifies a Snowflake account within your organization, as well as throughout the global network of + Snowflake-supported cloud platforms and cloud regions. + + The URL for an account uses the following format: .snowflakecomputing.com. + An example URL is https://acme-test_aws_us_east_2.snowflakecomputing.com. + """ + + database: typing.Optional[str] = None + """ + Specifies the default database to use once connected. If unspecified, defaults to the empty string. + The specified database should be an existing database for which the specified default role has privileges. + + See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#db + """ + + role: typing.Optional[str] = None + """ + Specifies the default access control role to use in the Snowflake session initiated by the driver. + If unspecified, no role will be used when the session is initiated by the driver. + + The specified role should be an existing role that has already been assigned to the specified user for + the driver. If the specified role has not already been assigned to the user, the role is not used when + the session is initiated by the driver. + + See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#role + """ + + schema_: typing.Optional[str] = pydantic.Field(alias=str("schema"), default=None) # type: ignore[literal-required] + """ + Specifies the default schema to use for the specified database once connected. If unspecified, + defaults to the empty string. + The specified schema should be an existing schema for which the specified default role has privileges. + + See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#schema + """ + + warehouse: typing.Optional[str] = None + """ + Specifies the virtual warehouse to use once connected. If unspecified, defaults to the empty string. + The specified warehouse should be an existing warehouse for which the specified default role has privileges. + + See https://docs.snowflake.com/developer-guide/jdbc/jdbc-parameters#warehouse + """ + + authentication_mode: SnowflakeAuthenticationMode = pydantic.Field(alias=str("authenticationMode")) # type: ignore[literal-required] + """The authentication mode to use to connect to the Snowflake database.""" + + jdbc_properties: typing.Dict[str, str] = pydantic.Field(alias=str("jdbcProperties")) # type: ignore[literal-required] + """ + A map of [properties](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html) passed + to the JDBC driver to configure behavior. Refer to the documentation of your specific connection type for additional + available JDBC properties to add to your connection configuration. + """ + + type: typing.Literal["snowflake"] = "snowflake" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +class SnowflakeExternalOauth(pydantic.BaseModel): + """ + Use an External OAuth security integration to connect and authenticate to Snowflake. + + See https://docs.snowflake.com/en/user-guide/oauth-ext-custom + """ + + audience: str + """Identifies the recipients that the access token is intended for as a string URI.""" + + issuer_url: str = pydantic.Field(alias=str("issuerUrl")) # type: ignore[literal-required] + """Identifies the principal that issued the access token as a string URI.""" + + subject: ConnectionRid + """The RID of the Connection that is connecting to the external system.""" + + type: typing.Literal["externalOauth"] = "externalOauth" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +class SnowflakeKeyPairAuthentication(pydantic.BaseModel): + """ + Use a key-pair to connect and authenticate to Snowflake. + + See https://docs.snowflake.com/en/user-guide/key-pair-auth + """ + + user: str + private_key: EncryptedProperty = pydantic.Field(alias=str("privateKey")) # type: ignore[literal-required] + type: typing.Literal["keyPair"] = "keyPair" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +class SnowflakeTableImportConfig(pydantic.BaseModel): + """The table import configuration for a [Snowflake connection](/docs/foundry/available-connectors/snowflake).""" + + query: str + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + initial_incremental_state: typing.Optional[TableImportInitialIncrementalState] = pydantic.Field(alias=str("initialIncrementalState"), default=None) # type: ignore[literal-required] + type: typing.Literal["snowflakeImportConfig"] = "snowflakeImportConfig" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +class StringColumnInitialIncrementalState(pydantic.BaseModel): + """The state for an incremental table import using a column with a string data type.""" + + column_name: str = pydantic.Field(alias=str("columnName")) # type: ignore[literal-required] + current_value: str = pydantic.Field(alias=str("currentValue")) # type: ignore[literal-required] + """The initial incremental state value for the string column to reference in the query.""" + + type: typing.Literal["stringColumnInitialIncrementalState"] = ( + "stringColumnInitialIncrementalState" + ) + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1209,7 +1613,7 @@ class StsRoleConfiguration(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1235,7 +1639,7 @@ class TableImport(pydantic.BaseModel): config: TableImportConfig model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1250,6 +1654,7 @@ def to_dict(self) -> dict: MicrosoftSqlServerImportConfig, PostgreSqlImportConfig, MicrosoftAccessImportConfig, + SnowflakeTableImportConfig, OracleImportConfig, ], pydantic.Field(discriminator="type"), @@ -1261,6 +1666,28 @@ def to_dict(self) -> dict: """TableImportDisplayName""" +TableImportInitialIncrementalState = typing_extensions.Annotated[ + typing.Union[ + StringColumnInitialIncrementalState, + DateColumnInitialIncrementalState, + IntegerColumnInitialIncrementalState, + "TimestampColumnInitialIncrementalState", + LongColumnInitialIncrementalState, + DecimalColumnInitialIncrementalState, + ], + pydantic.Field(discriminator="type"), +] +""" +The incremental configuration for a table import enables append-style transactions from the same table without duplication of data. +You must provide a monotonically increasing column such as a timestamp or id and an initial value for this column. +An incremental table import will import rows where the value is greater than the largest already imported. + +You can use the '?' character to reference the incremental state value when constructing your query. +Normally this would be used in a WHERE clause or similar filter applied in order to only sync data with an incremental column value +larger than the previously observed maximum value stored in the incremental state. +""" + + TableImportMode = typing.Literal["SNAPSHOT", "APPEND"] """ Import mode governs how data is read from an external system, and written into a Foundry dataset. @@ -1274,6 +1701,23 @@ def to_dict(self) -> dict: """The Resource Identifier (RID) of a TableImport (also known as a batch sync).""" +class TimestampColumnInitialIncrementalState(pydantic.BaseModel): + """TimestampColumnInitialIncrementalState""" + + column_name: str = pydantic.Field(alias=str("columnName")) # type: ignore[literal-required] + current_value: core.AwareDatetime = pydantic.Field(alias=str("currentValue")) # type: ignore[literal-required] + """The initial incremental state value for the timestamp column in UTC to reference in the query.""" + + type: typing.Literal["timestampColumnInitialIncrementalState"] = ( + "timestampColumnInitialIncrementalState" + ) + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + UriScheme = typing.Literal["HTTP", "HTTPS"] """Defines supported URI schemes to be used for external connections.""" @@ -1282,6 +1726,12 @@ def to_dict(self) -> dict: core.resolve_forward_references( CreateConnectionRequestConnectionConfiguration, globalns=globals(), localns=locals() ) +core.resolve_forward_references( + CreateConnectionRequestEncryptedProperty, globalns=globals(), localns=locals() +) +core.resolve_forward_references( + CreateConnectionRequestSnowflakeAuthenticationMode, globalns=globals(), localns=locals() +) core.resolve_forward_references( CreateTableImportRequestTableImportConfig, globalns=globals(), localns=locals() ) @@ -1293,7 +1743,11 @@ def to_dict(self) -> dict: ) core.resolve_forward_references(RestRequestApiKeyLocation, globalns=globals(), localns=locals()) core.resolve_forward_references(S3AuthenticationMode, globalns=globals(), localns=locals()) +core.resolve_forward_references(SnowflakeAuthenticationMode, globalns=globals(), localns=locals()) core.resolve_forward_references(TableImportConfig, globalns=globals(), localns=locals()) +core.resolve_forward_references( + TableImportInitialIncrementalState, globalns=globals(), localns=locals() +) __all__ = [ "ApiKeyAuthentication", @@ -1309,16 +1763,27 @@ def to_dict(self) -> dict: "ConnectionConfiguration", "ConnectionDisplayName", "ConnectionRid", + "CreateConnectionRequestAsPlaintextValue", + "CreateConnectionRequestAsSecretName", + "CreateConnectionRequestBasicCredentials", "CreateConnectionRequestConnectionConfiguration", + "CreateConnectionRequestEncryptedProperty", "CreateConnectionRequestJdbcConnectionConfiguration", "CreateConnectionRequestRestConnectionConfiguration", "CreateConnectionRequestS3ConnectionConfiguration", + "CreateConnectionRequestSnowflakeAuthenticationMode", + "CreateConnectionRequestSnowflakeConnectionConfiguration", + "CreateConnectionRequestSnowflakeExternalOauth", + "CreateConnectionRequestSnowflakeKeyPairAuthentication", "CreateTableImportRequestJdbcImportConfig", "CreateTableImportRequestMicrosoftAccessImportConfig", "CreateTableImportRequestMicrosoftSqlServerImportConfig", "CreateTableImportRequestOracleImportConfig", "CreateTableImportRequestPostgreSqlImportConfig", + "CreateTableImportRequestSnowflakeTableImportConfig", "CreateTableImportRequestTableImportConfig", + "DateColumnInitialIncrementalState", + "DecimalColumnInitialIncrementalState", "Domain", "EncryptedProperty", "FileAnyPathMatchesFilter", @@ -1337,10 +1802,12 @@ def to_dict(self) -> dict: "FileSizeFilter", "FilesCountLimitFilter", "HeaderApiKey", + "IntegerColumnInitialIncrementalState", "JdbcConnectionConfiguration", "JdbcImportConfig", "ListFileImportsResponse", "ListTableImportsResponse", + "LongColumnInitialIncrementalState", "MicrosoftAccessImportConfig", "MicrosoftSqlServerImportConfig", "OracleImportConfig", @@ -1361,12 +1828,20 @@ def to_dict(self) -> dict: "SecretName", "SecretsNames", "SecretsWithPlaintextValues", + "SnowflakeAuthenticationMode", + "SnowflakeConnectionConfiguration", + "SnowflakeExternalOauth", + "SnowflakeKeyPairAuthentication", + "SnowflakeTableImportConfig", + "StringColumnInitialIncrementalState", "StsRoleConfiguration", "TableImport", "TableImportAllowSchemaChanges", "TableImportConfig", "TableImportDisplayName", + "TableImportInitialIncrementalState", "TableImportMode", "TableImportRid", + "TimestampColumnInitialIncrementalState", "UriScheme", ] diff --git a/foundry_sdk/v2/core/errors.py b/foundry_sdk/v2/core/errors.py index 8a3fe8f2f..575e1f9e5 100644 --- a/foundry_sdk/v2/core/errors.py +++ b/foundry_sdk/v2/core/errors.py @@ -58,10 +58,10 @@ class BatchRequestSizeExceededLimitParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - MaximumBatchSize: int + maximumBatchSize: int """The maximum size of batch requests that can be sent to this endpoint.""" - ProvidedBatchSize: int + providedBatchSize: int """The size of the batch request that was sent to this endpoint.""" diff --git a/foundry_sdk/v2/core/models.py b/foundry_sdk/v2/core/models.py index bb9c4ac00..38d262928 100644 --- a/foundry_sdk/v2/core/models.py +++ b/foundry_sdk/v2/core/models.py @@ -16,7 +16,6 @@ from __future__ import annotations import typing -from datetime import datetime import pydantic import typing_extensions @@ -30,7 +29,7 @@ class AnyType(pydantic.BaseModel): type: typing.Literal["any"] = "any" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -42,7 +41,7 @@ class ArrayFieldType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -53,7 +52,7 @@ class AttachmentType(pydantic.BaseModel): type: typing.Literal["attachment"] = "attachment" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -64,7 +63,7 @@ class BinaryType(pydantic.BaseModel): type: typing.Literal["binary"] = "binary" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -75,7 +74,7 @@ class BooleanType(pydantic.BaseModel): type: typing.Literal["boolean"] = "boolean" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -90,7 +89,7 @@ class ByteType(pydantic.BaseModel): type: typing.Literal["byte"] = "byte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -104,7 +103,7 @@ class CipherTextType(pydantic.BaseModel): type: typing.Literal["cipherText"] = "cipherText" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -117,7 +116,7 @@ def to_dict(self) -> dict: """ContentType""" -CreatedTime = datetime +CreatedTime = core.AwareDatetime """The time at which the resource was created.""" @@ -131,7 +130,7 @@ class DateType(pydantic.BaseModel): type: typing.Literal["date"] = "date" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -148,7 +147,7 @@ class DecimalType(pydantic.BaseModel): type: typing.Literal["decimal"] = "decimal" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -164,7 +163,7 @@ class Distance(pydantic.BaseModel): unit: DistanceUnit model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -189,7 +188,7 @@ class DoubleType(pydantic.BaseModel): type: typing.Literal["double"] = "double" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -205,7 +204,7 @@ class Duration(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -230,7 +229,7 @@ class Field(pydantic.BaseModel): schema_: FieldSchema = pydantic.Field(alias=str("schema")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -270,7 +269,7 @@ class FieldSchema(pydantic.BaseModel): data_type: FieldDataType = pydantic.Field(alias=str("dataType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -289,7 +288,7 @@ class FilterBinaryType(pydantic.BaseModel): type: typing.Literal["binary"] = "binary" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -300,7 +299,7 @@ class FilterBooleanType(pydantic.BaseModel): type: typing.Literal["boolean"] = "boolean" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -311,7 +310,7 @@ class FilterDateTimeType(pydantic.BaseModel): type: typing.Literal["dateTime"] = "dateTime" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -322,7 +321,7 @@ class FilterDateType(pydantic.BaseModel): type: typing.Literal["date"] = "date" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -333,7 +332,7 @@ class FilterDoubleType(pydantic.BaseModel): type: typing.Literal["double"] = "double" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -347,7 +346,7 @@ class FilterEnumType(pydantic.BaseModel): type: typing.Literal["enum"] = "enum" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -358,7 +357,7 @@ class FilterFloatType(pydantic.BaseModel): type: typing.Literal["float"] = "float" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -369,7 +368,7 @@ class FilterIntegerType(pydantic.BaseModel): type: typing.Literal["integer"] = "integer" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -380,7 +379,7 @@ class FilterLongType(pydantic.BaseModel): type: typing.Literal["long"] = "long" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -391,7 +390,7 @@ class FilterRidType(pydantic.BaseModel): type: typing.Literal["rid"] = "rid" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -402,7 +401,7 @@ class FilterStringType(pydantic.BaseModel): type: typing.Literal["string"] = "string" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -433,7 +432,7 @@ class FilterUuidType(pydantic.BaseModel): type: typing.Literal["uuid"] = "uuid" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -444,7 +443,7 @@ class FloatType(pydantic.BaseModel): type: typing.Literal["float"] = "float" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -468,7 +467,7 @@ class FoundryLiveDeployment(pydantic.BaseModel): type: typing.Literal["foundryLiveDeployment"] = "foundryLiveDeployment" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -501,7 +500,7 @@ class FullRowChangeDataCaptureConfiguration(pydantic.BaseModel): type: typing.Literal["fullRow"] = "fullRow" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -512,7 +511,7 @@ class GeoPointType(pydantic.BaseModel): type: typing.Literal["geopoint"] = "geopoint" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -523,7 +522,18 @@ class GeoShapeType(pydantic.BaseModel): type: typing.Literal["geoshape"] = "geoshape" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + +class GeohashType(pydantic.BaseModel): + """GeohashType""" + + type: typing.Literal["geohash"] = "geohash" + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -534,7 +544,7 @@ class GeotimeSeriesReferenceType(pydantic.BaseModel): type: typing.Literal["geotimeSeriesReference"] = "geotimeSeriesReference" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -553,7 +563,7 @@ class IntegerType(pydantic.BaseModel): type: typing.Literal["integer"] = "integer" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -569,7 +579,7 @@ class LmsEmbeddingModel(pydantic.BaseModel): type: typing.Literal["lms"] = "lms" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -590,7 +600,7 @@ class LongType(pydantic.BaseModel): type: typing.Literal["long"] = "long" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -603,7 +613,7 @@ class MapFieldType(pydantic.BaseModel): type: typing.Literal["map"] = "map" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -618,7 +628,7 @@ class MarkingType(pydantic.BaseModel): type: typing.Literal["marking"] = "marking" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -647,7 +657,7 @@ class MediaReference(pydantic.BaseModel): reference: Reference model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -658,7 +668,7 @@ class MediaReferenceType(pydantic.BaseModel): type: typing.Literal["mediaReference"] = "mediaReference" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -676,7 +686,7 @@ class MediaSetViewItem(pydantic.BaseModel): token: typing.Optional[MediaItemReadToken] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -688,7 +698,7 @@ class MediaSetViewItemWrapper(pydantic.BaseModel): type: typing.Literal["mediaSetViewItem"] = "mediaSetViewItem" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -710,7 +720,7 @@ class NullType(pydantic.BaseModel): type: typing.Literal["null"] = "null" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -776,7 +786,7 @@ class ShortType(pydantic.BaseModel): type: typing.Literal["short"] = "short" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -814,7 +824,7 @@ class StreamSchema(pydantic.BaseModel): change_data_capture: typing.Optional[ChangeDataCaptureConfiguration] = pydantic.Field(alias=str("changeDataCapture"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -825,7 +835,7 @@ class StringType(pydantic.BaseModel): type: typing.Literal["string"] = "string" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -841,7 +851,7 @@ class StructFieldType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -865,7 +875,7 @@ class TimeseriesType(pydantic.BaseModel): type: typing.Literal["timeseries"] = "timeseries" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -876,7 +886,7 @@ class TimestampType(pydantic.BaseModel): type: typing.Literal["timestamp"] = "timestamp" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -892,12 +902,12 @@ class UnsupportedType(pydantic.BaseModel): type: typing.Literal["unsupported"] = "unsupported" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) -UpdatedTime = datetime +UpdatedTime = core.AwareDatetime """The time at which the resource was most recently updated.""" @@ -914,7 +924,7 @@ class VectorSimilarityFunction(pydantic.BaseModel): value: typing.Optional[VectorSimilarityFunctionValue] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -936,7 +946,7 @@ class VectorType(pydantic.BaseModel): type: typing.Literal["vector"] = "vector" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1022,6 +1032,7 @@ def to_dict(self) -> dict: "FullRowChangeDataCaptureConfiguration", "GeoPointType", "GeoShapeType", + "GeohashType", "GeotimeSeriesReferenceType", "GroupName", "GroupRid", diff --git a/foundry_sdk/v2/datasets/models.py b/foundry_sdk/v2/datasets/models.py index 70b5aeb97..c4ee944dd 100644 --- a/foundry_sdk/v2/datasets/models.py +++ b/foundry_sdk/v2/datasets/models.py @@ -16,7 +16,6 @@ from __future__ import annotations import typing -from datetime import datetime import pydantic @@ -34,7 +33,7 @@ class Branch(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -51,7 +50,7 @@ class Dataset(pydantic.BaseModel): parent_folder_rid: filesystem_models.FolderRid = pydantic.Field(alias=str("parentFolderRid")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -73,12 +72,12 @@ class File(pydantic.BaseModel): updated_time: FileUpdatedTime = pydantic.Field(alias=str("updatedTime")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) -FileUpdatedTime = datetime +FileUpdatedTime = core.AwareDatetime """FileUpdatedTime""" @@ -89,7 +88,7 @@ class ListBranchesResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -101,7 +100,7 @@ class ListFilesResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -119,17 +118,17 @@ class Transaction(pydantic.BaseModel): created_time: TransactionCreatedTime = pydantic.Field(alias=str("createdTime")) # type: ignore[literal-required] """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" - closed_time: typing.Optional[datetime] = pydantic.Field(alias=str("closedTime"), default=None) # type: ignore[literal-required] + closed_time: typing.Optional[core.AwareDatetime] = pydantic.Field(alias=str("closedTime"), default=None) # type: ignore[literal-required] """The timestamp when the transaction was closed, in ISO 8601 timestamp format.""" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) -TransactionCreatedTime = datetime +TransactionCreatedTime = core.AwareDatetime """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" diff --git a/foundry_sdk/v2/filesystem/models.py b/foundry_sdk/v2/filesystem/models.py index 76f1cc9d5..2a2a82779 100644 --- a/foundry_sdk/v2/filesystem/models.py +++ b/foundry_sdk/v2/filesystem/models.py @@ -34,7 +34,7 @@ class AccessRequirements(pydantic.BaseModel): markings: typing.List[Marking] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -45,7 +45,7 @@ class Everyone(pydantic.BaseModel): type: typing.Literal["everyone"] = "everyone" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -97,7 +97,7 @@ class Folder(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -128,7 +128,7 @@ class ListChildrenOfFolderResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -140,7 +140,7 @@ class ListMarkingsOfResourceResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -152,7 +152,7 @@ class ListOrganizationsOfProjectResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -164,7 +164,7 @@ class ListResourceRolesResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -176,7 +176,7 @@ class ListSpacesResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -193,7 +193,7 @@ class Marking(pydantic.BaseModel): is_directly_applied: IsDirectlyApplied = pydantic.Field(alias=str("isDirectlyApplied")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -212,7 +212,7 @@ class Organization(pydantic.BaseModel): is_directly_applied: IsDirectlyApplied = pydantic.Field(alias=str("isDirectlyApplied")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -225,7 +225,7 @@ class PrincipalWithId(pydantic.BaseModel): type: typing.Literal["principalWithId"] = "principalWithId" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -256,7 +256,7 @@ class Project(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -331,7 +331,7 @@ class Resource(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -355,7 +355,7 @@ class ResourceRole(pydantic.BaseModel): role_id: core_models.RoleId = pydantic.Field(alias=str("roleId")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -459,7 +459,7 @@ class Space(pydantic.BaseModel): organizations: typing.List[core_models.OrganizationRid] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) diff --git a/foundry_sdk/v2/functions/models.py b/foundry_sdk/v2/functions/models.py index 5a3e4a6c0..062e081b6 100644 --- a/foundry_sdk/v2/functions/models.py +++ b/foundry_sdk/v2/functions/models.py @@ -56,7 +56,7 @@ class ExecuteQueryResponse(pydantic.BaseModel): value: DataValue model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -79,7 +79,7 @@ class Parameter(pydantic.BaseModel): data_type: QueryDataType = pydantic.Field(alias=str("dataType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -103,7 +103,7 @@ class Query(pydantic.BaseModel): version: FunctionVersion model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -142,7 +142,7 @@ class QueryAggregationRangeType(pydantic.BaseModel): type: typing.Literal["range"] = "range" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -165,7 +165,7 @@ class QueryArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -207,7 +207,7 @@ class QuerySetType(pydantic.BaseModel): type: typing.Literal["set"] = "set" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -219,7 +219,7 @@ class QueryStructField(pydantic.BaseModel): field_type: QueryDataType = pydantic.Field(alias=str("fieldType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -231,7 +231,7 @@ class QueryStructType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -243,7 +243,7 @@ class QueryUnionType(pydantic.BaseModel): type: typing.Literal["union"] = "union" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -260,7 +260,7 @@ class ThreeDimensionalAggregation(pydantic.BaseModel): type: typing.Literal["threeDimensionalAggregation"] = "threeDimensionalAggregation" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -273,7 +273,7 @@ class TwoDimensionalAggregation(pydantic.BaseModel): type: typing.Literal["twoDimensionalAggregation"] = "twoDimensionalAggregation" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -290,7 +290,7 @@ class ValueType(pydantic.BaseModel): base_type: typing.Optional[ValueTypeDataType] = pydantic.Field(alias=str("baseType"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -332,7 +332,7 @@ class ValueTypeDataTypeArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -343,7 +343,7 @@ class ValueTypeDataTypeBinaryType(pydantic.BaseModel): type: typing.Literal["binary"] = "binary" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -354,7 +354,7 @@ class ValueTypeDataTypeBooleanType(pydantic.BaseModel): type: typing.Literal["boolean"] = "boolean" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -365,7 +365,7 @@ class ValueTypeDataTypeByteType(pydantic.BaseModel): type: typing.Literal["byte"] = "byte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -376,7 +376,7 @@ class ValueTypeDataTypeDateType(pydantic.BaseModel): type: typing.Literal["date"] = "date" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -387,7 +387,7 @@ class ValueTypeDataTypeDecimalType(pydantic.BaseModel): type: typing.Literal["decimal"] = "decimal" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -398,7 +398,7 @@ class ValueTypeDataTypeDoubleType(pydantic.BaseModel): type: typing.Literal["double"] = "double" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -409,7 +409,7 @@ class ValueTypeDataTypeFloatType(pydantic.BaseModel): type: typing.Literal["float"] = "float" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -420,7 +420,7 @@ class ValueTypeDataTypeIntegerType(pydantic.BaseModel): type: typing.Literal["integer"] = "integer" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -431,7 +431,7 @@ class ValueTypeDataTypeLongType(pydantic.BaseModel): type: typing.Literal["long"] = "long" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -444,7 +444,7 @@ class ValueTypeDataTypeMapType(pydantic.BaseModel): type: typing.Literal["map"] = "map" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -456,7 +456,7 @@ class ValueTypeDataTypeOptionalType(pydantic.BaseModel): type: typing.Literal["optional"] = "optional" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -467,7 +467,7 @@ class ValueTypeDataTypeShortType(pydantic.BaseModel): type: typing.Literal["short"] = "short" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -478,7 +478,7 @@ class ValueTypeDataTypeStringType(pydantic.BaseModel): type: typing.Literal["string"] = "string" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -490,7 +490,7 @@ class ValueTypeDataTypeStructElement(pydantic.BaseModel): field_type: ValueTypeDataType = pydantic.Field(alias=str("fieldType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -506,7 +506,7 @@ class ValueTypeDataTypeStructType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -517,7 +517,7 @@ class ValueTypeDataTypeTimestampType(pydantic.BaseModel): type: typing.Literal["timestamp"] = "timestamp" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -529,7 +529,7 @@ class ValueTypeDataTypeUnionType(pydantic.BaseModel): type: typing.Literal["union"] = "union" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -542,7 +542,7 @@ class ValueTypeDataTypeValueTypeReference(pydantic.BaseModel): type: typing.Literal["valueTypeReference"] = "valueTypeReference" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -559,7 +559,7 @@ class ValueTypeReference(pydantic.BaseModel): type: typing.Literal["valueTypeReference"] = "valueTypeReference" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -588,7 +588,7 @@ class VersionId(pydantic.BaseModel): base_type: typing.Optional[ValueTypeDataType] = pydantic.Field(alias=str("baseType"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) diff --git a/foundry_sdk/v2/geo/models.py b/foundry_sdk/v2/geo/models.py index afe6ff8d3..737ed9020 100644 --- a/foundry_sdk/v2/geo/models.py +++ b/foundry_sdk/v2/geo/models.py @@ -62,7 +62,7 @@ class Feature(pydantic.BaseModel): type: typing.Literal["Feature"] = "Feature" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -75,7 +75,7 @@ class FeatureCollection(pydantic.BaseModel): type: typing.Literal["FeatureCollection"] = "FeatureCollection" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -92,7 +92,7 @@ class GeoPoint(pydantic.BaseModel): type: typing.Literal["Point"] = "Point" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -127,7 +127,7 @@ class GeometryCollection(pydantic.BaseModel): type: typing.Literal["GeometryCollection"] = "GeometryCollection" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -140,7 +140,7 @@ class LineString(pydantic.BaseModel): type: typing.Literal["LineString"] = "LineString" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -175,7 +175,7 @@ class MultiLineString(pydantic.BaseModel): type: typing.Literal["MultiLineString"] = "MultiLineString" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -188,7 +188,7 @@ class MultiPoint(pydantic.BaseModel): type: typing.Literal["MultiPoint"] = "MultiPoint" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -201,7 +201,7 @@ class MultiPolygon(pydantic.BaseModel): type: typing.Literal["MultiPolygon"] = "MultiPolygon" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -214,7 +214,7 @@ class Polygon(pydantic.BaseModel): type: typing.Literal["Polygon"] = "Polygon" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) diff --git a/foundry_sdk/v2/media_sets/models.py b/foundry_sdk/v2/media_sets/models.py index 458293fea..a822e77ce 100644 --- a/foundry_sdk/v2/media_sets/models.py +++ b/foundry_sdk/v2/media_sets/models.py @@ -16,7 +16,6 @@ from __future__ import annotations import typing -from datetime import datetime import pydantic @@ -43,7 +42,7 @@ class GetMediaItemInfoResponse(pydantic.BaseModel): attribution: typing.Optional[MediaAttribution] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -62,12 +61,12 @@ class MediaAttribution(pydantic.BaseModel): """MediaAttribution""" creator_id: core_models.UserId = pydantic.Field(alias=str("creatorId")) # type: ignore[literal-required] - creation_timestamp: datetime = pydantic.Field(alias=str("creationTimestamp")) # type: ignore[literal-required] + creation_timestamp: core.AwareDatetime = pydantic.Field(alias=str("creationTimestamp")) # type: ignore[literal-required] """The timestamp when the media item was created, in ISO 8601 timestamp format.""" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -78,7 +77,7 @@ class PutMediaItemResponse(pydantic.BaseModel): media_item_rid: core_models.MediaItemRid = pydantic.Field(alias=str("mediaItemRid")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) diff --git a/foundry_sdk/v2/ontologies/_client.py b/foundry_sdk/v2/ontologies/_client.py index 0e8688b0c..fb597e181 100644 --- a/foundry_sdk/v2/ontologies/_client.py +++ b/foundry_sdk/v2/ontologies/_client.py @@ -68,6 +68,16 @@ def AttachmentProperty(self): config=self._config, ) + @cached_property + def CipherTextProperty(self): + from foundry_sdk.v2.ontologies.cipher_text_property import CipherTextPropertyClient # NOQA + + return CipherTextPropertyClient( + auth=self._auth, + hostname=self._hostname, + config=self._config, + ) + @cached_property def LinkedObject(self): from foundry_sdk.v2.ontologies.linked_object import LinkedObjectClient diff --git a/foundry_sdk/v2/ontologies/cipher_text_property.py b/foundry_sdk/v2/ontologies/cipher_text_property.py new file mode 100644 index 000000000..188789383 --- /dev/null +++ b/foundry_sdk/v2/ontologies/cipher_text_property.py @@ -0,0 +1,117 @@ +# 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.ontologies import models as ontologies_models + + +class CipherTextPropertyClient: + """ + The API client for the CipherTextProperty Resource. + + :param auth: Your auth configuration. + :param hostname: Your Foundry hostname (for example, "myfoundry.palantirfoundry.com"). This can also include your API gateway service URI. + :param config: Optionally specify the configuration for the HTTP session. + """ + + def __init__( + self, + auth: core.Auth, + hostname: str, + config: typing.Optional[core.Config] = None, + ): + self._auth = auth + self._hostname = hostname + self._config = config + self._api_client = core.ApiClient(auth=auth, hostname=hostname, config=config) + + self.with_streaming_response = _CipherTextPropertyClientStreaming(self) + self.with_raw_response = _CipherTextPropertyClientRaw(self) + + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def decrypt( + self, + ontology: ontologies_models.OntologyIdentifier, + object_type: ontologies_models.ObjectTypeApiName, + primary_key: ontologies_models.PropertyValueEscapedString, + property: ontologies_models.PropertyApiName, + *, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> ontologies_models.DecryptionResult: + """ + Decrypt the value of a ciphertext property. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read api:ontologies-decrypt-ciphertext`. + + :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. + :type ontology: OntologyIdentifier + :param object_type: The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. + :type object_type: ObjectTypeApiName + :param primary_key: The primary key of the object with the CipherText property. + :type primary_key: PropertyValueEscapedString + :param property: The API name of the CipherText property. To find the API name for your CipherText property, check the **Ontology Manager** or use the **Get object type** endpoint. + :type property: PropertyApiName + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ontologies_models.DecryptionResult + """ + + return self._api_client.call_api( + core.RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/ciphertexts/{property}/decrypt", + query_params={}, + path_params={ + "ontology": ontology, + "objectType": object_type, + "primaryKey": primary_key, + "property": property, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ontologies_models.DecryptionResult, + request_timeout=request_timeout, + throwable_errors={}, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + + +class _CipherTextPropertyClientRaw: + def __init__(self, client: CipherTextPropertyClient) -> None: + def decrypt(_: ontologies_models.DecryptionResult): ... + + self.decrypt = core.with_raw_response(decrypt, client.decrypt) + + +class _CipherTextPropertyClientStreaming: + def __init__(self, client: CipherTextPropertyClient) -> None: + def decrypt(_: ontologies_models.DecryptionResult): ... + + self.decrypt = core.with_streaming_response(decrypt, client.decrypt) diff --git a/foundry_sdk/v2/ontologies/errors.py b/foundry_sdk/v2/ontologies/errors.py index 508a64a18..ccad2254a 100644 --- a/foundry_sdk/v2/ontologies/errors.py +++ b/foundry_sdk/v2/ontologies/errors.py @@ -275,6 +275,24 @@ class AttachmentSizeExceededLimit(errors.BadRequestError): error_instance_id: str +class CipherChannelNotFoundParameters(typing_extensions.TypedDict): + """ + The Cipher Channel was not found. + It either does not exist, or you do not have permission to see it. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + cipherChannel: core.RID + + +@dataclass +class CipherChannelNotFound(errors.NotFoundError): + name: typing.Literal["CipherChannelNotFound"] + parameters: CipherChannelNotFoundParameters + error_instance_id: str + + class CompositePrimaryKeyNotSupportedParameters(typing_extensions.TypedDict): """ Primary keys consisting of multiple properties are not supported by this API. If you need support for this, @@ -1039,6 +1057,25 @@ class MultiplePropertyValuesNotSupported(errors.BadRequestError): error_instance_id: str +class NotCipherFormattedParameters(typing_extensions.TypedDict): + """ + The value intended for decryption with Cipher is not formatted correctly. + It may already be a plaintext value and not require decryption. + Ensure it is correctly formatted (CIPHER::::::CIPHER). + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: str + + +@dataclass +class NotCipherFormatted(errors.BadRequestError): + name: typing.Literal["NotCipherFormatted"] + parameters: NotCipherFormattedParameters + error_instance_id: str + + class ObjectAlreadyExistsParameters(typing_extensions.TypedDict): """The object the user is attempting to create already exists.""" @@ -1628,6 +1665,21 @@ class QueryTimeExceededLimit(errors.InternalServerError): error_instance_id: str +class RateLimitReachedParameters(typing_extensions.TypedDict): + """Unable to decrypt this CipherText because the available rate limits in Cipher licenses were reached.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + cipherChannel: core.RID + + +@dataclass +class RateLimitReached(errors.PermissionDeniedError): + name: typing.Literal["RateLimitReached"] + parameters: RateLimitReachedParameters + error_instance_id: str + + class SearchVectorDimensionsDifferParameters(typing_extensions.TypedDict): """The dimensions of the provided vector don't match the dimensions of the embedding model being queried.""" @@ -1686,6 +1738,39 @@ class TooManyNearestNeighborsRequested(errors.BadRequestError): error_instance_id: str +class UnauthorizedCipherOperationParameters(typing_extensions.TypedDict): + """The provided token does not have permission to take a specific Cipher operation.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + cipherChannel: core.RID + + +@dataclass +class UnauthorizedCipherOperation(errors.PermissionDeniedError): + name: typing.Literal["UnauthorizedCipherOperation"] + parameters: UnauthorizedCipherOperationParameters + error_instance_id: str + + +class UndecryptableValueParameters(typing_extensions.TypedDict): + """ + The value intended for decryption with Cipher cannot be decrypted. + Ensure it is correctly formatted (CIPHER:::::CIPHER). + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: str + + +@dataclass +class UndecryptableValue(errors.BadRequestError): + name: typing.Literal["UndecryptableValue"] + parameters: UndecryptableValueParameters + error_instance_id: str + + class UnknownParameterParameters(typing_extensions.TypedDict): """ The provided parameters were not found. Please look at the `knownParameters` field @@ -1752,6 +1837,7 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): "ApplyActionFailed", "AttachmentNotFound", "AttachmentSizeExceededLimit", + "CipherChannelNotFound", "CompositePrimaryKeyNotSupported", "DerivedPropertyApiNamesNotUnique", "DuplicateOrderBy", @@ -1798,6 +1884,7 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): "MissingParameter", "MultipleGroupByOnFieldNotSupported", "MultiplePropertyValuesNotSupported", + "NotCipherFormatted", "ObjectAlreadyExists", "ObjectChanged", "ObjectNotFound", @@ -1833,10 +1920,13 @@ class ViewObjectPermissionDenied(errors.PermissionDeniedError): "QueryNotFound", "QueryRuntimeError", "QueryTimeExceededLimit", + "RateLimitReached", "SearchVectorDimensionsDiffer", "SharedPropertiesNotFound", "SharedPropertyTypeNotFound", "TooManyNearestNeighborsRequested", + "UnauthorizedCipherOperation", + "UndecryptableValue", "UnknownParameter", "UnsupportedObjectSet", "ViewObjectPermissionDenied", diff --git a/foundry_sdk/v2/ontologies/models.py b/foundry_sdk/v2/ontologies/models.py index da314876b..789b0a493 100644 --- a/foundry_sdk/v2/ontologies/models.py +++ b/foundry_sdk/v2/ontologies/models.py @@ -16,7 +16,6 @@ from __future__ import annotations import typing -from datetime import datetime import pydantic import typing_extensions @@ -29,12 +28,12 @@ class AbsoluteTimeRange(pydantic.BaseModel): """ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.""" - start_time: typing.Optional[datetime] = pydantic.Field(alias=str("startTime"), default=None) # type: ignore[literal-required] - end_time: typing.Optional[datetime] = pydantic.Field(alias=str("endTime"), default=None) # type: ignore[literal-required] + start_time: typing.Optional[core.AwareDatetime] = pydantic.Field(alias=str("startTime"), default=None) # type: ignore[literal-required] + end_time: typing.Optional[core.AwareDatetime] = pydantic.Field(alias=str("endTime"), default=None) # type: ignore[literal-required] type: typing.Literal["absolute"] = "absolute" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -46,7 +45,7 @@ class AbsoluteValuePropertyExpression(pydantic.BaseModel): type: typing.Literal["absoluteValue"] = "absoluteValue" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -58,7 +57,7 @@ class ActionParameterArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -71,6 +70,7 @@ def to_dict(self) -> dict: core_models.StringType, core_models.DoubleType, core_models.IntegerType, + core_models.GeoShapeType, core_models.LongType, "OntologyObjectTypeReferenceType", core_models.BooleanType, @@ -79,6 +79,7 @@ def to_dict(self) -> dict: core_models.MediaReferenceType, ActionParameterArrayType, "OntologyObjectSetType", + core_models.GeohashType, "OntologyObjectType", core_models.TimestampType, ], @@ -96,7 +97,7 @@ class ActionParameterV2(pydantic.BaseModel): required: bool model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -134,7 +135,7 @@ class ActionTypeV2(pydantic.BaseModel): operations: typing.List[LogicRule] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -148,7 +149,7 @@ class ActivePropertyTypeStatus(pydantic.BaseModel): type: typing.Literal["active"] = "active" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -163,7 +164,7 @@ class AddLink(pydantic.BaseModel): type: typing.Literal["addLink"] = "addLink" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -176,7 +177,7 @@ class AddObject(pydantic.BaseModel): type: typing.Literal["addObject"] = "addObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -188,7 +189,7 @@ class AddPropertyExpression(pydantic.BaseModel): type: typing.Literal["add"] = "add" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -200,7 +201,7 @@ class AggregateObjectsResponseItemV2(pydantic.BaseModel): metrics: typing.List[AggregationMetricResultV2] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -213,7 +214,7 @@ class AggregateObjectsResponseV2(pydantic.BaseModel): data: typing.List[AggregateObjectsResponseItemV2] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -225,7 +226,7 @@ class AggregateTimeSeries(pydantic.BaseModel): strategy: TimeSeriesAggregationStrategy model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -250,7 +251,7 @@ class AggregationDurationGroupingV2(pydantic.BaseModel): type: typing.Literal["duration"] = "duration" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -264,7 +265,7 @@ class AggregationExactGroupingV2(pydantic.BaseModel): type: typing.Literal["exact"] = "exact" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -277,7 +278,7 @@ class AggregationFixedWidthGroupingV2(pydantic.BaseModel): type: typing.Literal["fixedWidth"] = "fixedWidth" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -318,7 +319,7 @@ class AggregationMetricResultV2(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -334,7 +335,7 @@ class AggregationRangeV2(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -347,7 +348,7 @@ class AggregationRangesGroupingV2(pydantic.BaseModel): type: typing.Literal["ranges"] = "ranges" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -375,7 +376,7 @@ class AndQueryV2(pydantic.BaseModel): type: typing.Literal["and"] = "and" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -391,7 +392,7 @@ class ApplyActionRequestOptions(pydantic.BaseModel): return_edits: typing.Optional[ReturnEditsMode] = pydantic.Field(alias=str("returnEdits"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -405,7 +406,7 @@ class ApproximateDistinctAggregationV2(pydantic.BaseModel): type: typing.Literal["approximateDistinct"] = "approximateDistinct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -420,7 +421,7 @@ class ApproximatePercentileAggregationV2(pydantic.BaseModel): type: typing.Literal["approximatePercentile"] = "approximatePercentile" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -443,7 +444,7 @@ class ArraySizeConstraint(pydantic.BaseModel): type: typing.Literal["arraySize"] = "arraySize" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -472,7 +473,7 @@ class AttachmentV2(pydantic.BaseModel): type: typing.Literal["single"] = "single" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -486,7 +487,7 @@ class AvgAggregationV2(pydantic.BaseModel): type: typing.Literal["avg"] = "avg" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -509,7 +510,7 @@ class BatchActionObjectEdits(pydantic.BaseModel): type: typing.Literal["edits"] = "edits" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -526,7 +527,7 @@ class BatchApplyActionRequestItem(pydantic.BaseModel): parameters: typing.Dict[ParameterId, typing.Optional[DataValue]] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -537,7 +538,7 @@ class BatchApplyActionRequestOptions(pydantic.BaseModel): return_edits: typing.Optional[BatchReturnEditsMode] = pydantic.Field(alias=str("returnEdits"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -548,7 +549,7 @@ class BatchApplyActionResponseV2(pydantic.BaseModel): edits: typing.Optional[BatchActionResults] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -572,7 +573,7 @@ class BlueprintIcon(pydantic.BaseModel): type: typing.Literal["blueprint"] = "blueprint" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -584,7 +585,7 @@ class BoundingBoxValue(pydantic.BaseModel): bottom_right: WithinBoundingBoxPoint = pydantic.Field(alias=str("bottomRight")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -596,7 +597,7 @@ class CenterPoint(pydantic.BaseModel): distance: core_models.Distance model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -617,7 +618,7 @@ class ContainsAllTermsInOrderPrefixLastTerm(pydantic.BaseModel): ) model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -635,7 +636,7 @@ class ContainsAllTermsInOrderQuery(pydantic.BaseModel): type: typing.Literal["containsAllTermsInOrder"] = "containsAllTermsInOrder" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -654,7 +655,7 @@ class ContainsAllTermsQuery(pydantic.BaseModel): type: typing.Literal["containsAllTerms"] = "containsAllTerms" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -673,7 +674,7 @@ class ContainsAnyTermQuery(pydantic.BaseModel): type: typing.Literal["containsAnyTerm"] = "containsAnyTerm" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -690,7 +691,7 @@ class ContainsQueryV2(pydantic.BaseModel): type: typing.Literal["contains"] = "contains" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -703,7 +704,7 @@ class CountAggregationV2(pydantic.BaseModel): type: typing.Literal["count"] = "count" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -714,7 +715,7 @@ class CountObjectsResponseV2(pydantic.BaseModel): count: typing.Optional[int] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -726,7 +727,7 @@ class CreateInterfaceObjectRule(pydantic.BaseModel): type: typing.Literal["createInterfaceObject"] = "createInterfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -741,7 +742,7 @@ class CreateLinkRule(pydantic.BaseModel): type: typing.Literal["createLink"] = "createLink" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -753,7 +754,7 @@ class CreateObjectRule(pydantic.BaseModel): type: typing.Literal["createObject"] = "createObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -764,7 +765,7 @@ class CreateTemporaryObjectSetResponseV2(pydantic.BaseModel): object_set_rid: ObjectSetRid = pydantic.Field(alias=str("objectSetRid")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -802,6 +803,17 @@ def to_dict(self) -> dict: """ +class DecryptionResult(pydantic.BaseModel): + """The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown.""" + + plaintext: typing.Optional[Plaintext] = None + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + class DeleteInterfaceObjectRule(pydantic.BaseModel): """DeleteInterfaceObjectRule""" @@ -809,7 +821,7 @@ class DeleteInterfaceObjectRule(pydantic.BaseModel): type: typing.Literal["deleteInterfaceObject"] = "deleteInterfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -824,7 +836,7 @@ class DeleteLink(pydantic.BaseModel): type: typing.Literal["deleteLink"] = "deleteLink" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -839,7 +851,7 @@ class DeleteLinkRule(pydantic.BaseModel): type: typing.Literal["deleteLink"] = "deleteLink" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -852,7 +864,7 @@ class DeleteObject(pydantic.BaseModel): type: typing.Literal["deleteObject"] = "deleteObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -864,7 +876,7 @@ class DeleteObjectRule(pydantic.BaseModel): type: typing.Literal["deleteObject"] = "deleteObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -876,12 +888,12 @@ class DeprecatedPropertyTypeStatus(pydantic.BaseModel): """ message: str - deadline: datetime + deadline: core.AwareDatetime replaced_by: typing.Optional[PropertyTypeRid] = pydantic.Field(alias=str("replacedBy"), default=None) # type: ignore[literal-required] type: typing.Literal["deprecated"] = "deprecated" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -917,7 +929,7 @@ class DividePropertyExpression(pydantic.BaseModel): type: typing.Literal["divide"] = "divide" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -935,7 +947,7 @@ class DoesNotIntersectBoundingBoxQuery(pydantic.BaseModel): type: typing.Literal["doesNotIntersectBoundingBox"] = "doesNotIntersectBoundingBox" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -953,7 +965,7 @@ class DoesNotIntersectPolygonQuery(pydantic.BaseModel): type: typing.Literal["doesNotIntersectPolygon"] = "doesNotIntersectPolygon" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -968,7 +980,7 @@ class DoubleVector(pydantic.BaseModel): type: typing.Literal["vector"] = "vector" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -981,7 +993,7 @@ class EntrySetType(pydantic.BaseModel): type: typing.Literal["entrySet"] = "entrySet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -998,7 +1010,7 @@ class EqualsQueryV2(pydantic.BaseModel): type: typing.Literal["eq"] = "eq" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1012,7 +1024,7 @@ class ExactDistinctAggregationV2(pydantic.BaseModel): type: typing.Literal["exactDistinct"] = "exactDistinct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1026,7 +1038,7 @@ class ExamplePropertyTypeStatus(pydantic.BaseModel): type: typing.Literal["example"] = "example" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1037,7 +1049,7 @@ class ExecuteQueryResponse(pydantic.BaseModel): value: DataValue model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1048,7 +1060,7 @@ class ExperimentalPropertyTypeStatus(pydantic.BaseModel): type: typing.Literal["experimental"] = "experimental" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1065,7 +1077,7 @@ class ExtractPropertyExpression(pydantic.BaseModel): type: typing.Literal["extract"] = "extract" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1104,7 +1116,7 @@ class GetSelectedPropertyOperation(pydantic.BaseModel): type: typing.Literal["get"] = "get" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1116,7 +1128,7 @@ class GreatestPropertyExpression(pydantic.BaseModel): type: typing.Literal["greatest"] = "greatest" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1127,7 +1139,7 @@ class GroupMemberConstraint(pydantic.BaseModel): type: typing.Literal["groupMember"] = "groupMember" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1144,7 +1156,7 @@ class GtQueryV2(pydantic.BaseModel): type: typing.Literal["gt"] = "gt" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1161,7 +1173,7 @@ class GteQueryV2(pydantic.BaseModel): type: typing.Literal["gte"] = "gte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1179,7 +1191,7 @@ class InQuery(pydantic.BaseModel): type: typing.Literal["in"] = "in" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1203,7 +1215,7 @@ class InterfaceLinkType(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1248,7 +1260,7 @@ class InterfaceSharedPropertyType(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1309,7 +1321,7 @@ class InterfaceType(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1337,7 +1349,7 @@ class IntersectsBoundingBoxQuery(pydantic.BaseModel): type: typing.Literal["intersectsBoundingBox"] = "intersectsBoundingBox" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1354,7 +1366,7 @@ class IntersectsPolygonQuery(pydantic.BaseModel): type: typing.Literal["intersectsPolygon"] = "intersectsPolygon" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1371,7 +1383,7 @@ class IsNullQueryV2(pydantic.BaseModel): type: typing.Literal["isNull"] = "isNull" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1383,7 +1395,7 @@ class LeastPropertyExpression(pydantic.BaseModel): type: typing.Literal["least"] = "least" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1395,7 +1407,7 @@ class LinkSideObject(pydantic.BaseModel): object_type: ObjectTypeApiName = pydantic.Field(alias=str("objectType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1427,7 +1439,7 @@ class LinkTypeSideV2(pydantic.BaseModel): link_type_rid: LinkTypeRid = pydantic.Field(alias=str("linkTypeRid")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1439,7 +1451,7 @@ class LinkedInterfaceTypeApiName(pydantic.BaseModel): type: typing.Literal["interfaceTypeApiName"] = "interfaceTypeApiName" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1451,7 +1463,7 @@ class LinkedObjectTypeApiName(pydantic.BaseModel): type: typing.Literal["objectTypeApiName"] = "objectTypeApiName" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1463,7 +1475,7 @@ class ListActionTypesResponseV2(pydantic.BaseModel): data: typing.List[ActionTypeV2] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1476,7 +1488,7 @@ class ListAttachmentsResponseV2(pydantic.BaseModel): type: typing.Literal["multiple"] = "multiple" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1488,7 +1500,7 @@ class ListInterfaceTypesResponse(pydantic.BaseModel): data: typing.List[InterfaceType] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1500,7 +1512,7 @@ class ListLinkedObjectsResponseV2(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1514,7 +1526,7 @@ class ListObjectTypesV2Response(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1529,7 +1541,7 @@ class ListObjectsResponseV2(pydantic.BaseModel): total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1542,7 +1554,7 @@ class ListOntologiesV2Response(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1556,7 +1568,7 @@ class ListOutgoingLinkTypesResponseV2(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1568,7 +1580,7 @@ class ListQueryTypesResponseV2(pydantic.BaseModel): data: typing.List[QueryTypeV2] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1583,7 +1595,7 @@ class LoadObjectSetResponseV2(pydantic.BaseModel): total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1608,7 +1620,7 @@ class LoadObjectSetV2MultipleObjectTypesResponse(pydantic.BaseModel): interface_to_object_type_mappings: typing.Dict[InterfaceTypeApiName, InterfaceToObjectTypeMappings] = pydantic.Field(alias=str("interfaceToObjectTypeMappings")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1626,7 +1638,7 @@ class LoadObjectSetV2ObjectsOrInterfacesResponse(pydantic.BaseModel): total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1659,7 +1671,7 @@ class LtQueryV2(pydantic.BaseModel): type: typing.Literal["lt"] = "lt" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1676,7 +1688,7 @@ class LteQueryV2(pydantic.BaseModel): type: typing.Literal["lte"] = "lte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1690,7 +1702,7 @@ class MaxAggregationV2(pydantic.BaseModel): type: typing.Literal["max"] = "max" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1703,7 +1715,7 @@ class MediaMetadata(pydantic.BaseModel): media_type: core_models.MediaType = pydantic.Field(alias=str("mediaType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1717,7 +1729,7 @@ class MinAggregationV2(pydantic.BaseModel): type: typing.Literal["min"] = "min" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1729,7 +1741,7 @@ class ModifyInterfaceObjectRule(pydantic.BaseModel): type: typing.Literal["modifyInterfaceObject"] = "modifyInterfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1742,7 +1754,7 @@ class ModifyObject(pydantic.BaseModel): type: typing.Literal["modifyObject"] = "modifyObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1754,7 +1766,7 @@ class ModifyObjectRule(pydantic.BaseModel): type: typing.Literal["modifyObject"] = "modifyObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1766,7 +1778,7 @@ class MultiplyPropertyExpression(pydantic.BaseModel): type: typing.Literal["multiply"] = "multiply" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1787,7 +1799,7 @@ class NearestNeighborsQueryText(pydantic.BaseModel): type: typing.Literal["text"] = "text" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1799,7 +1811,7 @@ class NegatePropertyExpression(pydantic.BaseModel): type: typing.Literal["negate"] = "negate" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1811,7 +1823,7 @@ class NotQueryV2(pydantic.BaseModel): type: typing.Literal["not"] = "not" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1835,7 +1847,7 @@ class ObjectEdits(pydantic.BaseModel): type: typing.Literal["edits"] = "edits" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1876,7 +1888,7 @@ class ObjectPropertyValueConstraint(pydantic.BaseModel): type: typing.Literal["objectPropertyValue"] = "objectPropertyValue" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1887,7 +1899,7 @@ class ObjectQueryResultConstraint(pydantic.BaseModel): type: typing.Literal["objectQueryResult"] = "objectQueryResult" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1929,7 +1941,7 @@ class ObjectSetAsBaseObjectTypesType(pydantic.BaseModel): type: typing.Literal["asBaseObjectTypes"] = "asBaseObjectTypes" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1948,7 +1960,7 @@ class ObjectSetAsTypeType(pydantic.BaseModel): type: typing.Literal["asType"] = "asType" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1962,7 +1974,7 @@ class ObjectSetBaseType(pydantic.BaseModel): type: typing.Literal["base"] = "base" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1975,7 +1987,7 @@ class ObjectSetFilterType(pydantic.BaseModel): type: typing.Literal["filter"] = "filter" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1998,7 +2010,7 @@ class ObjectSetInterfaceBaseType(pydantic.BaseModel): type: typing.Literal["interfaceBase"] = "interfaceBase" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2010,7 +2022,7 @@ class ObjectSetIntersectionType(pydantic.BaseModel): type: typing.Literal["intersect"] = "intersect" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2025,7 +2037,7 @@ class ObjectSetMethodInputType(pydantic.BaseModel): type: typing.Literal["methodInput"] = "methodInput" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2055,7 +2067,7 @@ class ObjectSetNearestNeighborsType(pydantic.BaseModel): type: typing.Literal["nearestNeighbors"] = "nearestNeighbors" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2067,7 +2079,7 @@ class ObjectSetReferenceType(pydantic.BaseModel): type: typing.Literal["reference"] = "reference" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2084,7 +2096,7 @@ class ObjectSetSearchAroundType(pydantic.BaseModel): type: typing.Literal["searchAround"] = "searchAround" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2096,7 +2108,7 @@ class ObjectSetStaticType(pydantic.BaseModel): type: typing.Literal["static"] = "static" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2108,7 +2120,7 @@ class ObjectSetSubtractType(pydantic.BaseModel): type: typing.Literal["subtract"] = "subtract" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2120,7 +2132,7 @@ class ObjectSetUnionType(pydantic.BaseModel): type: typing.Literal["union"] = "union" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2139,7 +2151,7 @@ class ObjectSetWithPropertiesType(pydantic.BaseModel): type: typing.Literal["withProperties"] = "withProperties" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2158,7 +2170,7 @@ class ObjectTypeEdits(pydantic.BaseModel): type: typing.Literal["largeScaleEdits"] = "largeScaleEdits" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2182,7 +2194,7 @@ class ObjectTypeFullMetadata(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2197,7 +2209,7 @@ class ObjectTypeInterfaceImplementation(pydantic.BaseModel): properties: typing.Dict[SharedPropertyTypeApiName, PropertyApiName] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2228,7 +2240,7 @@ class ObjectTypeV2(pydantic.BaseModel): visibility: typing.Optional[ObjectTypeVisibility] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2247,7 +2259,7 @@ class OneOfConstraint(pydantic.BaseModel): type: typing.Literal["oneOf"] = "oneOf" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2263,7 +2275,7 @@ class OntologyArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2309,7 +2321,7 @@ class OntologyFullMetadata(pydantic.BaseModel): shared_property_types: typing.Dict[SharedPropertyTypeApiName, SharedPropertyType] = pydantic.Field(alias=str("sharedPropertyTypes")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2325,7 +2337,7 @@ class OntologyInterfaceObjectType(pydantic.BaseModel): type: typing.Literal["interfaceObject"] = "interfaceObject" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2338,7 +2350,7 @@ class OntologyMapType(pydantic.BaseModel): type: typing.Literal["map"] = "map" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2350,7 +2362,7 @@ class OntologyObjectArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2363,7 +2375,7 @@ class OntologyObjectSetType(pydantic.BaseModel): type: typing.Literal["objectSet"] = "objectSet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2376,7 +2388,7 @@ class OntologyObjectType(pydantic.BaseModel): type: typing.Literal["object"] = "object" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2387,7 +2399,7 @@ class OntologyObjectTypeReferenceType(pydantic.BaseModel): type: typing.Literal["objectType"] = "objectType" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2410,7 +2422,7 @@ class OntologySetType(pydantic.BaseModel): type: typing.Literal["set"] = "set" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2423,7 +2435,7 @@ class OntologyStructField(pydantic.BaseModel): required: bool model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2435,7 +2447,7 @@ class OntologyStructType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2449,7 +2461,7 @@ class OntologyV2(pydantic.BaseModel): rid: OntologyRid model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2461,7 +2473,7 @@ class OrQueryV2(pydantic.BaseModel): type: typing.Literal["or"] = "or" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2530,7 +2542,7 @@ class ParameterEvaluationResult(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2551,11 +2563,15 @@ class ParameterOption(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) +Plaintext = str +"""Plaintext""" + + class PreciseDuration(pydantic.BaseModel): """A measurement of duration.""" @@ -2566,7 +2582,7 @@ class PreciseDuration(pydantic.BaseModel): type: typing.Literal["duration"] = "duration" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2593,7 +2609,7 @@ class PropertyApiNameSelector(pydantic.BaseModel): type: typing.Literal["property"] = "property" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2673,7 +2689,7 @@ class PropertyV2(pydantic.BaseModel): visibility: typing.Optional[PropertyTypeVisibility] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2746,7 +2762,7 @@ class QueryAggregationRangeType(pydantic.BaseModel): type: typing.Literal["range"] = "range" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2769,7 +2785,7 @@ class QueryArrayType(pydantic.BaseModel): type: typing.Literal["array"] = "array" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2809,7 +2825,7 @@ class QueryParameterV2(pydantic.BaseModel): data_type: QueryDataType = pydantic.Field(alias=str("dataType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2825,7 +2841,7 @@ class QuerySetType(pydantic.BaseModel): type: typing.Literal["set"] = "set" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2837,7 +2853,7 @@ class QueryStructField(pydantic.BaseModel): field_type: QueryDataType = pydantic.Field(alias=str("fieldType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2849,7 +2865,7 @@ class QueryStructType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2866,7 +2882,7 @@ class QueryTypeV2(pydantic.BaseModel): version: FunctionVersion model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2878,7 +2894,7 @@ class QueryUnionType(pydantic.BaseModel): type: typing.Literal["union"] = "union" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2901,7 +2917,7 @@ class RangeConstraint(pydantic.BaseModel): type: typing.Literal["range"] = "range" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2914,7 +2930,7 @@ class RelativeTime(pydantic.BaseModel): unit: RelativeTimeSeriesTimeUnit model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2927,7 +2943,7 @@ class RelativeTimeRange(pydantic.BaseModel): type: typing.Literal["relative"] = "relative" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -2953,7 +2969,7 @@ class RollingAggregateWindowPoints(pydantic.BaseModel): type: typing.Literal["pointsCount"] = "pointsCount" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3001,7 +3017,7 @@ class SearchObjectsResponseV2(pydantic.BaseModel): total_count: core_models.TotalCount = pydantic.Field(alias=str("totalCount")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3017,7 +3033,7 @@ class SearchOrderByV2(pydantic.BaseModel): fields: typing.List[SearchOrderingV2] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3031,7 +3047,7 @@ class SearchOrderingV2(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3063,7 +3079,7 @@ class SelectedPropertyApproximateDistinctAggregation(pydantic.BaseModel): type: typing.Literal["approximateDistinct"] = "approximateDistinct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3076,7 +3092,7 @@ class SelectedPropertyApproximatePercentileAggregation(pydantic.BaseModel): type: typing.Literal["approximatePercentile"] = "approximatePercentile" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3088,7 +3104,7 @@ class SelectedPropertyAvgAggregation(pydantic.BaseModel): type: typing.Literal["avg"] = "avg" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3111,7 +3127,7 @@ class SelectedPropertyCollectListAggregation(pydantic.BaseModel): type: typing.Literal["collectList"] = "collectList" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3134,7 +3150,7 @@ class SelectedPropertyCollectSetAggregation(pydantic.BaseModel): type: typing.Literal["collectSet"] = "collectSet" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3145,7 +3161,7 @@ class SelectedPropertyCountAggregation(pydantic.BaseModel): type: typing.Literal["count"] = "count" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3157,7 +3173,7 @@ class SelectedPropertyExactDistinctAggregation(pydantic.BaseModel): type: typing.Literal["exactDistinct"] = "exactDistinct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3170,7 +3186,7 @@ class SelectedPropertyExpression(pydantic.BaseModel): type: typing.Literal["selection"] = "selection" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3182,7 +3198,7 @@ class SelectedPropertyMaxAggregation(pydantic.BaseModel): type: typing.Literal["max"] = "max" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3194,7 +3210,7 @@ class SelectedPropertyMinAggregation(pydantic.BaseModel): type: typing.Literal["min"] = "min" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3225,7 +3241,7 @@ class SelectedPropertySumAggregation(pydantic.BaseModel): type: typing.Literal["sum"] = "sum" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3242,7 +3258,7 @@ class SharedPropertyType(pydantic.BaseModel): data_type: ObjectPropertyType = pydantic.Field(alias=str("dataType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3270,7 +3286,7 @@ class StartsWithQuery(pydantic.BaseModel): type: typing.Literal["startsWith"] = "startsWith" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3303,7 +3319,7 @@ class StringLengthConstraint(pydantic.BaseModel): type: typing.Literal["stringLength"] = "stringLength" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3323,7 +3339,7 @@ class StringRegexMatchConstraint(pydantic.BaseModel): type: typing.Literal["stringRegexMatch"] = "stringRegexMatch" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3345,7 +3361,7 @@ class StructFieldSelector(pydantic.BaseModel): type: typing.Literal["structField"] = "structField" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3357,7 +3373,7 @@ class StructFieldType(pydantic.BaseModel): data_type: ObjectPropertyType = pydantic.Field(alias=str("dataType")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3369,7 +3385,7 @@ class StructType(pydantic.BaseModel): type: typing.Literal["struct"] = "struct" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3390,7 +3406,7 @@ class SubmissionCriteriaEvaluation(pydantic.BaseModel): result: ValidationResult model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3403,7 +3419,7 @@ class SubtractPropertyExpression(pydantic.BaseModel): type: typing.Literal["subtract"] = "subtract" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3417,7 +3433,7 @@ class SumAggregationV2(pydantic.BaseModel): type: typing.Literal["sum"] = "sum" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3429,7 +3445,7 @@ class SyncApplyActionResponseV2(pydantic.BaseModel): edits: typing.Optional[ActionResults] = None model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3442,7 +3458,7 @@ class ThreeDimensionalAggregation(pydantic.BaseModel): type: typing.Literal["threeDimensionalAggregation"] = "threeDimensionalAggregation" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3492,7 +3508,7 @@ class TimeSeriesCumulativeAggregate(pydantic.BaseModel): type: typing.Literal["cumulative"] = "cumulative" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3511,7 +3527,7 @@ class TimeSeriesPeriodicAggregate(pydantic.BaseModel): """ window_size: PreciseDuration = pydantic.Field(alias=str("windowSize")) # type: ignore[literal-required] - alignment_timestamp: typing.Optional[datetime] = pydantic.Field(alias=str("alignmentTimestamp"), default=None) # type: ignore[literal-required] + alignment_timestamp: typing.Optional[core.AwareDatetime] = pydantic.Field(alias=str("alignmentTimestamp"), default=None) # type: ignore[literal-required] """ The timestamp used to align the result, such that ticks in the result time series will lie at integer multiples of the window duration from the alignment timestamp. @@ -3527,7 +3543,7 @@ class TimeSeriesPeriodicAggregate(pydantic.BaseModel): type: typing.Literal["periodic"] = "periodic" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3535,7 +3551,7 @@ def to_dict(self) -> dict: class TimeSeriesPoint(pydantic.BaseModel): """A time and value pair.""" - time: datetime + time: core.AwareDatetime """An ISO 8601 timestamp""" value: typing.Any @@ -3543,7 +3559,7 @@ class TimeSeriesPoint(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3555,7 +3571,7 @@ class TimeSeriesRollingAggregate(pydantic.BaseModel): type: typing.Literal["rolling"] = "rolling" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3587,7 +3603,7 @@ def to_dict(self) -> dict: class TimeseriesEntry(pydantic.BaseModel): """A time and value pair.""" - time: datetime + time: core.AwareDatetime """An ISO 8601 timestamp""" value: typing.Any @@ -3595,7 +3611,7 @@ class TimeseriesEntry(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3608,7 +3624,7 @@ class TwoDimensionalAggregation(pydantic.BaseModel): type: typing.Literal["twoDimensionalAggregation"] = "twoDimensionalAggregation" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3622,7 +3638,7 @@ class UnevaluableConstraint(pydantic.BaseModel): type: typing.Literal["unevaluable"] = "unevaluable" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3635,7 +3651,7 @@ class ValidateActionResponseV2(pydantic.BaseModel): parameters: typing.Dict[ParameterId, ParameterEvaluationResult] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3685,7 +3701,7 @@ class WithinBoundingBoxQuery(pydantic.BaseModel): type: typing.Literal["withinBoundingBox"] = "withinBoundingBox" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3703,7 +3719,7 @@ class WithinDistanceOfQuery(pydantic.BaseModel): type: typing.Literal["withinDistanceOf"] = "withinDistanceOf" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3721,7 +3737,7 @@ class WithinPolygonQuery(pydantic.BaseModel): type: typing.Literal["withinPolygon"] = "withinPolygon" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -3846,6 +3862,7 @@ def to_dict(self) -> dict: "CreateObjectRule", "CreateTemporaryObjectSetResponseV2", "DataValue", + "DecryptionResult", "DeleteInterfaceObjectRule", "DeleteLink", "DeleteLinkRule", @@ -3981,6 +3998,7 @@ def to_dict(self) -> dict: "ParameterEvaluationResult", "ParameterId", "ParameterOption", + "Plaintext", "PolygonValue", "PreciseDuration", "PreciseTimeUnit", diff --git a/foundry_sdk/v2/orchestration/build.py b/foundry_sdk/v2/orchestration/build.py index 50946cf9e..cf7f050ce 100644 --- a/foundry_sdk/v2/orchestration/build.py +++ b/foundry_sdk/v2/orchestration/build.py @@ -57,7 +57,6 @@ def cancel( self, build_rid: core_models.BuildRid, *, - preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> None: @@ -66,8 +65,6 @@ def cancel( :param build_rid: The RID of a Build. :type build_rid: BuildRid - :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. @@ -80,9 +77,7 @@ def cancel( core.RequestInfo( method="POST", resource_path="/v2/orchestration/builds/{buildRid}/cancel", - query_params={ - "preview": preview, - }, + query_params={}, path_params={ "buildRid": build_rid, }, @@ -110,7 +105,6 @@ def create( branch_name: typing.Optional[datasets_models.BranchName] = None, force_build: typing.Optional[orchestration_models.ForceBuild] = None, notifications_enabled: typing.Optional[orchestration_models.NotificationsEnabled] = None, - preview: typing.Optional[core_models.PreviewMode] = None, retry_backoff_duration: typing.Optional[orchestration_models.RetryBackoffDuration] = None, retry_count: typing.Optional[orchestration_models.RetryCount] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -130,8 +124,6 @@ def create( :type force_build: Optional[ForceBuild] :param notifications_enabled: The notification will be sent to the user that has most recently edited the schedule. No notification will be sent if the schedule has `scopeMode` set to `ProjectScope`. :type notifications_enabled: Optional[NotificationsEnabled] - :param preview: Enables the use of preview functionality. - :type preview: Optional[PreviewMode] :param retry_backoff_duration: :type retry_backoff_duration: Optional[RetryBackoffDuration] :param retry_count: The number of retry attempts for failed jobs. @@ -148,9 +140,7 @@ def create( core.RequestInfo( method="POST", resource_path="/v2/orchestration/builds/create", - query_params={ - "preview": preview, - }, + query_params={}, path_params={}, header_params={ "Content-Type": "application/json", @@ -199,7 +189,6 @@ def get( self, build_rid: core_models.BuildRid, *, - preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> orchestration_models.Build: @@ -207,8 +196,6 @@ def get( Get the Build with the specified rid. :param build_rid: The RID of a Build. :type build_rid: BuildRid - :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. @@ -221,9 +208,7 @@ def get( core.RequestInfo( method="GET", resource_path="/v2/orchestration/builds/{buildRid}", - query_params={ - "preview": preview, - }, + query_params={}, path_params={ "buildRid": build_rid, }, @@ -251,7 +236,6 @@ def get_batch( annotated_types.Len(min_length=1, max_length=100), ], *, - preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, _sdk_internal: core.SdkInternal = {}, ) -> orchestration_models.GetBuildsBatchResponse: @@ -261,8 +245,6 @@ def get_batch( The maximum batch size for this endpoint is 100. :param body: Body of the request :type body: List[GetBuildsBatchRequestElement] - :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. @@ -273,9 +255,7 @@ def get_batch( core.RequestInfo( method="POST", resource_path="/v2/orchestration/builds/getBatch", - query_params={ - "preview": preview, - }, + query_params={}, path_params={}, header_params={ "Content-Type": "application/json", diff --git a/foundry_sdk/v2/orchestration/models.py b/foundry_sdk/v2/orchestration/models.py index c3ce202f9..803f5da9e 100644 --- a/foundry_sdk/v2/orchestration/models.py +++ b/foundry_sdk/v2/orchestration/models.py @@ -16,7 +16,6 @@ from __future__ import annotations import typing -from datetime import datetime import pydantic import typing_extensions @@ -48,7 +47,7 @@ class Action(pydantic.BaseModel): notifications_enabled: NotificationsEnabled = pydantic.Field(alias=str("notificationsEnabled")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -60,7 +59,7 @@ class AndTrigger(pydantic.BaseModel): type: typing.Literal["and"] = "and" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -88,7 +87,7 @@ class Build(pydantic.BaseModel): status: BuildStatus model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -129,7 +128,7 @@ class ConnectingTarget(pydantic.BaseModel): type: typing.Literal["connecting"] = "connecting" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -149,7 +148,7 @@ class CreateScheduleRequestAction(pydantic.BaseModel): target: CreateScheduleRequestBuildTarget model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -180,7 +179,7 @@ class CreateScheduleRequestConnectingTarget(pydantic.BaseModel): type: typing.Literal["connecting"] = "connecting" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -192,7 +191,7 @@ class CreateScheduleRequestManualTarget(pydantic.BaseModel): type: typing.Literal["manual"] = "manual" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -204,7 +203,7 @@ class CreateScheduleRequestProjectScope(pydantic.BaseModel): type: typing.Literal["project"] = "project" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -228,7 +227,7 @@ class CreateScheduleRequestUpstreamTarget(pydantic.BaseModel): type: typing.Literal["upstream"] = "upstream" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -239,7 +238,7 @@ class CreateScheduleRequestUserScope(pydantic.BaseModel): type: typing.Literal["user"] = "user" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -259,7 +258,7 @@ class DatasetJobOutput(pydantic.BaseModel): type: typing.Literal["datasetJobOutput"] = "datasetJobOutput" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -275,7 +274,7 @@ class DatasetUpdatedTrigger(pydantic.BaseModel): type: typing.Literal["datasetUpdated"] = "datasetUpdated" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -299,7 +298,7 @@ class GetBuildsBatchRequestElement(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -310,7 +309,7 @@ class GetBuildsBatchResponse(pydantic.BaseModel): data: typing.Dict[core_models.BuildRid, Build] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -323,7 +322,7 @@ class GetJobsBatchRequestElement(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -334,7 +333,7 @@ class GetJobsBatchResponse(pydantic.BaseModel): data: typing.Dict[core_models.JobRid, Job] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -351,7 +350,7 @@ class Job(pydantic.BaseModel): started_time: JobStartedTime = pydantic.Field(alias=str("startedTime")) # type: ignore[literal-required] """The time this job started waiting for the dependencies to be resolved.""" - finished_time: typing.Optional[datetime] = pydantic.Field(alias=str("finishedTime"), default=None) # type: ignore[literal-required] + finished_time: typing.Optional[core.AwareDatetime] = pydantic.Field(alias=str("finishedTime"), default=None) # type: ignore[literal-required] """The time this job was finished.""" job_status: JobStatus = pydantic.Field(alias=str("jobStatus")) # type: ignore[literal-required] @@ -363,7 +362,7 @@ class Job(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -375,7 +374,7 @@ def to_dict(self) -> dict: """Other types of Job Outputs exist in Foundry. Currently, only Dataset and Media Set are supported by the API.""" -JobStartedTime = datetime +JobStartedTime = core.AwareDatetime """The time this job started waiting for the dependencies to be resolved.""" @@ -394,7 +393,7 @@ class JobSucceededTrigger(pydantic.BaseModel): type: typing.Literal["jobSucceeded"] = "jobSucceeded" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -406,7 +405,7 @@ class ListJobsOfBuildResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -418,7 +417,7 @@ class ListRunsOfScheduleResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -430,7 +429,7 @@ class ManualTarget(pydantic.BaseModel): type: typing.Literal["manual"] = "manual" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -448,7 +447,7 @@ class MediaSetUpdatedTrigger(pydantic.BaseModel): type: typing.Literal["mediaSetUpdated"] = "mediaSetUpdated" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -464,7 +463,7 @@ class NewLogicTrigger(pydantic.BaseModel): type: typing.Literal["newLogic"] = "newLogic" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -483,7 +482,7 @@ class OrTrigger(pydantic.BaseModel): type: typing.Literal["or"] = "or" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -495,7 +494,7 @@ class ProjectScope(pydantic.BaseModel): type: typing.Literal["project"] = "project" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -515,7 +514,7 @@ class ReplaceScheduleRequestAction(pydantic.BaseModel): target: ReplaceScheduleRequestBuildTarget model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -546,7 +545,7 @@ class ReplaceScheduleRequestConnectingTarget(pydantic.BaseModel): type: typing.Literal["connecting"] = "connecting" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -558,7 +557,7 @@ class ReplaceScheduleRequestManualTarget(pydantic.BaseModel): type: typing.Literal["manual"] = "manual" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -570,7 +569,7 @@ class ReplaceScheduleRequestProjectScope(pydantic.BaseModel): type: typing.Literal["project"] = "project" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -594,7 +593,7 @@ class ReplaceScheduleRequestUpstreamTarget(pydantic.BaseModel): type: typing.Literal["upstream"] = "upstream" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -605,7 +604,7 @@ class ReplaceScheduleRequestUserScope(pydantic.BaseModel): type: typing.Literal["user"] = "user" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -642,7 +641,7 @@ class Schedule(pydantic.BaseModel): scope_mode: ScopeMode = pydantic.Field(alias=str("scopeMode")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -680,7 +679,7 @@ class ScheduleRun(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -693,7 +692,7 @@ class ScheduleRunError(pydantic.BaseModel): type: typing.Literal["error"] = "error" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -716,7 +715,7 @@ class ScheduleRunIgnored(pydantic.BaseModel): type: typing.Literal["ignored"] = "ignored" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -742,7 +741,7 @@ class ScheduleRunSubmitted(pydantic.BaseModel): type: typing.Literal["submitted"] = "submitted" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -757,7 +756,7 @@ class ScheduleSucceededTrigger(pydantic.BaseModel): type: typing.Literal["scheduleSucceeded"] = "scheduleSucceeded" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -780,7 +779,7 @@ class ScheduleVersion(pydantic.BaseModel): scope_mode: ScopeMode = pydantic.Field(alias=str("scopeMode")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -802,7 +801,7 @@ class SearchBuildsAndFilter(pydantic.BaseModel): type: typing.Literal["and"] = "and" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -815,7 +814,7 @@ class SearchBuildsEqualsFilter(pydantic.BaseModel): type: typing.Literal["eq"] = "eq" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -846,7 +845,7 @@ class SearchBuildsGteFilter(pydantic.BaseModel): type: typing.Literal["gte"] = "gte" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -863,7 +862,7 @@ class SearchBuildsLtFilter(pydantic.BaseModel): type: typing.Literal["lt"] = "lt" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -879,7 +878,7 @@ class SearchBuildsNotFilter(pydantic.BaseModel): type: typing.Literal["not"] = "not" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -891,7 +890,7 @@ class SearchBuildsOrFilter(pydantic.BaseModel): type: typing.Literal["or"] = "or" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -902,7 +901,7 @@ class SearchBuildsOrderBy(pydantic.BaseModel): fields: typing.List[SearchBuildsOrderByItem] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -918,7 +917,7 @@ class SearchBuildsOrderByItem(pydantic.BaseModel): direction: core_models.OrderByDirection model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -930,7 +929,7 @@ class SearchBuildsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -943,7 +942,7 @@ class TimeTrigger(pydantic.BaseModel): type: typing.Literal["time"] = "time" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -956,7 +955,7 @@ class TransactionalMediaSetJobOutput(pydantic.BaseModel): type: typing.Literal["transactionalMediaSetJobOutput"] = "transactionalMediaSetJobOutput" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -989,7 +988,7 @@ class UpstreamTarget(pydantic.BaseModel): type: typing.Literal["upstream"] = "upstream" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -1003,7 +1002,7 @@ class UserScope(pydantic.BaseModel): type: typing.Literal["user"] = "user" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) diff --git a/foundry_sdk/v2/sql_queries/_client.py b/foundry_sdk/v2/sql_queries/_client.py index a21822f14..778e3a4f7 100644 --- a/foundry_sdk/v2/sql_queries/_client.py +++ b/foundry_sdk/v2/sql_queries/_client.py @@ -39,10 +39,10 @@ def __init__( self._config = config @cached_property - def Query(self): - from foundry_sdk.v2.sql_queries.query import QueryClient + def SqlQuery(self): + from foundry_sdk.v2.sql_queries.sql_query import SqlQueryClient - return QueryClient( + return SqlQueryClient( auth=self._auth, hostname=self._hostname, config=self._config, diff --git a/foundry_sdk/v2/sql_queries/errors.py b/foundry_sdk/v2/sql_queries/errors.py index 041d6fde7..fcb5a3ae9 100644 --- a/foundry_sdk/v2/sql_queries/errors.py +++ b/foundry_sdk/v2/sql_queries/errors.py @@ -23,64 +23,64 @@ from foundry_sdk.v2.sql_queries import models as sql_queries_models -class CancelQueryPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not cancel the Query.""" +class CancelSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): + """Could not cancel the SqlQuery.""" __pydantic_config__ = {"extra": "allow"} # type: ignore - queryId: sql_queries_models.QueryId + sqlQueryId: sql_queries_models.SqlQueryId """The id of a query.""" @dataclass -class CancelQueryPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["CancelQueryPermissionDenied"] - parameters: CancelQueryPermissionDeniedParameters +class CancelSqlQueryPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["CancelSqlQueryPermissionDenied"] + parameters: CancelSqlQueryPermissionDeniedParameters error_instance_id: str -class ExecuteQueryPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not execute the Query.""" +class ExecuteSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): + """Could not execute the SqlQuery.""" __pydantic_config__ = {"extra": "allow"} # type: ignore @dataclass -class ExecuteQueryPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["ExecuteQueryPermissionDenied"] - parameters: ExecuteQueryPermissionDeniedParameters +class ExecuteSqlQueryPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["ExecuteSqlQueryPermissionDenied"] + parameters: ExecuteSqlQueryPermissionDeniedParameters error_instance_id: str -class GetResultsPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not getResults the Query.""" +class GetResultsSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): + """Could not getResults the SqlQuery.""" __pydantic_config__ = {"extra": "allow"} # type: ignore - queryId: sql_queries_models.QueryId + sqlQueryId: sql_queries_models.SqlQueryId """The id of a query.""" @dataclass -class GetResultsPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["GetResultsPermissionDenied"] - parameters: GetResultsPermissionDeniedParameters +class GetResultsSqlQueryPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["GetResultsSqlQueryPermissionDenied"] + parameters: GetResultsSqlQueryPermissionDeniedParameters error_instance_id: str -class GetStatusPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not getStatus the Query.""" +class GetStatusSqlQueryPermissionDeniedParameters(typing_extensions.TypedDict): + """Could not getStatus the SqlQuery.""" __pydantic_config__ = {"extra": "allow"} # type: ignore - queryId: sql_queries_models.QueryId + sqlQueryId: sql_queries_models.SqlQueryId """The id of a query.""" @dataclass -class GetStatusPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["GetStatusPermissionDenied"] - parameters: GetStatusPermissionDeniedParameters +class GetStatusSqlQueryPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["GetStatusSqlQueryPermissionDenied"] + parameters: GetStatusSqlQueryPermissionDeniedParameters error_instance_id: str @@ -89,7 +89,7 @@ class QueryCanceledParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - queryId: sql_queries_models.QueryId + queryId: sql_queries_models.SqlQueryId @dataclass @@ -104,7 +104,7 @@ class QueryFailedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - queryId: sql_queries_models.QueryId + queryId: sql_queries_models.SqlQueryId errorMessage: str @@ -135,7 +135,7 @@ class QueryPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - queryId: sql_queries_models.QueryId + queryId: sql_queries_models.SqlQueryId @dataclass @@ -150,7 +150,7 @@ class QueryRunningParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - queryId: sql_queries_models.QueryId + queryId: sql_queries_models.SqlQueryId @dataclass @@ -177,10 +177,10 @@ class ReadQueryInputsPermissionDenied(errors.PermissionDeniedError): __all__ = [ - "CancelQueryPermissionDenied", - "ExecuteQueryPermissionDenied", - "GetResultsPermissionDenied", - "GetStatusPermissionDenied", + "CancelSqlQueryPermissionDenied", + "ExecuteSqlQueryPermissionDenied", + "GetResultsSqlQueryPermissionDenied", + "GetStatusSqlQueryPermissionDenied", "QueryCanceled", "QueryFailed", "QueryParseError", diff --git a/foundry_sdk/v2/sql_queries/models.py b/foundry_sdk/v2/sql_queries/models.py index 00c2b753f..b970fcfd2 100644 --- a/foundry_sdk/v2/sql_queries/models.py +++ b/foundry_sdk/v2/sql_queries/models.py @@ -29,7 +29,7 @@ class CanceledQueryStatus(pydantic.BaseModel): type: typing.Literal["canceled"] = "canceled" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -43,15 +43,11 @@ class FailedQueryStatus(pydantic.BaseModel): type: typing.Literal["failed"] = "failed" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) -QueryId = str -"""The identifier of a Query.""" - - QueryStatus = typing_extensions.Annotated[ typing.Union[ "RunningQueryStatus", CanceledQueryStatus, FailedQueryStatus, "SucceededQueryStatus" @@ -64,23 +60,27 @@ def to_dict(self) -> dict: class RunningQueryStatus(pydantic.BaseModel): """RunningQueryStatus""" - query_id: QueryId = pydantic.Field(alias=str("queryId")) # type: ignore[literal-required] + query_id: SqlQueryId = pydantic.Field(alias=str("queryId")) # type: ignore[literal-required] type: typing.Literal["running"] = "running" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) +SqlQueryId = str +"""The identifier of a SQL Query.""" + + class SucceededQueryStatus(pydantic.BaseModel): """SucceededQueryStatus""" - query_id: QueryId = pydantic.Field(alias=str("queryId")) # type: ignore[literal-required] + query_id: SqlQueryId = pydantic.Field(alias=str("queryId")) # type: ignore[literal-required] type: typing.Literal["succeeded"] = "succeeded" model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -90,8 +90,8 @@ def to_dict(self) -> dict: __all__ = [ "CanceledQueryStatus", "FailedQueryStatus", - "QueryId", "QueryStatus", "RunningQueryStatus", + "SqlQueryId", "SucceededQueryStatus", ] diff --git a/foundry_sdk/v2/sql_queries/query.py b/foundry_sdk/v2/sql_queries/sql_query.py similarity index 84% rename from foundry_sdk/v2/sql_queries/query.py rename to foundry_sdk/v2/sql_queries/sql_query.py index 244cedb14..334c524ea 100644 --- a/foundry_sdk/v2/sql_queries/query.py +++ b/foundry_sdk/v2/sql_queries/sql_query.py @@ -26,9 +26,9 @@ from foundry_sdk.v2.sql_queries import models as sql_queries_models -class QueryClient: +class SqlQueryClient: """ - The API client for the Query Resource. + The API client for the SqlQuery Resource. :param auth: Your auth configuration. :param hostname: Your Foundry hostname (for example, "myfoundry.palantirfoundry.com"). This can also include your API gateway service URI. @@ -46,15 +46,15 @@ def __init__( self._config = config self._api_client = core.ApiClient(auth=auth, hostname=hostname, config=config) - self.with_streaming_response = _QueryClientStreaming(self) - self.with_raw_response = _QueryClientRaw(self) + self.with_streaming_response = _SqlQueryClientStreaming(self) + self.with_raw_response = _SqlQueryClientRaw(self) @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected def cancel( self, - query_id: sql_queries_models.QueryId, + sql_query_id: sql_queries_models.SqlQueryId, *, preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -63,8 +63,8 @@ def cancel( """ Cancels a query. If the query is no longer running this is effectively a no-op. - :param query_id: The id of a query. - :type query_id: QueryId + :param sql_query_id: The id of a query. + :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -72,19 +72,19 @@ def cancel( :return: Returns the result object. :rtype: None - :raises CancelQueryPermissionDenied: Could not cancel the Query. + :raises CancelSqlQueryPermissionDenied: Could not cancel the SqlQuery. :raises QueryPermissionDenied: The provided token does not have permission to access the given query. """ return self._api_client.call_api( core.RequestInfo( method="POST", - resource_path="/v2/sqlQueries/queries/{queryId}/cancel", + resource_path="/v2/sqlQueries/{sqlQueryId}/cancel", query_params={ "preview": preview, }, path_params={ - "queryId": query_id, + "sqlQueryId": sql_query_id, }, header_params={}, body=None, @@ -92,7 +92,7 @@ def cancel( response_type=None, request_timeout=request_timeout, throwable_errors={ - "CancelQueryPermissionDenied": sql_queries_errors.CancelQueryPermissionDenied, + "CancelSqlQueryPermissionDenied": sql_queries_errors.CancelSqlQueryPermissionDenied, "QueryPermissionDenied": sql_queries_errors.QueryPermissionDenied, }, response_mode=_sdk_internal.get("response_mode"), @@ -125,7 +125,7 @@ def execute( :return: Returns the result object. :rtype: sql_queries_models.QueryStatus - :raises ExecuteQueryPermissionDenied: Could not execute the Query. + :raises ExecuteSqlQueryPermissionDenied: Could not execute the SqlQuery. :raises QueryParseError: The query cannot be parsed. :raises ReadQueryInputsPermissionDenied: The provided token does not have permission to access the inputs to the query. """ @@ -133,7 +133,7 @@ def execute( return self._api_client.call_api( core.RequestInfo( method="POST", - resource_path="/v2/sqlQueries/queries/execute", + resource_path="/v2/sqlQueries/execute", query_params={ "preview": preview, }, @@ -158,7 +158,7 @@ def execute( response_type=sql_queries_models.QueryStatus, request_timeout=request_timeout, throwable_errors={ - "ExecuteQueryPermissionDenied": sql_queries_errors.ExecuteQueryPermissionDenied, + "ExecuteSqlQueryPermissionDenied": sql_queries_errors.ExecuteSqlQueryPermissionDenied, "QueryParseError": sql_queries_errors.QueryParseError, "ReadQueryInputsPermissionDenied": sql_queries_errors.ReadQueryInputsPermissionDenied, }, @@ -171,7 +171,7 @@ def execute( @errors.handle_unexpected def get_results( self, - query_id: sql_queries_models.QueryId, + sql_query_id: sql_queries_models.SqlQueryId, *, preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -181,8 +181,8 @@ def get_results( Gets the results of a query. This endpoint implements long polling and requests will time out after one minute. - :param query_id: The id of a query. - :type query_id: QueryId + :param sql_query_id: The id of a query. + :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -190,7 +190,7 @@ def get_results( :return: Returns the result object. :rtype: bytes - :raises GetResultsPermissionDenied: Could not getResults the Query. + :raises GetResultsSqlQueryPermissionDenied: Could not getResults the SqlQuery. :raises QueryCanceled: The query was canceled. :raises QueryFailed: The query failed. :raises QueryPermissionDenied: The provided token does not have permission to access the given query. @@ -199,12 +199,12 @@ def get_results( return self._api_client.call_api( core.RequestInfo( method="GET", - resource_path="/v2/sqlQueries/queries/{queryId}/getResults", + resource_path="/v2/sqlQueries/{sqlQueryId}/getResults", query_params={ "preview": preview, }, path_params={ - "queryId": query_id, + "sqlQueryId": sql_query_id, }, header_params={ "Accept": "application/octet-stream", @@ -214,7 +214,7 @@ def get_results( response_type=bytes, request_timeout=request_timeout, throwable_errors={ - "GetResultsPermissionDenied": sql_queries_errors.GetResultsPermissionDenied, + "GetResultsSqlQueryPermissionDenied": sql_queries_errors.GetResultsSqlQueryPermissionDenied, "QueryCanceled": sql_queries_errors.QueryCanceled, "QueryFailed": sql_queries_errors.QueryFailed, "QueryPermissionDenied": sql_queries_errors.QueryPermissionDenied, @@ -228,7 +228,7 @@ def get_results( @errors.handle_unexpected def get_status( self, - query_id: sql_queries_models.QueryId, + sql_query_id: sql_queries_models.SqlQueryId, *, preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -237,8 +237,8 @@ def get_status( """ Gets the status of a query. - :param query_id: The id of a query. - :type query_id: QueryId + :param sql_query_id: The id of a query. + :type sql_query_id: SqlQueryId :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. @@ -246,19 +246,19 @@ def get_status( :return: Returns the result object. :rtype: sql_queries_models.QueryStatus - :raises GetStatusPermissionDenied: Could not getStatus the Query. + :raises GetStatusSqlQueryPermissionDenied: Could not getStatus the SqlQuery. :raises QueryPermissionDenied: The provided token does not have permission to access the given query. """ return self._api_client.call_api( core.RequestInfo( method="GET", - resource_path="/v2/sqlQueries/queries/{queryId}/getStatus", + resource_path="/v2/sqlQueries/{sqlQueryId}/getStatus", query_params={ "preview": preview, }, path_params={ - "queryId": query_id, + "sqlQueryId": sql_query_id, }, header_params={ "Accept": "application/json", @@ -268,7 +268,7 @@ def get_status( response_type=sql_queries_models.QueryStatus, request_timeout=request_timeout, throwable_errors={ - "GetStatusPermissionDenied": sql_queries_errors.GetStatusPermissionDenied, + "GetStatusSqlQueryPermissionDenied": sql_queries_errors.GetStatusSqlQueryPermissionDenied, "QueryPermissionDenied": sql_queries_errors.QueryPermissionDenied, }, response_mode=_sdk_internal.get("response_mode"), @@ -276,8 +276,8 @@ def get_status( ) -class _QueryClientRaw: - def __init__(self, client: QueryClient) -> None: +class _SqlQueryClientRaw: + def __init__(self, client: SqlQueryClient) -> None: def cancel(_: None): ... def execute(_: sql_queries_models.QueryStatus): ... def get_results(_: bytes): ... @@ -289,8 +289,8 @@ def get_status(_: sql_queries_models.QueryStatus): ... self.get_status = core.with_raw_response(get_status, client.get_status) -class _QueryClientStreaming: - def __init__(self, client: QueryClient) -> None: +class _SqlQueryClientStreaming: + def __init__(self, client: SqlQueryClient) -> None: def execute(_: sql_queries_models.QueryStatus): ... def get_results(_: bytes): ... def get_status(_: sql_queries_models.QueryStatus): ... diff --git a/foundry_sdk/v2/streams/models.py b/foundry_sdk/v2/streams/models.py index 64c441c16..4f9528eb0 100644 --- a/foundry_sdk/v2/streams/models.py +++ b/foundry_sdk/v2/streams/models.py @@ -62,7 +62,7 @@ class CreateStreamRequestStreamSchema(pydantic.BaseModel): change_data_capture: typing.Optional[core_models.ChangeDataCaptureConfiguration] = pydantic.Field(alias=str("changeDataCapture"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -75,7 +75,7 @@ class Dataset(pydantic.BaseModel): parent_folder_rid: filesystem_models.FolderRid = pydantic.Field(alias=str("parentFolderRid")) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -117,7 +117,7 @@ class Stream(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) diff --git a/foundry_sdk/v2/third_party_applications/models.py b/foundry_sdk/v2/third_party_applications/models.py index 2edb3e762..626df509b 100644 --- a/foundry_sdk/v2/third_party_applications/models.py +++ b/foundry_sdk/v2/third_party_applications/models.py @@ -30,7 +30,7 @@ class ListVersionsResponse(pydantic.BaseModel): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -47,7 +47,7 @@ class ThirdPartyApplication(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -64,7 +64,7 @@ class Version(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) @@ -84,7 +84,7 @@ class Website(pydantic.BaseModel): model_config = {"extra": "allow", "populate_by_name": True} - def to_dict(self) -> dict: + def to_dict(self) -> typing.Dict[str, typing.Any]: """Return the dictionary representation of the model using the field aliases.""" return self.model_dump(by_alias=True, exclude_none=True) diff --git a/tests/auth/test_confidential_client.py b/tests/auth/test_confidential_client.py index d6be54710..fdc203d86 100644 --- a/tests/auth/test_confidential_client.py +++ b/tests/auth/test_confidential_client.py @@ -14,7 +14,6 @@ import contextlib -import warnings import httpx import pytest @@ -75,16 +74,6 @@ def test_confidential_client_instantiate(): assert auth._should_refresh == True -def test_confidential_client_sign_in_as_service_user(): - with stubbed_auth() as auth: - with warnings.catch_warnings(record=True) as w: - assert auth.sign_in_as_service_user() == SignInResponse( - session={"accessToken": "access_token", "expiresIn": 3600} - ) - - assert len(w) == 1 - - def test_confidential_client_url(): assert ( ConfidentialClientAuth(client_id="", client_secret="", hostname="https://a.b.c.com").url diff --git a/tests/auth/test_user_auth_token_client.py b/tests/auth/test_user_auth_token_client.py index e0f2164c8..f48cc3269 100644 --- a/tests/auth/test_user_auth_token_client.py +++ b/tests/auth/test_user_auth_token_client.py @@ -13,18 +13,13 @@ # limitations under the License. -import warnings - import pytest from foundry_sdk import UserTokenAuth -def test_missing_token_raises_type_error(): +def test_invalid_token_raises_appropriate_error(): assert pytest.raises(TypeError, lambda: UserTokenAuth()) # type: ignore - - -def test_warns_if_given_hostname(): - with warnings.catch_warnings(record=True) as w: - UserTokenAuth(hostname="foo", token="bar") - assert len(w) == 1 + assert pytest.raises(TypeError, lambda: UserTokenAuth(1)) # type: ignore + assert pytest.raises(TypeError, lambda: UserTokenAuth(None)) # type: ignore + assert pytest.raises(ValueError, lambda: UserTokenAuth("")) diff --git a/tests/test_api_client.py b/tests/test_api_client.py index cb9250632..939d7c081 100644 --- a/tests/test_api_client.py +++ b/tests/test_api_client.py @@ -109,17 +109,6 @@ def create_client( return ApiClient(auth=UserTokenAuth(token="bar"), hostname=hostname, config=config) -def test_can_override_session_using_deprecated_method(): - client = create_mock_client() - - with warnings.catch_warnings(record=True) as w: - assert isinstance(client.session._session, httpx.Client) - # Ensure the warning is emitted when accessing the session - assert len(w) == 1 - - client.session._session.headers["Foo"] = "Bar" - - def test_authorization_header(): client = create_mock_client() client.call_api(RequestInfo.with_defaults("GET", "/foo/bar")) diff --git a/tests/test_datetime.py b/tests/test_datetime.py new file mode 100644 index 000000000..02c94e5b4 --- /dev/null +++ b/tests/test_datetime.py @@ -0,0 +1,27 @@ +from datetime import datetime +from datetime import timezone + +import pydantic +import pytest + + +class Model(pydantic.BaseModel): + datetype: pydantic.AwareDatetime + + +def test_init_fails_without_timezone(): + with pytest.raises(pydantic.ValidationError): + Model(datetype=datetime.now()) + + +def test_validate_python_fails_without_timezone(): + with pytest.raises(pydantic.ValidationError): + Model.model_validate({"datetype": "2022-01-01T00:00:00"}) + + +def test_init_passes_with_timezone(): + Model(datetype=datetime.now(tz=timezone.utc)) + + +def test_validate_python_passes_with_timezone(): + Model.model_validate({"datetype": "2022-01-01T00:00:00Z"}) diff --git a/tests/test_resorce_import.py b/tests/test_resorce_import.py index 988fa1fdd..10e3e61b7 100644 --- a/tests/test_resorce_import.py +++ b/tests/test_resorce_import.py @@ -298,6 +298,12 @@ def test_ontologies_v2_attachment_property_import(): assert AttachmentPropertyClient is not None +def test_ontologies_v2_cipher_text_property_import(): + from foundry_sdk.v2.ontologies.cipher_text_property import CipherTextPropertyClient + + assert CipherTextPropertyClient is not None + + def test_ontologies_v2_linked_object_import(): from foundry_sdk.v2.ontologies.linked_object import LinkedObjectClient @@ -392,10 +398,10 @@ def test_orchestration_v2_schedule_version_import(): assert ScheduleVersionClient is not None -def test_sql_queries_v2_query_import(): - from foundry_sdk.v2.sql_queries.query import QueryClient +def test_sql_queries_v2_sql_query_import(): + from foundry_sdk.v2.sql_queries.sql_query import SqlQueryClient - assert QueryClient is not None + assert SqlQueryClient is not None def test_streams_v2_dataset_import(): diff --git a/tests/test_utils.py b/tests/test_utils.py index 734c68502..897ff663b 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -1,5 +1,8 @@ import typing import warnings +from datetime import datetime +from datetime import timedelta +from datetime import timezone import pytest import typing_extensions @@ -8,6 +11,7 @@ from foundry_sdk._core.utils import RID from foundry_sdk._core.utils import UUID +from foundry_sdk._core.utils import AwareDatetime from foundry_sdk._core.utils import Long from foundry_sdk._core.utils import maybe_ignore_preview from foundry_sdk._core.utils import remove_prefixes @@ -114,6 +118,37 @@ class WithLong(BaseModel): assert WithLong(long=123).model_dump_json() == '{"long":"123"}' +def test_accepts_valid_datetime(): + class WithDatetime(BaseModel): + datetime: AwareDatetime + + WithDatetime.model_validate({"datetime": datetime.now(timezone.utc)}) + + +def test_rejects_invalid_datetime(): + class WithDatetime(BaseModel): + datetime: AwareDatetime + + with pytest.raises(ValidationError): + WithDatetime.model_validate({"datetime": datetime.now()}) + + +def test_datetime_serializes_to_string(): + class WithDatetime(BaseModel): + datetime: AwareDatetime + + t = datetime(2023, 10, 1, 12, 0, 0, tzinfo=timezone.utc) + assert WithDatetime(datetime=t).model_dump_json() == '{"datetime":"2023-10-01T12:00:00+00:00"}' + + +def test_non_utc_datetime_serializes_to_utc_string(): + class WithDatetime(BaseModel): + datetime: AwareDatetime + + t = datetime(2023, 10, 1, 12, 0, 0, tzinfo=timezone(timedelta(hours=2))) + assert WithDatetime(datetime=t).model_dump_json() == '{"datetime":"2023-10-01T10:00:00+00:00"}' + + def test_resolve_dict_forward_references(): A = typing.Dict[str, "B"] B = str @@ -130,3 +165,21 @@ def test_resolve_annotated_union_forward_references(): resolve_forward_references(A, globals(), locals()) assert A == typing_extensions.Annotated[typing.Union[str, int], "Foo Bar"] + + +def test_resolve_duplicate_forward_references(): + A = typing.List["C"] + B = typing.List["C"] + C = typing.List[float] + + resolve_forward_references(B, globals(), locals()) + resolve_forward_references(A, globals(), locals()) + assert A == typing.List[typing.List[float]] + + +def test_resolve_double_forward_reference(): + A = typing.List[typing.List["B"]] + B = float + + resolve_forward_references(A, globals(), locals()) + assert A == typing.List[typing.List[float]] From 629645e4df596858105eec2885844a70938f69c6 Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Tue, 8 Apr 2025 11:54:27 -0300 Subject: [PATCH 04/11] fix --- tox.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index 446552fab..47fd1e432 100644 --- a/tox.ini +++ b/tox.ini @@ -21,7 +21,7 @@ deps = allowlist_externals = poetry commands = poetry run pytest --tb=short tests/ - pyright foundry/ + pyright foundry_sdk/ passenv = PYDANTIC_VERSION,HTTPX_VERSION [testenv:black] From 3e6c032fc64b0169068f22ad8a86ff1bbff3aad4 Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Tue, 8 Apr 2025 11:57:22 -0300 Subject: [PATCH 05/11] fix tox --- tox.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index 47fd1e432..6adddb3dc 100644 --- a/tox.ini +++ b/tox.ini @@ -28,4 +28,4 @@ passenv = PYDANTIC_VERSION,HTTPX_VERSION deps = black == 24.1.1 commands = - black --check foundry tests + black --check foundry_sdk tests From d54319a46c579283fe038a394888bfbc91a6754d Mon Sep 17 00:00:00 2001 From: svc-changelog Date: Tue, 8 Apr 2025 14:58:00 +0000 Subject: [PATCH 06/11] Add generated changelog entries --- changelog/@unreleased/pr-180.v2.yml | 32 +++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 changelog/@unreleased/pr-180.v2.yml diff --git a/changelog/@unreleased/pr-180.v2.yml b/changelog/@unreleased/pr-180.v2.yml new file mode 100644 index 000000000..b394e515f --- /dev/null +++ b/changelog/@unreleased/pr-180.v2.yml @@ -0,0 +1,32 @@ +type: break +break: + description: "### Migration Guide\n- The deprecated `page` operations have been + removed in favor of the `list` operations. If you were still using the `page` + methods, you can switch them to `list` instead.\n\n```python\npage = client.datasets.Dataset.Branch.page(dataset_rid, + page_size=page_size) # before\npage = client.datasets.Dataset.Branch.list(dataset_rid, + page_size=page_size) # after\n```\n\n- The method definitions no longer include + `TypeDict` types for complex objects. Instead, only the pydantic `BaseModel` classes + will be included in the method definition. Python dictionaries can continue to + be passed into these methods; however, mypy/pyright type checking will start to + error if you use dictionaries.\n\n```python\n# before\nclass ScheduleClient:\n + \ ...\n \n def create(\n self,\n *,\n action: typing.Union[CreateScheduleRequestAction, + CreateScheduleRequestActionDict],\n ...\n ) -> Schedule:\n \n# after\nclass + ScheduleClient:\n ...\n \n def create(\n self,\n *,\n action: + CreateScheduleRequestAction,\n ...\n ) -> Schedule:\n```\n\n- Typing + support has also been removed from the `to_dict()` methods on the base classes. + Support may be added back in the future if there are use cases for having typing + support.\n\n```python\n# before\nclass Schedule(BaseModel):\n ...\n\n def + to_dict(self) -> \"ScheduleDict\":\n \"\"\"Return the dictionary representation + of the model using the field aliases.\"\"\"\n return typing.cast(ScheduleDict, + self.model_dump(by_alias=True, exclude_none=True))\n\n# after\nclass Schedule(BaseModel):\n + \ ...\n\n def to_dict(self) -> Dict[str, Any]:\n \"\"\"Return the + dictionary representation of the model using the field aliases.\"\"\"\n return + self.model_dump(by_alias=True, exclude_none=True)\n```\n\n- The deprecated `sign_in_as_service_user` + method was removed `ConfidentialClientAuth`. The `get_token` method can be used + instead.\n- The deprecated `page_iterator` property from `ResourceIterator` was + removed. Instead, the `data` and `next_page_token` properties can be accessed + directly from the `ResourceIterator` class.\n- The deprecated `hostname` parameter + was removed from the `UserTokenAuth` class and `token` was made a positional + argument." + links: + - https://github.com/palantir/foundry-platform-python/pull/180 From 2e5d5517d60a6e17d855855b024cb8605045b06c Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Tue, 8 Apr 2025 13:19:08 -0300 Subject: [PATCH 07/11] links --- config.json | 1 + docs/v1/Datasets/Branch.md | 4 +- docs/v1/Datasets/File.md | 20 +++--- docs/v1/Ontologies/Action.md | 8 +-- docs/v1/Ontologies/ActionType.md | 4 +- docs/v1/Ontologies/ObjectType.md | 4 +- docs/v1/Ontologies/OntologyObject.md | 12 ++-- docs/v1/Ontologies/QueryType.md | 4 +- docs/v2/AipAgents/Agent.md | 4 +- docs/v2/AipAgents/AgentVersion.md | 8 +-- docs/v2/AipAgents/Content.md | 4 +- docs/v2/AipAgents/Session.md | 54 ++++++++-------- docs/v2/AipAgents/models/Agent.md | 4 +- docs/v2/AipAgents/models/AgentRid.md | 2 +- docs/v2/AipAgents/models/InputContext.md | 2 +- .../models/ObjectSetParameterValue.md | 2 +- docs/v2/AipAgents/models/Parameter.md | 2 +- docs/v2/AipAgents/models/ParameterId.md | 2 +- docs/v2/AipAgents/models/ParameterValue.md | 2 +- .../AipAgents/models/ParameterValueUpdate.md | 2 +- docs/v2/Connectivity/Connection.md | 4 +- docs/v2/Connectivity/FileImport.md | 10 +-- docs/v2/Connectivity/TableImport.md | 2 +- .../models/AwsOidcAuthentication.md | 2 +- docs/v2/Connectivity/models/CloudIdentity.md | 2 +- ...ctionRequestRestConnectionConfiguration.md | 2 +- ...eateTableImportRequestTableImportConfig.md | 2 +- docs/v2/Connectivity/models/FileImport.md | 2 +- .../Connectivity/models/FileImportFilter.md | 2 +- .../Connectivity/models/JdbcImportConfig.md | 2 +- .../models/MicrosoftAccessImportConfig.md | 2 +- .../models/MicrosoftSqlServerImportConfig.md | 2 +- .../models/PostgreSqlImportConfig.md | 2 +- .../models/RestConnectionConfiguration.md | 4 +- .../models/RestConnectionOAuth2.md | 2 +- .../models/S3ConnectionConfiguration.md | 2 +- .../models/SnowflakeTableImportConfig.md | 2 +- .../Connectivity/models/TableImportConfig.md | 2 +- .../models/ChangeDataCaptureConfiguration.md | 2 +- docs/v2/Core/models/Field.md | 2 +- docs/v2/Core/models/RoleId.md | 2 +- docs/v2/Core/models/StreamSchema.md | 2 +- docs/v2/Datasets/File.md | 16 ++--- docs/v2/Datasets/Transaction.md | 4 +- docs/v2/Filesystem/models/FolderType.md | 4 +- docs/v2/Filesystem/models/Marking.md | 2 +- docs/v2/Filesystem/models/Organization.md | 2 +- docs/v2/MediaSets/MediaSet.md | 2 +- docs/v2/Ontologies/Action.md | 4 +- docs/v2/Ontologies/ActionType.md | 4 +- docs/v2/Ontologies/LinkedObject.md | 4 +- docs/v2/Ontologies/ObjectType.md | 4 +- docs/v2/Ontologies/OntologyInterface.md | 4 +- docs/v2/Ontologies/OntologyObject.md | 4 +- docs/v2/Ontologies/QueryType.md | 4 +- docs/v2/Ontologies/models/ObjectTypeId.md | 2 +- docs/v2/Streams/Dataset.md | 2 +- .../models/CreateStreamRequestStreamSchema.md | 2 +- docs/v2/Streams/models/StreamType.md | 2 +- docs/v2/ThirdPartyApplications/Version.md | 8 +-- foundry_sdk/v1/cli.py | 42 ++++++------ foundry_sdk/v1/datasets/branch.py | 2 +- foundry_sdk/v1/datasets/file.py | 18 +++--- foundry_sdk/v1/ontologies/action.py | 8 +-- foundry_sdk/v1/ontologies/action_type.py | 2 +- foundry_sdk/v1/ontologies/object_type.py | 2 +- foundry_sdk/v1/ontologies/ontology_object.py | 8 +-- foundry_sdk/v1/ontologies/query_type.py | 2 +- foundry_sdk/v2/aip_agents/agent.py | 2 +- foundry_sdk/v2/aip_agents/agent_version.py | 4 +- foundry_sdk/v2/aip_agents/content.py | 2 +- foundry_sdk/v2/aip_agents/errors.py | 24 +++---- foundry_sdk/v2/aip_agents/models.py | 18 +++--- foundry_sdk/v2/aip_agents/session.py | 44 ++++++------- foundry_sdk/v2/cli.py | 64 +++++++++---------- foundry_sdk/v2/connectivity/connection.py | 4 +- foundry_sdk/v2/connectivity/file_import.py | 6 +- foundry_sdk/v2/connectivity/models.py | 32 +++++----- foundry_sdk/v2/connectivity/table_import.py | 2 +- foundry_sdk/v2/core/models.py | 8 +-- foundry_sdk/v2/datasets/file.py | 16 ++--- foundry_sdk/v2/datasets/transaction.py | 4 +- foundry_sdk/v2/filesystem/models.py | 8 +-- foundry_sdk/v2/media_sets/media_set.py | 2 +- foundry_sdk/v2/ontologies/action.py | 4 +- foundry_sdk/v2/ontologies/action_type.py | 2 +- foundry_sdk/v2/ontologies/linked_object.py | 2 +- foundry_sdk/v2/ontologies/models.py | 2 +- foundry_sdk/v2/ontologies/object_type.py | 2 +- .../v2/ontologies/ontology_interface.py | 2 +- foundry_sdk/v2/ontologies/ontology_object.py | 2 +- foundry_sdk/v2/ontologies/query_type.py | 2 +- foundry_sdk/v2/streams/dataset.py | 2 +- foundry_sdk/v2/streams/models.py | 4 +- .../v2/third_party_applications/version.py | 4 +- 95 files changed, 314 insertions(+), 313 deletions(-) diff --git a/config.json b/config.json index f3cd8a582..6fd4ba93f 100644 --- a/config.json +++ b/config.json @@ -7,6 +7,7 @@ "userHeader": "python-foundry-platform-sdk", "description": "The official Python library for the Foundry API", "promotedMajorVersion": "v2", + "documentationBaseUrl": "https://palantir.com", "extraDocsDir": "assets/docs_examples", "exampleOperation": { "majorVersion": "v2", diff --git a/docs/v1/Datasets/Branch.md b/docs/v1/Datasets/Branch.md index db69d8390..5485ee031 100644 --- a/docs/v1/Datasets/Branch.md +++ b/docs/v1/Datasets/Branch.md @@ -182,7 +182,7 @@ Third-party applications using this endpoint via OAuth2 must request the followi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **dataset_rid** | DatasetRid | The Resource Identifier (RID) of the Dataset on which to list Branches. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | +**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | ### Return type @@ -199,7 +199,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # DatasetRid | The Resource Identifier (RID) of the Dataset on which to list Branches. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] page_token = None diff --git a/docs/v1/Datasets/File.md b/docs/v1/Datasets/File.md index 7048b19e1..105eacc62 100644 --- a/docs/v1/Datasets/File.md +++ b/docs/v1/Datasets/File.md @@ -14,14 +14,14 @@ branch - `master` for most enrollments. The file will still be visible on histor #### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction will be created and committed on this branch. To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a -single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to +single transaction. See [createTransaction](https://palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. @@ -88,7 +88,7 @@ view of the default branch - `master` for most enrollments. #### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest @@ -177,7 +177,7 @@ branch - `master` for most enrollments. #### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the @@ -207,7 +207,7 @@ Name | Type | Description | Notes | **dataset_rid** | DatasetRid | The Resource Identifier (RID) of the Dataset on which to list Files. | | **branch_id** | Optional[BranchId] | The identifier (name) of the Branch on which to list Files. Defaults to `master` for most enrollments. | [optional] | **end_transaction_rid** | Optional[TransactionRid] | The Resource Identifier (RID) of the end Transaction. | [optional] | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | +**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | **start_transaction_rid** | Optional[TransactionRid] | The Resource Identifier (RID) of the start Transaction. | [optional] | @@ -229,7 +229,7 @@ dataset_rid = None branch_id = None # Optional[TransactionRid] | The Resource Identifier (RID) of the end Transaction. end_transaction_rid = None -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] page_token = None @@ -291,7 +291,7 @@ view of the default branch - `master` for most enrollments. #### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will retrieve the content for the most recent version of the file since the latest snapshot transaction, or the @@ -384,16 +384,16 @@ If the file already exists only the most recent version will be visible in the u #### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this default specify `transactionType` in addition to `branchId`. -See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. +See [createBranch](https://palantir.com/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as `transactionRid`. This is useful for uploading multiple files in a single transaction. -See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. +See [createTransaction](https://palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. diff --git a/docs/v1/Ontologies/Action.md b/docs/v1/Ontologies/Action.md index b3cd2228c..127f6bccb 100644 --- a/docs/v1/Ontologies/Action.md +++ b/docs/v1/Ontologies/Action.md @@ -10,7 +10,7 @@ Method | HTTP request | Release Stage | Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take some time to be visible. -Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by +Note that [parameter default values](https://palantir.com/docs/foundry/action-types/parameters-default-value/) are not currently supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the @@ -76,8 +76,8 @@ Changes to the Ontology are eventually consistent and may take some time to be v Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not call Functions may receive a higher limit. -Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) and -[notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. +Note that [parameter default values](https://palantir.com/docs/foundry/action-types/parameters-default-value/) and +[notifications](https://palantir.com/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read api:ontologies-write`. @@ -144,7 +144,7 @@ The response contains the evaluation of parameters and **submission criteria** that determine if the request is `VALID` or `INVALID`. For performance reasons, validations will not consider existing objects or other data in Foundry. For example, the uniqueness of a primary key or the existence of a user ID will not be checked. -Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by +Note that [parameter default values](https://palantir.com/docs/foundry/action-types/parameters-default-value/) are not currently supported by this endpoint. Unspecified parameters will be given a default value of `null`. Third-party applications using this endpoint via OAuth2 must request the diff --git a/docs/v1/Ontologies/ActionType.md b/docs/v1/Ontologies/ActionType.md index e33780544..3dd3cbc0f 100644 --- a/docs/v1/Ontologies/ActionType.md +++ b/docs/v1/Ontologies/ActionType.md @@ -74,7 +74,7 @@ Third-party applications using this endpoint via OAuth2 must request the followi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology_rid** | OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | +**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | ### Return type @@ -91,7 +91,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] page_token = None diff --git a/docs/v1/Ontologies/ObjectType.md b/docs/v1/Ontologies/ObjectType.md index 720772543..6197bc287 100644 --- a/docs/v1/Ontologies/ObjectType.md +++ b/docs/v1/Ontologies/ObjectType.md @@ -134,7 +134,7 @@ Third-party applications using this endpoint via OAuth2 must request the followi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology_rid** | OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | +**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | ### Return type @@ -151,7 +151,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] page_token = None diff --git a/docs/v1/Ontologies/OntologyObject.md b/docs/v1/Ontologies/OntologyObject.md index 40b3ccf25..10ad01575 100644 --- a/docs/v1/Ontologies/OntologyObject.md +++ b/docs/v1/Ontologies/OntologyObject.md @@ -221,7 +221,7 @@ See [README](../../../README.md#authorization) Lists the objects for the given Ontology and object type. This endpoint supports filtering objects. -See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. +See the [Filtering Objects documentation](https://palantir.com/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or repeated objects in the response pages. @@ -245,7 +245,7 @@ Name | Type | Description | Notes | **ontology_rid** | OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. | | **object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | | **order_by** | Optional[OrderBy] | | [optional] | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | +**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | **properties** | Optional[List[SelectedPropertyApiName]] | The properties of the object type that should be included in the response. Omit this parameter to get all the properties. | [optional] | @@ -267,7 +267,7 @@ ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" object_type = "employee" # Optional[OrderBy] order_by = None -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] page_token = None @@ -307,7 +307,7 @@ See [README](../../../README.md#authorization) Lists the linked objects for a specific object and the given link type. This endpoint supports filtering objects. -See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. +See the [Filtering Objects documentation](https://palantir.com/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or repeated objects in the response pages. @@ -333,7 +333,7 @@ Name | Type | Description | Notes | **primary_key** | PropertyValueEscapedString | The primary key of the object from which the links originate. To look up the expected primary key for your object type, use the `Get object type` endpoint or the **Ontology Manager**. | | **link_type** | LinkTypeApiName | The API name of the link that exists between the object and the requested objects. To find the API name for your link type, check the **Ontology Manager**. | | **order_by** | Optional[OrderBy] | | [optional] | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | +**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | **properties** | Optional[List[SelectedPropertyApiName]] | The properties of the object type that should be included in the response. Omit this parameter to get all the properties. | [optional] | @@ -359,7 +359,7 @@ primary_key = 50030 link_type = "directReport" # Optional[OrderBy] order_by = None -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] page_token = None diff --git a/docs/v1/Ontologies/QueryType.md b/docs/v1/Ontologies/QueryType.md index 19994c0a5..50048b30f 100644 --- a/docs/v1/Ontologies/QueryType.md +++ b/docs/v1/Ontologies/QueryType.md @@ -72,7 +72,7 @@ Third-party applications using this endpoint via OAuth2 must request the followi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology_rid** | OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | +**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | ### Return type @@ -89,7 +89,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +# Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] page_token = None diff --git a/docs/v2/AipAgents/Agent.md b/docs/v2/AipAgents/Agent.md index e59b93ddc..c0fb737d0 100644 --- a/docs/v2/AipAgents/Agent.md +++ b/docs/v2/AipAgents/Agent.md @@ -68,7 +68,7 @@ Get details for an AIP Agent. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | +**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | **version** | Optional[AgentVersionString] | The version of the Agent to retrieve. If not specified, the latest published version will be returned. | [optional] | @@ -84,7 +84,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # Optional[PreviewMode] | Enables the use of preview functionality. preview = None diff --git a/docs/v2/AipAgents/AgentVersion.md b/docs/v2/AipAgents/AgentVersion.md index b1a5fd703..23bb1aa61 100644 --- a/docs/v2/AipAgents/AgentVersion.md +++ b/docs/v2/AipAgents/AgentVersion.md @@ -12,7 +12,7 @@ Get version details for an AIP Agent. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | +**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). | | **agent_version_string** | AgentVersionString | The semantic version of the Agent, formatted as "majorVersion.minorVersion". | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -28,7 +28,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # AgentVersionString | The semantic version of the Agent, formatted as "majorVersion.minorVersion". agent_version_string = "1.0" @@ -69,7 +69,7 @@ Versions are returned in descending order, by most recent versions first. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | +**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). | | **page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | **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] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -86,7 +86,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # Optional[PageSize] | The page size to use for the endpoint. page_size = None diff --git a/docs/v2/AipAgents/Content.md b/docs/v2/AipAgents/Content.md index 1bc4ae1e0..930503e39 100644 --- a/docs/v2/AipAgents/Content.md +++ b/docs/v2/AipAgents/Content.md @@ -11,7 +11,7 @@ Get the conversation content for a session between the calling user and an Agent Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | +**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). | | **session_rid** | SessionRid | The Resource Identifier (RID) of the conversation session. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -27,7 +27,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # SessionRid | The Resource Identifier (RID) of the conversation session. session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6" diff --git a/docs/v2/AipAgents/Session.md b/docs/v2/AipAgents/Session.md index 0342452ac..0f6b0660d 100644 --- a/docs/v2/AipAgents/Session.md +++ b/docs/v2/AipAgents/Session.md @@ -24,11 +24,11 @@ Clients should wait to receive a response before sending the next message. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | +**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). | | **session_rid** | SessionRid | The Resource Identifier (RID) of the conversation session. | | -**parameter_inputs** | Dict[ParameterId, ParameterValue] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. | | +**parameter_inputs** | Dict[ParameterId, ParameterValue] | Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. | | **user_input** | UserTextInput | The user message for the Agent to respond to. | | -**contexts_override** | Optional[List[InputContext]] | If set, automatic [context retrieval](/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. | [optional] | +**contexts_override** | Optional[List[InputContext]] | If set, automatic [context retrieval](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | ### Return type @@ -43,11 +43,11 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # SessionRid | The Resource Identifier (RID) of the conversation session. session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6" -# Dict[ParameterId, ParameterValue] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. +# Dict[ParameterId, ParameterValue] | Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. parameter_inputs = { "currentCustomerOrders": { "type": "objectSet", @@ -61,7 +61,7 @@ parameter_inputs = { } # UserTextInput | The user message for the Agent to respond to. user_input = {"text": "What is the status of my order?"} -# Optional[List[InputContext]] | If set, automatic [context retrieval](/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. +# Optional[List[InputContext]] | If set, automatic [context retrieval](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. contexts_override = None # Optional[PreviewMode] | Enables the use of preview functionality. preview = None @@ -106,7 +106,7 @@ Note that canceling an exchange does not terminate the stream returned by `strea Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | +**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). | | **session_rid** | SessionRid | The Resource Identifier (RID) of the conversation session. | | **message_id** | MessageId | The identifier for the in-progress exchange to cancel. This should match the `messageId` which was provided when initiating the exchange with `streamingContinue`. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -124,7 +124,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # SessionRid | The Resource Identifier (RID) of the conversation session. session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6" @@ -169,7 +169,7 @@ Use `blockingContinue` or `streamingContinue` to start adding exchanges to the s Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | +**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). | | **agent_version** | Optional[AgentVersionString] | The version of the Agent associated with the session. This can be set by clients on session creation. If not specified, defaults to use the latest published version of the Agent at session creation time. | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -185,7 +185,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # Optional[AgentVersionString] | The version of the Agent associated with the session. This can be set by clients on session creation. If not specified, defaults to use the latest published version of the Agent at session creation time. agent_version = "1.0" @@ -224,7 +224,7 @@ Get the details of a conversation session between the calling user and an Agent. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | +**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). | | **session_rid** | SessionRid | The Resource Identifier (RID) of the conversation session. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -240,7 +240,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # SessionRid | The Resource Identifier (RID) of the conversation session. session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6" @@ -283,7 +283,7 @@ Sessions are returned in order of most recently updated first. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | +**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). | | **page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] | **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] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -300,7 +300,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # Optional[PageSize] | The page size to use for the endpoint. page_size = None @@ -334,7 +334,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) # **rag_context** -Retrieve relevant [context](/docs/foundry/agent-studio/core-concepts/#retrieval-context) for a user message from the data sources configured for the session. +Retrieve relevant [context](https://palantir.com/docs/foundry/agent-studio/core-concepts/#retrieval-context) for a user message from the data sources configured for the session. This allows clients to pre-retrieve context for a user message before sending it to the Agent with the `contextsOverride` option when continuing a session, to allow any pre-processing of the context before sending it to the Agent. @@ -342,9 +342,9 @@ This allows clients to pre-retrieve context for a user message before sending it Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | +**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). | | **session_rid** | SessionRid | The Resource Identifier (RID) of the conversation session. | | -**parameter_inputs** | Dict[ParameterId, ParameterValue] | Any values for [application variables](/docs/foundry/agent-studio/application-state/) to use for the context retrieval. | | +**parameter_inputs** | Dict[ParameterId, ParameterValue] | Any values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to use for the context retrieval. | | **user_input** | UserTextInput | The user message to retrieve relevant context for from the configured Agent data sources. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -360,11 +360,11 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # SessionRid | The Resource Identifier (RID) of the conversation session. session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6" -# Dict[ParameterId, ParameterValue] | Any values for [application variables](/docs/foundry/agent-studio/application-state/) to use for the context retrieval. +# Dict[ParameterId, ParameterValue] | Any values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to use for the context retrieval. parameter_inputs = {"customerName": {"type": "string", "value": "Titan Technologies"}} # UserTextInput | The user message to retrieve relevant context for from the configured Agent data sources. user_input = {"text": "What is the status of my order?"} @@ -414,11 +414,11 @@ Clients should wait to receive a response, or cancel the in-progress exchange, b Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | +**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). | | **session_rid** | SessionRid | The Resource Identifier (RID) of the conversation session. | | -**parameter_inputs** | Dict[ParameterId, ParameterValue] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. | | +**parameter_inputs** | Dict[ParameterId, ParameterValue] | Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. | | **user_input** | UserTextInput | The user message for the Agent to respond to. | | -**contexts_override** | Optional[List[InputContext]] | If set, automatic [context](/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. | [optional] | +**contexts_override** | Optional[List[InputContext]] | If set, automatic [context](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. | [optional] | **message_id** | Optional[MessageId] | A client-generated Universally Unique Identifier (UUID) to identify the message, which the client can use to cancel the exchange before the streaming response is complete. | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -434,11 +434,11 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # SessionRid | The Resource Identifier (RID) of the conversation session. session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6" -# Dict[ParameterId, ParameterValue] | Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. +# Dict[ParameterId, ParameterValue] | Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. parameter_inputs = { "currentCustomerOrders": { "type": "objectSet", @@ -452,7 +452,7 @@ parameter_inputs = { } # UserTextInput | The user message for the Agent to respond to. user_input = {"text": "What is the status of my order?"} -# Optional[List[InputContext]] | If set, automatic [context](/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. +# Optional[List[InputContext]] | If set, automatic [context](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. contexts_override = None # Optional[MessageId] | A client-generated Universally Unique Identifier (UUID) to identify the message, which the client can use to cancel the exchange before the streaming response is complete. message_id = "00f8412a-c29d-4063-a417-8052825285a5" @@ -499,7 +499,7 @@ Use this to set a custom title for a session to help identify it in the list of Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | -**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | | +**agent_rid** | AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). | | **session_rid** | SessionRid | The Resource Identifier (RID) of the conversation session. | | **title** | str | The new title for the session. The maximum title length is 200 characters. Titles are truncated if they exceed this length. | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -516,7 +516,7 @@ from pprint import pprint client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com") -# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +# AgentRid | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). agent_rid = "ri.aip-agents..agent.732cd5b4-7ca7-4219-aabb-6e976faf63b1" # SessionRid | The Resource Identifier (RID) of the conversation session. session_rid = "ri.aip-agents..session.292db3b2-b653-4de6-971c-7e97a7b881d6" diff --git a/docs/v2/AipAgents/models/Agent.md b/docs/v2/AipAgents/models/Agent.md index 19b0682f0..d60afff26 100644 --- a/docs/v2/AipAgents/models/Agent.md +++ b/docs/v2/AipAgents/models/Agent.md @@ -5,10 +5,10 @@ Agent ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**rid** | AgentRid | Yes | An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). | +**rid** | AgentRid | Yes | An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). | **version** | AgentVersionString | Yes | The version of this instance of the Agent. | **metadata** | AgentMetadata | Yes | | -**parameters** | Dict[ParameterId, Parameter] | Yes | The types and names of variables configured for the Agent in [AIP Agent Studio](/docs/foundry/agent-studio/overview/) in the [application state](/docs/foundry/agent-studio/application-state/). These variables can be used to send custom values in prompts sent to an Agent to customize and control the Agent's behavior. | +**parameters** | Dict[ParameterId, Parameter] | Yes | The types and names of variables configured for the Agent in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/) in the [application state](https://palantir.com/docs/foundry/agent-studio/application-state/). These variables can be used to send custom values in prompts sent to an Agent to customize and control the Agent's behavior. | [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/AipAgents/models/AgentRid.md b/docs/v2/AipAgents/models/AgentRid.md index e882de1d9..19b731c8a 100644 --- a/docs/v2/AipAgents/models/AgentRid.md +++ b/docs/v2/AipAgents/models/AgentRid.md @@ -1,6 +1,6 @@ # AgentRid -An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). ## Type ```python diff --git a/docs/v2/AipAgents/models/InputContext.md b/docs/v2/AipAgents/models/InputContext.md index feec7e56b..91fbb82ec 100644 --- a/docs/v2/AipAgents/models/InputContext.md +++ b/docs/v2/AipAgents/models/InputContext.md @@ -1,6 +1,6 @@ # InputContext -Custom retrieved [context](/docs/foundry/agent-studio/retrieval-context/) to provide to an Agent for continuing a session. +Custom retrieved [context](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) to provide to an Agent for continuing a session. This is a discriminator type and does not contain any fields. Instead, it is a union diff --git a/docs/v2/AipAgents/models/ObjectSetParameterValue.md b/docs/v2/AipAgents/models/ObjectSetParameterValue.md index bb29b00f9..86641488e 100644 --- a/docs/v2/AipAgents/models/ObjectSetParameterValue.md +++ b/docs/v2/AipAgents/models/ObjectSetParameterValue.md @@ -6,7 +6,7 @@ A value passed for `ObjectSetParameter` application variable types. | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **object_set** | ObjectSet | Yes | | -**ontology** | OntologyIdentifier | Yes | The API name of the Ontology for the provided `ObjectSet`. To find the API name, use the `List ontologies` endpoint or check the [Ontology Manager](/docs/foundry/ontology-manager/overview/). | +**ontology** | OntologyIdentifier | Yes | The API name of the Ontology for the provided `ObjectSet`. To find the API name, use the `List ontologies` endpoint or check the [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). | **type** | Literal["objectSet"] | Yes | None | diff --git a/docs/v2/AipAgents/models/Parameter.md b/docs/v2/AipAgents/models/Parameter.md index 61c708cd6..c96c207a5 100644 --- a/docs/v2/AipAgents/models/Parameter.md +++ b/docs/v2/AipAgents/models/Parameter.md @@ -1,6 +1,6 @@ # Parameter -A variable configured in the application state of an Agent in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +A variable configured in the application state of an Agent in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). ## Properties diff --git a/docs/v2/AipAgents/models/ParameterId.md b/docs/v2/AipAgents/models/ParameterId.md index bc0f66aaa..4ed80ecb6 100644 --- a/docs/v2/AipAgents/models/ParameterId.md +++ b/docs/v2/AipAgents/models/ParameterId.md @@ -1,6 +1,6 @@ # ParameterId -The unique identifier for a variable configured in the application state of an Agent in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). +The unique identifier for a variable configured in the application state of an Agent in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). ## Type diff --git a/docs/v2/AipAgents/models/ParameterValue.md b/docs/v2/AipAgents/models/ParameterValue.md index 998149972..8c112b420 100644 --- a/docs/v2/AipAgents/models/ParameterValue.md +++ b/docs/v2/AipAgents/models/ParameterValue.md @@ -1,6 +1,6 @@ # ParameterValue -The value provided for a variable configured in the [application state](/docs/foundry/agent-studio/application-state/) of an Agent. +The value provided for a variable configured in the [application state](https://palantir.com/docs/foundry/agent-studio/application-state/) of an Agent. This is a discriminator type and does not contain any fields. Instead, it is a union diff --git a/docs/v2/AipAgents/models/ParameterValueUpdate.md b/docs/v2/AipAgents/models/ParameterValueUpdate.md index 9c3d41059..a6a7f750a 100644 --- a/docs/v2/AipAgents/models/ParameterValueUpdate.md +++ b/docs/v2/AipAgents/models/ParameterValueUpdate.md @@ -1,6 +1,6 @@ # ParameterValueUpdate -A value update for an [application variable](/docs/foundry/agent-studio/application-state/) generated by the Agent. +A value update for an [application variable](https://palantir.com/docs/foundry/agent-studio/application-state/) generated by the Agent. For `StringParameter` types, this will be the updated string value. For `ObjectSetParameter` types, this will be a Resource Identifier (RID) for the updated object set. diff --git a/docs/v2/Connectivity/Connection.md b/docs/v2/Connectivity/Connection.md index 79301908d..97fbc41ec 100644 --- a/docs/v2/Connectivity/Connection.md +++ b/docs/v2/Connectivity/Connection.md @@ -8,7 +8,7 @@ Method | HTTP request | Release Stage | [**update_secrets**](#update_secrets) | **POST** /v2/connectivity/connections/{connectionRid}/updateSecrets | Public Beta | # **create** -Creates a new Connection with a [direct connection](/docs/foundry/data-connection/core-concepts/#direct-connection) runtime. +Creates a new Connection with a [direct connection](https://palantir.com/docs/foundry/data-connection/core-concepts/#direct-connection) runtime. Any secrets specified in the request body are transmitted over the network encrypted using TLS. Once the secrets reach Foundry's servers, they will be temporarily decrypted and remain in plaintext in memory to @@ -132,7 +132,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) # **get_configuration** -Retrieves the ConnectionConfiguration of the [Connection](/docs/foundry/data-connection/set-up-source/) itself. +Retrieves the ConnectionConfiguration of the [Connection](https://palantir.com/docs/foundry/data-connection/set-up-source/) itself. This operation is intended for use when other Connection data is not required, providing a lighter-weight alternative to `getConnection` operation. diff --git a/docs/v2/Connectivity/FileImport.md b/docs/v2/Connectivity/FileImport.md index 540004e86..b22073943 100644 --- a/docs/v2/Connectivity/FileImport.md +++ b/docs/v2/Connectivity/FileImport.md @@ -19,7 +19,7 @@ Name | Type | Description | Notes | **connection_rid** | ConnectionRid | | | **dataset_rid** | DatasetRid | The RID of the output dataset. | | **display_name** | FileImportDisplayName | | | -**file_import_filters** | List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) | | +**file_import_filters** | List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](https://palantir.com/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) | | **import_mode** | FileImportMode | | | **branch_name** | Optional[BranchName] | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -43,7 +43,7 @@ connection_rid = None dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" # FileImportDisplayName display_name = "My file import" -# List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) +# List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](https://palantir.com/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) file_import_filters = [{"type": "pathMatchesFilter", "regex": "my-subfolder"}] # FileImportMode import_mode = "SNAPSHOT" @@ -145,7 +145,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) # **execute** -Executes the FileImport, which runs asynchronously as a [Foundry Build](/docs/foundry/data-integration/builds/). +Executes the FileImport, which runs asynchronously as a [Foundry Build](https://palantir.com/docs/foundry/data-integration/builds/). The returned BuildRid can be used to check the status via the Orchestration API. @@ -326,7 +326,7 @@ Name | Type | Description | Notes | **file_import_rid** | FileImportRid | | | **dataset_rid** | DatasetRid | The RID of the output dataset. | | **display_name** | FileImportDisplayName | | | -**file_import_filters** | List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) | | +**file_import_filters** | List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](https://palantir.com/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) | | **import_mode** | FileImportMode | | | **branch_name** | Optional[BranchName] | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. | [optional] | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | @@ -352,7 +352,7 @@ file_import_rid = None dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" # FileImportDisplayName display_name = "My file import" -# List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) +# List[FileImportFilter] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](https://palantir.com/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) file_import_filters = [{"type": "pathMatchesFilter", "regex": "my-subfolder"}] # FileImportMode import_mode = "SNAPSHOT" diff --git a/docs/v2/Connectivity/TableImport.md b/docs/v2/Connectivity/TableImport.md index c47f8ebec..4445dd509 100644 --- a/docs/v2/Connectivity/TableImport.md +++ b/docs/v2/Connectivity/TableImport.md @@ -144,7 +144,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) # **execute** -Executes the TableImport, which runs asynchronously as a [Foundry Build](/docs/foundry/data-integration/builds/). +Executes the TableImport, which runs asynchronously as a [Foundry Build](https://palantir.com/docs/foundry/data-integration/builds/). The returned BuildRid can be used to check the status via the Orchestration API. diff --git a/docs/v2/Connectivity/models/AwsOidcAuthentication.md b/docs/v2/Connectivity/models/AwsOidcAuthentication.md index 9fd368e3a..f1a1b65b9 100644 --- a/docs/v2/Connectivity/models/AwsOidcAuthentication.md +++ b/docs/v2/Connectivity/models/AwsOidcAuthentication.md @@ -1,6 +1,6 @@ # AwsOidcAuthentication -[OpenID Connect (OIDC)](/docs/foundry/data-connection/oidc/) is an open authentication protocol that allows +[OpenID Connect (OIDC)](https://palantir.com/docs/foundry/data-connection/oidc/) is an open authentication protocol that allows you to authenticate to external system resources without the use of static credentials. diff --git a/docs/v2/Connectivity/models/CloudIdentity.md b/docs/v2/Connectivity/models/CloudIdentity.md index 3d605a69a..ad79daa69 100644 --- a/docs/v2/Connectivity/models/CloudIdentity.md +++ b/docs/v2/Connectivity/models/CloudIdentity.md @@ -1,6 +1,6 @@ # CloudIdentity -[Cloud identities](/docs/foundry/administration/configure-cloud-identities/) allow you to authenticate to +[Cloud identities](https://palantir.com/docs/foundry/administration/configure-cloud-identities/) allow you to authenticate to cloud provider resources without the use of static credentials. diff --git a/docs/v2/Connectivity/models/CreateConnectionRequestRestConnectionConfiguration.md b/docs/v2/Connectivity/models/CreateConnectionRequestRestConnectionConfiguration.md index f0d6856d9..d362d778b 100644 --- a/docs/v2/Connectivity/models/CreateConnectionRequestRestConnectionConfiguration.md +++ b/docs/v2/Connectivity/models/CreateConnectionRequestRestConnectionConfiguration.md @@ -6,7 +6,7 @@ CreateConnectionRequestRestConnectionConfiguration | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **additional_secrets** | Optional[RestConnectionAdditionalSecrets] | No | Additional secrets that can be referenced in code and webhook configurations. If not provided, no additional secrets will be created. | -**oauth2_client_rid** | Optional[RID] | No | The RID of the [Outbound application](/docs/foundry/administration/configure-outbound-applications) that is used to authenticate to the external system via OAuth2. Currently, a connection may use only one outbound application for OAuth 2.0 authentication. Selecting a different outbound application will update the configuration for all domains with OAuth 2.0 as the selected authorization. | +**oauth2_client_rid** | Optional[RID] | No | The RID of the [Outbound application](https://palantir.com/docs/foundry/administration/configure-outbound-applications) that is used to authenticate to the external system via OAuth2. Currently, a connection may use only one outbound application for OAuth 2.0 authentication. Selecting a different outbound application will update the configuration for all domains with OAuth 2.0 as the selected authorization. | **domains** | List[Domain] | Yes | The domains that the connection is allowed to access. At least one domain must be specified. | **type** | Literal["rest"] | Yes | None | diff --git a/docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfig.md b/docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfig.md index 3ff658c30..7e379b21d 100644 --- a/docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfig.md +++ b/docs/v2/Connectivity/models/CreateTableImportRequestTableImportConfig.md @@ -1,6 +1,6 @@ # CreateTableImportRequestTableImportConfig -The import configuration for a specific [connector type](/docs/foundry/data-integration/source-type-overview). +The import configuration for a specific [connector type](https://palantir.com/docs/foundry/data-integration/source-type-overview). This is a discriminator type and does not contain any fields. Instead, it is a union diff --git a/docs/v2/Connectivity/models/FileImport.md b/docs/v2/Connectivity/models/FileImport.md index 24c2f83d4..1f50a57c4 100644 --- a/docs/v2/Connectivity/models/FileImport.md +++ b/docs/v2/Connectivity/models/FileImport.md @@ -10,7 +10,7 @@ FileImport **dataset_rid** | DatasetRid | Yes | The RID of the output dataset. | **branch_name** | Optional[BranchName] | No | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. | **display_name** | FileImportDisplayName | Yes | | -**file_import_filters** | List[FileImportFilter] | Yes | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) | +**file_import_filters** | List[FileImportFilter] | Yes | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](https://palantir.com/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) | **import_mode** | FileImportMode | Yes | | **subfolder** | Optional[str] | No | A subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system. | diff --git a/docs/v2/Connectivity/models/FileImportFilter.md b/docs/v2/Connectivity/models/FileImportFilter.md index 88d13648c..e72d6f0f1 100644 --- a/docs/v2/Connectivity/models/FileImportFilter.md +++ b/docs/v2/Connectivity/models/FileImportFilter.md @@ -1,6 +1,6 @@ # FileImportFilter -[Filters](/docs/foundry/data-connection/file-based-syncs/#filters) allow you to filter source files +[Filters](https://palantir.com/docs/foundry/data-connection/file-based-syncs/#filters) allow you to filter source files before they are imported into Foundry. diff --git a/docs/v2/Connectivity/models/JdbcImportConfig.md b/docs/v2/Connectivity/models/JdbcImportConfig.md index 958de65bc..53961eece 100644 --- a/docs/v2/Connectivity/models/JdbcImportConfig.md +++ b/docs/v2/Connectivity/models/JdbcImportConfig.md @@ -1,6 +1,6 @@ # JdbcImportConfig -The import configuration for a [custom JDBC connection](/docs/foundry/available-connectors/custom-jdbc-sources). +The import configuration for a [custom JDBC connection](https://palantir.com/docs/foundry/available-connectors/custom-jdbc-sources). ## Properties diff --git a/docs/v2/Connectivity/models/MicrosoftAccessImportConfig.md b/docs/v2/Connectivity/models/MicrosoftAccessImportConfig.md index b5a2798d0..ba5e453fd 100644 --- a/docs/v2/Connectivity/models/MicrosoftAccessImportConfig.md +++ b/docs/v2/Connectivity/models/MicrosoftAccessImportConfig.md @@ -1,6 +1,6 @@ # MicrosoftAccessImportConfig -The import configuration for a [Microsoft Access connection](/docs/foundry/available-connectors/microsoft-access). +The import configuration for a [Microsoft Access connection](https://palantir.com/docs/foundry/available-connectors/microsoft-access). ## Properties diff --git a/docs/v2/Connectivity/models/MicrosoftSqlServerImportConfig.md b/docs/v2/Connectivity/models/MicrosoftSqlServerImportConfig.md index 8d0e13375..3d6e11d99 100644 --- a/docs/v2/Connectivity/models/MicrosoftSqlServerImportConfig.md +++ b/docs/v2/Connectivity/models/MicrosoftSqlServerImportConfig.md @@ -1,6 +1,6 @@ # MicrosoftSqlServerImportConfig -The import configuration for a [Microsoft SQL Server connection](/docs/foundry/available-connectors/microsoft-sql-server). +The import configuration for a [Microsoft SQL Server connection](https://palantir.com/docs/foundry/available-connectors/microsoft-sql-server). ## Properties diff --git a/docs/v2/Connectivity/models/PostgreSqlImportConfig.md b/docs/v2/Connectivity/models/PostgreSqlImportConfig.md index 5fdde38de..c270454bb 100644 --- a/docs/v2/Connectivity/models/PostgreSqlImportConfig.md +++ b/docs/v2/Connectivity/models/PostgreSqlImportConfig.md @@ -1,6 +1,6 @@ # PostgreSqlImportConfig -The import configuration for a [PostgreSQL connection](/docs/foundry/available-connectors/postgresql). +The import configuration for a [PostgreSQL connection](https://palantir.com/docs/foundry/available-connectors/postgresql). ## Properties diff --git a/docs/v2/Connectivity/models/RestConnectionConfiguration.md b/docs/v2/Connectivity/models/RestConnectionConfiguration.md index fb7092afa..69b1377d6 100644 --- a/docs/v2/Connectivity/models/RestConnectionConfiguration.md +++ b/docs/v2/Connectivity/models/RestConnectionConfiguration.md @@ -1,13 +1,13 @@ # RestConnectionConfiguration -The configuration needed to connect to a [REST external system](/docs/foundry/available-connectors/rest-apis). +The configuration needed to connect to a [REST external system](https://palantir.com/docs/foundry/available-connectors/rest-apis). ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **domains** | List[Domain] | Yes | The domains that the connection is allowed to access. At least one domain must be specified. | **additional_secrets** | Optional[RestConnectionAdditionalSecrets] | No | Additional secrets that can be referenced in code and webhook configurations. If not provided, no additional secrets will be created. | -**oauth2_client_rid** | Optional[RID] | No | The RID of the [Outbound application](/docs/foundry/administration/configure-outbound-applications) that is used to authenticate to the external system via OAuth2. Currently, a connection may use only one outbound application for OAuth 2.0 authentication. Selecting a different outbound application will update the configuration for all domains with OAuth 2.0 as the selected authorization. | +**oauth2_client_rid** | Optional[RID] | No | The RID of the [Outbound application](https://palantir.com/docs/foundry/administration/configure-outbound-applications) that is used to authenticate to the external system via OAuth2. Currently, a connection may use only one outbound application for OAuth 2.0 authentication. Selecting a different outbound application will update the configuration for all domains with OAuth 2.0 as the selected authorization. | **type** | Literal["rest"] | Yes | None | diff --git a/docs/v2/Connectivity/models/RestConnectionOAuth2.md b/docs/v2/Connectivity/models/RestConnectionOAuth2.md index c109f4f92..ad7200da1 100644 --- a/docs/v2/Connectivity/models/RestConnectionOAuth2.md +++ b/docs/v2/Connectivity/models/RestConnectionOAuth2.md @@ -1,6 +1,6 @@ # RestConnectionOAuth2 -In order to use OAuth2 you must have an Outbound application configured in the [Foundry Control Panel Organization settings](/docs/foundry/administration/configure-outbound-applications#create-an-outbound-application). +In order to use OAuth2 you must have an Outbound application configured in the [Foundry Control Panel Organization settings](https://palantir.com/docs/foundry/administration/configure-outbound-applications#create-an-outbound-application). The RID of the Outbound application must be configured in the RestConnectionConfiguration in the `oauth2ClientRid` field. diff --git a/docs/v2/Connectivity/models/S3ConnectionConfiguration.md b/docs/v2/Connectivity/models/S3ConnectionConfiguration.md index 0f300e5a6..47b9e3330 100644 --- a/docs/v2/Connectivity/models/S3ConnectionConfiguration.md +++ b/docs/v2/Connectivity/models/S3ConnectionConfiguration.md @@ -1,7 +1,7 @@ # S3ConnectionConfiguration The configuration needed to connect to an [AWS S3 external system (or any other S3-like external systems that -implement the s3a protocol)](/docs/foundry/available-connectors/amazon-s3/#amazon-s3). +implement the s3a protocol)](https://palantir.com/docs/foundry/available-connectors/amazon-s3/#amazon-s3). ## Properties diff --git a/docs/v2/Connectivity/models/SnowflakeTableImportConfig.md b/docs/v2/Connectivity/models/SnowflakeTableImportConfig.md index 66061ed56..ddce6e96f 100644 --- a/docs/v2/Connectivity/models/SnowflakeTableImportConfig.md +++ b/docs/v2/Connectivity/models/SnowflakeTableImportConfig.md @@ -1,6 +1,6 @@ # SnowflakeTableImportConfig -The table import configuration for a [Snowflake connection](/docs/foundry/available-connectors/snowflake). +The table import configuration for a [Snowflake connection](https://palantir.com/docs/foundry/available-connectors/snowflake). ## Properties diff --git a/docs/v2/Connectivity/models/TableImportConfig.md b/docs/v2/Connectivity/models/TableImportConfig.md index f6c840aa9..4c08b8874 100644 --- a/docs/v2/Connectivity/models/TableImportConfig.md +++ b/docs/v2/Connectivity/models/TableImportConfig.md @@ -1,6 +1,6 @@ # TableImportConfig -The import configuration for a specific [connector type](/docs/foundry/data-integration/source-type-overview). +The import configuration for a specific [connector type](https://palantir.com/docs/foundry/data-integration/source-type-overview). This is a discriminator type and does not contain any fields. Instead, it is a union diff --git a/docs/v2/Core/models/ChangeDataCaptureConfiguration.md b/docs/v2/Core/models/ChangeDataCaptureConfiguration.md index ff736f0d0..8fa28594d 100644 --- a/docs/v2/Core/models/ChangeDataCaptureConfiguration.md +++ b/docs/v2/Core/models/ChangeDataCaptureConfiguration.md @@ -4,7 +4,7 @@ Configuration for utilizing the stream as a change data capture (CDC) dataset. T least one key needs to be provided. For more information on CDC in -Foundry, see the [Change Data Capture](/docs/foundry/data-integration/change-data-capture/) user documentation. +Foundry, see the [Change Data Capture](https://palantir.com/docs/foundry/data-integration/change-data-capture/) user documentation. ## Type diff --git a/docs/v2/Core/models/Field.md b/docs/v2/Core/models/Field.md index 08a5694a6..6ff96c1ec 100644 --- a/docs/v2/Core/models/Field.md +++ b/docs/v2/Core/models/Field.md @@ -1,7 +1,7 @@ # Field A field in a Foundry schema. For more information on supported data types, see the -[supported field types](/docs/foundry/data-integration/datasets/#supported-field-types) user documentation. +[supported field types](https://palantir.com/docs/foundry/data-integration/datasets/#supported-field-types) user documentation. ## Properties diff --git a/docs/v2/Core/models/RoleId.md b/docs/v2/Core/models/RoleId.md index f3a438269..16cbf09eb 100644 --- a/docs/v2/Core/models/RoleId.md +++ b/docs/v2/Core/models/RoleId.md @@ -2,7 +2,7 @@ The unique ID for a Role. Roles are sets of permissions that grant different levels of access to resources. The default roles in Foundry are: Owner, Editor, Viewer, and Discoverer. See more about -[roles](/docs/foundry/security/projects-and-roles#roles) in the user documentation. +[roles](https://palantir.com/docs/foundry/security/projects-and-roles#roles) in the user documentation. ## Type diff --git a/docs/v2/Core/models/StreamSchema.md b/docs/v2/Core/models/StreamSchema.md index bb53a3135..dd60f7481 100644 --- a/docs/v2/Core/models/StreamSchema.md +++ b/docs/v2/Core/models/StreamSchema.md @@ -7,7 +7,7 @@ The schema for a Foundry stream. Records pushed to this stream must match this s | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **fields** | List[Field] | Yes | | -**key_field_names** | Optional[List[FieldName]] | No | The names of the fields to be used as keys for partitioning records. These key fields are used to group all records with the same key into the same partition, to guarantee processing order of grouped records. These keys are not meant to uniquely identify records, and do not by themselves deduplicate records. To deduplicate records, provide a change data capture configuration for the schema. Key fields can only be of the following types: - Boolean - Byte - Date - Decimal - Integer - Long - Short - String - Timestamp For additional information on keys for Foundry streams, see the [streaming keys](/docs/foundry/building-pipelines/streaming-keys/) user documentation. | +**key_field_names** | Optional[List[FieldName]] | No | The names of the fields to be used as keys for partitioning records. These key fields are used to group all records with the same key into the same partition, to guarantee processing order of grouped records. These keys are not meant to uniquely identify records, and do not by themselves deduplicate records. To deduplicate records, provide a change data capture configuration for the schema. Key fields can only be of the following types: - Boolean - Byte - Date - Decimal - Integer - Long - Short - String - Timestamp For additional information on keys for Foundry streams, see the [streaming keys](https://palantir.com/docs/foundry/building-pipelines/streaming-keys/) user documentation. | **change_data_capture** | Optional[ChangeDataCaptureConfiguration] | No | | diff --git a/docs/v2/Datasets/File.md b/docs/v2/Datasets/File.md index a2d6696a7..e6aa9bb4c 100644 --- a/docs/v2/Datasets/File.md +++ b/docs/v2/Datasets/File.md @@ -12,7 +12,7 @@ Method | HTTP request | Release Stage | Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest view of the default branch - `master` for most enrollments. #### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **get a file's content from a specific Branch** specify the Branch's name as `branchName`. This will retrieve the content for the most recent version of the file since the latest snapshot transaction, or the earliest ancestor transaction of the branch if there are no snapshot transactions. @@ -94,12 +94,12 @@ See [README](../../../README.md#authorization) Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default branch - `master` for most enrollments. The file will still be visible on historical views. #### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **delete a File from a specific Branch** specify the Branch's name as `branchName`. A new delete Transaction will be created and committed on this branch. To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a -single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to +single transaction. See [createTransaction](https://palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. @@ -162,7 +162,7 @@ See [README](../../../README.md#authorization) Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest view of the default branch - `master` for most enrollments. #### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **get a file's metadata from a specific Branch** specify the Branch's name as `branchName`. This will retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest ancestor transaction of the branch if there are no snapshot transactions. @@ -243,7 +243,7 @@ See [README](../../../README.md#authorization) Lists Files contained in a Dataset. By default files are listed on the latest view of the default branch - `master` for most enrollments. #### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the branch if there are no snapshot transactions. @@ -331,14 +331,14 @@ The body of the request must contain the binary content of the file and the `Con By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments. If the file already exists only the most recent version will be visible in the updated view. #### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **upload a file to a specific Branch** specify the Branch's name as `branchName`. A new transaction will be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this default specify `transactionType` in addition to `branchName`. -See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. +See [createBranch](https://palantir.com/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as `transactionRid`. This is useful for uploading multiple files in a single transaction. -See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. +See [createTransaction](https://palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. ### Parameters diff --git a/docs/v2/Datasets/Transaction.md b/docs/v2/Datasets/Transaction.md index dccc40795..719dd5386 100644 --- a/docs/v2/Datasets/Transaction.md +++ b/docs/v2/Datasets/Transaction.md @@ -62,7 +62,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) # **build** -Get the [Build](/docs/foundry/data-integration/builds#builds) that computed the +Get the [Build](https://palantir.com/docs/foundry/data-integration/builds#builds) that computed the given Transaction. Not all Transactions have an associated Build. For example, if a Dataset is updated by a User uploading a CSV file into the browser, no Build will be tied to the Transaction. @@ -301,7 +301,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) # **job** -Get the [Job](/docs/foundry/data-integration/builds#jobs-and-jobspecs) that computed the +Get the [Job](https://palantir.com/docs/foundry/data-integration/builds#jobs-and-jobspecs) that computed the given Transaction. Not all Transactions have an associated Job. For example, if a Dataset is updated by a User uploading a CSV file into the browser, no Job will be tied to the Transaction. diff --git a/docs/v2/Filesystem/models/FolderType.md b/docs/v2/Filesystem/models/FolderType.md index 63cdbbfbe..2cfe4eef9 100644 --- a/docs/v2/Filesystem/models/FolderType.md +++ b/docs/v2/Filesystem/models/FolderType.md @@ -1,8 +1,8 @@ # FolderType A folder can be a regular Folder, a -[Project](/docs/foundry/getting-started/projects-and-resources/#projects) or a -[Space](/docs/foundry/security/orgs-and-spaces/#spaces). +[Project](https://palantir.com/docs/foundry/getting-started/projects-and-resources/#projects) or a +[Space](https://palantir.com/docs/foundry/security/orgs-and-spaces/#spaces). | **Value** | diff --git a/docs/v2/Filesystem/models/Marking.md b/docs/v2/Filesystem/models/Marking.md index ccf30dd23..3dafc3f10 100644 --- a/docs/v2/Filesystem/models/Marking.md +++ b/docs/v2/Filesystem/models/Marking.md @@ -1,6 +1,6 @@ # Marking -[Markings](/docs/foundry/security/markings/) provide an additional level of access control for files, +[Markings](https://palantir.com/docs/foundry/security/markings/) provide an additional level of access control for files, folders, and Projects within Foundry. Markings define eligibility criteria that restrict visibility and actions to users who meet those criteria. To access a resource, a user must be a member of all Markings applied to a resource to access it. diff --git a/docs/v2/Filesystem/models/Organization.md b/docs/v2/Filesystem/models/Organization.md index 33d591289..1d9bb7a03 100644 --- a/docs/v2/Filesystem/models/Organization.md +++ b/docs/v2/Filesystem/models/Organization.md @@ -1,6 +1,6 @@ # Organization -[Organizations](/docs/foundry/security/orgs-and-spaces/#organizations) are access requirements applied to +[Organizations](https://palantir.com/docs/foundry/security/orgs-and-spaces/#organizations) are access requirements applied to Projects that enforce strict silos between groups of users and resources. Every user is a member of only one Organization, but can be a guest member of multiple Organizations. In order to meet access requirements, users must be a member or guest member of at least one Organization applied to a Project. diff --git a/docs/v2/MediaSets/MediaSet.md b/docs/v2/MediaSets/MediaSet.md index 5a241a3a8..5a495b192 100644 --- a/docs/v2/MediaSets/MediaSet.md +++ b/docs/v2/MediaSets/MediaSet.md @@ -369,7 +369,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) # **reference** -Gets the [media reference](/docs/foundry/data-integration/media-sets/#media-references) for this media item. +Gets the [media reference](https://palantir.com/docs/foundry/data-integration/media-sets/#media-references) for this media item. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:mediasets-read`. diff --git a/docs/v2/Ontologies/Action.md b/docs/v2/Ontologies/Action.md index d595496e0..fc78dc2fa 100644 --- a/docs/v2/Ontologies/Action.md +++ b/docs/v2/Ontologies/Action.md @@ -10,7 +10,7 @@ Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take some time to be visible. -Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by +Note that [parameter default values](https://palantir.com/docs/foundry/action-types/parameters-default-value/) are not currently supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the @@ -90,7 +90,7 @@ Changes to the Ontology are eventually consistent and may take some time to be v Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not call Functions may receive a higher limit. -Note that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. +Note that [notifications](https://palantir.com/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read api:ontologies-write`. diff --git a/docs/v2/Ontologies/ActionType.md b/docs/v2/Ontologies/ActionType.md index b2de8952f..8ee98e1b7 100644 --- a/docs/v2/Ontologies/ActionType.md +++ b/docs/v2/Ontologies/ActionType.md @@ -128,7 +128,7 @@ Third-party applications using this endpoint via OAuth2 must request the followi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | +**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | ### Return type @@ -145,7 +145,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] page_token = None diff --git a/docs/v2/Ontologies/LinkedObject.md b/docs/v2/Ontologies/LinkedObject.md index 4165edc4d..ea337e7a2 100644 --- a/docs/v2/Ontologies/LinkedObject.md +++ b/docs/v2/Ontologies/LinkedObject.md @@ -121,7 +121,7 @@ Name | Type | Description | Notes | **exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] | **order_by** | Optional[OrderBy] | | [optional] | **package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | +**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | **select** | Optional[List[SelectedPropertyApiName]] | The properties of the object type that should be included in the response. Omit this parameter to get all the properties. | [optional] | @@ -153,7 +153,7 @@ exclude_rid = None order_by = None # Optional[SdkPackageName] | The package name of the generated SDK. package_name = None -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] page_token = None diff --git a/docs/v2/Ontologies/ObjectType.md b/docs/v2/Ontologies/ObjectType.md index 9572cc0ca..5ad42f667 100644 --- a/docs/v2/Ontologies/ObjectType.md +++ b/docs/v2/Ontologies/ObjectType.md @@ -193,7 +193,7 @@ Third-party applications using this endpoint via OAuth2 must request the followi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | +**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | ### Return type @@ -210,7 +210,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] page_token = None diff --git a/docs/v2/Ontologies/OntologyInterface.md b/docs/v2/Ontologies/OntologyInterface.md index 59c87f854..213ecc2ac 100644 --- a/docs/v2/Ontologies/OntologyInterface.md +++ b/docs/v2/Ontologies/OntologyInterface.md @@ -185,7 +185,7 @@ Third-party applications using this endpoint via OAuth2 must request the followi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | +**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | **preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] | @@ -203,7 +203,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] page_token = None diff --git a/docs/v2/Ontologies/OntologyObject.md b/docs/v2/Ontologies/OntologyObject.md index eadcf66df..82bd7aaa0 100644 --- a/docs/v2/Ontologies/OntologyObject.md +++ b/docs/v2/Ontologies/OntologyObject.md @@ -263,7 +263,7 @@ Name | Type | Description | Notes | **exclude_rid** | Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] | **order_by** | Optional[OrderBy] | | [optional] | **package_name** | Optional[SdkPackageName] | The package name of the generated SDK. | [optional] | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | +**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | **select** | Optional[List[SelectedPropertyApiName]] | The properties of the object type that should be included in the response. Omit this parameter to get all the properties. | [optional] | @@ -291,7 +291,7 @@ exclude_rid = None order_by = None # Optional[SdkPackageName] | The package name of the generated SDK. package_name = None -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +# Optional[PageSize] | The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] page_token = None diff --git a/docs/v2/Ontologies/QueryType.md b/docs/v2/Ontologies/QueryType.md index 47a57ad74..504834769 100644 --- a/docs/v2/Ontologies/QueryType.md +++ b/docs/v2/Ontologies/QueryType.md @@ -72,7 +72,7 @@ Third-party applications using this endpoint via OAuth2 must request the followi Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology** | OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. | | -**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | +**page_size** | Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. | [optional] | **page_token** | Optional[PageToken] | | [optional] | ### Return type @@ -89,7 +89,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa # OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. ontology = "palantir" -# Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +# Optional[PageSize] | The desired size of the page to be returned. Defaults to 100. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. page_size = None # Optional[PageToken] page_token = None diff --git a/docs/v2/Ontologies/models/ObjectTypeId.md b/docs/v2/Ontologies/models/ObjectTypeId.md index 436a66258..2544a3cb8 100644 --- a/docs/v2/Ontologies/models/ObjectTypeId.md +++ b/docs/v2/Ontologies/models/ObjectTypeId.md @@ -1,6 +1,6 @@ # ObjectTypeId -The unique identifier (ID) for an object type. This can be viewed in [Ontology Manager](/docs/foundry/ontology-manager/overview/). +The unique identifier (ID) for an object type. This can be viewed in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). ## Type ```python diff --git a/docs/v2/Streams/Dataset.md b/docs/v2/Streams/Dataset.md index e8a0437e0..2e5174c7f 100644 --- a/docs/v2/Streams/Dataset.md +++ b/docs/v2/Streams/Dataset.md @@ -7,7 +7,7 @@ Method | HTTP request | Release Stage | # **create** Creates a streaming dataset with a stream on the specified branch, or if no branch is specified, on the default branch ('master' for most enrollments). For more information on streaming datasets, refer to the -[streams](/docs/foundry/data-integration/streams/) user documentation. +[streams](https://palantir.com/docs/foundry/data-integration/streams/) user documentation. ### Parameters diff --git a/docs/v2/Streams/models/CreateStreamRequestStreamSchema.md b/docs/v2/Streams/models/CreateStreamRequestStreamSchema.md index 77cbec3d7..eb2b02be5 100644 --- a/docs/v2/Streams/models/CreateStreamRequestStreamSchema.md +++ b/docs/v2/Streams/models/CreateStreamRequestStreamSchema.md @@ -5,7 +5,7 @@ CreateStreamRequestStreamSchema ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**key_field_names** | Optional[List[FieldName]] | No | The names of the fields to be used as keys for partitioning records. These key fields are used to group all records with the same key into the same partition, to guarantee processing order of grouped records. These keys are not meant to uniquely identify records, and do not by themselves deduplicate records. To deduplicate records, provide a change data capture configuration for the schema. Key fields can only be of the following types: - Boolean - Byte - Date - Decimal - Integer - Long - Short - String - Timestamp For additional information on keys for Foundry streams, see the [streaming keys](/docs/foundry/building-pipelines/streaming-keys/) user documentation. | +**key_field_names** | Optional[List[FieldName]] | No | The names of the fields to be used as keys for partitioning records. These key fields are used to group all records with the same key into the same partition, to guarantee processing order of grouped records. These keys are not meant to uniquely identify records, and do not by themselves deduplicate records. To deduplicate records, provide a change data capture configuration for the schema. Key fields can only be of the following types: - Boolean - Byte - Date - Decimal - Integer - Long - Short - String - Timestamp For additional information on keys for Foundry streams, see the [streaming keys](https://palantir.com/docs/foundry/building-pipelines/streaming-keys/) user documentation. | **fields** | List[Field] | Yes | | **change_data_capture** | Optional[ChangeDataCaptureConfiguration] | No | | diff --git a/docs/v2/Streams/models/StreamType.md b/docs/v2/Streams/models/StreamType.md index 59ff32e69..6c13b49db 100644 --- a/docs/v2/Streams/models/StreamType.md +++ b/docs/v2/Streams/models/StreamType.md @@ -9,7 +9,7 @@ to the max match size, or if jobs using the stream are failing due to Kafka prod additional information on inspecting stream metrics, refer to the (stream monitoring)[/docs/foundry/data-integration/stream-monitoring/#viewing-metrics] documentation. -For more information, refer to the [stream types](/docs/foundry/data-integration/streams/#stream-types) +For more information, refer to the [stream types](https://palantir.com/docs/foundry/data-integration/streams/#stream-types) documentation. diff --git a/docs/v2/ThirdPartyApplications/Version.md b/docs/v2/ThirdPartyApplications/Version.md index e8c236ded..2aa843430 100644 --- a/docs/v2/ThirdPartyApplications/Version.md +++ b/docs/v2/ThirdPartyApplications/Version.md @@ -186,7 +186,7 @@ Upload a new version of the Website. Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **third_party_application_rid** | ThirdPartyApplicationRid | An RID identifying a third-party application created in Developer Console. | | -**body** | bytes | The zip file that contains the contents of your application. For more information, refer to the [documentation](/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. | | +**body** | bytes | The zip file that contains the contents of your application. For more information, refer to the [documentation](https://palantir.com/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. | | **version** | VersionVersion | | | ### Return type @@ -205,7 +205,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa third_party_application_rid = ( "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" ) -# bytes | The zip file that contains the contents of your application. For more information, refer to the [documentation](/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. +# bytes | The zip file that contains the contents of your application. For more information, refer to the [documentation](https://palantir.com/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. body = None # VersionVersion version = None @@ -246,7 +246,7 @@ Upload a snapshot version of the Website. Snapshot versions are automatically de Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **third_party_application_rid** | ThirdPartyApplicationRid | An RID identifying a third-party application created in Developer Console. | | -**body** | bytes | The zip file that contains the contents of your application. For more information, refer to the [documentation](/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. | | +**body** | bytes | The zip file that contains the contents of your application. For more information, refer to the [documentation](https://palantir.com/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. | | **version** | VersionVersion | | | **preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] | **snapshot_identifier** | Optional[str] | The identifier of the snapshot. If the identifier follows the format `foundry.v1@@@`, PR preview for such identifier will be accessible from foundry code repositories. | [optional] | @@ -267,7 +267,7 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa third_party_application_rid = ( "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" ) -# bytes | The zip file that contains the contents of your application. For more information, refer to the [documentation](/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. +# bytes | The zip file that contains the contents of your application. For more information, refer to the [documentation](https://palantir.com/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. body = None # VersionVersion version = None diff --git a/foundry_sdk/v1/cli.py b/foundry_sdk/v1/cli.py index bf7ee7f35..c0e17e634 100644 --- a/foundry_sdk/v1/cli.py +++ b/foundry_sdk/v1/cli.py @@ -426,14 +426,14 @@ def datasets_dataset_file_delete( #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction will be created and committed on this branch. To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a - single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to + single transaction. See [createTransaction](https://palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. @@ -484,7 +484,7 @@ def datasets_dataset_file_get( #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest @@ -534,7 +534,7 @@ def datasets_dataset_file_get( type=int, required=False, help="""The desired size of the page to be returned. Defaults to 1,000. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. """, ) @click.option("--page_token", type=str, required=False, help="""""") @@ -560,7 +560,7 @@ def datasets_dataset_file_list( #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the @@ -630,7 +630,7 @@ def datasets_dataset_file_read( #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will retrieve the content for the most recent version of the file since the latest snapshot transaction, or the @@ -705,16 +705,16 @@ def datasets_dataset_file_upload( #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this default specify `transactionType` in addition to `branchId`. - See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. + See [createBranch](https://palantir.com/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as `transactionRid`. This is useful for uploading multiple files in a single transaction. - See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. + See [createTransaction](https://palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. @@ -811,7 +811,7 @@ def datasets_dataset_branch_get( type=int, required=False, help="""The desired size of the page to be returned. Defaults to 1,000. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. """, ) @click.option("--page_token", type=str, required=False, help="""""") @@ -998,7 +998,7 @@ def ontologies_ontology_object_get_linked_object( type=int, required=False, help="""The desired size of the page to be returned. Defaults to 1,000. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. """, ) @click.option("--page_token", type=str, required=False, help="""""") @@ -1024,7 +1024,7 @@ def ontologies_ontology_object_list( Lists the objects for the given Ontology and object type. This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. + See the [Filtering Objects documentation](https://palantir.com/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or repeated objects in the response pages. @@ -1063,7 +1063,7 @@ def ontologies_ontology_object_list( type=int, required=False, help="""The desired size of the page to be returned. Defaults to 1,000. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. """, ) @click.option("--page_token", type=str, required=False, help="""""") @@ -1091,7 +1091,7 @@ def ontologies_ontology_object_list_linked_objects( Lists the linked objects for a specific object and the given link type. This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. + See the [Filtering Objects documentation](https://palantir.com/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or repeated objects in the response pages. @@ -1258,7 +1258,7 @@ def ontologies_ontology_query_type_get( type=int, required=False, help="""The desired size of the page to be returned. Defaults to 100. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. """, ) @click.option("--page_token", type=str, required=False, help="""""") @@ -1346,7 +1346,7 @@ def ontologies_ontology_object_type_get_outgoing_link_type( type=int, required=False, help="""The desired size of the page to be returned. Defaults to 500. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. """, ) @click.option("--page_token", type=str, required=False, help="""""") @@ -1440,7 +1440,7 @@ def ontologies_ontology_action_type_get( type=int, required=False, help="""The desired size of the page to be returned. Defaults to 500. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. """, ) @click.option("--page_token", type=str, required=False, help="""""") @@ -1575,7 +1575,7 @@ def ontologies_action_apply( Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take some time to be visible. - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by + Note that [parameter default values](https://palantir.com/docs/foundry/action-types/parameters-default-value/) are not currently supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the @@ -1608,8 +1608,8 @@ def ontologies_action_apply_batch( Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not call Functions may receive a higher limit. - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) and - [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + Note that [parameter default values](https://palantir.com/docs/foundry/action-types/parameters-default-value/) and + [notifications](https://palantir.com/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read api:ontologies-write`. @@ -1640,7 +1640,7 @@ def ontologies_action_validate( that determine if the request is `VALID` or `INVALID`. For performance reasons, validations will not consider existing objects or other data in Foundry. For example, the uniqueness of a primary key or the existence of a user ID will not be checked. - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by + Note that [parameter default values](https://palantir.com/docs/foundry/action-types/parameters-default-value/) are not currently supported by this endpoint. Unspecified parameters will be given a default value of `null`. Third-party applications using this endpoint via OAuth2 must request the diff --git a/foundry_sdk/v1/datasets/branch.py b/foundry_sdk/v1/datasets/branch.py index 03d1f929f..f8ac76213 100644 --- a/foundry_sdk/v1/datasets/branch.py +++ b/foundry_sdk/v1/datasets/branch.py @@ -217,7 +217,7 @@ def list( :param dataset_rid: The Resource Identifier (RID) of the Dataset on which to list Branches. :type dataset_rid: DatasetRid - :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] diff --git a/foundry_sdk/v1/datasets/file.py b/foundry_sdk/v1/datasets/file.py index f48773e53..06a2971d9 100644 --- a/foundry_sdk/v1/datasets/file.py +++ b/foundry_sdk/v1/datasets/file.py @@ -66,14 +66,14 @@ def delete( #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction will be created and committed on this branch. To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a - single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to + single transaction. See [createTransaction](https://palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. @@ -134,7 +134,7 @@ def get( #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest @@ -216,7 +216,7 @@ def list( #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the @@ -244,7 +244,7 @@ def list( :type branch_id: Optional[BranchId] :param end_transaction_rid: The Resource Identifier (RID) of the end Transaction. :type end_transaction_rid: Optional[TransactionRid] - :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] @@ -302,7 +302,7 @@ def read( #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will retrieve the content for the most recent version of the file since the latest snapshot transaction, or the @@ -388,16 +388,16 @@ def upload( #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this default specify `transactionType` in addition to `branchId`. - See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. + See [createBranch](https://palantir.com/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as `transactionRid`. This is useful for uploading multiple files in a single transaction. - See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. + See [createTransaction](https://palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. diff --git a/foundry_sdk/v1/ontologies/action.py b/foundry_sdk/v1/ontologies/action.py index 8ec1e75ae..cc0d9fd28 100644 --- a/foundry_sdk/v1/ontologies/action.py +++ b/foundry_sdk/v1/ontologies/action.py @@ -64,7 +64,7 @@ def apply( Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take some time to be visible. - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by + Note that [parameter default values](https://palantir.com/docs/foundry/action-types/parameters-default-value/) are not currently supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the @@ -133,8 +133,8 @@ def apply_batch( Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not call Functions may receive a higher limit. - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) and - [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + Note that [parameter default values](https://palantir.com/docs/foundry/action-types/parameters-default-value/) and + [notifications](https://palantir.com/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read api:ontologies-write`. @@ -200,7 +200,7 @@ def validate( that determine if the request is `VALID` or `INVALID`. For performance reasons, validations will not consider existing objects or other data in Foundry. For example, the uniqueness of a primary key or the existence of a user ID will not be checked. - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by + Note that [parameter default values](https://palantir.com/docs/foundry/action-types/parameters-default-value/) are not currently supported by this endpoint. Unspecified parameters will be given a default value of `null`. Third-party applications using this endpoint via OAuth2 must request the diff --git a/foundry_sdk/v1/ontologies/action_type.py b/foundry_sdk/v1/ontologies/action_type.py index 666d33926..9cf0ea482 100644 --- a/foundry_sdk/v1/ontologies/action_type.py +++ b/foundry_sdk/v1/ontologies/action_type.py @@ -116,7 +116,7 @@ def list( :param ontology_rid: The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. :type ontology_rid: OntologyRid - :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] diff --git a/foundry_sdk/v1/ontologies/object_type.py b/foundry_sdk/v1/ontologies/object_type.py index 2d42b8119..c9cebf069 100644 --- a/foundry_sdk/v1/ontologies/object_type.py +++ b/foundry_sdk/v1/ontologies/object_type.py @@ -169,7 +169,7 @@ def list( :param ontology_rid: The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. :type ontology_rid: OntologyRid - :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] diff --git a/foundry_sdk/v1/ontologies/ontology_object.py b/foundry_sdk/v1/ontologies/ontology_object.py index 3b8d8d002..ab39e2389 100644 --- a/foundry_sdk/v1/ontologies/ontology_object.py +++ b/foundry_sdk/v1/ontologies/ontology_object.py @@ -255,7 +255,7 @@ def list( Lists the objects for the given Ontology and object type. This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. + See the [Filtering Objects documentation](https://palantir.com/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or repeated objects in the response pages. @@ -277,7 +277,7 @@ def list( :type object_type: ObjectTypeApiName :param order_by: :type order_by: Optional[OrderBy] - :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] @@ -336,7 +336,7 @@ def list_linked_objects( Lists the linked objects for a specific object and the given link type. This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. + See the [Filtering Objects documentation](https://palantir.com/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details. Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or repeated objects in the response pages. @@ -362,7 +362,7 @@ def list_linked_objects( :type link_type: LinkTypeApiName :param order_by: :type order_by: Optional[OrderBy] - :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] diff --git a/foundry_sdk/v1/ontologies/query_type.py b/foundry_sdk/v1/ontologies/query_type.py index 845e622d4..2853f1de6 100644 --- a/foundry_sdk/v1/ontologies/query_type.py +++ b/foundry_sdk/v1/ontologies/query_type.py @@ -116,7 +116,7 @@ def list( :param ontology_rid: The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**. :type ontology_rid: OntologyRid - :param page_size: The desired size of the page to be returned. Defaults to 100. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + :param page_size: The desired size of the page to be returned. Defaults to 100. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] diff --git a/foundry_sdk/v2/aip_agents/agent.py b/foundry_sdk/v2/aip_agents/agent.py index 6966bdc54..cd9f71635 100644 --- a/foundry_sdk/v2/aip_agents/agent.py +++ b/foundry_sdk/v2/aip_agents/agent.py @@ -137,7 +137,7 @@ def get( ) -> aip_agents_models.Agent: """ Get details for an AIP Agent. - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] diff --git a/foundry_sdk/v2/aip_agents/agent_version.py b/foundry_sdk/v2/aip_agents/agent_version.py index c9dae3a34..04b125b54 100644 --- a/foundry_sdk/v2/aip_agents/agent_version.py +++ b/foundry_sdk/v2/aip_agents/agent_version.py @@ -62,7 +62,7 @@ def get( ) -> aip_agents_models.AgentVersion: """ Get version details for an AIP Agent. - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param agent_version_string: The semantic version of the Agent, formatted as "majorVersion.minorVersion". :type agent_version_string: AgentVersionString @@ -118,7 +118,7 @@ def list( List all versions for an AIP Agent. Versions are returned in descending order, by most recent versions first. - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param page_size: The page size to use for the endpoint. :type page_size: Optional[PageSize] diff --git a/foundry_sdk/v2/aip_agents/content.py b/foundry_sdk/v2/aip_agents/content.py index 4c2c362e4..152c530da 100644 --- a/foundry_sdk/v2/aip_agents/content.py +++ b/foundry_sdk/v2/aip_agents/content.py @@ -62,7 +62,7 @@ def get( ) -> aip_agents_models.Content: """ Get the conversation content for a session between the calling user and an Agent. - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid diff --git a/foundry_sdk/v2/aip_agents/errors.py b/foundry_sdk/v2/aip_agents/errors.py index 4bc5da9f7..ebb693a89 100644 --- a/foundry_sdk/v2/aip_agents/errors.py +++ b/foundry_sdk/v2/aip_agents/errors.py @@ -52,7 +52,7 @@ class AgentNotFoundParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" @dataclass @@ -68,7 +68,7 @@ class AgentVersionNotFoundParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" agentVersionString: aip_agents_models.AgentVersionString """The semantic version of the Agent, formatted as "majorVersion.minorVersion".""" @@ -87,7 +87,7 @@ class BlockingContinueSessionPermissionDeniedParameters(typing_extensions.TypedD __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -135,7 +135,7 @@ class CancelSessionPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -154,7 +154,7 @@ class ContentNotFoundParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -194,7 +194,7 @@ class CreateSessionPermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" @dataclass @@ -249,7 +249,7 @@ class GetRagContextForSessionPermissionDeniedParameters(typing_extensions.TypedD __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -357,7 +357,7 @@ class ObjectTypeIdsNotFoundParameters(typing_extensions.TypedDict): """ Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. - Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](/docs/foundry/ontology-manager/overview/). + Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). """ __pydantic_config__ = {"extra": "allow"} # type: ignore @@ -380,7 +380,7 @@ class ObjectTypeRidsNotFoundParameters(typing_extensions.TypedDict): """ Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. - Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](/docs/foundry/ontology-manager/overview/). + Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). """ __pydantic_config__ = {"extra": "allow"} # type: ignore @@ -444,7 +444,7 @@ class SessionNotFoundParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -463,7 +463,7 @@ class StreamingContinueSessionPermissionDeniedParameters(typing_extensions.Typed __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" @@ -482,7 +482,7 @@ class UpdateSessionTitlePermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore agentRid: aip_agents_models.AgentRid - """An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" sessionRid: aip_agents_models.SessionRid """The Resource Identifier (RID) of the conversation session.""" diff --git a/foundry_sdk/v2/aip_agents/models.py b/foundry_sdk/v2/aip_agents/models.py index 80248c9c0..6a2844ca4 100644 --- a/foundry_sdk/v2/aip_agents/models.py +++ b/foundry_sdk/v2/aip_agents/models.py @@ -30,7 +30,7 @@ class Agent(pydantic.BaseModel): """Agent""" rid: AgentRid - """An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" + """An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" version: AgentVersionString """The version of this instance of the Agent.""" @@ -38,7 +38,7 @@ class Agent(pydantic.BaseModel): metadata: AgentMetadata parameters: typing.Dict[ParameterId, Parameter] """ - The types and names of variables configured for the Agent in [AIP Agent Studio](/docs/foundry/agent-studio/overview/) in the [application state](/docs/foundry/agent-studio/application-state/). + The types and names of variables configured for the Agent in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/) in the [application state](https://palantir.com/docs/foundry/agent-studio/application-state/). These variables can be used to send custom values in prompts sent to an Agent to customize and control the Agent's behavior. """ @@ -76,7 +76,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: AgentRid = core.RID -"""An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" +"""An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" class AgentSessionRagContextResponse(pydantic.BaseModel): @@ -199,7 +199,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: InputContext = typing_extensions.Annotated[ typing.Union[FunctionRetrievedContext, "ObjectContext"], pydantic.Field(discriminator="type") ] -"""Custom retrieved [context](/docs/foundry/agent-studio/retrieval-context/) to provide to an Agent for continuing a session.""" +"""Custom retrieved [context](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) to provide to an Agent for continuing a session.""" class ListAgentVersionsResponse(pydantic.BaseModel): @@ -271,7 +271,7 @@ class ObjectSetParameterValue(pydantic.BaseModel): ontology: ontologies_models.OntologyIdentifier """ The API name of the Ontology for the provided `ObjectSet`. - To find the API name, use the `List ontologies` endpoint or check the [Ontology Manager](/docs/foundry/ontology-manager/overview/). + To find the API name, use the `List ontologies` endpoint or check the [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). """ type: typing.Literal["objectSet"] = "objectSet" @@ -295,7 +295,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class Parameter(pydantic.BaseModel): - """A variable configured in the application state of an Agent in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" + """A variable configured in the application state of an Agent in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" parameter_type: ParameterType = pydantic.Field(alias=str("parameterType")) # type: ignore[literal-required] """Details of the types of values accepted and defaults for this variable.""" @@ -324,7 +324,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: ParameterId = str -"""The unique identifier for a variable configured in the application state of an Agent in [AIP Agent Studio](/docs/foundry/agent-studio/overview/).""" +"""The unique identifier for a variable configured in the application state of an Agent in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/).""" ParameterType = typing_extensions.Annotated[ @@ -337,7 +337,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: typing.Union["StringParameterValue", ObjectSetParameterValue], pydantic.Field(discriminator="type"), ] -"""The value provided for a variable configured in the [application state](/docs/foundry/agent-studio/application-state/) of an Agent.""" +"""The value provided for a variable configured in the [application state](https://palantir.com/docs/foundry/agent-studio/application-state/) of an Agent.""" ParameterValueUpdate = typing_extensions.Annotated[ @@ -345,7 +345,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: pydantic.Field(discriminator="type"), ] """ -A value update for an [application variable](/docs/foundry/agent-studio/application-state/) generated by the Agent. +A value update for an [application variable](https://palantir.com/docs/foundry/agent-studio/application-state/) generated by the Agent. For `StringParameter` types, this will be the updated string value. For `ObjectSetParameter` types, this will be a Resource Identifier (RID) for the updated object set. """ diff --git a/foundry_sdk/v2/aip_agents/session.py b/foundry_sdk/v2/aip_agents/session.py index ba9ce69ad..e0886ab23 100644 --- a/foundry_sdk/v2/aip_agents/session.py +++ b/foundry_sdk/v2/aip_agents/session.py @@ -84,15 +84,15 @@ def blocking_continue( Concurrent requests to continue the same session are not supported. Clients should wait to receive a response before sending the next message. - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid - :param parameter_inputs: Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. + :param parameter_inputs: Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. :type parameter_inputs: Dict[ParameterId, ParameterValue] :param user_input: The user message for the Agent to respond to. :type user_input: UserTextInput - :param contexts_override: If set, automatic [context retrieval](/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. + :param contexts_override: If set, automatic [context retrieval](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. :type contexts_override: Optional[List[InputContext]] :param preview: Enables the use of preview functionality. :type preview: Optional[PreviewMode] @@ -108,8 +108,8 @@ def blocking_continue( :raises FunctionLocatorNotFound: The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access. :raises InvalidParameter: The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. :raises InvalidParameterType: The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. - :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](/docs/foundry/ontology-manager/overview/). - :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](/docs/foundry/ontology-manager/overview/). + :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). + :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises RateLimitExceeded: Failed to generate a response as the model rate limits were exceeded. Clients should wait and retry. :raises SessionExecutionFailed: Failed to generate a response for a session due to an unexpected error. :raises SessionNotFound: The given Session could not be found. @@ -186,7 +186,7 @@ def cancel( Canceling an exchange allows clients to prevent the exchange from being added to the session, or to provide a response to replace the Agent-generated response. Note that canceling an exchange does not terminate the stream returned by `streamingContinue`; clients should close the stream on triggering the cancellation request to stop reading from the stream. - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid @@ -261,7 +261,7 @@ def create( Create a new conversation session between the calling user and an Agent. Use `blockingContinue` or `streamingContinue` to start adding exchanges to the session. - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param agent_version: The version of the Agent associated with the session. This can be set by clients on session creation. If not specified, defaults to use the latest published version of the Agent at session creation time. :type agent_version: Optional[AgentVersionString] @@ -276,8 +276,8 @@ def create( :raises CreateSessionPermissionDenied: Could not create the Session. :raises FunctionLocatorNotFound: The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access. :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Agent Studio to use the latest published version, or specify the version of the Agent to use. - :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](/docs/foundry/ontology-manager/overview/). - :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](/docs/foundry/ontology-manager/overview/). + :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). + :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). """ return self._api_client.call_api( @@ -331,7 +331,7 @@ def get( ) -> aip_agents_models.Session: """ Get the details of a conversation session between the calling user and an Agent. - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid @@ -389,7 +389,7 @@ def list( For example, any sessions created by the user in AIP Agent Studio will not be listed here. Sessions are returned in order of most recently updated first. - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param page_size: The page size to use for the endpoint. :type page_size: Optional[PageSize] @@ -448,14 +448,14 @@ def rag_context( _sdk_internal: core.SdkInternal = {}, ) -> aip_agents_models.AgentSessionRagContextResponse: """ - Retrieve relevant [context](/docs/foundry/agent-studio/core-concepts/#retrieval-context) for a user message from the data sources configured for the session. + Retrieve relevant [context](https://palantir.com/docs/foundry/agent-studio/core-concepts/#retrieval-context) for a user message from the data sources configured for the session. This allows clients to pre-retrieve context for a user message before sending it to the Agent with the `contextsOverride` option when continuing a session, to allow any pre-processing of the context before sending it to the Agent. - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid - :param parameter_inputs: Any values for [application variables](/docs/foundry/agent-studio/application-state/) to use for the context retrieval. + :param parameter_inputs: Any values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to use for the context retrieval. :type parameter_inputs: Dict[ParameterId, ParameterValue] :param user_input: The user message to retrieve relevant context for from the configured Agent data sources. :type user_input: UserTextInput @@ -469,8 +469,8 @@ def rag_context( :raises AgentNotFound: The given Agent could not be found. :raises FunctionLocatorNotFound: The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access. :raises GetRagContextForSessionPermissionDenied: Could not ragContext the Session. - :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](/docs/foundry/ontology-manager/overview/). - :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](/docs/foundry/ontology-manager/overview/). + :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). + :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises SessionNotFound: The given Session could not be found. """ @@ -543,15 +543,15 @@ def streaming_continue( Concurrent requests to continue the same session are not supported. Clients should wait to receive a response, or cancel the in-progress exchange, before sending the next message. - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid - :param parameter_inputs: Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. + :param parameter_inputs: Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. :type parameter_inputs: Dict[ParameterId, ParameterValue] :param user_input: The user message for the Agent to respond to. :type user_input: UserTextInput - :param contexts_override: If set, automatic [context](/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. + :param contexts_override: If set, automatic [context](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. :type contexts_override: Optional[List[InputContext]] :param message_id: A client-generated Universally Unique Identifier (UUID) to identify the message, which the client can use to cancel the exchange before the streaming response is complete. :type message_id: Optional[MessageId] @@ -566,8 +566,8 @@ def streaming_continue( :raises FunctionLocatorNotFound: The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access. :raises InvalidParameter: The provided application variable is not valid for the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. :raises InvalidParameterType: The provided value does not match the expected type for the application variable configured on the Agent for this session. Check the available application variables for the Agent under the `parameters` property, and version through the API with `getAgent`, or in AIP Agent Studio. The Agent version used for the session can be checked through the API with `getSession`. - :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](/docs/foundry/ontology-manager/overview/). - :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](/docs/foundry/ontology-manager/overview/). + :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). + :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises SessionNotFound: The given Session could not be found. :raises StreamingContinueSessionPermissionDenied: Could not streamingContinue the Session. """ @@ -639,7 +639,7 @@ def update_title( Update the title for a session. Use this to set a custom title for a session to help identify it in the list of sessions with an Agent. - :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](/docs/foundry/agent-studio/overview/). + :param agent_rid: An RID identifying an AIP Agent created in [AIP Agent Studio](https://palantir.com/docs/foundry/agent-studio/overview/). :type agent_rid: AgentRid :param session_rid: The Resource Identifier (RID) of the conversation session. :type session_rid: SessionRid diff --git a/foundry_sdk/v2/cli.py b/foundry_sdk/v2/cli.py index ecbc79e7a..b232a5ae6 100644 --- a/foundry_sdk/v2/cli.py +++ b/foundry_sdk/v2/cli.py @@ -1376,7 +1376,7 @@ def aip_agents_agent_session(): "--parameter_inputs", type=str, required=True, - help="""Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. + help="""Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. """, ) @click.option( @@ -1389,7 +1389,7 @@ def aip_agents_agent_session(): "--contexts_override", type=str, required=False, - help="""If set, automatic [context retrieval](/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. + help="""If set, automatic [context retrieval](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. """, ) @@ -1578,7 +1578,7 @@ def aip_agents_agent_session_list( "--parameter_inputs", type=str, required=True, - help="""Any values for [application variables](/docs/foundry/agent-studio/application-state/) to use for the context retrieval. + help="""Any values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to use for the context retrieval. """, ) @click.option( @@ -1600,7 +1600,7 @@ def aip_agents_agent_session_rag_context( preview: typing.Optional[bool], ): """ - Retrieve relevant [context](/docs/foundry/agent-studio/core-concepts/#retrieval-context) for a user message from the data sources configured for the session. + Retrieve relevant [context](https://palantir.com/docs/foundry/agent-studio/core-concepts/#retrieval-context) for a user message from the data sources configured for the session. This allows clients to pre-retrieve context for a user message before sending it to the Agent with the `contextsOverride` option when continuing a session, to allow any pre-processing of the context before sending it to the Agent. """ @@ -1621,7 +1621,7 @@ def aip_agents_agent_session_rag_context( "--parameter_inputs", type=str, required=True, - help="""Any supplied values for [application variables](/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. + help="""Any supplied values for [application variables](https://palantir.com/docs/foundry/agent-studio/application-state/) to pass to the Agent for the exchange. """, ) @click.option( @@ -1634,7 +1634,7 @@ def aip_agents_agent_session_rag_context( "--contexts_override", type=str, required=False, - help="""If set, automatic [context](/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. + help="""If set, automatic [context](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. """, ) @@ -1844,7 +1844,7 @@ def connectivity_connection_create( preview: typing.Optional[bool], ): """ - Creates a new Connection with a [direct connection](/docs/foundry/data-connection/core-concepts/#direct-connection) runtime. + Creates a new Connection with a [direct connection](https://palantir.com/docs/foundry/data-connection/core-concepts/#direct-connection) runtime. Any secrets specified in the request body are transmitted over the network encrypted using TLS. Once the secrets reach Foundry's servers, they will be temporarily decrypted and remain in plaintext in memory to @@ -1897,7 +1897,7 @@ def connectivity_connection_get_configuration( preview: typing.Optional[bool], ): """ - Retrieves the ConnectionConfiguration of the [Connection](/docs/foundry/data-connection/set-up-source/) itself. + Retrieves the ConnectionConfiguration of the [Connection](https://palantir.com/docs/foundry/data-connection/set-up-source/) itself. This operation is intended for use when other Connection data is not required, providing a lighter-weight alternative to `getConnection` operation. """ @@ -2046,7 +2046,7 @@ def connectivity_connection_table_import_execute( preview: typing.Optional[bool], ): """ - Executes the TableImport, which runs asynchronously as a [Foundry Build](/docs/foundry/data-integration/builds/). + Executes the TableImport, which runs asynchronously as a [Foundry Build](https://palantir.com/docs/foundry/data-integration/builds/). The returned BuildRid can be used to check the status via the Orchestration API. """ @@ -2133,7 +2133,7 @@ def connectivity_connection_file_import(): "--file_import_filters", type=str, required=True, - help="""Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs)""", + help="""Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](https://palantir.com/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs)""", ) @click.option( "--import_mode", type=click.Choice(["SNAPSHOT", "APPEND", "UPDATE"]), required=True, help="""""" @@ -2222,7 +2222,7 @@ def connectivity_connection_file_import_execute( preview: typing.Optional[bool], ): """ - Executes the FileImport, which runs asynchronously as a [Foundry Build](/docs/foundry/data-integration/builds/). + Executes the FileImport, which runs asynchronously as a [Foundry Build](https://palantir.com/docs/foundry/data-integration/builds/). The returned BuildRid can be used to check the status via the Orchestration API. """ @@ -2305,7 +2305,7 @@ def connectivity_connection_file_import_list( "--file_import_filters", type=str, required=True, - help="""Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs)""", + help="""Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](https://palantir.com/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs)""", ) @click.option( "--import_mode", type=click.Choice(["SNAPSHOT", "APPEND", "UPDATE"]), required=True, help="""""" @@ -2521,7 +2521,7 @@ def datasets_dataset_file_content( Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest view of the default branch - `master` for most enrollments. #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **get a file's content from a specific Branch** specify the Branch's name as `branchName`. This will retrieve the content for the most recent version of the file since the latest snapshot transaction, or the earliest ancestor transaction of the branch if there are no snapshot transactions. @@ -2576,12 +2576,12 @@ def datasets_dataset_file_delete( Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default branch - `master` for most enrollments. The file will still be visible on historical views. #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **delete a File from a specific Branch** specify the Branch's name as `branchName`. A new delete Transaction will be created and committed on this branch. To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a - single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to + single transaction. See [createTransaction](https://palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. """ @@ -2631,7 +2631,7 @@ def datasets_dataset_file_get( Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest view of the default branch - `master` for most enrollments. #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **get a file's metadata from a specific Branch** specify the Branch's name as `branchName`. This will retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest ancestor transaction of the branch if there are no snapshot transactions. @@ -2704,7 +2704,7 @@ def datasets_dataset_file_list( Lists Files contained in a Dataset. By default files are listed on the latest view of the default branch - `master` for most enrollments. #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the branch if there are no snapshot transactions. @@ -2773,14 +2773,14 @@ def datasets_dataset_file_upload( By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments. If the file already exists only the most recent version will be visible in the updated view. #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **upload a file to a specific Branch** specify the Branch's name as `branchName`. A new transaction will be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this default specify `transactionType` in addition to `branchName`. - See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. + See [createBranch](https://palantir.com/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as `transactionRid`. This is useful for uploading multiple files in a single transaction. - See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. + See [createTransaction](https://palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. """ result = client.datasets.Dataset.File.upload( @@ -2834,7 +2834,7 @@ def datasets_dataset_transaction_build( preview: typing.Optional[bool], ): """ - Get the [Build](/docs/foundry/data-integration/builds#builds) that computed the + Get the [Build](https://palantir.com/docs/foundry/data-integration/builds#builds) that computed the given Transaction. Not all Transactions have an associated Build. For example, if a Dataset is updated by a User uploading a CSV file into the browser, no Build will be tied to the Transaction. @@ -2936,7 +2936,7 @@ def datasets_dataset_transaction_job( preview: typing.Optional[bool], ): """ - Get the [Job](/docs/foundry/data-integration/builds#jobs-and-jobspecs) that computed the + Get the [Job](https://palantir.com/docs/foundry/data-integration/builds#jobs-and-jobspecs) that computed the given Transaction. Not all Transactions have an associated Job. For example, if a Dataset is updated by a User uploading a CSV file into the browser, no Job will be tied to the Transaction. @@ -4080,7 +4080,7 @@ def media_sets_media_set_reference( read_token: typing.Optional[str], ): """ - Gets the [media reference](/docs/foundry/data-integration/media-sets/#media-references) for this media item. + Gets the [media reference](https://palantir.com/docs/foundry/data-integration/media-sets/#media-references) for this media item. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:mediasets-read`. @@ -5019,7 +5019,7 @@ def ontologies_ontology_object_get( type=int, required=False, help="""The desired size of the page to be returned. Defaults to 1,000. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. """, ) @click.option("--page_token", type=str, required=False, help="""""") @@ -5275,7 +5275,7 @@ def ontologies_ontology_interface_get( type=int, required=False, help="""The desired size of the page to be returned. Defaults to 500. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. """, ) @click.option("--page_token", type=str, required=False, help="""""") @@ -5536,7 +5536,7 @@ def ontologies_ontology_query_type_get( type=int, required=False, help="""The desired size of the page to be returned. Defaults to 100. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. """, ) @click.option("--page_token", type=str, required=False, help="""""") @@ -5655,7 +5655,7 @@ def ontologies_ontology_object_type_get_outgoing_link_type( type=int, required=False, help="""The desired size of the page to be returned. Defaults to 500. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. """, ) @click.option("--page_token", type=str, required=False, help="""""") @@ -5771,7 +5771,7 @@ def ontologies_ontology_action_type_get_by_rid( type=int, required=False, help="""The desired size of the page to be returned. Defaults to 500. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. """, ) @click.option("--page_token", type=str, required=False, help="""""") @@ -6070,7 +6070,7 @@ def ontologies_linked_object_get_linked_object( type=int, required=False, help="""The desired size of the page to be returned. Defaults to 1,000. -See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. +See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. """, ) @click.option("--page_token", type=str, required=False, help="""""") @@ -6492,7 +6492,7 @@ def ontologies_action_apply( Changes to the Ontology are eventually consistent and may take some time to be visible. - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by + Note that [parameter default values](https://palantir.com/docs/foundry/action-types/parameters-default-value/) are not currently supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the @@ -6546,7 +6546,7 @@ def ontologies_action_apply_batch( Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not call Functions may receive a higher limit. - Note that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + Note that [notifications](https://palantir.com/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read api:ontologies-write`. @@ -7260,7 +7260,7 @@ def streams_dataset_create( """ Creates a streaming dataset with a stream on the specified branch, or if no branch is specified, on the default branch ('master' for most enrollments). For more information on streaming datasets, refer to the - [streams](/docs/foundry/data-integration/streams/) user documentation. + [streams](https://palantir.com/docs/foundry/data-integration/streams/) user documentation. """ result = client.streams.Dataset.create( diff --git a/foundry_sdk/v2/connectivity/connection.py b/foundry_sdk/v2/connectivity/connection.py index 8f8a88c0d..97395efa9 100644 --- a/foundry_sdk/v2/connectivity/connection.py +++ b/foundry_sdk/v2/connectivity/connection.py @@ -84,7 +84,7 @@ def create( _sdk_internal: core.SdkInternal = {}, ) -> connectivity_models.Connection: """ - Creates a new Connection with a [direct connection](/docs/foundry/data-connection/core-concepts/#direct-connection) runtime. + Creates a new Connection with a [direct connection](https://palantir.com/docs/foundry/data-connection/core-concepts/#direct-connection) runtime. Any secrets specified in the request body are transmitted over the network encrypted using TLS. Once the secrets reach Foundry's servers, they will be temporarily decrypted and remain in plaintext in memory to @@ -215,7 +215,7 @@ def get_configuration( _sdk_internal: core.SdkInternal = {}, ) -> connectivity_models.ConnectionConfiguration: """ - Retrieves the ConnectionConfiguration of the [Connection](/docs/foundry/data-connection/set-up-source/) itself. + Retrieves the ConnectionConfiguration of the [Connection](https://palantir.com/docs/foundry/data-connection/set-up-source/) itself. This operation is intended for use when other Connection data is not required, providing a lighter-weight alternative to `getConnection` operation. :param connection_rid: diff --git a/foundry_sdk/v2/connectivity/file_import.py b/foundry_sdk/v2/connectivity/file_import.py index 3c127aa54..5b8bf0f75 100644 --- a/foundry_sdk/v2/connectivity/file_import.py +++ b/foundry_sdk/v2/connectivity/file_import.py @@ -75,7 +75,7 @@ def create( :type dataset_rid: DatasetRid :param display_name: :type display_name: FileImportDisplayName - :param file_import_filters: Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) + :param file_import_filters: Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](https://palantir.com/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) :type file_import_filters: List[FileImportFilter] :param import_mode: :type import_mode: FileImportMode @@ -222,7 +222,7 @@ def execute( _sdk_internal: core.SdkInternal = {}, ) -> core_models.BuildRid: """ - Executes the FileImport, which runs asynchronously as a [Foundry Build](/docs/foundry/data-integration/builds/). + Executes the FileImport, which runs asynchronously as a [Foundry Build](https://palantir.com/docs/foundry/data-integration/builds/). The returned BuildRid can be used to check the status via the Orchestration API. :param connection_rid: @@ -400,7 +400,7 @@ def replace( :type dataset_rid: DatasetRid :param display_name: :type display_name: FileImportDisplayName - :param file_import_filters: Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) + :param file_import_filters: Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](https://palantir.com/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) :type file_import_filters: List[FileImportFilter] :param import_mode: :type import_mode: FileImportMode diff --git a/foundry_sdk/v2/connectivity/models.py b/foundry_sdk/v2/connectivity/models.py index ada41cc14..3a20b729b 100644 --- a/foundry_sdk/v2/connectivity/models.py +++ b/foundry_sdk/v2/connectivity/models.py @@ -93,7 +93,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class AwsOidcAuthentication(pydantic.BaseModel): """ - [OpenID Connect (OIDC)](/docs/foundry/data-connection/oidc/) is an open authentication protocol that allows + [OpenID Connect (OIDC)](https://palantir.com/docs/foundry/data-connection/oidc/) is an open authentication protocol that allows you to authenticate to external system resources without the use of static credentials. """ @@ -141,7 +141,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class CloudIdentity(pydantic.BaseModel): """ - [Cloud identities](/docs/foundry/administration/configure-cloud-identities/) allow you to authenticate to + [Cloud identities](https://palantir.com/docs/foundry/administration/configure-cloud-identities/) allow you to authenticate to cloud provider resources without the use of static credentials. """ @@ -292,7 +292,7 @@ class CreateConnectionRequestRestConnectionConfiguration(pydantic.BaseModel): oauth2_client_rid: typing.Optional[core.RID] = pydantic.Field(alias=str("oauth2ClientRid"), default=None) # type: ignore[literal-required] """ - The RID of the [Outbound application](/docs/foundry/administration/configure-outbound-applications) that is used to authenticate to the external system via OAuth2. + The RID of the [Outbound application](https://palantir.com/docs/foundry/administration/configure-outbound-applications) that is used to authenticate to the external system via OAuth2. Currently, a connection may use only one outbound application for OAuth 2.0 authentication. Selecting a different outbound application will update the configuration for all domains with OAuth 2.0 as the selected authorization. """ @@ -629,7 +629,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: ], pydantic.Field(discriminator="type"), ] -"""The import configuration for a specific [connector type](/docs/foundry/data-integration/source-type-overview).""" +"""The import configuration for a specific [connector type](https://palantir.com/docs/foundry/data-integration/source-type-overview).""" class DateColumnInitialIncrementalState(pydantic.BaseModel): @@ -775,7 +775,7 @@ class FileImport(pydantic.BaseModel): display_name: FileImportDisplayName = pydantic.Field(alias=str("displayName")) # type: ignore[literal-required] file_import_filters: typing.List[FileImportFilter] = pydantic.Field(alias=str("fileImportFilters")) # type: ignore[literal-required] - """Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs)""" + """Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](https://palantir.com/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs)""" import_mode: FileImportMode = pydantic.Field(alias=str("importMode")) # type: ignore[literal-required] subfolder: typing.Optional[str] = None @@ -822,7 +822,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: pydantic.Field(discriminator="type"), ] """ -[Filters](/docs/foundry/data-connection/file-based-syncs/#filters) allow you to filter source files +[Filters](https://palantir.com/docs/foundry/data-connection/file-based-syncs/#filters) allow you to filter source files before they are imported into Foundry. """ @@ -1015,7 +1015,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class JdbcImportConfig(pydantic.BaseModel): - """The import configuration for a [custom JDBC connection](/docs/foundry/available-connectors/custom-jdbc-sources).""" + """The import configuration for a [custom JDBC connection](https://palantir.com/docs/foundry/available-connectors/custom-jdbc-sources).""" query: str """ @@ -1073,7 +1073,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class MicrosoftAccessImportConfig(pydantic.BaseModel): - """The import configuration for a [Microsoft Access connection](/docs/foundry/available-connectors/microsoft-access).""" + """The import configuration for a [Microsoft Access connection](https://palantir.com/docs/foundry/available-connectors/microsoft-access).""" query: str """ @@ -1092,7 +1092,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class MicrosoftSqlServerImportConfig(pydantic.BaseModel): - """The import configuration for a [Microsoft SQL Server connection](/docs/foundry/available-connectors/microsoft-sql-server).""" + """The import configuration for a [Microsoft SQL Server connection](https://palantir.com/docs/foundry/available-connectors/microsoft-sql-server).""" query: str """ @@ -1134,7 +1134,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class PostgreSqlImportConfig(pydantic.BaseModel): - """The import configuration for a [PostgreSQL connection](/docs/foundry/available-connectors/postgresql).""" + """The import configuration for a [PostgreSQL connection](https://palantir.com/docs/foundry/available-connectors/postgresql).""" query: str """ @@ -1191,7 +1191,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class RestConnectionConfiguration(pydantic.BaseModel): - """The configuration needed to connect to a [REST external system](/docs/foundry/available-connectors/rest-apis).""" + """The configuration needed to connect to a [REST external system](https://palantir.com/docs/foundry/available-connectors/rest-apis).""" domains: typing.List[Domain] """ @@ -1207,7 +1207,7 @@ class RestConnectionConfiguration(pydantic.BaseModel): oauth2_client_rid: typing.Optional[core.RID] = pydantic.Field(alias=str("oauth2ClientRid"), default=None) # type: ignore[literal-required] """ - The RID of the [Outbound application](/docs/foundry/administration/configure-outbound-applications) that is used to authenticate to the external system via OAuth2. + The RID of the [Outbound application](https://palantir.com/docs/foundry/administration/configure-outbound-applications) that is used to authenticate to the external system via OAuth2. Currently, a connection may use only one outbound application for OAuth 2.0 authentication. Selecting a different outbound application will update the configuration for all domains with OAuth 2.0 as the selected authorization. """ @@ -1222,7 +1222,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class RestConnectionOAuth2(pydantic.BaseModel): """ - In order to use OAuth2 you must have an Outbound application configured in the [Foundry Control Panel Organization settings](/docs/foundry/administration/configure-outbound-applications#create-an-outbound-application). + In order to use OAuth2 you must have an Outbound application configured in the [Foundry Control Panel Organization settings](https://palantir.com/docs/foundry/administration/configure-outbound-applications#create-an-outbound-application). The RID of the Outbound application must be configured in the RestConnectionConfiguration in the `oauth2ClientRid` field. """ @@ -1250,7 +1250,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class S3ConnectionConfiguration(pydantic.BaseModel): """ The configuration needed to connect to an [AWS S3 external system (or any other S3-like external systems that - implement the s3a protocol)](/docs/foundry/available-connectors/amazon-s3/#amazon-s3). + implement the s3a protocol)](https://palantir.com/docs/foundry/available-connectors/amazon-s3/#amazon-s3). """ bucket_url: str = pydantic.Field(alias=str("bucketUrl")) # type: ignore[literal-required] @@ -1541,7 +1541,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class SnowflakeTableImportConfig(pydantic.BaseModel): - """The table import configuration for a [Snowflake connection](/docs/foundry/available-connectors/snowflake).""" + """The table import configuration for a [Snowflake connection](https://palantir.com/docs/foundry/available-connectors/snowflake).""" query: str """ @@ -1659,7 +1659,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: ], pydantic.Field(discriminator="type"), ] -"""The import configuration for a specific [connector type](/docs/foundry/data-integration/source-type-overview).""" +"""The import configuration for a specific [connector type](https://palantir.com/docs/foundry/data-integration/source-type-overview).""" TableImportDisplayName = str diff --git a/foundry_sdk/v2/connectivity/table_import.py b/foundry_sdk/v2/connectivity/table_import.py index 76582fae8..d225c407e 100644 --- a/foundry_sdk/v2/connectivity/table_import.py +++ b/foundry_sdk/v2/connectivity/table_import.py @@ -216,7 +216,7 @@ def execute( _sdk_internal: core.SdkInternal = {}, ) -> core_models.BuildRid: """ - Executes the TableImport, which runs asynchronously as a [Foundry Build](/docs/foundry/data-integration/builds/). + Executes the TableImport, which runs asynchronously as a [Foundry Build](https://palantir.com/docs/foundry/data-integration/builds/). The returned BuildRid can be used to check the status via the Orchestration API. :param connection_rid: diff --git a/foundry_sdk/v2/core/models.py b/foundry_sdk/v2/core/models.py index 38d262928..1e25dcfd2 100644 --- a/foundry_sdk/v2/core/models.py +++ b/foundry_sdk/v2/core/models.py @@ -222,7 +222,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class Field(pydantic.BaseModel): """ A field in a Foundry schema. For more information on supported data types, see the - [supported field types](/docs/foundry/data-integration/datasets/#supported-field-types) user documentation. + [supported field types](https://palantir.com/docs/foundry/data-integration/datasets/#supported-field-types) user documentation. """ name: FieldName @@ -776,7 +776,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: """ The unique ID for a Role. Roles are sets of permissions that grant different levels of access to resources. The default roles in Foundry are: Owner, Editor, Viewer, and Discoverer. See more about -[roles](/docs/foundry/security/projects-and-roles#roles) in the user documentation. +[roles](https://palantir.com/docs/foundry/security/projects-and-roles#roles) in the user documentation. """ @@ -818,7 +818,7 @@ class StreamSchema(pydantic.BaseModel): - Timestamp For additional information on keys for Foundry streams, see the - [streaming keys](/docs/foundry/building-pipelines/streaming-keys/) user documentation. + [streaming keys](https://palantir.com/docs/foundry/building-pipelines/streaming-keys/) user documentation. """ change_data_capture: typing.Optional[ChangeDataCaptureConfiguration] = pydantic.Field(alias=str("changeDataCapture"), default=None) # type: ignore[literal-required] @@ -961,7 +961,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: least one key needs to be provided. For more information on CDC in -Foundry, see the [Change Data Capture](/docs/foundry/data-integration/change-data-capture/) user documentation. +Foundry, see the [Change Data Capture](https://palantir.com/docs/foundry/data-integration/change-data-capture/) user documentation. """ diff --git a/foundry_sdk/v2/datasets/file.py b/foundry_sdk/v2/datasets/file.py index 5e7a2b9fa..17776ae9d 100644 --- a/foundry_sdk/v2/datasets/file.py +++ b/foundry_sdk/v2/datasets/file.py @@ -66,7 +66,7 @@ def content( Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest view of the default branch - `master` for most enrollments. #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **get a file's content from a specific Branch** specify the Branch's name as `branchName`. This will retrieve the content for the most recent version of the file since the latest snapshot transaction, or the earliest ancestor transaction of the branch if there are no snapshot transactions. @@ -149,12 +149,12 @@ def delete( Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default branch - `master` for most enrollments. The file will still be visible on historical views. #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **delete a File from a specific Branch** specify the Branch's name as `branchName`. A new delete Transaction will be created and committed on this branch. To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a - single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to + single transaction. See [createTransaction](https://palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. :param dataset_rid: @@ -221,7 +221,7 @@ def get( Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest view of the default branch - `master` for most enrollments. #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **get a file's metadata from a specific Branch** specify the Branch's name as `branchName`. This will retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest ancestor transaction of the branch if there are no snapshot transactions. @@ -305,7 +305,7 @@ def list( Lists Files contained in a Dataset. By default files are listed on the latest view of the default branch - `master` for most enrollments. #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the branch if there are no snapshot transactions. @@ -392,14 +392,14 @@ def upload( By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments. If the file already exists only the most recent version will be visible in the updated view. #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + See [Datasets Core Concepts](https://palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions. To **upload a file to a specific Branch** specify the Branch's name as `branchName`. A new transaction will be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this default specify `transactionType` in addition to `branchName`. - See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. + See [createBranch](https://palantir.com/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as `transactionRid`. This is useful for uploading multiple files in a single transaction. - See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. + See [createTransaction](https://palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. :param dataset_rid: :type dataset_rid: DatasetRid diff --git a/foundry_sdk/v2/datasets/transaction.py b/foundry_sdk/v2/datasets/transaction.py index df3fc6306..ff5e6c76a 100644 --- a/foundry_sdk/v2/datasets/transaction.py +++ b/foundry_sdk/v2/datasets/transaction.py @@ -111,7 +111,7 @@ def build( _sdk_internal: core.SdkInternal = {}, ) -> typing.Optional[core_models.BuildRid]: """ - Get the [Build](/docs/foundry/data-integration/builds#builds) that computed the + Get the [Build](https://palantir.com/docs/foundry/data-integration/builds#builds) that computed the given Transaction. Not all Transactions have an associated Build. For example, if a Dataset is updated by a User uploading a CSV file into the browser, no Build will be tied to the Transaction. @@ -333,7 +333,7 @@ def job( _sdk_internal: core.SdkInternal = {}, ) -> typing.Optional[core_models.JobRid]: """ - Get the [Job](/docs/foundry/data-integration/builds#jobs-and-jobspecs) that computed the + Get the [Job](https://palantir.com/docs/foundry/data-integration/builds#jobs-and-jobspecs) that computed the given Transaction. Not all Transactions have an associated Job. For example, if a Dataset is updated by a User uploading a CSV file into the browser, no Job will be tied to the Transaction. diff --git a/foundry_sdk/v2/filesystem/models.py b/foundry_sdk/v2/filesystem/models.py index 2a2a82779..2c47fe488 100644 --- a/foundry_sdk/v2/filesystem/models.py +++ b/foundry_sdk/v2/filesystem/models.py @@ -109,8 +109,8 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: FolderType = typing.Literal["FOLDER", "SPACE", "PROJECT"] """ A folder can be a regular Folder, a -[Project](/docs/foundry/getting-started/projects-and-resources/#projects) or a -[Space](/docs/foundry/security/orgs-and-spaces/#spaces). +[Project](https://palantir.com/docs/foundry/getting-started/projects-and-resources/#projects) or a +[Space](https://palantir.com/docs/foundry/security/orgs-and-spaces/#spaces). """ @@ -183,7 +183,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class Marking(pydantic.BaseModel): """ - [Markings](/docs/foundry/security/markings/) provide an additional level of access control for files, + [Markings](https://palantir.com/docs/foundry/security/markings/) provide an additional level of access control for files, folders, and Projects within Foundry. Markings define eligibility criteria that restrict visibility and actions to users who meet those criteria. To access a resource, a user must be a member of all Markings applied to a resource to access it. @@ -200,7 +200,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class Organization(pydantic.BaseModel): """ - [Organizations](/docs/foundry/security/orgs-and-spaces/#organizations) are access requirements applied to + [Organizations](https://palantir.com/docs/foundry/security/orgs-and-spaces/#organizations) are access requirements applied to Projects that enforce strict silos between groups of users and resources. Every user is a member of only one Organization, but can be a guest member of multiple Organizations. In order to meet access requirements, users must be a member or guest member of at least one Organization applied to a Project. diff --git a/foundry_sdk/v2/media_sets/media_set.py b/foundry_sdk/v2/media_sets/media_set.py index c5aa74188..c068eeca5 100644 --- a/foundry_sdk/v2/media_sets/media_set.py +++ b/foundry_sdk/v2/media_sets/media_set.py @@ -381,7 +381,7 @@ def reference( _sdk_internal: core.SdkInternal = {}, ) -> core_models.MediaReference: """ - Gets the [media reference](/docs/foundry/data-integration/media-sets/#media-references) for this media item. + Gets the [media reference](https://palantir.com/docs/foundry/data-integration/media-sets/#media-references) for this media item. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:mediasets-read`. diff --git a/foundry_sdk/v2/ontologies/action.py b/foundry_sdk/v2/ontologies/action.py index 76abb4201..a87de6109 100644 --- a/foundry_sdk/v2/ontologies/action.py +++ b/foundry_sdk/v2/ontologies/action.py @@ -68,7 +68,7 @@ def apply( Changes to the Ontology are eventually consistent and may take some time to be visible. - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by + Note that [parameter default values](https://palantir.com/docs/foundry/action-types/parameters-default-value/) are not currently supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the @@ -151,7 +151,7 @@ def apply_batch( Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not call Functions may receive a higher limit. - Note that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + Note that [notifications](https://palantir.com/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read api:ontologies-write`. diff --git a/foundry_sdk/v2/ontologies/action_type.py b/foundry_sdk/v2/ontologies/action_type.py index 2647563af..8d2bb59a7 100644 --- a/foundry_sdk/v2/ontologies/action_type.py +++ b/foundry_sdk/v2/ontologies/action_type.py @@ -163,7 +163,7 @@ def list( :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. :type ontology: OntologyIdentifier - :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] diff --git a/foundry_sdk/v2/ontologies/linked_object.py b/foundry_sdk/v2/ontologies/linked_object.py index 97b34d603..b55c0ca11 100644 --- a/foundry_sdk/v2/ontologies/linked_object.py +++ b/foundry_sdk/v2/ontologies/linked_object.py @@ -178,7 +178,7 @@ def list_linked_objects( :type order_by: Optional[OrderBy] :param package_name: The package name of the generated SDK. :type package_name: Optional[SdkPackageName] - :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] diff --git a/foundry_sdk/v2/ontologies/models.py b/foundry_sdk/v2/ontologies/models.py index 789b0a493..4223475dd 100644 --- a/foundry_sdk/v2/ontologies/models.py +++ b/foundry_sdk/v2/ontologies/models.py @@ -2200,7 +2200,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: ObjectTypeId = str -"""The unique identifier (ID) for an object type. This can be viewed in [Ontology Manager](/docs/foundry/ontology-manager/overview/).""" +"""The unique identifier (ID) for an object type. This can be viewed in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/).""" class ObjectTypeInterfaceImplementation(pydantic.BaseModel): diff --git a/foundry_sdk/v2/ontologies/object_type.py b/foundry_sdk/v2/ontologies/object_type.py index 324553cf1..2e0e85c0d 100644 --- a/foundry_sdk/v2/ontologies/object_type.py +++ b/foundry_sdk/v2/ontologies/object_type.py @@ -221,7 +221,7 @@ def list( :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. :type ontology: OntologyIdentifier - :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] diff --git a/foundry_sdk/v2/ontologies/ontology_interface.py b/foundry_sdk/v2/ontologies/ontology_interface.py index 05d3a0195..3c9f26953 100644 --- a/foundry_sdk/v2/ontologies/ontology_interface.py +++ b/foundry_sdk/v2/ontologies/ontology_interface.py @@ -220,7 +220,7 @@ def list( :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. :type ontology: OntologyIdentifier - :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + :param page_size: The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] diff --git a/foundry_sdk/v2/ontologies/ontology_object.py b/foundry_sdk/v2/ontologies/ontology_object.py index fb4ccbe9b..14e9346a9 100644 --- a/foundry_sdk/v2/ontologies/ontology_object.py +++ b/foundry_sdk/v2/ontologies/ontology_object.py @@ -300,7 +300,7 @@ def list( :type order_by: Optional[OrderBy] :param package_name: The package name of the generated SDK. :type package_name: Optional[SdkPackageName] - :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + :param page_size: The desired size of the page to be returned. Defaults to 1,000. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] diff --git a/foundry_sdk/v2/ontologies/query_type.py b/foundry_sdk/v2/ontologies/query_type.py index 0d94fec7e..d77cf1caa 100644 --- a/foundry_sdk/v2/ontologies/query_type.py +++ b/foundry_sdk/v2/ontologies/query_type.py @@ -116,7 +116,7 @@ def list( :param ontology: The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. :type ontology: OntologyIdentifier - :param page_size: The desired size of the page to be returned. Defaults to 100. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + :param page_size: The desired size of the page to be returned. Defaults to 100. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details. :type page_size: Optional[PageSize] :param page_token: :type page_token: Optional[PageToken] diff --git a/foundry_sdk/v2/streams/dataset.py b/foundry_sdk/v2/streams/dataset.py index 88a0aae9e..dc4573e5b 100644 --- a/foundry_sdk/v2/streams/dataset.py +++ b/foundry_sdk/v2/streams/dataset.py @@ -82,7 +82,7 @@ def create( """ Creates a streaming dataset with a stream on the specified branch, or if no branch is specified, on the default branch ('master' for most enrollments). For more information on streaming datasets, refer to the - [streams](/docs/foundry/data-integration/streams/) user documentation. + [streams](https://palantir.com/docs/foundry/data-integration/streams/) user documentation. :param name: :type name: DatasetName diff --git a/foundry_sdk/v2/streams/models.py b/foundry_sdk/v2/streams/models.py index 4f9528eb0..1b138bb67 100644 --- a/foundry_sdk/v2/streams/models.py +++ b/foundry_sdk/v2/streams/models.py @@ -55,7 +55,7 @@ class CreateStreamRequestStreamSchema(pydantic.BaseModel): - Timestamp For additional information on keys for Foundry streams, see the - [streaming keys](/docs/foundry/building-pipelines/streaming-keys/) user documentation. + [streaming keys](https://palantir.com/docs/foundry/building-pipelines/streaming-keys/) user documentation. """ fields: typing.List[core_models.Field] @@ -133,7 +133,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: additional information on inspecting stream metrics, refer to the (stream monitoring)[/docs/foundry/data-integration/stream-monitoring/#viewing-metrics] documentation. -For more information, refer to the [stream types](/docs/foundry/data-integration/streams/#stream-types) +For more information, refer to the [stream types](https://palantir.com/docs/foundry/data-integration/streams/#stream-types) documentation. """ diff --git a/foundry_sdk/v2/third_party_applications/version.py b/foundry_sdk/v2/third_party_applications/version.py index 1fa8977db..bfff08ad2 100644 --- a/foundry_sdk/v2/third_party_applications/version.py +++ b/foundry_sdk/v2/third_party_applications/version.py @@ -213,7 +213,7 @@ def upload( Upload a new version of the Website. :param third_party_application_rid: An RID identifying a third-party application created in Developer Console. :type third_party_application_rid: ThirdPartyApplicationRid - :param body: The zip file that contains the contents of your application. For more information, refer to the [documentation](/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. + :param body: The zip file that contains the contents of your application. For more information, refer to the [documentation](https://palantir.com/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. :type body: bytes :param version: :type version: VersionVersion @@ -269,7 +269,7 @@ def upload_snapshot( :param third_party_application_rid: An RID identifying a third-party application created in Developer Console. :type third_party_application_rid: ThirdPartyApplicationRid - :param body: The zip file that contains the contents of your application. For more information, refer to the [documentation](/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. + :param body: The zip file that contains the contents of your application. For more information, refer to the [documentation](https://palantir.com/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. :type body: bytes :param version: :type version: VersionVersion From f980d676a955f1decb51d016a7dd2d0fcebf8951 Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Tue, 8 Apr 2025 13:23:49 -0300 Subject: [PATCH 08/11] update release notes --- changelog/@unreleased/pr-180.v2.yml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/changelog/@unreleased/pr-180.v2.yml b/changelog/@unreleased/pr-180.v2.yml index b394e515f..1cbc0478a 100644 --- a/changelog/@unreleased/pr-180.v2.yml +++ b/changelog/@unreleased/pr-180.v2.yml @@ -1,6 +1,11 @@ type: break break: - description: "### Migration Guide\n- The deprecated `page` operations have been + description: "### Migration Guide\n- The top level module was renamed from `foundry` to `foundry_sdk` to + resolve a name collision with the `foundry` package. This means that all imports + will need to be updated. For example, the following import:\n\n```python\nfrom + foundry import FoundryClient\n```\n\nwill need to be updated to:\n\n```python\nfrom + foundry_sdk import FoundryClient\n```\n + \n- The deprecated `page` operations have been removed in favor of the `list` operations. If you were still using the `page` methods, you can switch them to `list` instead.\n\n```python\npage = client.datasets.Dataset.Branch.page(dataset_rid, page_size=page_size) # before\npage = client.datasets.Dataset.Branch.list(dataset_rid, From 7fea887a98363ed84ac6062bcf0b8eabe1799877 Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Tue, 8 Apr 2025 13:26:32 -0300 Subject: [PATCH 09/11] fix --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index e3f33aae2..c64d9582a 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,7 @@ import the **v2** client from a sub-module you would import it like this: ```python from foundry_sdk.v2 import FoundryClient +``` More information about how the API is versioned can be found [here](https://www.palantir.com/docs/foundry_sdk/api/general/overview/versioning/). From 8b23a2990c9a00669ea8a2adba553aca60eba089 Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Tue, 8 Apr 2025 13:40:35 -0300 Subject: [PATCH 10/11] fix readme --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c64d9582a..d04a5d497 100644 --- a/README.md +++ b/README.md @@ -439,7 +439,8 @@ the following environment variables (in order of precedence): The SDK will only check for the presence of these environment variables if the `verify` option is set to `True` (the default value). If `verify` is set to False, the environment variables will be ignored. -> [!NOTE] If you are using an HTTPS proxy server, the `verify` value will be passed to the proxy's +> [!IMPORTANT] +> If you are using an HTTPS proxy server, the `verify` value will be passed to the proxy's > SSL context as well. ## Common errors From ebf6ebc8146a429eb2b89d734ece6ff76550f722 Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Tue, 8 Apr 2025 13:48:02 -0300 Subject: [PATCH 11/11] fix reference --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d04a5d497..59a25e952 100644 --- a/README.md +++ b/README.md @@ -297,11 +297,11 @@ There are a handful of other exception classes that could be thrown when instant ## Pagination -When calling any iterator endpoints, we return a `Pager` class designed to simplify the process of working +When calling any iterator endpoints, we return a `ResourceIterator` class designed to simplify the process of working with paginated API endpoints. This class provides a convenient way to fetch, iterate over, and manage pages of data, while handling the underlying pagination logic. -To iterate over all items, you can simply create a `Pager` instance and use it in a for loop, like this: +To iterate over all items, you can simply create a `ResourceIterator` instance and use it in a for loop, like this: ```python for item in client.datasets.Dataset.Branch.list(dataset_rid):