@kittycad/lib 3.1.10 → 3.1.11

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 (37) hide show
  1. package/dist/cjs/index.cjs +1 -1
  2. package/dist/mjs/index.js +1 -1
  3. package/dist/types/src/api/ml/create_custom_model.d.ts +24 -0
  4. package/dist/types/src/api/ml/create_custom_model.d.ts.map +1 -0
  5. package/dist/types/src/api/ml/get_custom_model.d.ts +22 -0
  6. package/dist/types/src/api/ml/get_custom_model.d.ts.map +1 -0
  7. package/dist/types/src/api/ml/list_org_datasets_for_model.d.ts +22 -0
  8. package/dist/types/src/api/ml/list_org_datasets_for_model.d.ts.map +1 -0
  9. package/dist/types/src/api/ml/update_custom_model.d.ts +24 -0
  10. package/dist/types/src/api/ml/update_custom_model.d.ts.map +1 -0
  11. package/dist/types/src/api/orgs/create_org_dataset.d.ts +24 -0
  12. package/dist/types/src/api/orgs/create_org_dataset.d.ts.map +1 -0
  13. package/dist/types/src/api/orgs/get_org_dataset.d.ts +22 -0
  14. package/dist/types/src/api/orgs/get_org_dataset.d.ts.map +1 -0
  15. package/dist/types/src/api/orgs/get_org_dataset_conversion.d.ts +24 -0
  16. package/dist/types/src/api/orgs/get_org_dataset_conversion.d.ts.map +1 -0
  17. package/dist/types/src/api/orgs/get_org_dataset_conversion_stats.d.ts +22 -0
  18. package/dist/types/src/api/orgs/get_org_dataset_conversion_stats.d.ts.map +1 -0
  19. package/dist/types/src/api/orgs/list_org_dataset_conversions.d.ts +30 -0
  20. package/dist/types/src/api/orgs/list_org_dataset_conversions.d.ts.map +1 -0
  21. package/dist/types/src/api/orgs/list_org_datasets.d.ts +28 -0
  22. package/dist/types/src/api/orgs/list_org_datasets.d.ts.map +1 -0
  23. package/dist/types/src/api/orgs/org_dataset_s3_policies.d.ts +24 -0
  24. package/dist/types/src/api/orgs/org_dataset_s3_policies.d.ts.map +1 -0
  25. package/dist/types/src/api/orgs/rescan_org_dataset.d.ts +22 -0
  26. package/dist/types/src/api/orgs/rescan_org_dataset.d.ts.map +1 -0
  27. package/dist/types/src/api/orgs/retry_org_dataset_conversion.d.ts +24 -0
  28. package/dist/types/src/api/orgs/retry_org_dataset_conversion.d.ts.map +1 -0
  29. package/dist/types/src/api/orgs/update_enterprise_pricing_for_org.d.ts +3 -3
  30. package/dist/types/src/api/orgs/update_enterprise_pricing_for_org.d.ts.map +1 -1
  31. package/dist/types/src/api/orgs/update_org_dataset.d.ts +26 -0
  32. package/dist/types/src/api/orgs/update_org_dataset.d.ts.map +1 -0
  33. package/dist/types/src/index.d.ts +33 -1
  34. package/dist/types/src/index.d.ts.map +1 -1
  35. package/dist/types/src/models.d.ts +329 -14
  36. package/dist/types/src/models.d.ts.map +1 -1
  37. package/package.json +1 -1
@@ -1446,6 +1446,20 @@ export interface Coupon {
1446
1446
  */
1447
1447
  percent_off?: number;
1448
1448
  }
