@osdk/client.unstable 2.3.0-beta.8 → 2.3.0-beta.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/build/cjs/index.d.cts +87 -6
  3. package/build/types/generated/ontology-metadata/api/OntologyMetadataSearchService/getObjectTypeSemanticSearchStatus.d.ts +7 -0
  4. package/build/types/generated/ontology-metadata/api/OntologyMetadataSearchService/getObjectTypeSemanticSearchStatus.d.ts.map +1 -0
  5. package/build/types/generated/ontology-metadata/api/OntologyMetadataSearchService.d.ts +1 -0
  6. package/build/types/generated/ontology-metadata/api/OntologyMetadataSearchService.d.ts.map +1 -1
  7. package/build/types/generated/ontology-metadata/api/__components.d.ts +74 -3
  8. package/build/types/generated/ontology-metadata/api/__components.d.ts.map +1 -1
  9. package/build/types/generated/ontology-metadata/api/audit/__components.d.ts +6 -2
  10. package/build/types/generated/ontology-metadata/api/audit/__components.d.ts.map +1 -1
  11. package/build/types/generated/ontology-metadata/api/audit/index.d.ts +1 -1
  12. package/build/types/generated/ontology-metadata/api/audit/index.d.ts.map +1 -1
  13. package/build/types/generated/ontology-metadata/api/index.d.ts +1 -1
  14. package/build/types/generated/ontology-metadata/api/index.d.ts.map +1 -1
  15. package/build/types/generated/ontology-metadata/api/modification/__components.d.ts +6 -1
  16. package/build/types/generated/ontology-metadata/api/modification/__components.d.ts.map +1 -1
  17. package/build/types/generated/ontology-metadata/api/provenance/__components.d.ts +2 -0
  18. package/build/types/generated/ontology-metadata/api/provenance/__components.d.ts.map +1 -1
  19. package/build/types/generated/ontology-metadata/api/search/__components.d.ts +12 -0
  20. package/build/types/generated/ontology-metadata/api/search/__components.d.ts.map +1 -1
  21. package/build/types/generated/ontology-metadata/api/search/index.d.ts +1 -1
  22. package/build/types/generated/ontology-metadata/api/search/index.d.ts.map +1 -1
  23. package/build/types/generated/ontology-metadata/api/typemapping/__components.d.ts +1 -1
  24. package/build/types/generated/ontology-metadata/api/typemapping/__components.d.ts.map +1 -1
  25. package/build/types/generated/ontology-metadata/api/types/__components.d.ts +9 -1
  26. package/build/types/generated/ontology-metadata/api/types/__components.d.ts.map +1 -1
  27. package/build/types/generated/ontology-metadata/api/types/index.d.ts +1 -1
  28. package/build/types/generated/ontology-metadata/api/types/index.d.ts.map +1 -1
  29. package/build/types/generated/ontology-metadata/api/usage/__components.d.ts +2 -1
  30. package/build/types/generated/ontology-metadata/api/usage/__components.d.ts.map +1 -1
  31. package/build/types/generated/ontology-metadata/api/validation/__components.d.ts +70 -6
  32. package/build/types/generated/ontology-metadata/api/validation/__components.d.ts.map +1 -1
  33. package/build/types/generated/ontology-metadata/api/validation/index.d.ts +1 -1
  34. package/build/types/generated/ontology-metadata/api/validation/index.d.ts.map +1 -1
  35. package/build/types/generated/ontology-metadata/branch/api/OntologyBranchService/discardChangesOnBranch.d.ts +3 -0
  36. package/build/types/generated/ontology-metadata/branch/api/OntologyBranchService/discardChangesOnBranch.d.ts.map +1 -1
  37. package/build/types/generated/ontology-metadata/branch/api/OntologyBranchService/discardChangesOnBranchV2.d.ts +12 -0
  38. package/build/types/generated/ontology-metadata/branch/api/OntologyBranchService/discardChangesOnBranchV2.d.ts.map +1 -0
  39. package/build/types/generated/ontology-metadata/branch/api/OntologyBranchService.d.ts +1 -0
  40. package/build/types/generated/ontology-metadata/branch/api/OntologyBranchService.d.ts.map +1 -1
  41. package/build/types/generated/ontology-metadata/branch/api/__components.d.ts +44 -1
  42. package/build/types/generated/ontology-metadata/branch/api/__components.d.ts.map +1 -1
  43. package/build/types/generated/ontology-metadata/branch/api/index.d.ts +1 -1
  44. package/build/types/generated/ontology-metadata/branch/api/index.d.ts.map +1 -1
  45. package/package.json +3 -3
