@osdk/api 2.6.1 → 2.7.0-beta.10

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 (101) hide show
  1. package/CHANGELOG.md +19 -33
  2. package/build/browser/OsdkObjectFrom.js.map +1 -1
  3. package/build/browser/aggregate/BaseFilter.js.map +1 -1
  4. package/build/browser/aggregate/BooleanFilter.js.map +1 -1
  5. package/build/browser/aggregate/StringFilter.js.map +1 -1
  6. package/build/browser/derivedProperties/DerivedProperty.js.map +1 -1
  7. package/build/browser/experimental/fetchOneByRid.js.map +1 -1
  8. package/build/browser/index.js.map +1 -1
  9. package/build/browser/object/FetchPageArgs.js.map +1 -1
  10. package/build/browser/object/PropertySecurity.js +2 -0
  11. package/build/browser/object/PropertySecurity.js.map +1 -0
  12. package/build/browser/objectSet/ObjectSet.js.map +1 -1
  13. package/build/browser/objectSet/ObjectSet.test.js +67 -1
  14. package/build/browser/objectSet/ObjectSet.test.js.map +1 -1
  15. package/build/browser/objectSet/ObjectSetLinks.js +2 -0
  16. package/build/browser/objectSet/ObjectSetLinks.js.map +1 -0
  17. package/build/browser/ontology/ObjectTypeDefinition.js.map +1 -1
  18. package/build/browser/ontology/QueryDefinition.js.map +1 -1
  19. package/build/browser/ontology/valueFormatting/PropertyBooleanFormattingRule.js +2 -0
  20. package/build/browser/ontology/valueFormatting/PropertyBooleanFormattingRule.js.map +1 -0
  21. package/build/browser/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js +2 -0
  22. package/build/browser/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js.map +1 -0
  23. package/build/browser/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js +2 -0
  24. package/build/browser/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js.map +1 -0
  25. package/build/browser/ontology/valueFormatting/PropertyNumberFormattingRule.js +2 -0
  26. package/build/browser/ontology/valueFormatting/PropertyNumberFormattingRule.js.map +1 -0
  27. package/build/browser/ontology/valueFormatting/PropertyValueFormattingRule.js +2 -0
  28. package/build/browser/ontology/valueFormatting/PropertyValueFormattingRule.js.map +1 -0
  29. package/build/browser/ontology/valueFormatting/PropertyValueFormattingUtils.js +2 -0
  30. package/build/browser/ontology/valueFormatting/PropertyValueFormattingUtils.js.map +1 -0
  31. package/build/cjs/{ObjectSet-CpvLXsFU.d.cts → ObjectSet-DlNhU1QE.d.cts} +327 -19
  32. package/build/cjs/index.d.cts +2 -6
  33. package/build/cjs/public/unstable.d.cts +3 -3
  34. package/build/esm/OsdkObjectFrom.js.map +1 -1
  35. package/build/esm/aggregate/BaseFilter.js.map +1 -1
  36. package/build/esm/aggregate/BooleanFilter.js.map +1 -1
  37. package/build/esm/aggregate/StringFilter.js.map +1 -1
  38. package/build/esm/derivedProperties/DerivedProperty.js.map +1 -1
  39. package/build/esm/experimental/fetchOneByRid.js.map +1 -1
  40. package/build/esm/index.js.map +1 -1
  41. package/build/esm/object/FetchPageArgs.js.map +1 -1
  42. package/build/esm/object/PropertySecurity.js +2 -0
  43. package/build/esm/object/PropertySecurity.js.map +1 -0
  44. package/build/esm/objectSet/ObjectSet.js.map +1 -1
  45. package/build/esm/objectSet/ObjectSet.test.js +67 -1
  46. package/build/esm/objectSet/ObjectSet.test.js.map +1 -1
  47. package/build/esm/objectSet/ObjectSetLinks.js +2 -0
  48. package/build/esm/objectSet/ObjectSetLinks.js.map +1 -0
  49. package/build/esm/ontology/ObjectTypeDefinition.js.map +1 -1
  50. package/build/esm/ontology/QueryDefinition.js.map +1 -1
  51. package/build/esm/ontology/valueFormatting/PropertyBooleanFormattingRule.js +2 -0
  52. package/build/esm/ontology/valueFormatting/PropertyBooleanFormattingRule.js.map +1 -0
  53. package/build/esm/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js +2 -0
  54. package/build/esm/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.js.map +1 -0
  55. package/build/esm/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js +2 -0
  56. package/build/esm/ontology/valueFormatting/PropertyKnownTypeFormattingRule.js.map +1 -0
  57. package/build/esm/ontology/valueFormatting/PropertyNumberFormattingRule.js +2 -0
  58. package/build/esm/ontology/valueFormatting/PropertyNumberFormattingRule.js.map +1 -0
  59. package/build/esm/ontology/valueFormatting/PropertyValueFormattingRule.js +2 -0
  60. package/build/esm/ontology/valueFormatting/PropertyValueFormattingRule.js.map +1 -0
  61. package/build/esm/ontology/valueFormatting/PropertyValueFormattingUtils.js +2 -0
  62. package/build/esm/ontology/valueFormatting/PropertyValueFormattingUtils.js.map +1 -0
  63. package/build/types/OsdkObjectFrom.d.ts +21 -8
  64. package/build/types/OsdkObjectFrom.d.ts.map +1 -1
  65. package/build/types/aggregate/BaseFilter.d.ts +3 -0
  66. package/build/types/aggregate/BaseFilter.d.ts.map +1 -1
  67. package/build/types/aggregate/BooleanFilter.d.ts.map +1 -1
  68. package/build/types/aggregate/StringFilter.d.ts +3 -0
  69. package/build/types/aggregate/StringFilter.d.ts.map +1 -1
  70. package/build/types/derivedProperties/DerivedProperty.d.ts +10 -1
  71. package/build/types/derivedProperties/DerivedProperty.d.ts.map +1 -1
  72. package/build/types/experimental/fetchOneByRid.d.ts +2 -3
  73. package/build/types/experimental/fetchOneByRid.d.ts.map +1 -1
  74. package/build/types/index.d.ts +8 -0
  75. package/build/types/index.d.ts.map +1 -1
  76. package/build/types/object/FetchPageArgs.d.ts +9 -5
  77. package/build/types/object/FetchPageArgs.d.ts.map +1 -1
  78. package/build/types/object/PropertySecurity.d.ts +61 -0
  79. package/build/types/object/PropertySecurity.d.ts.map +1 -0
  80. package/build/types/objectSet/ObjectSet.d.ts +33 -12
  81. package/build/types/objectSet/ObjectSet.d.ts.map +1 -1
  82. package/build/types/objectSet/ObjectSet.test.d.ts.map +1 -1
  83. package/build/types/objectSet/ObjectSetLinks.d.ts +24 -0
  84. package/build/types/objectSet/ObjectSetLinks.d.ts.map +1 -0
  85. package/build/types/ontology/ObjectTypeDefinition.d.ts +2 -0
  86. package/build/types/ontology/ObjectTypeDefinition.d.ts.map +1 -1
  87. package/build/types/ontology/QueryDefinition.d.ts +0 -4
  88. package/build/types/ontology/QueryDefinition.d.ts.map +1 -1
  89. package/build/types/ontology/valueFormatting/PropertyBooleanFormattingRule.d.ts +5 -0
  90. package/build/types/ontology/valueFormatting/PropertyBooleanFormattingRule.d.ts.map +1 -0
  91. package/build/types/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.d.ts +37 -0
  92. package/build/types/ontology/valueFormatting/PropertyDateAndTimestampFormattingRule.d.ts.map +1 -0
  93. package/build/types/ontology/valueFormatting/PropertyKnownTypeFormattingRule.d.ts +8 -0
  94. package/build/types/ontology/valueFormatting/PropertyKnownTypeFormattingRule.d.ts.map +1 -0
  95. package/build/types/ontology/valueFormatting/PropertyNumberFormattingRule.d.ts +117 -0
  96. package/build/types/ontology/valueFormatting/PropertyNumberFormattingRule.d.ts.map +1 -0
  97. package/build/types/ontology/valueFormatting/PropertyValueFormattingRule.d.ts +8 -0
  98. package/build/types/ontology/valueFormatting/PropertyValueFormattingRule.d.ts.map +1 -0
  99. package/build/types/ontology/valueFormatting/PropertyValueFormattingUtils.d.ts +12 -0
  100. package/build/types/ontology/valueFormatting/PropertyValueFormattingUtils.d.ts.map +1 -0
  101. package/package.json +3 -3
