@osdk/client.unstable 2.8.0-beta.3 → 2.8.0-beta.30

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

@@ -38,6 +38,18 @@ export type ActionApplyClientPreferences = ActionApplyClientPreferences_disallow
 export interface ActionApplyDisallowedClients {
 	disallowedFrontendConsumer: Array<ActionTypeFrontendConsumer>;
 }
+/**
+* Contains the definition for platform effects that are executed as part of running an Action.
+*/
+export interface ActionEffects {
+	synchronousPreWritebackEffect?: SynchronousPreWritebackEffect | null | undefined;
+}
+/**
+* See ActionEffects docs.
+*/
+export interface ActionEffectsModification {
+	synchronousPreWritebackEffect?: SynchronousPreWritebackEffectModification | null | undefined;
+}
 export interface ActionLogConfiguration {
 	actionLogSummary: Array<ActionLogSummaryPart>;
 }
@@ -507,6 +519,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;
@@ -514,8 +528,10 @@ export interface ActionTypeCreate {
 	apiName: ActionTypeApiName;
 	branchSettings?: ActionTypeBranchSettingsModification | null | undefined;
 	displayMetadata: ActionTypeDisplayMetadataModification;
+	effects?: ActionEffectsModification | null | undefined;
 	formContentOrdering: Array<FormContent>;
 	logic: ActionLogicModification;
+	markings: Array<MarkingId>;
 	notifications: Array<ActionNotificationModification>;
 	notificationSettings?: ActionNotificationSettings | null | undefined;
 	packageRid?: OntologyPackageRid | null | undefined;
@@ -524,6 +540,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 +566,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 +591,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;
@@ -732,6 +755,7 @@ export interface ActionTypeLoadVersionedResponse {
 	actionTypes: Array<ActionType>;
 }
 export interface ActionTypeLogic {
+	effects?: ActionEffects | null | undefined;
 	logic: ActionLogic;
 	notifications: Array<ActionNotification>;
 	revert?: ActionRevert | null | undefined;
@@ -739,6 +763,7 @@ export interface ActionTypeLogic {
 	webhooks?: ActionWebhooks | null | undefined;
 }
 export interface ActionTypeLogicRequest {
+	effects?: ActionEffects | null | undefined;
 	logic: ActionLogic;
 	notifications: Array<ActionNotification>;
 	revert?: ActionRevert | null | undefined;
@@ -761,6 +786,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 +809,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 +825,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 +906,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 +962,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;
@@ -925,6 +971,7 @@ export interface ActionTypeUpdate {
 	apiName: ActionTypeApiName;
 	branchSettings?: ActionTypeBranchSettingsModification | null | undefined;
 	displayMetadata: ActionTypeDisplayMetadataModification;
+	effects?: ActionEffectsModification | null | undefined;
 	formContentOrdering?: Array<FormContent> | null | undefined;
 	logic: ActionLogicModification;
 	notifications: Array<ActionNotificationModification>;
@@ -935,6 +982,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 +1562,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 +1857,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";
@@ -1835,6 +1892,10 @@ export interface CarbonWorkspaceUrlTargetModification {
 	resource?: CarbonWorkspaceComponentUrlTargetModification | null | undefined;
 }
 /**
+* Display name for a marking category.
+*/
+export type CategoryDisplayName = string | null | undefined;
+/**
 * Id for a category (group of markings)
 */
 export type CategoryId = string;
@@ -2611,12 +2672,15 @@ 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;
 	apiName: ActionTypeApiName;
 	branchSettings?: ActionTypeBranchSettingsModification | null | undefined;
 	displayMetadata: ActionTypeDisplayMetadataModification;
+	effects?: ActionEffects | null | undefined;
 	logic: ActionLogic;
 	notifications: Array<ActionNotification>;
 	notificationSettings?: ActionNotificationSettings | null | undefined;
@@ -2625,6 +2689,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 +2703,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 +2729,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 +2758,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 +2955,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;
@@ -3248,6 +3328,41 @@ export interface IntegerTypeRangeConstraint {
 	max?: IntegerTypeDataValue | null | undefined;
 	min?: IntegerTypeDataValue | null | undefined;
 }
+export interface InterfaceActionTypeConstraint {
+	metadata: InterfaceActionTypeConstraintMetadata;
+	parameters: Record<InterfaceParameterConstraintRid, InterfaceParameterConstraint>;
+	requireImplementation: boolean;
+	rid: InterfaceActionTypeConstraintRid;
+}
+/**
+* A string indicating the API name to use for the interface action type constraint. This API name will be used to
+* reference the interface action type constraint in programming languages. The name should be given in
+* lowerCamelCase and should be unique across the interface and the superset of its parent interfaces.
+*/
+export type InterfaceActionTypeConstraintApiName = string;
+/**
+* Reference to an InterfaceActionTypeConstraint. Used to reference an InterfaceActionTypeConstraint in the same
+* request it is created in.
+*/
+export type InterfaceActionTypeConstraintIdInRequest = string;
+export interface InterfaceActionTypeConstraintMetadata {
+	apiName: InterfaceActionTypeConstraintApiName;
+	description: string;
+	displayName: string;
+}
+/**
+* ResourceIdentifier for an InterfaceActionTypeConstraint.
+*/
+export type InterfaceActionTypeConstraintRid = string;
+export interface InterfaceActionTypeConstraintRidOrIdInRequest_rid {
+	type: "rid";
+	rid: InterfaceActionTypeConstraintRid;
+}
+export interface InterfaceActionTypeConstraintRidOrIdInRequest_idInRequest {
+	type: "idInRequest";
+	idInRequest: InterfaceActionTypeConstraintIdInRequest;
+}
+export type InterfaceActionTypeConstraintRidOrIdInRequest = InterfaceActionTypeConstraintRidOrIdInRequest_rid | InterfaceActionTypeConstraintRidOrIdInRequest_idInRequest;
 export interface InterfaceArrayPropertyType {
 	subtype: InterfacePropertyTypeType;
 }
@@ -3338,6 +3453,28 @@ export interface InterfaceObjectParameterStructListFieldValueModification {
 	parameterId: ParameterId;
 	structFieldApiNameOrRid: StructFieldApiNameOrRid;
 }
+/**
+* Parameter constraint of an InterfaceActionTypeConstraint
+*/
+export interface InterfaceParameterConstraint {
+	displayMetadata: InterfaceParameterConstraintDisplayMetadata;
+	requireImplementation: boolean;
+	type: _api_types_BaseParameterType;
+}
+export interface InterfaceParameterConstraintDisplayMetadata {
+	displayName: string;
+}
+export type InterfaceParameterConstraintIdInRequest = string;
+export type InterfaceParameterConstraintRid = string;
+export interface InterfaceParameterConstraintRidOrIdInRequest_rid {
+	type: "rid";
+	rid: InterfaceParameterConstraintRid;
+}
+export interface InterfaceParameterConstraintRidOrIdInRequest_idInRequest {
+	type: "idInRequest";
+	idInRequest: InterfaceParameterConstraintIdInRequest;
+}
+export type InterfaceParameterConstraintRidOrIdInRequest = InterfaceParameterConstraintRidOrIdInRequest_rid | InterfaceParameterConstraintRidOrIdInRequest_idInRequest;
 export interface InterfaceParameterPropertyValue {
 	parameterId: ParameterId;
 	sharedPropertyTypeRid: SharedPropertyTypeRid;
@@ -3542,6 +3679,7 @@ export interface InterfaceStructPropertyType {
 * interface, it is guaranteed to have the conform to the interface shape.
 */
 export interface InterfaceType {
+	actionTypeConstraints: Array<InterfaceActionTypeConstraint>;
 	allExtendsInterfaces: Array<InterfaceTypeRid>;
 	allLinks: Array<InterfaceLinkType>;
 	allProperties: Array<SharedPropertyType>;
@@ -4352,11 +4490,15 @@ export interface LogicRuleValue_synchronousWebhookOutput {
 	type: "synchronousWebhookOutput";
 	synchronousWebhookOutput: WebhookOutputParamName;
 }
+export interface LogicRuleValue_scheduleRunRid {
+	type: "scheduleRunRid";
+	scheduleRunRid: ScheduleRunRidValue;
+}
 /**
 * These are the possible values that can be passed into LogicRules as well as Notification and Webhook side
 * effects.
 */
-export type LogicRuleValue = LogicRuleValue_parameterId | LogicRuleValue_staticValue | LogicRuleValue_objectParameterPropertyValue | LogicRuleValue_interfaceParameterPropertyValue | LogicRuleValue_interfaceParameterPropertyValueV2 | LogicRuleValue_currentUser | LogicRuleValue_currentTime | LogicRuleValue_uniqueIdentifier | LogicRuleValue_synchronousWebhookOutput;
+export type LogicRuleValue = LogicRuleValue_parameterId | LogicRuleValue_staticValue | LogicRuleValue_objectParameterPropertyValue | LogicRuleValue_interfaceParameterPropertyValue | LogicRuleValue_interfaceParameterPropertyValueV2 | LogicRuleValue_currentUser | LogicRuleValue_currentTime | LogicRuleValue_uniqueIdentifier | LogicRuleValue_synchronousWebhookOutput | LogicRuleValue_scheduleRunRid;
 export interface LogicRuleValueModification_parameterId {
 	type: "parameterId";
 	parameterId: ParameterId;
@@ -4393,11 +4535,15 @@ export interface LogicRuleValueModification_synchronousWebhookOutput {
 	type: "synchronousWebhookOutput";
 	synchronousWebhookOutput: WebhookOutputParamName;
 }
+export interface LogicRuleValueModification_scheduleRunRid {
+	type: "scheduleRunRid";
+	scheduleRunRid: ScheduleRunRidValue;
+}
 /**
 * These are the possible values that can be passed into LogicRules as well as Notification and Webhook side
 * effects.
 */
-export type LogicRuleValueModification = LogicRuleValueModification_parameterId | LogicRuleValueModification_staticValue | LogicRuleValueModification_objectParameterPropertyValue | LogicRuleValueModification_interfaceParameterPropertyValue | LogicRuleValueModification_interfaceParameterPropertyValueV2 | LogicRuleValueModification_currentUser | LogicRuleValueModification_currentTime | LogicRuleValueModification_uniqueIdentifier | LogicRuleValueModification_synchronousWebhookOutput;
+export type LogicRuleValueModification = LogicRuleValueModification_parameterId | LogicRuleValueModification_staticValue | LogicRuleValueModification_objectParameterPropertyValue | LogicRuleValueModification_interfaceParameterPropertyValue | LogicRuleValueModification_interfaceParameterPropertyValueV2 | LogicRuleValueModification_currentUser | LogicRuleValueModification_currentTime | LogicRuleValueModification_uniqueIdentifier | LogicRuleValueModification_synchronousWebhookOutput | LogicRuleValueModification_scheduleRunRid;
 export interface LongPropertyType {}
 export interface LongTypeDataConstraints_range {
 	type: "range";
@@ -4494,9 +4640,11 @@ export type MarkingFilter = MarkingFilter_markingTypes;
 */
 export type MarkingId = string;
 /**
-* Combined information about a marking including its type and optional display name.
+* Combined information about a marking including its type, optional display name,
+* and optional category display name.
 */
 export interface MarkingInfo {
+	categoryDisplayName: CategoryDisplayName;
 	displayName: MarkingDisplayName;
 	markingType: MarkingType;
 }
@@ -4693,6 +4841,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 +4965,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 +5101,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 +5460,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 +5539,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 +5705,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 +5941,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>;
@@ -5802,6 +5985,12 @@ export interface OntologyInformation {
 	displayName: string;
 }
 /**
+* Contains the definition for platform effects that are executed as part of running an Action.
+*/
+export interface OntologyIrActionEffects {
+	synchronousPreWritebackEffect?: OntologyIrSynchronousPreWritebackEffect | null | undefined;
+}
+/**
 * The ActionLogic in an ActionType map the Parameters to what edits should be made in Phonograph. It employs
 * LogicRules for the core Action logic and, optionally, an ActionLogRule for capturing a record of the Action
 * execution. We don't allow the mixing of FunctionRule with other LogicRules in the same ActionType.
@@ -6241,7 +6430,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";
@@ -6918,11 +7108,15 @@ export interface OntologyIrLogicRuleValue_synchronousWebhookOutput {
 	type: "synchronousWebhookOutput";
 	synchronousWebhookOutput: WebhookOutputParamName;
 }
+export interface OntologyIrLogicRuleValue_scheduleRunRid {
+	type: "scheduleRunRid";
+	scheduleRunRid: ScheduleRunRidValue;
+}
 /**
 * These are the possible values that can be passed into LogicRules as well as Notification and Webhook side
 * effects.
 */
-export type OntologyIrLogicRuleValue = OntologyIrLogicRuleValue_parameterId | OntologyIrLogicRuleValue_staticValue | OntologyIrLogicRuleValue_objectParameterPropertyValue | OntologyIrLogicRuleValue_interfaceParameterPropertyValue | OntologyIrLogicRuleValue_currentUser | OntologyIrLogicRuleValue_currentTime | OntologyIrLogicRuleValue_uniqueIdentifier | OntologyIrLogicRuleValue_synchronousWebhookOutput;
+export type OntologyIrLogicRuleValue = OntologyIrLogicRuleValue_parameterId | OntologyIrLogicRuleValue_staticValue | OntologyIrLogicRuleValue_objectParameterPropertyValue | OntologyIrLogicRuleValue_interfaceParameterPropertyValue | OntologyIrLogicRuleValue_currentUser | OntologyIrLogicRuleValue_currentTime | OntologyIrLogicRuleValue_uniqueIdentifier | OntologyIrLogicRuleValue_synchronousWebhookOutput | OntologyIrLogicRuleValue_scheduleRunRid;
 /**
 * Contains a set of markings that represent the mandatory security of this datasource.
 */
@@ -7156,7 +7350,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 +7579,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"
@@ -7961,6 +8160,16 @@ export interface OntologyIrRuleSetBinding {
 	ruleSetRid: RuleSetRid;
 }
 /**
+* This effect calls SchedulerDeploymentsService.upsertAndRunDeployment endpoint which upserts a schedule
+* deployment and runs it. See the Scheduler API docs for more details.
+* The synchronous effect doesn't wait for the actual schedule run to complete, it only waits for a successful
+* kick-off of the schedule run.
+*/
+export interface OntologyIrRunScheduleDeploymentEffect {
+	parameterValues: Record<ScheduleParamName, OntologyIrLogicRuleValue>;
+	scheduleRid: ScheduleRid;
+}
+/**
 * Applies the edits from a specified Scenario instance to the main branch
 */
 export interface OntologyIrScenarioRule {
@@ -8076,6 +8285,7 @@ export interface OntologyIrSecurityGroupMandatoryOnlySecurityDefinition {
 }
 export interface OntologyIrSecurityGroupMandatoryPolicy {
 	assumedMarkings: Array<MarkingId>;
+	assumedMarkingsV2: Record<MarkingId, MarkingType>;
 	markings: Record<MarkingId, MarkingType>;
 }
 /**
@@ -8283,7 +8493,8 @@ export interface OntologyIrStructFieldValidationDisplayMetadata {
 	visibility: _api_types_ParameterVisibility;
 }
 export interface OntologyIrStructMainValue {
-	fields: Array<StructFieldRid>;
+	fieldApiNames: Array<ObjectTypeFieldApiName>;
+	structApiName: ObjectTypeFieldApiName;
 	type: OntologyIrType;
 }
 export interface OntologyIrStructPropertyType {
@@ -8312,6 +8523,14 @@ export interface OntologyIrSubtractionOperation {
 	leftOperand: OntologyIrParameterTransformPrefillValue;
 	rightOperand: OntologyIrParameterTransformPrefillValue;
 }
+export interface OntologyIrSynchronousPreWritebackEffect_runScheduleDeployment {
+	type: "runScheduleDeployment";
+	runScheduleDeployment: OntologyIrRunScheduleDeploymentEffect;
+}
+/**
+* Union wrapping the various options available for configuring a platform effect which will be executed synchronously.
+*/
+export type OntologyIrSynchronousPreWritebackEffect = OntologyIrSynchronousPreWritebackEffect_runScheduleDeployment;
 export interface OntologyIrSynchronousPreWritebackWebhook_staticDirectInput {
 	type: "staticDirectInput";
 	staticDirectInput: OntologyIrStaticWebhookWithDirectInput;
@@ -9821,6 +10040,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 +10073,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 +10119,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,12 +10376,15 @@ 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;
 	apiName: ActionTypeApiName;
 	branchSettings?: ActionTypeBranchSettingsModification | null | undefined;
 	displayMetadata: ActionTypeDisplayMetadataModification;
+	effects?: ActionEffects | null | undefined;
 	logic: ActionLogic;
 	notifications: Array<ActionNotification>;
 	notificationSettings?: ActionNotificationSettings | null | undefined;
@@ -10129,6 +10398,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 +10416,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>;
@@ -10408,6 +10681,23 @@ export interface RuleSetsAlreadyExistError {
 export interface RuleSetsNotFoundError {
 	ruleSetRids: Array<RuleSetRid>;
 }
+/**
+* This effect calls SchedulerDeploymentsService.upsertAndRunDeployment endpoint which upserts a schedule
+* deployment and runs it. See the Scheduler API docs for more details.
+* The synchronous effect doesn't wait for the actual schedule run to complete, it only waits for a successful
+* kick-off of the schedule run.
+*/
+export interface RunScheduleDeploymentEffect {
+	parameterValues: Record<ScheduleParamName, LogicRuleValue>;
+	scheduleRid: ScheduleRid;
+}
+/**
+* See RunScheduleDeploymentEffect docs.
+*/
+export interface RunScheduleDeploymentEffectModification {
+	parameterValues: Record<ScheduleParamName, LogicRuleValue>;
+	scheduleRid: ScheduleRid;
+}
 export interface SafeArg {
 	name: string;
 	value: string;
@@ -10492,6 +10782,18 @@ export interface ScenarioScope {
 	objectTypes: Array<ObjectTypeId>;
 }
 /**
+* Name of a schedule parameter. Not safe to log.
+*/
+export type ScheduleParamName = string;
+/**
+* The rid for a Schedule, generated and owned by Scheduler service.
+*/
+export type ScheduleRid = string;
+/**
+* The resulting schedule run RID of a synchronous RunScheduleDeploymentEffect on the Action type.
+*/
+export interface ScheduleRunRidValue {}
+/**
 * Identifier for a schema migration.
 */
 export type SchemaMigrationRid = string;
@@ -11557,6 +11859,22 @@ export interface SubtractionOperation {
 	leftOperand: ParameterTransformPrefillValue;
 	rightOperand: ParameterTransformPrefillValue;
 }
+export interface SynchronousPreWritebackEffect_runScheduleDeployment {
+	type: "runScheduleDeployment";
+	runScheduleDeployment: RunScheduleDeploymentEffect;
+}
+/**
+* Union wrapping the various options available for configuring a platform effect which will be executed synchronously.
+*/
+export type SynchronousPreWritebackEffect = SynchronousPreWritebackEffect_runScheduleDeployment;
+export interface SynchronousPreWritebackEffectModification_runScheduleDeployment {
+	type: "runScheduleDeployment";
+	runScheduleDeployment: RunScheduleDeploymentEffectModification;
+}
+/**
+* See SynchronousPreWritebackEffect docs.
+*/
+export type SynchronousPreWritebackEffectModification = SynchronousPreWritebackEffectModification_runScheduleDeployment;
 export interface SynchronousPreWritebackWebhook_staticDirectInput {
 	type: "staticDirectInput";
 	staticDirectInput: StaticWebhookWithDirectInput;
@@ -11637,9 +11955,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 {