@@ -0,0 +1,7 @@
1
+ import { type ConjureContext } from "conjure-lite";
2
+ import type { GetObjectTypeSemanticSearchStatusResponse as _api_search_GetObjectTypeSemanticSearchStatusResponse } from "../search/__components.js";
3
+ /**
4
+ * Endpoint to check if semantic search on object types is available for the requesting user.
5
+ * Returns whether it is enabled and, if not, the primary reason why it is disabled.
6
+ */
7
+ export declare function getObjectTypeSemanticSearchStatus(ctx: ConjureContext): Promise<_api_search_GetObjectTypeSemanticSearchStatusResponse>;
@@ -0,0 +1 @@
1
+ {"mappings":"AAgBA,cAAc,sBAAoC,cAAe;AACjE,cAAc,6CAA6C,6DAA6D,2BAA4B;;;;;AAMpJ,OAAO,iBAAe,kCACpBA,KAAK,iBACJ,QAAQ","names":["ctx: ConjureContext"],"sources":["../../../../../../src/generated/ontology-metadata/api/OntologyMetadataSearchService/getObjectTypeSemanticSearchStatus.ts"],"version":3,"file":"getObjectTypeSemanticSearchStatus.d.ts"}
@@ -1,3 +1,4 @@
1
+ export { getObjectTypeSemanticSearchStatus } from "./OntologyMetadataSearchService/getObjectTypeSemanticSearchStatus.js";
1
2
  export { objectTypes } from "./OntologyMetadataSearchService/objectTypes.js";
2
3
  export { searchActionTypes } from "./OntologyMetadataSearchService/searchActionTypes.js";
3
4
  export { searchInterfaceTypes } from "./OntologyMetadataSearchService/searchInterfaceTypes.js";