@@ -299,6 +299,193 @@ interface OsdkMetadata {
299
299
 
300
300
  type PrimaryKeyTypes = "string" | "datetime" | "double" | "integer" | "timestamp" | "short" | "long" | "byte";
301
301
 
302
+ interface PropertyBooleanFormattingRule {
303
+ type: "boolean";
304
+ valueIfTrue: string;
305
+ valueIfFalse: string;
306
+ }
307
+
308
+ /**
309
+ * Reference to another property value or a string constant.
310
+ */
311
+ type PropertyTypeReferenceOrStringConstant = StringConstant | PropertyTypeReference;
312
+ interface StringConstant {
313
+ type: "constant";
314
+ value: string;
315
+ }
316
+ interface PropertyTypeReference {
317
+ type: "propertyType";
318
+ propertyApiName: string;
319
+ }
320
+
321
+ interface PropertyDateFormattingRule {
322
+ type: "date";
323
+ format: DatetimeFormat;
324
+ }
325
+ interface PropertyTimestampFormattingRule {
326
+ type: "timestamp";
327
+ format: DatetimeFormat;
328
+ displayTimezone: DatetimeTimezone;
329
+ }
330
+ type DatetimeFormat = DatetimeStringFormat | DatetimeLocalizedFormat;
331
+ /**
332
+ * A custom date format pattern.
333
+ */
334
+ interface DatetimeStringFormat {
335
+ type: "stringFormat";
336
+ pattern: string;
337
+ }
338
+ /**
339
+ * Predefined localized date/time formats.
340
+ */
341
+ interface DatetimeLocalizedFormat {
342
+ type: "localizedFormat";
343
+ format: DatetimeLocalizedFormatType;
344
+ }
345
+ type DatetimeLocalizedFormatType = "DATE_FORMAT_RELATIVE_TO_NOW" | "DATE_FORMAT_DATE" | "DATE_FORMAT_YEAR_AND_MONTH" | "DATE_FORMAT_DATE_TIME" | "DATE_FORMAT_DATE_TIME_SHORT" | "DATE_FORMAT_TIME" | "DATE_FORMAT_ISO_INSTANT";
346
+ type DatetimeTimezone = DatetimeTimezoneStatic | DatetimeTimezoneUser;
347
+ interface DatetimeTimezoneStatic {
348
+ type: "static";
349
+ zoneId: PropertyTypeReferenceOrStringConstant;
350
+ }
351
+ /**
352
+ * Use the user's local timezone.
353
+ */
354
+ interface DatetimeTimezoneUser {
355
+ type: "user";
356
+ }
357
+
358
+ interface PropertyKnownTypeFormattingRule {
359
+ type: "knownType";
360
+ knownType: KnownType;
361
+ }
362
+ /**
363
+ * Known Foundry types with specialized formatting.
364
+ */
365
+ type KnownType = "USER_OR_GROUP_ID" | "RESOURCE_RID" | "ARTIFACT_GID";
366
+
367
+ interface PropertyNumberFormattingRule {
368
+ type: "number";
369
+ numberType: PropertyNumberFormattingRuleType;
370
+ }
371
+ type PropertyNumberFormattingRuleType = NumberFormatStandard | NumberFormatFixedValues | NumberFormatCurrency | NumberFormatStandardUnit | NumberFormatCustomUnit | NumberFormatAffix | NumberFormatDuration | NumberFormatScale | NumberFormatRatio;
372
+ /**
373
+ * Base number formatting options.
374
+ */
375
+ interface NumberFormatOptions {
376
+ useGrouping?: boolean;
377
+ convertNegativeToParenthesis?: boolean;
378
+ minimumIntegerDigits?: number;
379
+ minimumFractionDigits?: number;
380
+ maximumFractionDigits?: number;
381
+ minimumSignificantDigits?: number;
382
+ maximumSignificantDigits?: number;
383
+ notation?: NumberFormatNotation;
384
+ roundingMode?: NumberRoundingMode;
385
+ }
386
+ /**
387
+ * Number notation style.
388
+ */
389
+ type NumberFormatNotation = "STANDARD" | "SCIENTIFIC" | "ENGINEERING" | "COMPACT";
390
+ /**
391
+ * Number rounding behavior.
392
+ */
393
+ type NumberRoundingMode = "CEIL" | "FLOOR" | "ROUND_CLOSEST";
394
+ /**
395
+ * Standard number formatting with configurable options.
396
+ */
397
+ interface NumberFormatStandard {
398
+ type: "standard";
399
+ baseFormatOptions: NumberFormatOptions;
400
+ }
401
+ /**
402
+ * Map integer values to custom strings.
403
+ */
404
+ interface NumberFormatFixedValues {
405
+ type: "fixedValues";
406
+ values: Record<number, string>;
407
+ }
408
+ /**
409
+ * Format numbers as currency values.
410
+ */
411
+ interface NumberFormatCurrency {
412
+ type: "currency";
413
+ baseFormatOptions: NumberFormatOptions;
414
+ style: NumberFormatCurrencyStyle;
415
+ currencyCode: PropertyTypeReferenceOrStringConstant;
416
+ }
417
+ type NumberFormatCurrencyStyle = "STANDARD" | "COMPACT";
418
+ /**
419
+ * Format numbers with standard units supported by Intl.NumberFormat.
420
+ */
421
+ interface NumberFormatStandardUnit {
422
+ type: "standardUnit";
423
+ baseFormatOptions: NumberFormatOptions;
424
+ unit: PropertyTypeReferenceOrStringConstant;
425
+ }
426
+ /**
427
+ * Format numbers with custom units.
428
+ */
429
+ interface NumberFormatCustomUnit {
430
+ type: "customUnit";
431
+ baseFormatOptions: NumberFormatOptions;
432
+ unit: PropertyTypeReferenceOrStringConstant;
433
+ }
434
+ /**
435
+ * Attach text before and/or after the formatted number.
436
+ */
437
+ interface NumberFormatAffix {
438
+ type: "affix";
439
+ baseFormatOptions: NumberFormatOptions;
440
+ affix: Affix;
441
+ }
442
+ interface Affix {
443
+ prefix?: PropertyTypeReferenceOrStringConstant;
444
+ postfix?: PropertyTypeReferenceOrStringConstant;
445
+ }
446
+ /**
447
+ * Format numeric values representing time durations.
448
+ */
449
+ interface NumberFormatDuration {
450
+ type: "duration";
451
+ formatStyle: DurationFormatStyle;
452
+ precision?: DurationPrecision;
453
+ baseValue: DurationBaseValue;
454
+ }
455
+ type DurationFormatStyle = HumanReadableFormat | TimeCodeFormat;
456
+ interface HumanReadableFormat {
457
+ type: "humanReadable";
458
+ showFullUnits?: boolean;
459
+ }
460
+ interface TimeCodeFormat {
461
+ type: "timecode";
462
+ }
463
+ type DurationPrecision = "DAYS" | "HOURS" | "MINUTES" | "SECONDS" | "AUTO";
464
+ type DurationBaseValue = "SECONDS" | "MILLISECONDS";
465
+ /**
466
+ * Scale numeric values by the specified factor.
467
+ */
468
+ interface NumberFormatScale {
469
+ type: "scale";
470
+ scaleType: NumberScaleType;
471
+ baseFormatOptions: NumberFormatOptions;
472
+ }
473
+ type NumberScaleType = "THOUSANDS" | "MILLIONS" | "BILLIONS";
474
+ /**
475
+ * Display values as ratios with different scaling factors.
476
+ */
477
+ interface NumberFormatRatio {
478
+ type: "ratio";
479
+ ratioType: NumberRatioType;
480
+ baseFormatOptions: NumberFormatOptions;
481
+ }
482
+ type NumberRatioType = "PERCENTAGE" | "PER_MILLE" | "BASIS_POINTS";
483
+
484
+ /**
485
+ * Formatting configuration for property values.
486
+ */
487
+ type PropertyValueFormattingRule = PropertyNumberFormattingRule | PropertyTimestampFormattingRule | PropertyDateFormattingRule | PropertyBooleanFormattingRule | PropertyKnownTypeFormattingRule;
488
+
302
489
  type VersionString<Major extends number, Minor extends number, Patch extends number> = `${Major}.${Minor}.${Patch}`;
303
490
 
304
491
  type WirePropertyTypes = BaseWirePropertyTypes | Record<string, BaseWirePropertyTypes>;
@@ -353,6 +540,7 @@ declare namespace ObjectMetadata {
353
540
  multiplicity?: boolean;
354
541
  nullable?: boolean;
355
542
  valueTypeApiName?: string;
543
+ valueFormatting?: PropertyValueFormattingRule;
356
544
  }
357
545
  interface Link<Q extends ObjectTypeDefinition, M extends boolean> {
358
546
  __OsdkLinkTargetType?: Q;
@@ -646,18 +834,19 @@ declare namespace ObjectSetArgs {
646
834
  $pageSize?: number;
647
835
  }
648
836
  }
649
- interface SelectArg<Q extends ObjectOrInterfaceDefinition, L extends string = PropertyKeys<Q>, R extends boolean = false, S extends NullabilityAdherence = NullabilityAdherence.Default, RDP_KEYS extends string = never> {
837
+ interface SelectArg<Q extends ObjectOrInterfaceDefinition, L extends string = PropertyKeys<Q>, R extends boolean = false, S extends NullabilityAdherence = NullabilityAdherence.Default, RDP_KEYS extends string = never, PROPERTY_SECURITIES extends boolean = false> {
650
838
  $select?: readonly L[];
651
839
  $includeRid?: R;
840
+ $loadPropertySecurityMetadata?: PROPERTY_SECURITIES;
652
841
  }
653
842
  interface OrderByArg<Q extends ObjectOrInterfaceDefinition, L extends string = PropertyKeys<Q>, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = never> extends ObjectSetArgs.OrderBy<ORDER_BY_OPTIONS, L> {
654
843
  }
655
844
  type SelectArgToKeys<Q extends ObjectOrInterfaceDefinition, A extends SelectArg<Q, any, any>> = A extends SelectArg<Q, never> ? PropertyKeys<Q> : A["$select"] extends readonly string[] ? A["$select"][number] : PropertyKeys<Q>;
656
- interface FetchPageArgs<Q extends ObjectOrInterfaceDefinition, K extends string = PropertyKeys<Q>, R extends boolean = false, A extends Augments = never, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false, RDP_KEYS extends string = never, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<K> = {}> extends AsyncIterArgs<Q, K, R, A, S, T, RDP_KEYS, ORDER_BY_OPTIONS> {
845
+ interface FetchPageArgs<Q extends ObjectOrInterfaceDefinition, K extends string = PropertyKeys<Q>, R extends boolean = false, A extends Augments = never, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false, RDP_KEYS extends string = never, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<K> = {}, PROPERTY_SECURITIES extends boolean = false> extends AsyncIterArgs<Q, K, R, A, S, T, RDP_KEYS, ORDER_BY_OPTIONS, PROPERTY_SECURITIES> {
657
846
  $nextPageToken?: string;
658
847
  $pageSize?: number;
659
848
  }
660
- interface AsyncIterArgs<Q extends ObjectOrInterfaceDefinition, K extends string = PropertyKeys<Q>, R extends boolean = false, A extends Augments = never, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false, RDP_KEYS extends string = never, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<K> = never> extends SelectArg<Q, K, R, S, RDP_KEYS>, OrderByArg<Q, PropertyKeys<Q> | RDP_KEYS, ORDER_BY_OPTIONS> {
849
+ interface AsyncIterArgs<Q extends ObjectOrInterfaceDefinition, K extends string = PropertyKeys<Q>, R extends boolean = false, A extends Augments = never, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false, RDP_KEYS extends string = never, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<K> = never, PROPERTY_SECURITIES extends boolean = false> extends SelectArg<Q, K, R, S, RDP_KEYS, PROPERTY_SECURITIES>, OrderByArg<Q, PropertyKeys<Q> | RDP_KEYS, ORDER_BY_OPTIONS> {
661
850
  $__UNSTABLE_useOldInterfaceApis?: boolean;
662
851
  $includeAllBaseObjectProperties?: PropertyKeys<Q> extends K ? T : never;
663
852
  }
@@ -716,6 +905,68 @@ type SingleOsdkResult<Q extends ObjectOrInterfaceDefinition, L extends PropertyK
716
905
  [K in Extract<keyof RDPs, L>]: RDPs[K];
717
906
  }>, ORDER_BY_OPTIONS>;
718
907
 
908
+ /**
909
+ * A discriminated union representing different types of property security outcomes.
910
+ *
911
+ * @discriminator type - The type field determines which security outcome is represented:
912
+ * - "propertyMarkings": Successfully computed security markings for the property
913
+ * - "unsupportedPolicy": The property is backed by a restricted view that doesn't support property securities
914
+ * - "errorComputingSecurity": The server was unable to load the securities of the property
915
+ */
916
+ type PropertySecurity = ({
917
+ type: "propertyMarkings";
918
+ } & PropertyMarkings) | ({
919
+ type: "unsupportedPolicy";
920
+ }) | ({
921
+ type: "errorComputingSecurity";
922
+ });
923
+ /**
924
+ * All marking requirements applicable to a property value.
925
+ *
926
+ * Markings represent security classifications or access control requirements
927
+ * that must be satisfied to access the property value.
928
+ */
929
+ interface PropertyMarkings {
930
+ /**
931
+ * The conjunctive set of markings required to access the property value.
932
+ * All markings from a conjunctive set must be met for access.
933
+ */
934
+ conjunctive?: Array<MarkingId>;
935
+ /**
936
+ * The disjunctive set of markings required to access the property value.
937
+ *
938
+ * Disjunctive markings are represented as a conjunctive list of disjunctive sets.
939
+ * The top-level array is a conjunction of sets, where each inner array should be
940
+ * treated as a unit where any marking within the set can satisfy the set.
941
+ * All sets within the top level array must be satisfied.
942
+ */
943
+ disjunctive?: Array<Array<MarkingId>>;
944
+ /**
945
+ * The conjunctive set of markings for the container of this property value,
946
+ * such as the project of a dataset. These markings may differ from the marking
947
+ * on the actual property value, but still must be satisfied for accessing the property.
948
+ *
949
+ * All markings from a conjunctive set must be met for access.
950
+ */
951
+ containerConjunctive?: Array<MarkingId>;
952
+ /**
953
+ * The disjunctive set of markings for the container of this property value,
954
+ * such as the project of a dataset. These markings may differ from the marking
955
+ * on the actual property value, but still must be satisfied for accessing the property.
956
+ *
957
+ * Disjunctive markings are represented as a conjunctive list of disjunctive sets.
958
+ * The top-level array is a conjunction of sets, where each inner array should be
959
+ * treated as a unit where any marking within the set can satisfy the set.
960
+ * All sets within the top level array must be satisfied.
961
+ */
962
+ containerDisjunctive?: Array<Array<MarkingId>>;
963
+ }
964
+ /**
965
+ * A unique identifier for a security marking.
966
+ * Markings represent security classifications or access control requirements.
967
+ */
968
+ type MarkingId = string;
969
+
719
970
  type ObjectSpecifier<Q extends ObjectOrInterfaceDefinition> = string & {
720
971
  __apiName: Q["apiName"] | (Q extends InterfaceDefinition ? CompileTimeMetadata<Q> extends InterfaceMetadata ? NonNullable<CompileTimeMetadata<Q>["implementedBy"]>[number] : never : never);
721
972
  };
@@ -738,7 +989,7 @@ type ValidOsdkPropParams<Q extends ObjectOrInterfaceDefinition> = SpecialOsdkPro
738
989
  type ApiNameAsString<T extends ObjectOrInterfaceDefinition> = CompileTimeMetadata<T>["apiName"];
739
990
  type JustProps<T extends ObjectOrInterfaceDefinition, P extends ValidOsdkPropParams<T>> = P extends "$all" ? PropertyKeys<T> : Exclude<P, SpecialOsdkPropParams>;
740
991
  type PropMapToObject<FROM extends ObjectOrInterfaceDefinition, TO extends ObjectTypeDefinition> = NonNullable<CompileTimeMetadata<TO>["interfaceMap"]>[ApiNameAsString<FROM>];
741
- type MapPropNamesToObjectType<FROM extends ObjectOrInterfaceDefinition, TO extends ObjectTypeDefinition, P extends ValidOsdkPropParams<FROM>, OPTIONS extends never | "$rid" | "$allBaseProperties" = never> = "$allBaseProperties" extends OPTIONS ? PropertyKeys<FROM> extends P ? PropertyKeys<TO> : PropMapToObject<FROM, TO>[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>] : PropMapToObject<FROM, TO>[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>];
992
+ type MapPropNamesToObjectType<FROM extends ObjectOrInterfaceDefinition, TO extends ObjectTypeDefinition, P extends ValidOsdkPropParams<FROM>, OPTIONS extends never | "$rid" | "$allBaseProperties" | "$propertySecurities" = never> = "$allBaseProperties" extends OPTIONS ? PropertyKeys<FROM> extends P ? PropertyKeys<TO> : PropMapToObject<FROM, TO>[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>] : PropMapToObject<FROM, TO>[JustProps<FROM, P> & keyof PropMapToObject<FROM, TO>];
742
993
  type NamespaceOf<S extends string> = S extends `${infer Before}.${infer After}` ? After extends `${string}.${string}` ? `${Before}.${NamespaceOf<After>}` : Before : never;
743
994
  type MaybeStripNamespaces<S extends string, TO extends InterfaceDefinition> = S extends `${NamespaceOf<S>}.${infer Rest}` ? NamespaceOf<S> extends NamespaceOf<ApiNameAsString<TO>> ? Rest : S : S;
744
995
  type PropMapToInterface<FROM extends ObjectTypeDefinition, TO extends InterfaceDefinition> = NonNullable<CompileTimeMetadata<FROM>["inverseInterfaceMap"]>[ApiNameAsString<TO>];
@@ -750,7 +1001,7 @@ type MapPropNamesToInterface<FROM extends ObjectTypeDefinition, TO extends Inter
750
1001
  * @param TO - the interface or object type to convert to
751
1002
  * @param P - the property(s) to convert
752
1003
  */
753
- type ConvertProps<FROM extends ObjectOrInterfaceDefinition, TO extends ValidToFrom<FROM>, P extends ValidOsdkPropParams<FROM>, OPTIONS extends never | "$rid" | "$allBaseProperties" = never> = TO extends FROM ? P : TO extends ObjectTypeDefinition ? (UnionIfTrue<MapPropNamesToObjectType<FROM, TO, P, OPTIONS>, P extends "$rid" ? true : false, "$rid">) : TO extends InterfaceDefinition ? FROM extends ObjectTypeDefinition ? (UnionIfTrue<MapPropNamesToInterface<FROM, TO, P>, P extends "$rid" ? true : false, "$rid">) : never : never;
1004
+ type ConvertProps<FROM extends ObjectOrInterfaceDefinition, TO extends ValidToFrom<FROM>, P extends ValidOsdkPropParams<FROM>, OPTIONS extends never | "$rid" | "$allBaseProperties" | "$propertySecurities" = never> = TO extends FROM ? P : TO extends ObjectTypeDefinition ? (UnionIfTrue<MapPropNamesToObjectType<FROM, TO, P, OPTIONS>, P extends "$rid" ? true : false, "$rid">) : TO extends InterfaceDefinition ? FROM extends ObjectTypeDefinition ? (UnionIfTrue<MapPropNamesToInterface<FROM, TO, P>, P extends "$rid" ? true : false, "$rid">) : never : never;
754
1005
  /** DO NOT EXPORT FROM PACKAGE */
755
1006
  type ValidToFrom<FROM extends ObjectOrInterfaceDefinition> = FROM extends InterfaceDefinition ? ObjectOrInterfaceDefinition : InterfaceDefinition;
756
1007
  type IsNever<T> = [T] extends [never] ? true : false;
@@ -765,7 +1016,7 @@ type MaybeScore<T extends Osdk.Instance<any>, ORDER_BY_OPTIONS extends ObjectSet
765
1016
  */
766
1017
  type Osdk<Q extends ObjectOrInterfaceDefinition, OPTIONS extends string = never, P extends PropertyKeys<Q> = PropertyKeys<Q>> = IsNever<OPTIONS> extends true ? Osdk.Instance<Q, never, P> : IsAny<OPTIONS> extends true ? Osdk.Instance<Q, never, P> : (IsNever<Exclude<OPTIONS, "$rid">>) extends true ? Osdk.Instance<Q, OPTIONS & "$rid", P> : Osdk.Instance<Q, ("$rid" extends OPTIONS ? "$rid" : never), ExtractPropsKeysFromOldPropsStyle<Q, OPTIONS>>;
767
1018
  declare namespace Osdk {
768
- type Instance<Q extends ObjectOrInterfaceDefinition, OPTIONS extends never | "$rid" | "$allBaseProperties" = never, P extends PropertyKeys<Q> = PropertyKeys<Q>, R extends Record<string, SimplePropertyDef> = {}> = OsdkBase<Q> & Pick<CompileTimeMetadata<Q>["props"], GetPropsKeys<Q, P, [R] extends [{}] ? false : true>> & ([R] extends [never] ? {} : {
1019
+ type Instance<Q extends ObjectOrInterfaceDefinition, OPTIONS extends never | "$rid" | "$allBaseProperties" | "$propertySecurities" = never, P extends PropertyKeys<Q> = PropertyKeys<Q>, R extends Record<string, SimplePropertyDef> = {}> = OsdkBase<Q> & Pick<CompileTimeMetadata<Q>["props"], GetPropsKeys<Q, P, [R] extends [{}] ? false : true>> & ([R] extends [never] ? {} : {
769
1020
  [A in keyof R]: SimplePropertyDef.ToRuntimeProperty<R[A]>;
770
1021
  }) & {
771
1022
  readonly $link: Q extends {
@@ -781,7 +1032,15 @@ declare namespace Osdk {
781
1032
  ObjectMetadata: ObjectMetadata;
782
1033
  InterfaceMetadata: InterfaceMetadata;
783
1034
  };
784
- } & (IsNever<OPTIONS> extends true ? {} : IsAny<OPTIONS> extends true ? {} : "$rid" extends OPTIONS ? {
1035
+ readonly $__EXPERIMENTAL__NOT_SUPPORTED_YET__getFormattedValue: <PropertyApiName extends PropertyKeys<Q>>(propertyApiName: PropertyApiName, options?: {
1036
+ locale?: string;
1037
+ timezoneId?: string;
1038
+ }) => string | undefined;
1039
+ } & (IsNever<OPTIONS> extends true ? {} : IsAny<OPTIONS> extends true ? {} : "$propertySecurities" extends OPTIONS ? {
1040
+ readonly $propertySecurities: ObjectPropertySecurities<Q, GetPropsKeys<Q, P, [
1041
+ R
1042
+ ] extends [{}] ? false : true>>;
1043
+ } : {}) & (IsNever<OPTIONS> extends true ? {} : IsAny<OPTIONS> extends true ? {} : "$rid" extends OPTIONS ? {
785
1044
  readonly $rid: string;
786
1045
  } : {});
787
1046
  }
@@ -791,8 +1050,12 @@ declare namespace Osdk {
791
1050
  * Anything you throw at this that is not exactly `true` should always be `never`.
792
1051
  */
793
1052
  type ExtractRidOption<R extends boolean> = IsNever<R> extends true ? never : DefaultToFalse<R> extends false ? never : "$rid";
1053
+ type ExtractPropertySecurityOption<S extends boolean> = IsNever<S> extends true ? never : DefaultToFalse<S> extends false ? never : "$propertySecurities";
794
1054
  type ExtractAllPropertiesOption<T extends boolean> = IsNever<T> extends true ? never : DefaultToFalse<T> extends false ? never : "$allBaseProperties";
795
- type ExtractOptions<R extends boolean, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false> = ExtractRidOption<R> | ExtractAllPropertiesOption<T>;
1055
+ type ExtractOptions<RID extends boolean, UNUSED extends NullabilityAdherence = NullabilityAdherence.Default, ALL_PROPERTIES extends boolean = false, PROPERTY_SECURITIES extends boolean = false> = ExtractRidOption<RID> | ExtractAllPropertiesOption<ALL_PROPERTIES> | ExtractPropertySecurityOption<PROPERTY_SECURITIES>;
1056
+ type ObjectPropertySecurities<Q extends ObjectOrInterfaceDefinition, T extends PropertyKeys<Q>> = {
1057
+ [K in T]: CompileTimeMetadata<Q>["properties"][K]["multiplicity"] extends true ? PropertySecurity[][] : PropertySecurity[];
1058
+ };
796
1059
 
797
1060
  type Just<Z extends keyof V, V> = {
798
1061
  [k in Z]: V[k];
@@ -818,6 +1081,9 @@ type EqFilterOption<T> = {
818
1081
  interface BaseFilterOptions<T> extends EqFilterOption<T> {
819
1082
  "$ne": T;
820
1083
  "$isNull": boolean;
1084
+ /**
1085
+ * Matches any of the provided values. If an empty array is provided, the filter will match all objects.
1086
+ */
821
1087
  "$in": ReadonlyArray<T>;
822
1088
  }
823
1089
  declare namespace BaseFilter {
@@ -841,6 +1107,9 @@ declare namespace BooleanFilter {
841
1107
  }
842
1108
  interface $isNull extends Just<"$isNull", BooleanFilterOptions> {
843
1109
  }
1110
+ /**
1111
+ * Matches any of the provided values. If an empty array is provided, the filter will match all objects.
1112
+ */
844
1113
  interface $in extends Just<"$in", BooleanFilterOptions> {
845
1114
  }
846
1115
  }
@@ -945,6 +1214,9 @@ interface StringFilterOptions extends BaseFilterOptions<string> {
945
1214
  term: string;
946
1215
  fuzzySearch?: boolean;
947
1216
  };
1217
+ /**
1218
+ * Matches any of the provided values. If an empty array is provided, the filter will match all objects.
1219
+ */
948
1220
  "$in": ReadonlyArray<string>;
949
1221
  }
950
1222
  declare namespace StringFilter {
@@ -1091,7 +1363,7 @@ declare namespace DerivedProperty {
1091
1363
  };
1092
1364
  interface BaseBuilder<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> extends Filterable<Q, CONSTRAINED>, Pivotable<Q, CONSTRAINED> {
1093
1365
  }
1094
- export interface Builder<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> extends BaseBuilder<Q, CONSTRAINED>, Selectable<Q> {
1366
+ export interface Builder<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> extends BaseBuilder<Q, CONSTRAINED>, Selectable<Q>, Constant<Q> {
1095
1367
  }
1096
1368
  export interface AggregateBuilder<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> extends BaseBuilder<Q, CONSTRAINED>, Aggregatable<Q> {
1097
1369
  }
@@ -1107,6 +1379,15 @@ type Filterable<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boole
1107
1379
  type Pivotable<Q extends ObjectOrInterfaceDefinition, CONSTRAINED extends boolean> = {
1108
1380
  readonly pivotTo: <L extends LinkNames<Q>>(type: L) => CONSTRAINED extends true ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true> : NonNullable<CompileTimeMetadata<Q>["links"][L]["multiplicity"]> extends true ? DerivedProperty.AggregateBuilder<LinkedType<Q, L>, true> : DerivedProperty.SelectPropertyBuilder<LinkedType<Q, L>, false>;
1109
1381
  };
1382
+ type Constant<Q extends ObjectOrInterfaceDefinition> = {
1383
+ readonly constant: {
1384
+ readonly double: (value: number) => DerivedProperty.NumericPropertyDefinition<SimplePropertyDef.Make<"double", "non-nullable", "single">, Q>;
1385
+ readonly integer: (value: number) => DerivedProperty.NumericPropertyDefinition<SimplePropertyDef.Make<"integer", "non-nullable", "single">, Q>;
1386
+ readonly long: (value: string) => DerivedProperty.NumericPropertyDefinition<SimplePropertyDef.Make<"long", "non-nullable", "single">, Q>;
1387
+ readonly datetime: (value: string) => DerivedProperty.DatetimePropertyDefinition<SimplePropertyDef.Make<"datetime", "non-nullable", "single">, Q>;
1388
+ readonly timestamp: (value: string) => DerivedProperty.DatetimePropertyDefinition<SimplePropertyDef.Make<"timestamp", "non-nullable", "single">, Q>;
1389
+ };
1390
+ };
1110
1391
  type Aggregatable<Q extends ObjectOrInterfaceDefinition> = {
1111
1392
  readonly aggregate: <V extends ValidAggregationKeys<Q, "withPropertiesAggregate">>(aggregationSpecifier: V, opts?: V extends `${any}:${infer P}` ? P extends CollectWithPropAggregations ? {
1112
1393
  limit: number;
@@ -1124,6 +1405,18 @@ interface BaseObjectSet<Q extends ObjectOrInterfaceDefinition> {
1124
1405
  };
1125
1406
  }
1126
1407
 
1408
+ type LinkTypeApiNamesFor<Q extends ObjectOrInterfaceDefinition> = Extract<keyof CompileTimeMetadata<Q>["links"], string>;
1409
+ type LinkedObjectType<Q extends ObjectOrInterfaceDefinition, LINK_TYPE_API_NAME extends LinkTypeApiNamesFor<Q>> = NonNullable<CompileTimeMetadata<Q>["links"][LINK_TYPE_API_NAME]["__OsdkLinkTargetType"]>;
1410
+ type MinimalDirectedObjectLinkInstance<Q extends ObjectOrInterfaceDefinition, LINK_TYPE_API_NAME extends LinkTypeApiNamesFor<Q>> = {
1411
+ source: ObjectIdentifiers<Q>;
1412
+ target: ObjectIdentifiers<LinkedObjectType<Q, LINK_TYPE_API_NAME>>;
1413
+ linkType: LINK_TYPE_API_NAME;
1414
+ };
1415
+ type FetchLinksPageResult<Q extends ObjectOrInterfaceDefinition, LINK_TYPE extends LinkTypeApiNamesFor<Q>> = {
1416
+ data: Array<MinimalDirectedObjectLinkInstance<Q, LINK_TYPE>>;
1417
+ nextPageToken?: string;
1418
+ };
1419
+
1127
1420
  declare namespace ObjectSetSubscription {
1128
1421
  interface Listener<O extends ObjectOrInterfaceDefinition, P extends PropertyKeys<O> = PropertyKeys<O>> {
1129
1422
  /**
@@ -1165,7 +1458,7 @@ type ObjectUpdate<O extends ObjectOrInterfaceDefinition, P extends PropertyKeys<
1165
1458
  type MergeObjectSet<Q extends ObjectOrInterfaceDefinition, D extends Record<string, SimplePropertyDef> = {}> = DerivedObjectOrInterfaceDefinition.WithDerivedProperties<Q, D>;
1166
1459
  type ExtractRdp<D extends BaseObjectSet<any> | Record<string, SimplePropertyDef>> = [D] extends [never] ? {} : D extends BaseObjectSet<any> ? {} : D extends Record<string, SimplePropertyDef> ? D : {};
1167
1460
  type SubSelectKeysHelper<Q extends ObjectOrInterfaceDefinition, L extends string> = [L] extends [never] ? PropertyKeys<Q> : PropertyKeys<Q> extends L ? PropertyKeys<Q> : L & PropertyKeys<Q>;
1168
- type SubSelectKeys<Q extends ObjectOrInterfaceDefinition, X extends SelectArg<Q, PropertyKeys<Q>, any, any> = never> = SubSelectKeysHelper<Q, Extract$Select<X>>;
1461
+ type SubSelectKeys<Q extends ObjectOrInterfaceDefinition, X extends SelectArg<Q, PropertyKeys<Q>, any, any, any, any> = never> = SubSelectKeysHelper<Q, Extract$Select<X>>;
1169
1462
  type NOOP<T> = T extends (...args: any[]) => any ? T : T extends abstract new (...args: any[]) => any ? T : {
1170
1463
  [K in keyof T]: T[K];
1171
1464
  };
@@ -1173,7 +1466,7 @@ type SubSelectRDPsHelper<X extends ValidFetchPageArgs<any, any, any> | ValidAsyn
1173
1466
  type SubSelectRDPs<RDPs extends Record<string, SimplePropertyDef>, X extends ValidFetchPageArgs<any, RDPs, any> | ValidAsyncIterArgs<any, RDPs>> = [RDPs] extends [never] ? never : NOOP<{
1174
1467
  [K in SubSelectRDPsHelper<X, string & keyof RDPs>]: RDPs[K];
1175
1468
  }>;
1176
- interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}> extends BaseObjectSet<Q>, FetchPage<Q, RDPs>, AsyncIter<Q, RDPs, ORDER_BY_OPTIONS>, Where<Q, RDPs> {
1469
+ interface MinimalObjectSet<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}> extends BaseObjectSet<Q>, FetchPage<Q, RDPs>, AsyncIter<Q, RDPs, ORDER_BY_OPTIONS>, Where<Q, RDPs>, AsyncIterLinks<Q> {
1177
1470
  }
1178
1471
  type ExtractOptions2<X extends FetchPageArgs<any, any, any, any, any, any, any>> = [X] extends [never] ? never : ExtractRidOption<X["$includeRid"] extends true ? true : false> | ExtractAllPropertiesOption<X["$includeAllBaseObjectProperties"] extends true ? true : false>;
1179
1472
  type Extract$Select<X extends FetchPageArgs<any, any>> = NonNullable<X["$select"]>[number];
@@ -1196,7 +1489,7 @@ interface FetchPageSignature<Q extends ObjectOrInterfaceDefinition, RDPs extends
1196
1489
 
1197
1490
  * @returns a page of objects
1198
1491
  */
1199
- <L extends PropertyKeys<Q> | (string & keyof RDPs), R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {}>(args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>): Promise<PageResult<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>>;
1492
+ <L extends PropertyKeys<Q> | (string & keyof RDPs), R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {}, PROPERTY_SECURITIES extends boolean = false>(args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS, PROPERTY_SECURITIES>): Promise<PageResult<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T, PROPERTY_SECURITIES>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>>;
1200
1493
  }
1201
1494
  interface NearestNeighbors<Q extends ObjectOrInterfaceDefinition> {
1202
1495
  /**
@@ -1213,7 +1506,7 @@ interface NearestNeighbors<Q extends ObjectOrInterfaceDefinition> {
1213
1506
  */
1214
1507
  readonly nearestNeighbors: (query: string | number[], numNeighbors: number, property: PropertyKeys.Filtered<Q, "vector">) => this;
1215
1508
  }
1216
- interface FetchPageWithErrorsSignature<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> {
1509
+ interface FetchPageWithErrorsSignature<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}, PROPERTY_SECURITIES extends boolean = false> {
1217
1510
  /**
1218
1511
  * Gets a page of objects of this type, with a result wrapper
1219
1512
  * @param args - Args to specify next page token and page size, if applicable
@@ -1228,7 +1521,7 @@ interface FetchPageWithErrorsSignature<Q extends ObjectOrInterfaceDefinition, RD
1228
1521
  }
1229
1522
  * @returns a page of objects, wrapped in a result wrapper
1230
1523
  */
1231
- <L extends PropertyKeys<Q> | (string & keyof RDPs), R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {}>(args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>): Promise<Result<PageResult<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>>>;
1524
+ <L extends PropertyKeys<Q> | (string & keyof RDPs), R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<L> = {}>(args?: FetchPageArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS, PROPERTY_SECURITIES>): Promise<Result<PageResult<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T, PROPERTY_SECURITIES>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>>>;
1232
1525
  }
1233
1526
  interface Where<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}> {
1234
1527
  /**
@@ -1243,7 +1536,7 @@ interface Where<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<strin
1243
1536
  */
1244
1537
  readonly where: (clause: WhereClause<MergeObjectSet<Q, RDPs>>) => this;
1245
1538
  }
1246
- interface AsyncIterSignature<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}> {
1539
+ interface AsyncIterSignature<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}, PROPERTY_SECURITIES extends boolean = false> {
1247
1540
  /**
1248
1541
  * Returns an async iterator to load all objects of this type
1249
1542
  * @example
@@ -1261,7 +1554,7 @@ interface AsyncIterSignature<Q extends ObjectOrInterfaceDefinition, RDPs extends
1261
1554
  * }
1262
1555
  * @returns an async iterator to load all objects
1263
1556
  */
1264
- <L extends PropertyKeys<Q> | (string & keyof RDPs), R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}>(args?: AsyncIterArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS>): AsyncIterableIterator<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>;
1557
+ <L extends PropertyKeys<Q> | (string & keyof RDPs), R extends boolean, const A extends Augments, S extends NullabilityAdherence = NullabilityAdherence.Default, T extends boolean = false, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}>(args?: AsyncIterArgs<Q, L, R, A, S, T, never, ORDER_BY_OPTIONS, PROPERTY_SECURITIES>): AsyncIterableIterator<MaybeScore<Osdk.Instance<Q, ExtractOptions<R, S, T, PROPERTY_SECURITIES>, NoInfer<SubSelectKeys<Q, NonNullable<typeof args>>>, SubSelectRDPs<RDPs, NonNullable<typeof args>>>, ORDER_BY_OPTIONS>>;
1265
1558
  }
1266
1559
  interface AsyncIter<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = {}, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}> {
1267
1560
  asyncIter: AsyncIterSignature<Q, RDPs, ORDER_BY_OPTIONS>;
@@ -1345,7 +1638,7 @@ interface FetchOneSignature<Q extends ObjectTypeDefinition, RDPs extends Record<
1345
1638
  /**
1346
1639
  * Fetches one object with the specified primary key, without a result wrapper
1347
1640
  */
1348
- <const L extends PropertyKeys<Q> | (string & keyof RDPs), const R extends boolean, const S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>): Promise<Osdk.Instance<Q, ExtractOptions<R, S>, NoInfer<SubSelectKeys<Q, {
1641
+ <const L extends PropertyKeys<Q> | (string & keyof RDPs), const R extends boolean, const S extends false | "throw" = NullabilityAdherence.Default, PROPERTY_SECURITIES extends boolean = false>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>): Promise<Osdk.Instance<Q, ExtractOptions<R, S, false, PROPERTY_SECURITIES>, NoInfer<SubSelectKeys<Q, {
1349
1642
  $select: Array<L>;
1350
1643
  }>>, SubSelectRDPs<RDPs, {
1351
1644
  $select: Array<L>;
@@ -1355,7 +1648,7 @@ interface FetchOneWithErrorsSignature<Q extends ObjectTypeDefinition, RDPs exten
1355
1648
  /**
1356
1649
  * Fetches one object with the specified primary key, with a result wrapper
1357
1650
  */
1358
- <const L extends PropertyKeys<Q> | (string & keyof RDPs), const R extends boolean, const S extends false | "throw" = NullabilityAdherence.Default>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S>): Promise<Result<Osdk.Instance<Q, ExtractOptions<R, S>, NoInfer<SubSelectKeys<Q, {
1651
+ <const L extends PropertyKeys<Q> | (string & keyof RDPs), const R extends boolean, const S extends false | "throw" = NullabilityAdherence.Default, PROPERTY_SECURITIES extends boolean = false>(primaryKey: PrimaryKeyType<Q>, options?: SelectArg<Q, L, R, S, never, PROPERTY_SECURITIES>): Promise<Result<Osdk.Instance<Q, ExtractOptions<R, S, false, PROPERTY_SECURITIES>, NoInfer<SubSelectKeys<Q, {
1359
1652
  $select: Array<L>;
1360
1653
  }>>, SubSelectRDPs<RDPs, {
1361
1654
  $select: Array<L>;
@@ -1398,7 +1691,22 @@ type ExtractImplementingTypes<T extends InterfaceDefinition> = CompileTimeMetada
1398
1691
  } ? (ObjectTypeDefinition & {
1399
1692
  apiName: API_NAME;
1400
1693
  }) | InterfaceDefinition : InterfaceDefinition;
1694
+ interface AsyncIterLinks<Q extends ObjectOrInterfaceDefinition> {
1695
+ /**
1696
+ * Batch load links on an object set. This is an experimental method that may change while in beta.
1697
+ * Use this method in conjunction with `.asyncIter()` and `.pivotTo(...).asyncIter()` to build an
1698
+ * object graph in memory.
1699
+ *
1700
+ * Please keep these limitations in mind:
1701
+ * - Links returned may be stale. For example, primary keys returned by this endpoint may not exist anymore.
1702
+ * - The backend API fetches pages of *n* objects at a time. If, for any page of *n* objects, there are more
1703
+ * than 100,000 links present, results are limited to 100,000 links and should be considered partial.
1704
+ * - This method does not support OSv1 links and will throw an exception if links provided are backed by OSv1.
1705
+ * - This method currently does not support interface links, but support will be added in the near future.
1706
+ */
1707
+ readonly experimental_asyncIterLinks: <LINK_TYPE_API_NAME extends LinkTypeApiNamesFor<Q>>(links: LINK_TYPE_API_NAME[]) => AsyncIterableIterator<MinimalDirectedObjectLinkInstance<Q, LINK_TYPE_API_NAME>>;
1708
+ }
1401
1709
  interface ObjectSetCleanedTypes<Q extends ObjectOrInterfaceDefinition, D extends Record<string, SimplePropertyDef>, MERGED extends ObjectOrInterfaceDefinition & Q, ORDER_BY_OPTIONS extends ObjectSetArgs.OrderByOptions<PropertyKeys<Q>> = {}> extends MinimalObjectSet<Q, D, ORDER_BY_OPTIONS>, WithProperties<Q, D>, Aggregate<MERGED>, SetArithmetic<MERGED>, PivotTo<Q>, FetchOne<Q, D>, Subscribe<MERGED>, NearestNeighbors<Q>, NarrowToType<Q> {
1402
1710
  }
1403
1711
 
1404
- export { isOk as $, type AttachmentUpload as A, type GroupByClause as B, type CompileTimeMetadata as C, DistanceUnitMapping as D, type GroupByRange as E, type AsyncIterArgs as F, type GeoFilterOptions as G, type Augment as H, type InterfaceDefinition as I, type Augments as J, type FetchPageArgs as K, NullabilityAdherence as L, type MediaReference as M, type NotWhereClause as N, type ObjectTypeDefinition as O, type PropertyValueWireToClient as P, ObjectSetArgs as Q, type ReleaseStatus as R, type SingleLinkAccessor as S, type SelectArg as T, type SelectArgToKeys as U, type ValidAggregationKeys as V, type WhereClause as W, type FetchPageResult as X, type SingleOsdkResult as Y, type Media as Z, type MediaMetadata as _, type MediaUpload as a, type Result as a0, type BaseObjectSet as a1, ObjectSetSubscription as a2, InterfaceMetadata as a3, PropertyKeys as a4, type ObjectSpecifier as a5, ObjectMetadata as a6, type PropertyDef as a7, type VersionBound as a8, SimplePropertyDef as a9, type BaseWirePropertyTypes as aa, type WirePropertyTypes as ab, type PrimaryKeyType as ac, type ConvertProps as ad, type MaybeScore as ae, Osdk as af, type PageResult as ag, TimeseriesDurationMapping as ah, type GeotimeSeriesProperty as ai, type TimeSeriesPoint as aj, type TimeSeriesProperty as ak, type TimeSeriesQuery as al, type LinkedType as am, type LinkNames as an, type ExtractOptions as ao, type MinimalObjectSet as ap, type Attachment as b, type ObjectIdentifiers as c, type OsdkObjectPrimaryKeyType as d, type ObjectSet as e, type OsdkMetadata as f, type ObjectOrInterfaceDefinition as g, type PrimaryKeyTypes as h, type OsdkBase as i, type AggregateOpts as j, type AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy as k, type AggregationResultsWithGroups as l, type AggregationResultsWithoutGroups as m, type AggregationClause as n, type AggregationsResults as o, type AndWhereClause as p, type GeoFilter_Intersects as q, type GeoFilter_Within as r, type OrWhereClause as s, type PossibleWhereClauseFilters as t, type OsdkObjectCreatePropertyType as u, type OsdkObjectPropertyType as v, type OsdkObjectLinksObject as w, DerivedProperty as x, DurationMapping as y, type AllGroupByValues as z };
1712
+ export { type PropertyMarkings as $, type AttachmentUpload as A, type GroupByClause as B, type CompileTimeMetadata as C, DistanceUnitMapping as D, type GroupByRange as E, type AsyncIterArgs as F, type GeoFilterOptions as G, type Augment as H, type InterfaceDefinition as I, type Augments as J, type FetchPageArgs as K, NullabilityAdherence as L, type MediaReference as M, type NotWhereClause as N, type ObjectTypeDefinition as O, type PropertyValueWireToClient as P, ObjectSetArgs as Q, type ReleaseStatus as R, type SingleLinkAccessor as S, type SelectArg as T, type SelectArgToKeys as U, type ValidAggregationKeys as V, type WhereClause as W, type FetchPageResult as X, type SingleOsdkResult as Y, type Media as Z, type MediaMetadata as _, type MediaUpload as a, type TimeSeriesPoint as a$, type PropertySecurity as a0, isOk as a1, type Result as a2, type BaseObjectSet as a3, type FetchLinksPageResult as a4, type LinkTypeApiNamesFor as a5, type MinimalDirectedObjectLinkInstance as a6, ObjectSetSubscription as a7, InterfaceMetadata as a8, PropertyKeys as a9, type NumberFormatDuration as aA, type NumberFormatFixedValues as aB, type NumberFormatNotation as aC, type NumberFormatOptions as aD, type NumberFormatRatio as aE, type NumberFormatScale as aF, type NumberFormatStandard as aG, type NumberFormatStandardUnit as aH, type NumberRatioType as aI, type NumberRoundingMode as aJ, type NumberScaleType as aK, type PropertyNumberFormattingRule as aL, type PropertyNumberFormattingRuleType as aM, type TimeCodeFormat as aN, type PropertyValueFormattingRule as aO, type PropertyTypeReference as aP, type PropertyTypeReferenceOrStringConstant as aQ, type StringConstant as aR, type BaseWirePropertyTypes as aS, type WirePropertyTypes as aT, type PrimaryKeyType as aU, type ConvertProps as aV, type MaybeScore as aW, Osdk as aX, type PageResult as aY, TimeseriesDurationMapping as aZ, type GeotimeSeriesProperty as a_, type ObjectSpecifier as aa, ObjectMetadata as ab, type PropertyDef as ac, type VersionBound as ad, SimplePropertyDef as ae, type PropertyBooleanFormattingRule as af, type DatetimeFormat as ag, type DatetimeLocalizedFormat as ah, type DatetimeLocalizedFormatType as ai, type DatetimeStringFormat as aj, type DatetimeTimezone as ak, type DatetimeTimezoneStatic as al, type DatetimeTimezoneUser as am, type PropertyDateFormattingRule as an, type PropertyTimestampFormattingRule as ao, type KnownType as ap, type PropertyKnownTypeFormattingRule as aq, type Affix as ar, type DurationBaseValue as as, type DurationFormatStyle as at, type DurationPrecision as au, type HumanReadableFormat as av, type NumberFormatAffix as aw, type NumberFormatCurrency as ax, type NumberFormatCurrencyStyle as ay, type NumberFormatCustomUnit as az, type Attachment as b, type TimeSeriesProperty as b0, type TimeSeriesQuery as b1, type LinkedType as b2, type LinkNames as b3, type ExtractOptions as b4, type MinimalObjectSet as b5, type ObjectIdentifiers as c, type OsdkObjectPrimaryKeyType as d, type ObjectSet as e, type OsdkMetadata as f, type ObjectOrInterfaceDefinition as g, type PrimaryKeyTypes as h, type OsdkBase as i, type AggregateOpts as j, type AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy as k, type AggregationResultsWithGroups as l, type AggregationResultsWithoutGroups as m, type AggregationClause as n, type AggregationsResults as o, type AndWhereClause as p, type GeoFilter_Intersects as q, type GeoFilter_Within as r, type OrWhereClause as s, type PossibleWhereClauseFilters as t, type OsdkObjectCreatePropertyType as u, type OsdkObjectPropertyType as v, type OsdkObjectLinksObject as w, DerivedProperty as x, DurationMapping as y, type AllGroupByValues as z };
@@ -1,5 +1,5 @@
1
- import { A as AttachmentUpload, M as MediaReference, a as MediaUpload, b as Attachment, O as ObjectTypeDefinition, c as ObjectIdentifiers, d as OsdkObjectPrimaryKeyType, e as ObjectSet, I as InterfaceDefinition, C as CompileTimeMetadata, f as OsdkMetadata, R as ReleaseStatus, g as ObjectOrInterfaceDefinition, P as PropertyValueWireToClient, h as PrimaryKeyTypes, i as OsdkBase } from './ObjectSet-CpvLXsFU.cjs';
2
- export { j as AggregateOpts, k as AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy, n as AggregationClause, l as AggregationResultsWithGroups, m as AggregationResultsWithoutGroups, o as AggregationsResults, z as AllGroupByValues, p as AndWhereClause, F as AsyncIterArgs, H as Augment, J as Augments, a1 as BaseObjectSet, aa as BaseWirePropertyTypes, ad as ConvertProps, x as DerivedProperty, D as DistanceUnitMapping, y as DurationMapping, K as FetchPageArgs, X as FetchPageResult, G as GeoFilterOptions, q as GeoFilter_Intersects, r as GeoFilter_Within, ai as GeotimeSeriesProperty, B as GroupByClause, E as GroupByRange, a3 as InterfaceMetadata, an as LinkNames, am as LinkedType, ae as MaybeScore, Z as Media, _ as MediaMetadata, N as NotWhereClause, L as NullabilityAdherence, a6 as ObjectMetadata, Q as ObjectSetArgs, a2 as ObjectSetSubscription, a5 as ObjectSpecifier, s as OrWhereClause, af as Osdk, u as OsdkObjectCreatePropertyType, w as OsdkObjectLinksObject, v as OsdkObjectPropertyType, ag as PageResult, t as PossibleWhereClauseFilters, ac as PrimaryKeyType, a7 as PropertyDef, a4 as PropertyKeys, a0 as Result, T as SelectArg, U as SelectArgToKeys, a9 as SimplePropertyDef, S as SingleLinkAccessor, Y as SingleOsdkResult, aj as TimeSeriesPoint, ak as TimeSeriesProperty, al as TimeSeriesQuery, ah as TimeseriesDurationMapping, V as ValidAggregationKeys, a8 as VersionBound, W as WhereClause, ab as WirePropertyTypes, $ as isOk } from './ObjectSet-CpvLXsFU.cjs';
1
+ import { A as AttachmentUpload, M as MediaReference, a as MediaUpload, b as Attachment, O as ObjectTypeDefinition, c as ObjectIdentifiers, d as OsdkObjectPrimaryKeyType, e as ObjectSet, I as InterfaceDefinition, C as CompileTimeMetadata, f as OsdkMetadata, R as ReleaseStatus, g as ObjectOrInterfaceDefinition, P as PropertyValueWireToClient, h as PrimaryKeyTypes, i as OsdkBase } from './ObjectSet-DlNhU1QE.cjs';
2
+ export { ar as Affix, j as AggregateOpts, k as AggregateOptsThatErrorsAndDisallowsOrderingWithMultipleGroupBy, n as AggregationClause, l as AggregationResultsWithGroups, m as AggregationResultsWithoutGroups, o as AggregationsResults, z as AllGroupByValues, p as AndWhereClause, F as AsyncIterArgs, H as Augment, J as Augments, a3 as BaseObjectSet, aS as BaseWirePropertyTypes, aV as ConvertProps, ag as DatetimeFormat, ah as DatetimeLocalizedFormat, ai as DatetimeLocalizedFormatType, aj as DatetimeStringFormat, ak as DatetimeTimezone, al as DatetimeTimezoneStatic, am as DatetimeTimezoneUser, x as DerivedProperty, D as DistanceUnitMapping, as as DurationBaseValue, at as DurationFormatStyle, y as DurationMapping, au as DurationPrecision, a4 as FetchLinksPageResult, K as FetchPageArgs, X as FetchPageResult, G as GeoFilterOptions, q as GeoFilter_Intersects, r as GeoFilter_Within, a_ as GeotimeSeriesProperty, B as GroupByClause, E as GroupByRange, av as HumanReadableFormat, a8 as InterfaceMetadata, ap as KnownType, b3 as LinkNames, a5 as LinkTypeApiNamesFor, b2 as LinkedType, aW as MaybeScore, Z as Media, _ as MediaMetadata, a6 as MinimalDirectedObjectLinkInstance, N as NotWhereClause, L as NullabilityAdherence, aw as NumberFormatAffix, ax as NumberFormatCurrency, ay as NumberFormatCurrencyStyle, az as NumberFormatCustomUnit, aA as NumberFormatDuration, aB as NumberFormatFixedValues, aC as NumberFormatNotation, aD as NumberFormatOptions, aE as NumberFormatRatio, aF as NumberFormatScale, aG as NumberFormatStandard, aH as NumberFormatStandardUnit, aI as NumberRatioType, aJ as NumberRoundingMode, aK as NumberScaleType, ab as ObjectMetadata, Q as ObjectSetArgs, a7 as ObjectSetSubscription, aa as ObjectSpecifier, s as OrWhereClause, aX as Osdk, u as OsdkObjectCreatePropertyType, w as OsdkObjectLinksObject, v as OsdkObjectPropertyType, aY as PageResult, t as PossibleWhereClauseFilters, aU as PrimaryKeyType, af as PropertyBooleanFormattingRule, an as PropertyDateFormattingRule, ac as PropertyDef, a9 as PropertyKeys, aq as PropertyKnownTypeFormattingRule, $ as PropertyMarkings, aL as PropertyNumberFormattingRule, aM as PropertyNumberFormattingRuleType, a0 as PropertySecurity, ao as PropertyTimestampFormattingRule, aP as PropertyTypeReference, aQ as PropertyTypeReferenceOrStringConstant, aO as PropertyValueFormattingRule, a2 as Result, T as SelectArg, U as SelectArgToKeys, ae as SimplePropertyDef, S as SingleLinkAccessor, Y as SingleOsdkResult, aR as StringConstant, aN as TimeCodeFormat, a$ as TimeSeriesPoint, b0 as TimeSeriesProperty, b1 as TimeSeriesQuery, aZ as TimeseriesDurationMapping, V as ValidAggregationKeys, ad as VersionBound, W as WhereClause, aT as WirePropertyTypes, a1 as isOk } from './ObjectSet-DlNhU1QE.cjs';
3
3
  import 'type-fest';
4
4
  import 'geojson';
5
5
 
@@ -332,8 +332,6 @@ type QueryParameterDefinition<T_Target extends ObjectTypeDefinition = any> = {
332
332
  } & QueryDataTypeDefinition<T_Target>;
333
333
  type QueryDataTypeDefinition<T_Target extends ObjectOrInterfaceDefinition = any> = PrimitiveDataType | ObjectQueryDataType<T_Target> | InterfaceQueryDataType<T_Target> | ObjectSetQueryDataType<T_Target> | InterfaceObjectSetQueryDataType<T_Target> | SetQueryDataType | UnionQueryDataType | StructQueryDataType | TwoDimensionalAggregationDataType | ThreeDimensionalAggregationDataType | MapDataType | ArrayQueryDataType;
334
334
  type BaseQueryDataTypeDefinition<T extends string> = {
335
- /** @deprecated use T["type"] extends "array" instead */
336
- multiplicity?: boolean;
337
335
  nullable?: boolean;
338
336
  type: T;
339
337
  };
@@ -360,8 +358,6 @@ interface SetQueryDataType extends BaseQueryDataTypeDefinition<"set"> {
360
358
  }
361
359
  interface ArrayQueryDataType extends BaseQueryDataTypeDefinition<"array"> {
362
360
  array: QueryDataTypeDefinition;
363
- /** @deprecated use T["type"] extends "array" instead */
364
- multiplicity?: true;
365
361
  }
366
362
  interface UnionQueryDataType extends BaseQueryDataTypeDefinition<"union"> {
367
363
  union: ReadonlyArray<QueryDataTypeDefinition>;
@@ -1,5 +1,5 @@
1
- import { g as ObjectOrInterfaceDefinition, a4 as PropertyKeys, M as MediaReference, O as ObjectTypeDefinition, L as NullabilityAdherence, T as SelectArg, af as Osdk, ao as ExtractOptions, K as FetchPageArgs, X as FetchPageResult, i as OsdkBase } from '../ObjectSet-CpvLXsFU.cjs';
2
- export { ap as MinimalObjectSet } from '../ObjectSet-CpvLXsFU.cjs';
1
+ import { g as ObjectOrInterfaceDefinition, a9 as PropertyKeys, M as MediaReference, L as NullabilityAdherence, T as SelectArg, aX as Osdk, b4 as ExtractOptions, K as FetchPageArgs, X as FetchPageResult, i as OsdkBase } from '../ObjectSet-DlNhU1QE.cjs';
2
+ export { b5 as MinimalObjectSet } from '../ObjectSet-DlNhU1QE.cjs';
3
3
  import 'type-fest';
4
4
  import 'geojson';
5
5
 
@@ -33,7 +33,7 @@ declare const __EXPERIMENTAL__NOT_SUPPORTED_YET__createMediaReference: Experimen
33
33
  createMediaReference: createMediaReference;
34
34
  }>;
35
35
 
36
- type fetchOneByRidFn = <Q extends ObjectTypeDefinition, const L extends PropertyKeys<Q>, const R extends boolean, const S extends false | "throw" = NullabilityAdherence.Default>(objectType: Q, rid: string, options?: SelectArg<Q, L, R, S>) => Promise<Osdk.Instance<Q, ExtractOptions<R, S>, L>>;
36
+ type fetchOneByRidFn = <Q extends ObjectOrInterfaceDefinition, const L extends PropertyKeys<Q>, const R extends boolean, const S extends false | "throw" = NullabilityAdherence.Default>(objectType: Q, rid: string, options?: SelectArg<Q, L, R, S>) => Promise<Osdk.Instance<Q, ExtractOptions<R, S>, L>>;
37
37
  declare const __EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid: Experiment<"2.1.0", "__EXPERIMENTAL__NOT_SUPPORTED_YET__fetchOneByRid", {
38
38
  fetchOneByRid: fetchOneByRidFn;
39
39
  }>;