1449
+ export interface CreateCustomModel {
1450
+ /** Org dataset IDs that should be linked to the model. Must contain at least one dataset owned by the org. */
1451
+ dataset_ids: Uuid[];
1452
+ /** The model's display name. */
1453
+ name: string;
1454
+ /** nullable:true, description:The model's system prompt. */
1455
+ system_prompt?: string;
1456
+ }
1457
+ export interface CreateOrgDataset {
1458
+ /** The dataset's display name. */
1459
+ name: string;
1460
+ /** Details for accessing the dataset. */
1461
+ source: OrgDatasetSource;
1462
+ }
1449
1463
  export interface CreateShortlinkRequest {
1450
1464
  /**
1451
1465
  * {
@@ -1502,6 +1516,20 @@ export interface CurveSetConstraint {
1502
1516
  export declare type CurveType =
1503
1517
  /** The type of Curve (embedded within path) */
1504
1518
  'line' | 'arc' | 'nurbs';
1519
+ export interface CustomModel {
1520
+ /** title:DateTime, format:date-time, description:The date and time the model was created. */
1521
+ created_at: string;
1522
+ /** The unique identifier for the model. */
1523
+ id: Uuid;
1524
+ /** User-provided display name. This is mutable; lookup by ID instead. */
1525
+ name: string;
1526
+ /** The ID of the org owning the model. */
1527
+ org_id: Uuid;
1528
+ /** User-provided LLM system prompt. This is akin to `AGENTS.md`. */
1529
+ system_prompt: string;
1530
+ /** title:DateTime, format:date-time, description:The date and time the model was last updated. */
1531
+ updated_at: string;
1532
+ }
1505
1533
  export interface Customer {
1506
1534
  /** nullable:true, description:The customer's address. */
1507
1535
  address?: AddressDetails;
@@ -1641,6 +1669,11 @@ export declare type CutTypeV2 = {
1641
1669
  path: string;
1642
1670
  };
1643
1671
  };
1672
+ export interface DatasetS3Policies {
1673
+ bucket_policy: string;
1674
+ permission_policy: string;
1675
+ trust_policy: string;
1676
+ }
1644
1677
  export interface DefaultCameraCenterToScene {
1645
1678
  }
1646
1679
  export interface DefaultCameraCenterToSelection {
@@ -1761,19 +1794,6 @@ export interface EngineUtilEvaluatePath {
1761
1794
  /** The evaluated path curve position */
1762
1795
  pos: Point3d;
1763
1796
  }
1764
- export declare type EnterpriseSubscriptionTierPrice = {
1765
- /** The interval the price is charged. */
1766
- interval: PlanInterval;
1767
- /** title:double, format:money-usd, description:The price. */
1768
- price: number;
1769
- type: 'flat';
1770
- } | {
1771
- /** The interval the price is charged. */
1772
- interval: PlanInterval;
1773
- /** title:double, format:money-usd, description:The price. */
1774
- price: number;
1775
- type: 'per_user';
1776
- };
1777
1797
  export interface EntityCircularPattern {
1778
1798
  /** The Face, edge, and entity ids of the patterned entities. */
1779
1799
  entity_face_edge_ids?: FaceEdgeInfo[];
@@ -3151,6 +3171,20 @@ export interface ModelingAppSubscriptionTier {
3151
3171
  endpoints_included?: ApiEndpoint[];
3152
3172
  /** minItems:0, maxItems:15, description:Features that are included in the subscription. */
3153
3173
  features?: SubscriptionTierFeature[];
3174
+ /**
3175
+ * {
3176
+ * "default": false,
3177
+ * "description": "Indicates whether this plan uses custom-quoted pricing."
3178
+ * }
3179
+ */
3180
+ is_custom_quote?: boolean;
3181
+ /**
3182
+ * {
3183
+ * "default": false,
3184
+ * "description": "Indicates whether the plan enables custom ML models."
3185
+ * }
3186
+ */
3187
+ ml_custom_models?: boolean;
3154
3188
  /**
3155
3189
  * {
3156
3190
  * "default": 0,
@@ -5721,6 +5755,13 @@ export interface Org {
5721
5755
  * }
5722
5756
  */
5723
5757
  allow_users_in_domain_to_auto_join?: boolean;
5758
+ /**
5759
+ * {
5760
+ * "nullable": true,
5761
+ * "description": "ExternalId our workers supply when assuming customer roles, following AWS guidance for avoiding the [confused deputy problem](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html). Required before an org can register external datasets."
5762
+ * }
5763
+ */
5764
+ aws_external_id?: Uuid;
5724
5765
  /** format:email, description:The billing email address of the org. */
5725
5766
  billing_email: string;
5726
5767
  /**
@@ -5816,6 +5857,219 @@ export interface OrgAdminDetails {
5816
5857
  /** nullable:true, description:Direct link to the Stripe customer dashboard. */
5817
5858
  stripe_dashboard_url?: string;
5818
5859
  }
5860
+ export interface OrgDataset {
5861
+ /** Identity we assume when accessing the dataset (AWS role ARN today). Pair this with the org's `aws_external_id` to mitigate the AWS confused deputy risk. See <https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html>. */
5862
+ access_role_arn: string;
5863
+ /** title:DateTime, format:date-time, description:The date and time the dataset was created. */
5864
+ created_at: string;
5865
+ /** The unique identifier for the dataset. */
5866
+ id: Uuid;
5867
+ /**
5868
+ * {
5869
+ * "nullable": true,
5870
+ * "description": "Last recorded sync error message, if dataset access failed."
5871
+ * }
5872
+ */
5873
+ last_sync_error?: string;
5874
+ /**
5875
+ * {
5876
+ * "nullable": true,
5877
+ * "title": "DateTime",
5878
+ * "format": "date-time",
5879
+ * "description": "Timestamp for the last sync error."
5880
+ * }
5881
+ */
5882
+ last_sync_error_at?: string;
5883
+ /** User-provided display name. This is mutable; lookup by ID instead. */
5884
+ name: string;
5885
+ /** The ID of the org owning the dataset. */
5886
+ org_id: Uuid;
5887
+ /** Fully-qualified URI to the dataset location (e.g. s3://bucket/prefix). */
5888
+ source_uri: string;
5889
+ /** Storage provider identifier. */
5890
+ storage_provider: StorageProvider;
5891
+ /** title:DateTime, format:date-time, description:The date and time the dataset was last updated. */
5892
+ updated_at: string;
5893
+ }
5894
+ export interface OrgDatasetConversionStatsResponse {
5895
+ by_status: {
5896
+ [key: string]: number;
5897
+ };
5898
+ /** Dataset identifier. */
5899
+ dataset_id: Uuid;
5900
+ /**
5901
+ * {
5902
+ * "format": "int64",
5903
+ * "description": "Number of conversions currently in an error state."
5904
+ * }
5905
+ */
5906
+ failures: number;
5907
+ /**
5908
+ * {
5909
+ * "format": "int64",
5910
+ * "description": "Number of conversions that completed successfully."
5911
+ * }
5912
+ */
5913
+ successes: number;
5914
+ /** format:int64, description:Total number of tracked conversions. */
5915
+ total: number;
5916
+ }
5917
+ export interface OrgDatasetFileConversion {
5918
+ /**
5919
+ * {
5920
+ * "nullable": true,
5921
+ * "title": "DateTime",
5922
+ * "format": "date-time",
5923
+ * "description": "The date and time the conversion got its current `status`."
5924
+ * }
5925
+ */
5926
+ completed_at?: string;
5927
+ /** title:DateTime, format:date-time, description:The date and time the conversion was created. */
5928
+ created_at: string;
5929
+ /** The ID of the dataset this file is being converted from. */
5930
+ dataset_id: Uuid;
5931
+ /** File's ETag from dataset bucket, for detecting whether a file needs to be converted again can be reused when creating new custom ML models. */
5932
+ file_etag: string;
5933
+ /** Location within dataset `path`. */
5934
+ file_path: string;
5935
+ /**
5936
+ * {
5937
+ * "format": "int64",
5938
+ * "description": "Number of bytes, for measuring throughput and debugging conversion errors."
5939
+ * }
5940
+ */
5941
+ file_size: number;
5942
+ /** The unique identifier for the conversion. */
5943
+ id: Uuid;
5944
+ /**
5945
+ * {
5946
+ * "nullable": true,
5947
+ * "description": "Tracks which version the file was processed with. If conversion failed due to an internal error, then it will be retried on converter version change."
5948
+ * }
5949
+ */
5950
+ importer_version?: string;
5951
+ /**
5952
+ * {
5953
+ * "nullable": true,
5954
+ * "description": "Path where the processed file output is stored, when available."
5955
+ * }
5956
+ */
5957
+ output_path?: string;
5958
+ /**
5959
+ * {
5960
+ * "nullable": true,
5961
+ * "title": "DateTime",
5962
+ * "format": "date-time",
5963
+ * "description": "The date and time the conversion started."
5964
+ * }
5965
+ */
5966
+ started_at?: string;
5967
+ /** Conversion status. */
5968
+ status: OrgDatasetFileConversionStatus;
5969
+ /** nullable:true, description:Details associated with `status`. */
5970
+ status_message?: string;
5971
+ /**
5972
+ * {
5973
+ * "title": "DateTime",
5974
+ * "format": "date-time",
5975
+ * "description": "The date and time the conversion was last updated."
5976
+ * }
5977
+ */
5978
+ updated_at: string;
5979
+ }
5980
+ export interface OrgDatasetFileConversionDetails {
5981
+ /** Conversion metadata without storage pointers. */
5982
+ conversion: OrgDatasetFileConversionSummary;
5983
+ /** Plain-text contents of the converted artifact. */
5984
+ output: string;
5985
+ }
5986
+ export declare type OrgDatasetFileConversionStatus = 'queued' | 'canceled' | 'in_progress' | 'success' | 'error_user' | 'error_unsupported' | 'error_internal';
5987
+ export interface OrgDatasetFileConversionSummary {
5988
+ /**
5989
+ * {
5990
+ * "nullable": true,
5991
+ * "title": "DateTime",
5992
+ * "format": "date-time",
5993
+ * "description": "The date and time the conversion got its current `status`."
5994
+ * }
5995
+ */
5996
+ completed_at?: string;
5997
+ /** title:DateTime, format:date-time, description:The date and time the conversion was created. */
5998
+ created_at: string;
5999
+ /** The ID of the dataset this file is being converted from. */
6000
+ dataset_id: Uuid;
6001
+ /** File's ETag from dataset bucket, for detecting whether a file needs to be reconverted. */
6002
+ file_etag: string;
6003
+ /** Location within dataset `path`. */
6004
+ file_path: string;
6005
+ /**
6006
+ * {
6007
+ * "format": "int64",
6008
+ * "description": "Number of bytes, for measuring throughput and debugging conversion errors."
6009
+ * }
6010
+ */
6011
+ file_size: number;
6012
+ /** The unique identifier for the conversion. */
6013
+ id: Uuid;
6014
+ /**
6015
+ * {
6016
+ * "nullable": true,
6017
+ * "description": "Tracks which version processed this file when available."
6018
+ * }
6019
+ */
6020
+ importer_version?: string;
6021
+ /**
6022
+ * {
6023
+ * "nullable": true,
6024
+ * "title": "DateTime",
6025
+ * "format": "date-time",
6026
+ * "description": "The date and time the conversion started."
6027
+ * }
6028
+ */
6029
+ started_at?: string;
6030
+ /** Conversion status. */
6031
+ status: OrgDatasetFileConversionStatus;
6032
+ /** nullable:true, description:Details associated with `status`. */
6033
+ status_message?: string;
6034
+ /**
6035
+ * {
6036
+ * "title": "DateTime",
6037
+ * "format": "date-time",
6038
+ * "description": "The date and time the conversion was last updated."
6039
+ * }
6040
+ */
6041
+ updated_at: string;
6042
+ }
6043
+ export interface OrgDatasetFileConversionSummaryResultsPage {
6044
+ /** list of items on this page of results */
6045
+ items: OrgDatasetFileConversionSummary[];
6046
+ /**
6047
+ * {
6048
+ * "nullable": true,
6049
+ * "description": "token used to fetch the next page of results (if any)"
6050
+ * }
6051
+ */
6052
+ next_page?: string;
6053
+ }
6054
+ export interface OrgDatasetResultsPage {
6055
+ /** list of items on this page of results */
6056
+ items: OrgDataset[];
6057
+ /**
6058
+ * {
6059
+ * "nullable": true,
6060
+ * "description": "token used to fetch the next page of results (if any)"
6061
+ * }
6062
+ */
6063
+ next_page?: string;
6064
+ }
6065
+ export interface OrgDatasetSource {
6066
+ /** Identity we assume when accessing the dataset. Must be configured with the org's `aws_external_id` per AWS confused deputy guidance. See <https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html>. */
6067
+ access_role_arn: string;
6068
+ /** Storage provider identifier. */
6069
+ provider: StorageProvider;
6070
+ /** Fully-qualified URI for the dataset contents. */
6071
+ uri: string;
6072
+ }
5819
6073
  export interface OrgDetails {
5820
6074
  /**
5821
6075
  * {
@@ -6701,6 +6955,7 @@ export interface SourceRangePrompt {
6701
6955
  export interface StartPath {
6702
6956
  }
6703
6957
  export declare type StlStorage = 'ascii' | 'binary';
6958
+ export declare type StorageProvider = 's3';
6704
6959
  export interface StoreCouponParams {
6705
6960
  /** format:uint32, minimum:0, description:The percentage off. */
6706
6961
  percent_off: number;
@@ -7891,10 +8146,40 @@ export interface UnitVolumeConversion {
7891
8146
  }
7892
8147
  export interface UpdateAnnotation {
7893
8148
  }
8149
+ export interface UpdateCustomModel {
8150
+ /** nullable:true, description:The model's display name. */
8151
+ name?: string;
8152
+ /** nullable:true, description:The model's system prompt. */
8153
+ system_prompt?: string;
8154
+ }
7894
8155
  export interface UpdateMemberToOrgBody {
7895
8156
  /** The organization role to give the user. */
7896
8157
  role: UserOrgRole;
7897
8158
  }
8159
+ export interface UpdateOrgDataset {
8160
+ /** nullable:true, description:Optional new display name. */
8161
+ name?: string;
8162
+ /** nullable:true, description:Optional storage connection overrides. */
8163
+ source?: UpdateOrgDatasetSource;
8164
+ }
8165
+ export interface UpdateOrgDatasetSource {
8166
+ /**
8167
+ * {
8168
+ * "nullable": true,
8169
+ * "description": "Updated identity Zoo should assume when reading the dataset."
8170
+ * }
8171
+ */
8172
+ access_role_arn?: string;
8173
+ /** nullable:true, description:Updated storage provider identifier. */
8174
+ provider?: StorageProvider;
8175
+ /**
8176
+ * {
8177
+ * "nullable": true,
8178
+ * "description": "Updated fully-qualified URI for the dataset contents."
8179
+ * }
8180
+ */
8181
+ uri?: string;
8182
+ }
7898
8183
  export interface UpdatePaymentBalance {
7899
8184
  /**
7900
8185
  * {
@@ -8241,6 +8526,20 @@ export declare type ZooProductSubscription = {
8241
8526
  endpoints_included?: ApiEndpoint[];
8242
8527
  /** minItems:0, maxItems:15, description:Features that are included in the subscription. */
8243
8528
  features?: SubscriptionTierFeature[];
8529
+ /**
8530
+ * {
8531
+ * "default": false,
8532
+ * "description": "Indicates whether this plan uses custom-quoted pricing."
8533
+ * }
8534
+ */
8535
+ is_custom_quote?: boolean;
8536
+ /**
8537
+ * {
8538
+ * "default": false,
8539
+ * "description": "Indicates whether the plan enables custom ML models."
8540
+ * }
8541
+ */
8542
+ ml_custom_models?: boolean;
8244
8543
  /**
8245
8544
  * {
8246
8545
  * "default": 0,
@@ -8392,6 +8691,8 @@ export interface Models {
8392
8691
  ConversionParams: ConversionParams;
8393
8692
  CountryCode: CountryCode;
8394
8693
  Coupon: Coupon;
8694
+ CreateCustomModel: CreateCustomModel;
8695
+ CreateOrgDataset: CreateOrgDataset;
8395
8696
  CreateShortlinkRequest: CreateShortlinkRequest;
8396
8697
  CreateShortlinkResponse: CreateShortlinkResponse;
8397
8698
  CrmData: CrmData;
@@ -8401,11 +8702,13 @@ export interface Models {
8401
8702
  CurveGetType: CurveGetType;
8402
8703
  CurveSetConstraint: CurveSetConstraint;
8403
8704
  CurveType: CurveType;
8705
+ CustomModel: CustomModel;
8404
8706
  Customer: Customer;
8405
8707
  CustomerBalance: CustomerBalance;
8406
8708
  CutStrategy: CutStrategy;
8407
8709
  CutType: CutType;
8408
8710
  CutTypeV2: CutTypeV2;
8711
+ DatasetS3Policies: DatasetS3Policies;
8409
8712
  DefaultCameraCenterToScene: DefaultCameraCenterToScene;
8410
8713
  DefaultCameraCenterToSelection: DefaultCameraCenterToSelection;
8411
8714
  DefaultCameraFocusOn: DefaultCameraFocusOn;
@@ -8435,7 +8738,6 @@ export interface Models {
8435
8738
  EnableDryRun: EnableDryRun;
8436
8739
  EnableSketchMode: EnableSketchMode;
8437
8740
  EngineUtilEvaluatePath: EngineUtilEvaluatePath;
8438
- EnterpriseSubscriptionTierPrice: EnterpriseSubscriptionTierPrice;
8439
8741
  EntityCircularPattern: EntityCircularPattern;
8440
8742
  EntityClone: EntityClone;
8441
8743
  EntityFade: EntityFade;
@@ -8558,6 +8860,15 @@ export interface Models {
8558
8860
  Org: Org;
8559
8861
  OrgAddress: OrgAddress;
8560
8862
  OrgAdminDetails: OrgAdminDetails;
8863
+ OrgDataset: OrgDataset;
8864
+ OrgDatasetConversionStatsResponse: OrgDatasetConversionStatsResponse;
8865
+ OrgDatasetFileConversion: OrgDatasetFileConversion;
8866
+ OrgDatasetFileConversionDetails: OrgDatasetFileConversionDetails;
8867
+ OrgDatasetFileConversionStatus: OrgDatasetFileConversionStatus;
8868
+ OrgDatasetFileConversionSummary: OrgDatasetFileConversionSummary;
8869
+ OrgDatasetFileConversionSummaryResultsPage: OrgDatasetFileConversionSummaryResultsPage;
8870
+ OrgDatasetResultsPage: OrgDatasetResultsPage;
8871
+ OrgDatasetSource: OrgDatasetSource;
8561
8872
  OrgDetails: OrgDetails;
8562
8873
  OrgMember: OrgMember;
8563
8874
  OrgMemberResultsPage: OrgMemberResultsPage;
@@ -8657,6 +8968,7 @@ export interface Models {
8657
8968
  SourceRangePrompt: SourceRangePrompt;
8658
8969
  StartPath: StartPath;
8659
8970
  StlStorage: StlStorage;
8971
+ StorageProvider: StorageProvider;
8660
8972
  StoreCouponParams: StoreCouponParams;
8661
8973
  Subscribe: Subscribe;
8662
8974
  SubscriptionTierFeature: SubscriptionTierFeature;
@@ -8711,7 +9023,10 @@ export interface Models {
8711
9023
  UnitVolume: UnitVolume;
8712
9024
  UnitVolumeConversion: UnitVolumeConversion;
8713
9025
  UpdateAnnotation: UpdateAnnotation;
9026
+ UpdateCustomModel: UpdateCustomModel;
8714
9027
  UpdateMemberToOrgBody: UpdateMemberToOrgBody;
9028
+ UpdateOrgDataset: UpdateOrgDataset;
9029
+ UpdateOrgDatasetSource: UpdateOrgDatasetSource;
8715
9030
  UpdatePaymentBalance: UpdatePaymentBalance;
8716
9031
  UpdateShortlinkRequest: UpdateShortlinkRequest;
8717
9032
  UpdateUser: UpdateUser;