@@ -1 +1 @@
1
- {"mappings":"AAgBA,SAAS,mBAAmB;AAC5B,SAAS,yBAAyB;AAClC,SAAS,4BAA4B;AACrC,SAAS,yBAAyB;AAClC,SAAS,iCAAiC;AAC1C,SAAS,wBAAwB","names":[],"sources":["../../../../../src/generated/ontology-metadata/api/OntologyMetadataSearchService.ts"],"version":3,"file":"OntologyMetadataSearchService.d.ts"}
1
+ {"mappings":"AAgBA,SAAS,yCAAyC;AAClD,SAAS,mBAAmB;AAC5B,SAAS,yBAAyB;AAClC,SAAS,4BAA4B;AACrC,SAAS,yBAAyB;AAClC,SAAS,iCAAiC;AAC1C,SAAS,wBAAwB","names":[],"sources":["../../../../../src/generated/ontology-metadata/api/OntologyMetadataSearchService.ts"],"version":3,"file":"OntologyMetadataSearchService.d.ts"}
@@ -653,6 +653,7 @@ export interface ActionTypeMetadata {
653
653
  provenance?: _api_entitymetadata_provenance_ActionTypeProvenance | null | undefined;
654
654
  rid: ActionTypeRid;
655
655
  sections: Record<SectionId, Section>;
656
+ stagingMediaSetRid?: MediaSetRid | null | undefined;
656
657
  status: ActionTypeStatus;
657
658
  submissionConfiguration?: ActionSubmissionConfiguration | null | undefined;
658
659
  version: ActionTypeVersion;
@@ -673,6 +674,7 @@ export interface ActionTypeMetadataModification {
673
674
  provenance?: _api_entitymetadata_provenance_ActionTypeProvenance | null | undefined;
674
675
  rid: ActionTypeRid;
675
676
  sections: Record<SectionId, Section>;
677
+ stagingMediaSetRid?: MediaSetRid | null | undefined;
676
678
  status: ActionTypeStatus;
677
679
  submissionConfiguration?: ActionSubmissionConfiguration | null | undefined;
678
680
  version: ActionTypeVersion;
@@ -2586,6 +2588,7 @@ export interface GetActionTypesForInterfaceTypeRequest {
2586
2588
  ontologyVersion?: OntologyVersion | null | undefined;
2587
2589
  pageSize?: number | null | undefined;
2588
2590
  pageToken?: GetActionTypesForInterfaceTypePageToken | null | undefined;
2591
+ versionReference?: VersionReference | null | undefined;
2589
2592
  }
2590
2593
  /**
2591
2594
  * Response to GetActionTypesForInterfaceTypeRequest.
@@ -2607,6 +2610,7 @@ export interface GetActionTypesForObjectTypeRequest {
2607
2610
  ontologyVersion?: OntologyVersion | null | undefined;
2608
2611
  pageSize?: number | null | undefined;
2609
2612
  pageToken?: GetActionTypesForObjectTypePageToken | null | undefined;
2613
+ versionReference?: VersionReference | null | undefined;
2610
2614
  }
2611
2615
  /**
2612
2616
  * Response to GetActionTypesForObjectTypeRequest.
@@ -2642,6 +2646,7 @@ export interface GetLinkMetadataForObjectTypesResponse {
2642
2646
  * Request to batch get LinkType(s) for ObjectType(s).
2643
2647
  */
2644
2648
  export interface GetLinkTypesForObjectTypesRequest {
2649
+ includeLinkTypesForDerivedPropertyLinkDefinitions?: boolean | null | undefined;
2645
2650
  includeObjectTypesWithoutSearchableDatasources?: boolean | null | undefined;
2646
2651
  loadRedacted?: boolean | null | undefined;
2647
2652
  objectTypeBranches: Record<ObjectTypeRid, OntologyBranchRid | null | undefined>;
@@ -2660,6 +2665,7 @@ export interface GetLinkTypesForObjectTypesResponse {
2660
2665
  export interface GetObjectTypesForInterfaceTypesRequest {
2661
2666
  interfaceTypeRids: Array<InterfaceTypeRid>;
2662
2667
  ontologyVersion?: OntologyVersion | null | undefined;
2668
+ versionReference?: VersionReference | null | undefined;
2663
2669
  }
2664
2670
  /**
2665
2671
  * Response to GetObjectTypesForInterfaceTypesRequest.
@@ -2673,6 +2679,7 @@ export interface GetObjectTypesForInterfaceTypesResponse {
2673
2679
  export interface GetObjectTypesForSharedPropertyTypesRequest {
2674
2680
  ontologyVersion?: OntologyVersion | null | undefined;
2675
2681
  sharedPropertyTypeRids: Array<SharedPropertyTypeRid>;
2682
+ versionReference?: VersionReference | null | undefined;
2676
2683
  }
2677
2684
  /**
2678
2685
  * Response to GetObjectTypesForSharedPropertyTypesRequest.
@@ -2841,6 +2848,17 @@ export interface InterfaceParameterPropertyValueModification {
2841
2848
  export interface InterfacePropertyImplementation {
2842
2849
  propertyTypeRid: PropertyTypeRid;
2843
2850
  }
2851
+ export interface InterfacePropertyType_sharedPropertyBasedPropertyType {
2852
+ type: "sharedPropertyBasedPropertyType";
2853
+ sharedPropertyBasedPropertyType: SharedPropertyBasedPropertyType;
2854
+ }
2855
+ export type InterfacePropertyType = InterfacePropertyType_sharedPropertyBasedPropertyType;
2856
+ export type InterfacePropertyTypeApiName = string;
2857
+ export interface InterfacePropertyTypeDisplayMetadata {
2858
+ description?: string | null | undefined;
2859
+ displayName: string;
2860
+ visibility: Visibility;
2861
+ }
2844
2862
  /**
2845
2863
  * Reference to a InterfacePropertyType. Used when referencing an InterfacePropertyType in the same request it is
2846
2864
  * created in.
@@ -2876,13 +2894,16 @@ export interface InterfaceType {
2876
2894
  allLinks: Array<InterfaceLinkType>;
2877
2895
  allProperties: Array<SharedPropertyType>;
2878
2896
  allPropertiesV2: Record<SharedPropertyTypeRid, InterfaceSharedPropertyType>;
2897
+ allPropertiesV3: Record<InterfacePropertyTypeRid, ResolvedInterfacePropertyType>;
2879
2898
  apiName: InterfaceTypeApiName;
2880
2899
  displayMetadata: InterfaceTypeDisplayMetadata;
2881
2900
  extendsInterfaces: Array<InterfaceTypeRid>;
2882
2901
  links: Array<InterfaceLinkType>;
2883
2902
  properties: Array<SharedPropertyType>;
2884
2903
  propertiesV2: Record<SharedPropertyTypeRid, InterfaceSharedPropertyType>;
2904
+ propertiesV3: Record<InterfacePropertyTypeRid, InterfacePropertyType>;
2885
2905
  rid: InterfaceTypeRid;
2906
+ searchable?: boolean | null | undefined;
2886
2907
  status: InterfaceTypeStatus;
2887
2908
  }
2888
2909
  /**
@@ -3036,7 +3057,7 @@ export interface LabelledValue {
3036
3057
  * A language-specific analyzer. Since some aren't provided natively with Elasticsearch, ontology-metadata cannot
3037
3058
  * guarantee that a given language-specific analyzer will be available for use.
3038
3059
  */
3039
- export type LanguageAnalyzer = "FRENCH" | "JAPANESE" | "ARABIC" | "COMBINED_ARABIC_ENGLISH";
3060
+ export type LanguageAnalyzer = "FRENCH" | "JAPANESE" | "KOREAN" | "ARABIC" | "COMBINED_ARABIC_ENGLISH";
3040
3061
  /**
3041
3062
  * ResourceIdentifier for lime indexes.
3042
3063
  */
@@ -3092,6 +3113,7 @@ export type LinkMetadata = LinkMetadata_linkType | LinkMetadata_softLink;
3092
3113
  */
3093
3114
  export interface LinkType {
3094
3115
  definition: LinkDefinition;
3116
+ description?: string | null | undefined;
3095
3117
  id: LinkTypeId;
3096
3118
  redacted?: boolean | null | undefined;
3097
3119
  rid: LinkTypeRid;
@@ -3640,9 +3662,10 @@ export interface LongTypeRangeConstraint {
3640
3662
  min?: LongTypeDataValue | null | undefined;
3641
3663
  }
3642
3664
  /**
3643
- * All mandatory marking properties linked to this datasource must only contain values within this set. It must have at least one marking specified. Note that Organization MarkingIds are not allowed in this set.
3665
+ * Contains a set of markings that represent the mandatory security of this datasource.
3644
3666
  */
3645
3667
  export interface MandatoryMarkingConstraint {
3668
+ allowEmptyMarkings?: boolean | null | undefined;
3646
3669
  markingIds: Array<MarkingId>;
3647
3670
  }
3648
3671
  export interface ManyToManyJoinDefinition {
@@ -3797,6 +3820,7 @@ export interface MissingAffectedObjectTypesForFunctionRule {
3797
3820
  functionVersion: SemanticFunctionVersion;
3798
3821
  missingAffectedObjectTypes: Array<ObjectTypeRid>;
3799
3822
  }
3823
+ export interface MissingParameterValueType {}
3800
3824
  export interface ModifyInterfaceRule {
3801
3825
  interfaceObjectToModify: ParameterId;
3802
3826
  sharedPropertyValues: Record<SharedPropertyTypeRid, LogicRuleValue>;
@@ -5113,6 +5137,7 @@ export interface OntologyIrActionTypeMetadata {
5113
5137
  parameterOrdering: Array<ParameterId>;
5114
5138
  parameters: Record<ParameterId, OntologyIrParameter>;
5115
5139
  sections: Record<SectionId, OntologyIrSection>;
5140
+ stagingMediaSetRid?: MediaSetRid | null | undefined;
5116
5141
  status: OntologyIrActionTypeStatus;
5117
5142
  }
5118
5143
  export interface OntologyIrActionTypeRichTextComponent_message {
@@ -5683,6 +5708,11 @@ export interface OntologyIrInterfaceParameterPropertyValue {
5683
5708
  export interface OntologyIrInterfacePropertyImplementation {
5684
5709
  propertyTypeRid: ObjectTypeFieldApiName;
5685
5710
  }
5711
+ export interface OntologyIrInterfacePropertyType_sharedPropertyBasedPropertyType {
5712
+ type: "sharedPropertyBasedPropertyType";
5713
+ sharedPropertyBasedPropertyType: OntologyIrSharedPropertyBasedPropertyType;
5714
+ }
5715
+ export type OntologyIrInterfacePropertyType = OntologyIrInterfacePropertyType_sharedPropertyBasedPropertyType;
5686
5716
  export interface OntologyIrInterfaceSharedPropertyType {
5687
5717
  required: boolean;
5688
5718
  sharedPropertyType: OntologyIrSharedPropertyType;
@@ -5696,12 +5726,15 @@ export interface OntologyIrInterfaceType {
5696
5726
  allLinks: Array<OntologyIrInterfaceLinkType>;
5697
5727
  allProperties: Array<OntologyIrSharedPropertyType>;
5698
5728
  allPropertiesV2: Record<ObjectTypeFieldApiName, OntologyIrInterfaceSharedPropertyType>;
5729
+ allPropertiesV3: Record<InterfacePropertyTypeApiName, OntologyIrResolvedInterfacePropertyType>;
5699
5730
  apiName: InterfaceTypeApiName;
5700
5731
  displayMetadata: InterfaceTypeDisplayMetadata;
5701
5732
  extendsInterfaces: Array<InterfaceTypeApiName>;
5702
5733
  links: Array<OntologyIrInterfaceLinkType>;
5703
5734
  properties: Array<OntologyIrSharedPropertyType>;
5704
5735
  propertiesV2: Record<ObjectTypeFieldApiName, OntologyIrInterfaceSharedPropertyType>;
5736
+ propertiesV3: Record<InterfacePropertyTypeApiName, OntologyIrInterfacePropertyType>;
5737
+ searchable?: boolean | null | undefined;
5705
5738
  status: OntologyIrInterfaceTypeStatus;
5706
5739
  }
5707
5740
  export interface OntologyIrInterfaceTypeStatus_experimental {
@@ -5769,6 +5802,7 @@ export type OntologyIrLinkedEntityTypeId = OntologyIrLinkedEntityTypeId_objectTy
5769
5802
  */
5770
5803
  export interface OntologyIrLinkType {
5771
5804
  definition: OntologyIrLinkDefinition;
5805
+ description?: string | null | undefined;
5772
5806
  id: LinkTypeId;
5773
5807
  redacted?: boolean | null | undefined;
5774
5808
  status: OntologyIrLinkTypeStatus;
@@ -6785,6 +6819,16 @@ export interface OntologyIrRegexCondition {
6785
6819
  value: OntologyIrConditionValue;
6786
6820
  }
6787
6821
  /**
6822
+ * All information about the shape of the interface property. For now this all comes from shared properties, but
6823
+ * in the future it can also come from property constraints defined on the interface.
6824
+ */
6825
+ export interface OntologyIrResolvedInterfacePropertyType {
6826
+ apiName: InterfacePropertyTypeApiName;
6827
+ displayMetadata: InterfacePropertyTypeDisplayMetadata;
6828
+ rid: InterfacePropertyTypeApiName;
6829
+ type: OntologyIrType;
6830
+ }
6831
+ /**
6788
6832
  * A URL target for a Foundry rid with query params.
6789
6833
  */
6790
6834
  export interface OntologyIrRidUrlTarget {
@@ -6940,6 +6984,10 @@ export interface OntologyIrSeriesValueMetadata_numericOrNonNumericV2 {
6940
6984
  numericOrNonNumericV2: OntologyIrNumericOrNonNumericSeriesValueMetadataV2;
6941
6985
  }
6942
6986
  export type OntologyIrSeriesValueMetadata = OntologyIrSeriesValueMetadata_numeric | OntologyIrSeriesValueMetadata_enum | OntologyIrSeriesValueMetadata_numericOrNonNumeric | OntologyIrSeriesValueMetadata_numericOrNonNumericV2;
6987
+ export interface OntologyIrSharedPropertyBasedPropertyType {
6988
+ requireImplementation: boolean;
6989
+ sharedPropertyType: OntologyIrSharedPropertyType;
6990
+ }
6943
6991
  /**
6944
6992
  * A property type that can be shared across object types.
6945
6993
  */
@@ -8275,7 +8323,16 @@ export interface ParameterValueTypeOrEmpty_valueType {
8275
8323
  type: "valueType";
8276
8324
  valueType: ParameterValueType;
8277
8325
  }
8278
- export type ParameterValueTypeOrEmpty = ParameterValueTypeOrEmpty_valueType;
8326
+ export interface ParameterValueTypeOrEmpty_missingParameterValueType {
8327
+ type: "missingParameterValueType";
8328
+ missingParameterValueType: MissingParameterValueType;
8329
+ }
8330
+ /**
8331
+ * When a value type is deleted, and it is present on an action type's parameter, the parameter's allowed values
8332
+ * will become MissingParameterValueType. When users try to run an action with MissingParameterValueType, Actions
8333
+ * will throw an error.
8334
+ */
8335
+ export type ParameterValueTypeOrEmpty = ParameterValueTypeOrEmpty_valueType | ParameterValueTypeOrEmpty_missingParameterValueType;
8279
8336
  export interface PartialObjectType {
8280
8337
  authorizationRidColumnLocator?: ColumnLocator | null | undefined;
8281
8338
  description?: string | null | undefined;
@@ -8860,6 +8917,16 @@ export interface RenderingSettings_anyNotificationRenderingCanFail {
8860
8917
  */
8861
8918
  export type RenderingSettings = RenderingSettings_allNotificationRenderingMustSucceed | RenderingSettings_anyNotificationRenderingCanFail;
8862
8919
  /**
8920
+ * All information about the shape of the interface property. For now this all comes from shared properties, but
8921
+ * in the future it can also come from property constraints defined on the interface.
8922
+ */
8923
+ export interface ResolvedInterfacePropertyType {
8924
+ apiName: InterfacePropertyTypeApiName;
8925
+ displayMetadata: InterfacePropertyTypeDisplayMetadata;
8926
+ rid: InterfacePropertyTypeRid;
8927
+ type: Type;
8928
+ }
8929
+ /**
8863
8930
  * An rid identifying a Foundry restricted view. This rid is a randomly generated identifier and is safe to log.
8864
8931
  */
8865
8932
  export type RestrictedViewRid = string;
@@ -9399,6 +9466,10 @@ export type SeriesValueMetadata = SeriesValueMetadata_numeric | SeriesValueMetad
9399
9466
  export interface SharedPropertiesSummary {
9400
9467
  visibleEntities: number;
9401
9468
  }
9469
+ export interface SharedPropertyBasedPropertyType {
9470
+ requireImplementation: boolean;
9471
+ sharedPropertyType: SharedPropertyType;
9472
+ }
9402
9473
  /**
9403
9474
  * A property type that can be shared across object types.
9404
9475
  */