@osdk/client.unstable 2.7.1 → 2.8.0-beta.10

package/build/types/generated/ontology-metadata/api/__components.d.ts

@@ -507,6 +507,8 @@ export interface ActionTypeBranchWebhooksMode_disableWebhooksOnBranches {
 export type ActionTypeBranchWebhooksMode = ActionTypeBranchWebhooksMode_allowWebhooksOnBranches | ActionTypeBranchWebhooksMode_disableWebhooksOnBranches;
 /**
 * A ActionTypeCreate is used to create ActionTypes.
+*
+* Used in OntologyModificationRequest.
 */
 export interface ActionTypeCreate {
 	actionApplyClientSettings?: ActionApplyClientPreferences | null | undefined;
@@ -516,6 +518,7 @@ export interface ActionTypeCreate {
 	displayMetadata: ActionTypeDisplayMetadataModification;
 	formContentOrdering: Array<FormContent>;
 	logic: ActionLogicModification;
+	markings: Array<MarkingId>;
 	notifications: Array<ActionNotificationModification>;
 	notificationSettings?: ActionNotificationSettings | null | undefined;
 	packageRid?: OntologyPackageRid | null | undefined;
@@ -524,6 +527,7 @@ export interface ActionTypeCreate {
 	projectRid?: CompassFolderRid | null | undefined;
 	provenance?: ActionTypeProvenanceModification | null | undefined;
 	revert?: ActionRevert | null | undefined;
+	scenarioSettings?: ActionTypeScenarioSettingsModification | null | undefined;
 	sections: Record<SectionId, PutSectionRequestModification>;
 	status?: ActionTypeStatus | null | undefined;
 	submissionConfiguration?: ActionSubmissionConfiguration | null | undefined;
@@ -549,12 +553,15 @@ export interface ActionTypeDeletedEvent {
 * DisplayMetadata shape used in responses
 */
 export interface ActionTypeDisplayMetadata {
+	applyingMessage: Array<ActionTypeRichTextComponent>;
+	applyingMessageEnabled: boolean;
 	configuration: ActionTypeDisplayMetadataConfiguration;
 	description: string;
 	displayName: string;
 	icon?: Icon | null | undefined;
 	submitButtonDisplayMetadata?: ButtonDisplayMetadata | null | undefined;
 	successMessage: Array<ActionTypeRichTextComponent>;
+	successMessageEnabled: boolean;
 	toolDescription?: string | null | undefined;
 	typeClasses: Array<TypeClass>;
 	undoButtonConfiguration?: boolean | null | undefined;
@@ -571,12 +578,15 @@ export interface ActionTypeDisplayMetadataConfiguration {
 * DisplayMetadata shape used in requests
 */
 export interface ActionTypeDisplayMetadataModification {
+	applyingMessage: Array<ActionTypeRichTextComponent>;
+	applyingMessageEnabled?: boolean | null | undefined;
 	configuration?: ActionTypeDisplayMetadataConfiguration | null | undefined;
 	description: string;
 	displayName: string;
 	icon?: Icon | null | undefined;
 	submitButtonDisplayMetadata?: ButtonDisplayMetadata | null | undefined;
 	successMessage: Array<ActionTypeRichTextComponent>;
+	successMessageEnabled?: boolean | null | undefined;
 	toolDescription?: string | null | undefined;
 	typeClasses: Array<TypeClass>;
 	undoButtonConfiguration?: boolean | null | undefined;
@@ -761,6 +771,7 @@ export interface ActionTypeMetadata {
 	parameters: Record<ParameterId, Parameter>;
 	provenance?: _api_entitymetadata_provenance_ActionTypeProvenance | null | undefined;
 	rid: ActionTypeRid;
+	scenarioSettings: ActionTypeScenarioSettings;
 	sections: Record<SectionId, Section>;
 	stagingMediaSetRid?: MediaSetRid | null | undefined;
 	status: ActionTypeStatus;
@@ -783,6 +794,7 @@ export interface ActionTypeMetadataModification {
 	parameters: Record<ParameterId, Parameter>;
 	provenance?: _api_entitymetadata_provenance_ActionTypeProvenance | null | undefined;
 	rid: ActionTypeRid;
+	scenarioSettings?: ActionTypeScenarioSettingsModification | null | undefined;
 	sections: Record<SectionId, Section>;
 	stagingMediaSetRid?: MediaSetRid | null | undefined;
 	status: ActionTypeStatus;
@@ -798,6 +810,8 @@ export interface ActionTypeModificationRequest {
 }
 /**
 * Request used to modify ActionTypes.
+*
+* Deprecated: Use OntologyModificationRequest with ActionTypeCreate and ActionTypeUpdate instead.
 */
 export interface ActionTypeModifyRequest {
 	actionsVersion?: ActionsVersion | null | undefined;
@@ -877,6 +891,21 @@ export type ActionTypeRid = string;
 export interface ActionTypesAlreadyExistError {
 	actionTypeRids: Array<ActionTypeRid>;
 }
+export interface ActionTypeScenarioExecutionOnlyMode_allowExecutionOnlyOnScenario {
+	type: "allowExecutionOnlyOnScenario";
+	allowExecutionOnlyOnScenario: AllowExecutionOnlyOnScenario;
+}
+export interface ActionTypeScenarioExecutionOnlyMode_noExecutionRestriction {
+	type: "noExecutionRestriction";
+	noExecutionRestriction: NoExecutionRestriction;
+}
+export type ActionTypeScenarioExecutionOnlyMode = ActionTypeScenarioExecutionOnlyMode_allowExecutionOnlyOnScenario | ActionTypeScenarioExecutionOnlyMode_noExecutionRestriction;
+export interface ActionTypeScenarioSettings {
+	scenarioExecutionOnlyMode: ActionTypeScenarioExecutionOnlyMode;
+}
+export interface ActionTypeScenarioSettingsModification {
+	scenarioExecutionOnlyMode?: ActionTypeScenarioExecutionOnlyMode | null | undefined;
+}
 /**
 * Request to associate given set of OrganizationRids with the specified ActionTypeRid(s).
 * Users should have permissions to modify the specified ActionTypeRid(s) and also have
@@ -918,6 +947,8 @@ export interface ActionTypeStatus_example {
 export type ActionTypeStatus = ActionTypeStatus_experimental | ActionTypeStatus_active | ActionTypeStatus_deprecated | ActionTypeStatus_example;
 /**
 * Request object to edit existing Action Types.
+*
+* Used in OntologyModificationRequest.
 */
 export interface ActionTypeUpdate {
 	actionApplyClientSettings?: ActionApplyClientPreferences | null | undefined;
@@ -935,6 +966,7 @@ export interface ActionTypeUpdate {
 	parametersToUpdate: Record<ParameterRid, EditParameterRequestModification>;
 	provenance?: ActionTypeProvenanceModification | null | undefined;
 	revert?: ActionRevert | null | undefined;
+	scenarioSettings?: ActionTypeScenarioSettingsModification | null | undefined;
 	sectionsToCreate: Record<SectionId, PutSectionRequestModification>;
 	sectionsToDelete: Array<SectionRid>;
 	sectionsToUpdate: Record<SectionRid, EditSectionRequestModification>;
@@ -1514,6 +1546,10 @@ export interface AllowedValuesOverrideModification {
 export interface AllowedValuesOverrideRequest {
 	allowedValues: AllowedParameterValuesRequest;
 }
+/**
+* When set, the action can only be executed within a Scenario context and not directly on the main ontology.
+*/
+export interface AllowExecutionOnlyOnScenario {}
 export interface AllowFunctionsWithExternalCallsOnBranches {}
 export interface AllowNotificationsOnBranches {
 	branchRecipients: AllowNotificationsOnBranchesBranchRecipients;
@@ -1805,6 +1841,11 @@ export interface ButtonDisplayMetadata {
 	text: string;
 }
 export interface BytePropertyType {}
+/**
+* Specifies the unit of the input byte size value, ensuring that the formatter correctly interprets the number.
+* All units use binary (base-1024) representation.
+*/
+export type BytesBaseValue = "BYTES" | "KILOBYTES" | "MEGABYTES" | "GIGABYTES" | "TERABYTES" | "PETABYTES";
 export type ByteTypeDataValue = number;
 export interface CarbonWorkspaceComponentUrlTarget_rid {
 	type: "rid";
@@ -2611,6 +2652,8 @@ export interface DynamicObjectSetInputUnioned {
 }
 /**
 * Request object to edit existing Action Types.
+*
+* Deprecated: Used in deprecated ActionTypeModifyRequest. Use ActionTypeUpdate with OntologyModificationRequest instead.
 */
 export interface EditActionTypeRequest {
 	actionLogConfiguration?: ActionLogConfiguration | null | undefined;
@@ -2625,6 +2668,7 @@ export interface EditActionTypeRequest {
 	parametersToDelete: Array<ParameterRid>;
 	parametersToEdit: Record<ParameterRid, EditParameterRequest>;
 	revert?: ActionRevert | null | undefined;
+	scenarioSettings?: ActionTypeScenarioSettingsModification | null | undefined;
 	status?: ActionTypeStatus | null | undefined;
 	submissionConfiguration?: ActionSubmissionConfiguration | null | undefined;
 	validationsToAdd: Array<ValidationRule>;
@@ -2638,6 +2682,8 @@ export interface EditActionTypeRequest {
 export interface EditOnlyPropertyType {}
 /**
 * Request to edit an existing parameter
+*
+* Deprecated: Used in deprecated ActionTypeModifyRequest. Use EditParameterRequestModification with OntologyModificationRequest instead.
 */
 export interface EditParameterRequest {
 	displayMetadata: ParameterDisplayMetadata;
@@ -2662,6 +2708,8 @@ export interface EditsConfiguration {
 }
 /**
 * Request to edit an existing Section
+*
+* Deprecated: Used in deprecated ActionTypeModifyRequest. Use EditSectionRequestModification with OntologyModificationRequest instead.
 */
 export interface EditSectionRequest {
 	content: Array<SectionContent>;
@@ -2689,6 +2737,9 @@ export type EditsHistoryObjectTypeRid = string;
 * must be a valid Compass project RID. If one is not specified, DatasourceRid will be used.
 */
 export type EditsOnlyRid = string;
+/**
+* Deprecated: Used in deprecated ActionTypeModifyRequest. Use ValidationRuleModification with OntologyModificationRequest instead.
+*/
 export interface EditValidationRuleRequest {
 	condition: Condition;
 	displayMetadata: ValidationRuleDisplayMetadata;
@@ -2883,6 +2934,14 @@ export interface FunctionAtVersion {
 	functionRid: FunctionRid;
 	functionVersion: SemanticFunctionVersion;
 }
+/**
+* An embedding model backed by a function registered in function-registry
+* and executed via function-executor.
+*/
+export interface FunctionBackedEmbeddingModel {
+	functionRid: FunctionRid;
+	functionVersion: FunctionVersion;
+}
 export interface FunctionExecutionWithRecipientInput_logicRuleValue {
 	type: "logicRuleValue";
 	logicRuleValue: LogicRuleValue;
@@ -4693,6 +4752,10 @@ export interface NewObjectUrlTargetModification {
 	keys: Record<PropertyId, LogicRuleValueModification>;
 	objectTypeId: ObjectTypeId;
 }
+/**
+* When set, no restriction is applied and the action can be executed both on the main ontology and within Scenarios.
+*/
+export interface NoExecutionRestriction {}
 export interface NoneEntityProvenance {}
 /**
 * Some ParameterPrefill(s) are referencing ParameterId(s) that do not exist on the ActionType.
@@ -4813,6 +4876,15 @@ export interface NumberFormatBillions {
 	base: NumberFormatBase;
 }
 /**
+* Render the number as bytes, automatically converting to the appropriate size (KB, MB, GB, etc)
+* and appending the corresponding suffix. Uses binary units (powers of 1024).
+*/
+export interface NumberFormatBytes {
+	base: NumberFormatBase;
+	baseValue: BytesBaseValue;
+	showFullUnits?: boolean | null | undefined;
+}
+/**
 * Note that non-visual features e.g. sorting & histograms, are not guaranteed to be currency-aware. They can
 * group the same number together even if they have different currencies.
 */
@@ -4940,7 +5012,11 @@ export interface NumberFormatter_basisPoint {
 	type: "basisPoint";
 	basisPoint: NumberFormatBasisPoint;
 }
-export type NumberFormatter = NumberFormatter_base | NumberFormatter_percentage | NumberFormatter_perMille | NumberFormatter_ordinal | NumberFormatter_currency | NumberFormatter_unit | NumberFormatter_customUnit | NumberFormatter_prePost | NumberFormatter_duration | NumberFormatter_thousands | NumberFormatter_millions | NumberFormatter_billions | NumberFormatter_basisPoint;
+export interface NumberFormatter_bytes {
+	type: "bytes";
+	bytes: NumberFormatBytes;
+}
+export type NumberFormatter = NumberFormatter_base | NumberFormatter_percentage | NumberFormatter_perMille | NumberFormatter_ordinal | NumberFormatter_currency | NumberFormatter_unit | NumberFormatter_customUnit | NumberFormatter_prePost | NumberFormatter_duration | NumberFormatter_thousands | NumberFormatter_millions | NumberFormatter_billions | NumberFormatter_basisPoint | NumberFormatter_bytes;
 /**
 * Scale the numeric value to thousands and append a suffix. For example, 1500 will be displayed as "1.5K".
 */
@@ -5295,6 +5371,7 @@ export interface ObjectTypeDirectDatasource {
 	propertyMapping: Record<PropertyTypeRid, PropertyTypeMappingInfo>;
 	propertySecurityGroups: PropertySecurityGroups;
 	retentionConfig?: RetentionConfig | null | undefined;
+	timeBasedRetentionConfig?: TimeBasedRetentionConfig | null | undefined;
 }
 /**
 * This includes metadata which can be used by front-ends when displaying the ObjectType.
@@ -5373,6 +5450,10 @@ export interface ObjectTypeGeotimeSeriesDatasource {
 * Please note that this is not safe to log as it is user-inputted and may contain sensitive information.
 */
 export type ObjectTypeId = string;
+export interface ObjectTypeIdAndPropertyTypeId {
+	objectTypeId: ObjectTypeId;
+	propertyTypeId: PropertyTypeId;
+}
 export interface ObjectTypeIdentifier_objectTypeId {
 	type: "objectTypeId";
 	objectTypeId: ObjectTypeId;
@@ -5535,6 +5616,18 @@ export interface ObjectTypeRestrictedViewDatasourceV2 {
 * ObjectTypeRid will be different.
 */
 export type ObjectTypeRid = string;
+export interface ObjectTypeRidOrInterfaceTypeRidOrIdInRequest_objectType {
+	type: "objectType";
+	objectType: ObjectTypeRid;
+}
+export interface ObjectTypeRidOrInterfaceTypeRidOrIdInRequest_interfaceType {
+	type: "interfaceType";
+	interfaceType: InterfaceTypeRidOrIdInRequest;
+}
+/**
+* Either an ObjectTypeRid or an InterfaceTypeRidOrIdInRequest.
+*/
+export type ObjectTypeRidOrInterfaceTypeRidOrIdInRequest = ObjectTypeRidOrInterfaceTypeRidOrIdInRequest_objectType | ObjectTypeRidOrInterfaceTypeRidOrIdInRequest_interfaceType;
 /**
 * A wrapping of ObjectType rids and InterfaceType rids, used when returning information from API name conflict
 * checks.
@@ -5759,6 +5852,7 @@ export interface OntologyBulkLoadEntitiesRequest {
 	includeTypeGroupEntitiesCount?: boolean | null | undefined;
 	interfaceTypes: Array<InterfaceTypeLoadRequest>;
 	linkTypes: Array<LinkTypeLoadRequest>;
+	loadLinkTypeRelatedObjectTypes?: boolean | null | undefined;
 	loadRedacted?: boolean | null | undefined;
 	objectTypes: Array<ObjectTypeLoadRequest>;
 	sharedPropertyTypes: Array<SharedPropertyTypeLoadRequest>;
@@ -6241,7 +6335,8 @@ export interface OntologyIrArrayPropertyType {
 }
 export interface OntologyIrArrayPropertyTypeReducer {
 	direction: ArrayPropertyTypeReducerSortDirection;
-	field?: StructFieldRid | null | undefined;
+	fieldApiName?: ObjectTypeFieldApiName | null | undefined;
+	structApiName?: ObjectTypeFieldApiName | null | undefined;
 }
 export interface OntologyIrAsynchronousPostWritebackWebhook_staticDirectInput {
 	type: "staticDirectInput";
@@ -7156,7 +7251,11 @@ export interface OntologyIrNumberFormatter_basisPoint {
 	type: "basisPoint";
 	basisPoint: NumberFormatBasisPoint;
 }
-export type OntologyIrNumberFormatter = OntologyIrNumberFormatter_base | OntologyIrNumberFormatter_percentage | OntologyIrNumberFormatter_perMille | OntologyIrNumberFormatter_ordinal | OntologyIrNumberFormatter_currency | OntologyIrNumberFormatter_unit | OntologyIrNumberFormatter_customUnit | OntologyIrNumberFormatter_prePost | OntologyIrNumberFormatter_duration | OntologyIrNumberFormatter_thousands | OntologyIrNumberFormatter_millions | OntologyIrNumberFormatter_billions | OntologyIrNumberFormatter_basisPoint;
+export interface OntologyIrNumberFormatter_bytes {
+	type: "bytes";
+	bytes: NumberFormatBytes;
+}
+export type OntologyIrNumberFormatter = OntologyIrNumberFormatter_base | OntologyIrNumberFormatter_percentage | OntologyIrNumberFormatter_perMille | OntologyIrNumberFormatter_ordinal | OntologyIrNumberFormatter_currency | OntologyIrNumberFormatter_unit | OntologyIrNumberFormatter_customUnit | OntologyIrNumberFormatter_prePost | OntologyIrNumberFormatter_duration | OntologyIrNumberFormatter_thousands | OntologyIrNumberFormatter_millions | OntologyIrNumberFormatter_billions | OntologyIrNumberFormatter_basisPoint | OntologyIrNumberFormatter_bytes;
 /**
 * Note that this formatter breaks e.g. sorting features if used in combination with auto-conversion.
 */
@@ -7381,10 +7480,11 @@ export interface OntologyIrObjectTypeDerivedPropertiesDatasource {
 * This type is only compatible with object storage v2.
 */
 export interface OntologyIrObjectTypeDirectDatasource {
-	directSourceRid: DirectSourceRid;
+	directSourceRid: _api_blockdata_DataSetName;
 	propertyMapping: Record<ObjectTypeFieldApiName, PropertyTypeMappingInfo>;
 	propertySecurityGroups: OntologyIrPropertySecurityGroups;
 	retentionConfig?: RetentionConfig | null | undefined;
+	timeBasedRetentionConfig?: TimeBasedRetentionConfig | null | undefined;
 }
 /**
 * Object type datasource which is not backed by any dataset or restricted view. This type of a "datasource"
@@ -8076,6 +8176,7 @@ export interface OntologyIrSecurityGroupMandatoryOnlySecurityDefinition {
 }
 export interface OntologyIrSecurityGroupMandatoryPolicy {
 	assumedMarkings: Array<MarkingId>;
+	assumedMarkingsV2: Record<MarkingId, MarkingType>;
 	markings: Record<MarkingId, MarkingType>;
 }
 /**
@@ -8283,7 +8384,8 @@ export interface OntologyIrStructFieldValidationDisplayMetadata {
 	visibility: _api_types_ParameterVisibility;
 }
 export interface OntologyIrStructMainValue {
-	fields: Array<StructFieldRid>;
+	fieldApiNames: Array<ObjectTypeFieldApiName>;
+	structApiName: ObjectTypeFieldApiName;
 	type: OntologyIrType;
 }
 export interface OntologyIrStructPropertyType {
@@ -9821,6 +9923,20 @@ export interface PropertySecurityGroup {
 	type?: PropertySecurityGroupType | null | undefined;
 }
 /**
+* Creates a new PSG. A RID will be generated.
+*/
+export interface PropertySecurityGroupCreate {
+	properties: Array<PropertyTypeId>;
+	security: SecurityGroupSecurityDefinitionModification;
+	type: PropertySecurityGroupType;
+}
+/**
+* Deletes an existing PSG by RID.
+*/
+export interface PropertySecurityGroupDelete {
+	rid: PropertySecurityGroupRid;
+}
+/**
 * Modification of PropertySecurityGroup. A globally unique identifier will be generated for each unique
 * SecurityGroupSecurityDefinitionModification specification.
 *
@@ -9840,6 +9956,29 @@ export interface PropertySecurityGroupModification {
 */
 export type PropertySecurityGroupName = string;
 /**
+* Leaves the specified PSG unchanged.
+*/
+export interface PropertySecurityGroupNoop {
+	rid: PropertySecurityGroupRid;
+}
+export interface PropertySecurityGroupPatch_create {
+	type: "create";
+	create: PropertySecurityGroupCreate;
+}
+export interface PropertySecurityGroupPatch_update {
+	type: "update";
+	update: PropertySecurityGroupUpdate;
+}
+export interface PropertySecurityGroupPatch_noop {
+	type: "noop";
+	noop: PropertySecurityGroupNoop;
+}
+export interface PropertySecurityGroupPatch_delete {
+	type: "delete";
+	delete: PropertySecurityGroupDelete;
+}
+export type PropertySecurityGroupPatch = PropertySecurityGroupPatch_create | PropertySecurityGroupPatch_update | PropertySecurityGroupPatch_noop | PropertySecurityGroupPatch_delete;
+/**
 * A randomly generated rid that identifies a unique PropertySecurityGroup.
 */
 export type PropertySecurityGroupRid = string;
@@ -9863,6 +10002,16 @@ export interface PropertySecurityGroupType_property {
 }
 export type PropertySecurityGroupType = PropertySecurityGroupType_primaryKey | PropertySecurityGroupType_property;
 /**
+* Updates an existing PSG by RID. Note that the rid of a PSG remains stable unless the security definition is
+* updated, in which case a new rid will be generated.
+*/
+export interface PropertySecurityGroupUpdate {
+	properties: Array<PropertyTypeId>;
+	rid: PropertySecurityGroupRid;
+	security: SecurityGroupSecurityDefinitionModification;
+	type: PropertySecurityGroupType;
+}
+/**
 * A PropertyType is a typed attribute of an ObjectType.
 */
 export interface PropertyType {
@@ -10110,6 +10259,8 @@ export interface PropertyWithoutRid {
 }
 /**
 * A PutActionTypeRequest is used to create or modify Action Types.
+*
+* Deprecated: Used in deprecated ActionTypeModifyRequest. Use ActionTypeCreate with OntologyModificationRequest instead.
 */
 export interface PutActionTypeRequest {
 	actionLogConfiguration?: ActionLogConfiguration | null | undefined;
@@ -10129,6 +10280,8 @@ export interface PutActionTypeRequest {
 }
 /**
 * A PutParameterRequest is used to create or modify Parameters.
+*
+* Deprecated: Used in deprecated ActionTypeModifyRequest. Use PutParameterRequestModification with OntologyModificationRequest instead.
 */
 export interface PutParameterRequest {
 	displayMetadata: ParameterDisplayMetadata;
@@ -10145,6 +10298,8 @@ export interface PutParameterRequestModification {
 }
 /**
 * A PutSectionRequest is used to create or modify Sections.
+*
+* Deprecated: Used in deprecated ActionTypeModifyRequest. Use PutSectionRequestModification with OntologyModificationRequest instead.
 */
 export interface PutSectionRequest {
 	content: Array<SectionContent>;
@@ -11637,9 +11792,21 @@ export interface TextEmbeddingModel_foundryLiveDeployment {
 	type: "foundryLiveDeployment";
 	foundryLiveDeployment: FoundryLiveDeployment;
 }
-export type TextEmbeddingModel = TextEmbeddingModel_lms | TextEmbeddingModel_foundryLiveDeployment;
+export interface TextEmbeddingModel_functionBacked {
+	type: "functionBacked";
+	functionBacked: FunctionBackedEmbeddingModel;
+}
+export type TextEmbeddingModel = TextEmbeddingModel_lms | TextEmbeddingModel_foundryLiveDeployment | TextEmbeddingModel_functionBacked;
 export interface TextModality {}
 /**
+* Time-based retention configuration for direct datasources. Objects older than the retention window will be
+* permanently deleted. The duration should be specified in ISO8601 format, such as `P30D` (30 days) or
+* `PT720H` (720 hours).
+*/
+export interface TimeBasedRetentionConfig {
+	window: string;
+}
+/**
 * A retention policy where the datasource will contain at least data from the specified time window.
 */
 export interface TimeBasedRetentionPolicy {