UNPKG

@kittycad/lib

Version:

Javascript library for KittyCAD API

1,974 lines 93.7 kB
export declare type AccountProvider_type = 'apple' | 'discord' | 'google' | 'github' | 'microsoft' | 'saml' | 'tencent'; export interface AddHoleFromOffset_type { entity_ids: string[]; } export interface AddOrgMember_type { email: string; role: UserOrgRole_type; } export interface AddressDetails_type { city: string; country: CountryCode_type; state: string; street1: string; street2: string; zip: string; } export interface Angle_type { unit: UnitAngle_type; value: number; } export declare type AnnotationLineEnd_type = 'none' | 'arrow'; export interface AnnotationLineEndOptions_type { end: AnnotationLineEnd_type; start: AnnotationLineEnd_type; } export interface AnnotationOptions_type { color?: Color_type; line_ends?: AnnotationLineEndOptions_type; line_width?: number; position?: Point3d_type; text?: AnnotationTextOptions_type; } export declare type AnnotationTextAlignmentX_type = 'left' | 'center' | 'right'; export declare type AnnotationTextAlignmentY_type = 'bottom' | 'center' | 'top'; export interface AnnotationTextOptions_type { point_size: number; text: string; x: AnnotationTextAlignmentX_type; y: AnnotationTextAlignmentY_type; } export declare type AnnotationType_type = 't2d' | 't3d'; export interface ApiCallQueryGroup_type { count: number; query: string; } export declare type ApiCallQueryGroupBy_type = 'email' | 'method' | 'endpoint' | 'user_id' | 'origin' | 'ip_address'; export declare type ApiCallStatus_type = 'queued' | 'uploaded' | 'in_progress' | 'completed' | 'failed'; export interface ApiCallWithPrice_type { completed_at?: string; created_at: string; duration?: number; email: string; endpoint: string; id: Uuid_type; ip_address: string; method: Method_type; minutes?: number; org_id?: Uuid_type; origin: string; price?: number; request_body?: string; request_query_params: string; response_body?: string; started_at?: string; status_code?: number; stripe_invoice_item_id: string; token: Uuid_type; updated_at: string; user_agent: string; user_id: Uuid_type; } export interface ApiCallWithPriceResultsPage_type { items: ApiCallWithPrice_type[]; next_page?: string; } export declare type ApiEndpoint_type = 'modeling' | 'ml' | 'file'; export interface ApiError_type { error_code: ErrorCode_type; message: string; } export interface ApiToken_type { created_at: string; id: Uuid_type; is_valid: boolean; label?: string; token: ApiTokenUuid_type; updated_at: string; user_id: Uuid_type; } export interface ApiTokenResultsPage_type { items: ApiToken_type[]; next_page?: string; } export declare type ApiTokenUuid_type = string; export interface AppClientInfo_type { url: string; } export interface AsyncApiCall_type { attempts: number; completed_at?: string; created_at: string; error?: string; id: Uuid_type; input: string; output: any; started_at?: string; status: ApiCallStatus_type; type: AsyncApiCallType_type; updated_at: string; user_id: Uuid_type; worker: string; } export declare type AsyncApiCallOutput_type = { completed_at?: string; created_at: string; error?: string; id: Uuid_type; output_format: FileExportFormat_type; output_format_options?: OutputFormat3d_type; outputs: { [key: string]: string; }; src_format: FileImportFormat_type; src_format_options?: InputFormat3d_type; started_at?: string; status: ApiCallStatus_type; type: 'file_conversion'; updated_at: string; user_id: Uuid_type; } | { center_of_mass?: Point3d_type; completed_at?: string; created_at: string; error?: string; id: Uuid_type; output_unit: UnitLength_type; src_format: FileImportFormat_type; started_at?: string; status: ApiCallStatus_type; type: 'file_center_of_mass'; updated_at: string; user_id: Uuid_type; } | { completed_at?: string; created_at: string; error?: string; id: Uuid_type; mass?: number; material_density: number; material_density_unit: UnitDensity_type; output_unit: UnitMass_type; src_format: FileImportFormat_type; started_at?: string; status: ApiCallStatus_type; type: 'file_mass'; updated_at: string; user_id: Uuid_type; } | { completed_at?: string; created_at: string; error?: string; id: Uuid_type; output_unit: UnitVolume_type; src_format: FileImportFormat_type; started_at?: string; status: ApiCallStatus_type; type: 'file_volume'; updated_at: string; user_id: Uuid_type; volume?: number; } | { completed_at?: string; created_at: string; density?: number; error?: string; id: Uuid_type; material_mass: number; material_mass_unit: UnitMass_type; output_unit: UnitDensity_type; src_format: FileImportFormat_type; started_at?: string; status: ApiCallStatus_type; type: 'file_density'; updated_at: string; user_id: Uuid_type; } | { completed_at?: string; created_at: string; error?: string; id: Uuid_type; output_unit: UnitArea_type; src_format: FileImportFormat_type; started_at?: string; status: ApiCallStatus_type; surface_area?: number; type: 'file_surface_area'; updated_at: string; user_id: Uuid_type; } | { code?: string; completed_at?: string; created_at: string; error?: string; feedback?: MlFeedback_type; id: Uuid_type; kcl_version?: string; model: TextToCadModel_type; model_version: string; output_format: FileExportFormat_type; outputs: { [key: string]: string; }; prompt: string; started_at?: string; status: ApiCallStatus_type; type: 'text_to_cad'; updated_at: string; user_id: Uuid_type; } | { code: string; completed_at?: string; created_at: string; error?: string; feedback?: MlFeedback_type; id: Uuid_type; model: TextToCadModel_type; model_version: string; original_source_code: string; prompt?: string; source_ranges: SourceRangePrompt_type[]; started_at?: string; status: ApiCallStatus_type; type: 'text_to_cad_iteration'; updated_at: string; user_id: Uuid_type; } | { completed_at?: string; created_at: string; error?: string; feedback?: MlFeedback_type; id: Uuid_type; kcl_version?: string; model: TextToCadModel_type; model_version: string; outputs: { [key: string]: string; }; project_name?: string; prompt?: string; source_ranges: SourceRangePrompt_type[]; started_at?: string; status: ApiCallStatus_type; type: 'text_to_cad_multi_file_iteration'; updated_at: string; user_id: Uuid_type; }; export interface AsyncApiCallResultsPage_type { items: AsyncApiCall_type[]; next_page?: string; } export declare type AsyncApiCallType_type = 'file_conversion' | 'file_volume' | 'file_center_of_mass' | 'file_mass' | 'file_density' | 'file_surface_area' | 'text_to_cad' | 'text_to_cad_iteration' | 'text_to_cad_multi_file_iteration'; export interface AuthCallback_type { code: string; id_token?: string; state: string; user?: string; } export declare type Axis_type = 'y' | 'z'; export interface AxisDirectionPair_type { axis: Axis_type; direction: Direction_type; } export declare type BatchResponse_type = { response: OkModelingCmdResponse_type; } | { errors: ApiError_type[]; }; export interface BillingInfo_type { address?: AddressDetails_type; name: string; phone: string; } export declare type BlockReason_type = 'missing_payment_method' | 'payment_method_failed'; export interface CacheMetadata_type { ok: boolean; } export interface CameraDragEnd_type { settings: CameraSettings_type; } export declare type CameraDragInteractionType_type = 'pan' | 'rotate' | 'rotatetrackball' | 'zoom'; export interface CameraDragMove_type { settings: CameraSettings_type; } export interface CameraDragStart_type { } export declare type CameraMovement_type = 'vantage' | 'none'; export interface CameraSettings_type { center: Point3d_type; fov_y?: number; orientation: Point4d_type; ortho: boolean; ortho_scale?: number; pos: Point3d_type; up: Point3d_type; } export interface CameraViewState_type { eye_offset: number; fov_y: number; is_ortho: boolean; ortho_scale_enabled: boolean; ortho_scale_factor: number; pivot_position: Point3d_type; pivot_rotation: Point4d_type; world_coord_system: WorldCoordinateSystem_type; } export interface CardDetails_type { brand: string; checks: PaymentMethodCardChecks_type; country: string; exp_month: number; exp_year: number; fingerprint: string; funding: string; last4: string; } export interface CenterOfMass_type { center_of_mass: Point3d_type; output_unit: UnitLength_type; } export interface ClientMetrics_type { rtc_frame_height?: number; rtc_frame_width?: number; rtc_frames_decoded?: number; rtc_frames_dropped?: number; rtc_frames_per_second?: number; rtc_frames_received?: number; rtc_freeze_count?: number; rtc_jitter_sec?: number; rtc_keyframes_decoded?: number; rtc_packets_lost?: number; rtc_pause_count?: number; rtc_pli_count?: number; rtc_stun_rtt_sec?: number; rtc_total_freezes_duration_sec?: number; rtc_total_pauses_duration_sec?: number; } export interface ClosePath_type { face_id: string; } export interface Cluster_type { addr?: string; auth_timeout: number; cluster_port: number; name: string; tls_timeout: number; urls: string[]; } export declare type CodeLanguage_type = 'go' | 'python' | 'node'; export interface CodeOutput_type { output_files: OutputFile_type[]; stderr: string; stdout: string; } export interface Color_type { a: number; b: number; g: number; r: number; } export interface ComponentTransform_type { rotate_angle_axis?: TransformByForPoint4d_type; rotate_rpy?: TransformByForPoint3d_type; scale?: TransformByForPoint3d_type; translate?: TransformByForPoint3d_type; } export interface Connection_type { auth_timeout: number; cluster: Cluster_type; config_load_time: string; connections: number; cores: number; cpu: number; gateway: Gateway_type; git_commit: string; go: string; gomaxprocs: number; host: string; http_base_path: string; http_host: string; http_port: number; http_req_stats: { [key: string]: number; }; https_port: number; in_bytes: number; in_msgs: number; jetstream: Jetstream_type; leaf: LeafNode_type; leafnodes: number; max_connections: number; max_control_line: number; max_payload: number; max_pending: number; mem: number; now: string; out_bytes: number; out_msgs: number; ping_interval: number; ping_max: number; port: number; proto: number; remotes: number; routes: number; server_id: string; server_name: string; slow_consumers: number; start: string; subscriptions: number; system_account: string; tls_timeout: number; total_connections: number; uptime: string; version: string; write_deadline: number; } export declare type CountryCode_type = string; export interface Coupon_type { amount_off?: number; deleted: boolean; id: string; metadata: { [key: string]: string; }; name?: string; percent_off?: number; } export interface CreateShortlinkRequest_type { password?: string; restrict_to_org: boolean; url: string; } export interface CreateShortlinkResponse_type { key: string; url: string; } export declare type CreatedAtSortMode_type = 'created_at_ascending' | 'created_at_descending'; export declare type Currency_type = string; export interface CurveGetControlPoints_type { control_points: Point3d_type[]; } export interface CurveGetEndPoints_type { end: Point3d_type; start: Point3d_type; } export interface CurveGetType_type { curve_type: CurveType_type; } export interface CurveSetConstraint_type { } export declare type CurveType_type = 'line' | 'arc' | 'nurbs'; export interface Customer_type { address?: AddressDetails_type; balance: number; created_at: string; currency: Currency_type; delinquent: boolean; email: string; id: string; metadata: { [key: string]: string; }; name: string; phone: string; } export interface CustomerBalance_type { created_at: string; id: Uuid_type; map_id: Uuid_type; modeling_app_enterprise_price?: SubscriptionTierPrice_type; monthly_credits_remaining: number; pre_pay_cash_remaining: number; pre_pay_credits_remaining: number; subscription_details?: ZooProductSubscriptions_type; subscription_id?: string; total_due: number; updated_at: string; } export declare type CutType_type = 'fillet' | 'chamfer'; export interface DefaultCameraCenterToScene_type { } export interface DefaultCameraCenterToSelection_type { } export interface DefaultCameraFocusOn_type { } export interface DefaultCameraGetSettings_type { settings: CameraSettings_type; } export interface DefaultCameraGetView_type { view: CameraViewState_type; } export interface DefaultCameraLookAt_type { } export interface DefaultCameraPerspectiveSettings_type { } export interface DefaultCameraSetOrthographic_type { } export interface DefaultCameraSetPerspective_type { } export interface DefaultCameraSetView_type { } export interface DefaultCameraZoom_type { settings: CameraSettings_type; } export interface Density_type { density: number; output_unit: UnitDensity_type; } export interface DerEncodedKeyPair_type { private_key: string; public_cert: string; } export interface DeviceAccessTokenRequestForm_type { client_id: string; device_code: string; grant_type: OAuth2GrantType_type; } export declare type DeviceAccessTokenUuid_type = string; export interface DeviceAuthRequestForm_type { client_id: string; } export interface DeviceAuthVerifyParams_type { user_code: string; } export declare type Direction_type = 'positive' | 'negative'; export interface DisableDryRun_type { } export interface Discount_type { coupon: Coupon_type; } export interface DiscountCode_type { code: string; expires_at?: string; percent_off: number; } export declare type DistanceType_type = { type: 'euclidean'; } | { axis: GlobalAxis_type; type: 'on_axis'; }; export declare type DxfStorage_type = 'ascii' | 'binary'; export interface EdgeLinesVisible_type { } export interface EmailAuthenticationForm_type { callback_url?: string; email: string; } export interface EnableDryRun_type { } export interface EnableSketchMode_type { } export interface EngineUtilEvaluatePath_type { pos: Point3d_type; } export declare type EnterpriseSubscriptionTierPrice_type = { interval: PlanInterval_type; price: number; type: 'flat'; } | { interval: PlanInterval_type; price: number; type: 'per_user'; }; export interface EntityCircularPattern_type { entity_ids: string[]; } export interface EntityClone_type { } export interface EntityFade_type { } export interface EntityGetAllChildUuids_type { entity_ids: string[]; } export interface EntityGetChildUuid_type { entity_id: string; } export interface EntityGetDistance_type { max_distance: LengthUnit_type; min_distance: LengthUnit_type; } export interface EntityGetNumChildren_type { num: number; } export interface EntityGetParentId_type { entity_id: string; } export interface EntityGetSketchPaths_type { entity_ids: string[]; } export interface EntityLinearPattern_type { entity_ids: string[]; } export interface EntityLinearPatternTransform_type { entity_ids: string[]; } export interface EntityMakeHelix_type { } export interface EntityMakeHelixFromEdge_type { } export interface EntityMakeHelixFromParams_type { } export interface EntityMirror_type { entity_ids: string[]; } export interface EntityMirrorAcrossEdge_type { entity_ids: string[]; } export interface EntitySetOpacity_type { } export declare type EntityType_type = 'entity' | 'object' | 'path' | 'curve' | 'solid2d' | 'solid3d' | 'edge' | 'face' | 'plane' | 'vertex'; export declare type Environment_type = 'DEVELOPMENT' | 'PREVIEW' | 'PRODUCTION'; export interface Error_type { error_code: string; message: string; request_id: string; } export declare type ErrorCode_type = 'internal_engine' | 'internal_api' | 'bad_request' | 'auth_token_missing' | 'auth_token_invalid' | 'invalid_json' | 'invalid_bson' | 'wrong_protocol' | 'connection_problem' | 'message_type_not_accepted' | 'message_type_not_accepted_for_web_r_t_c'; export declare type Event_type = { attachment_uri?: string; created_at: string; event_type: ModelingAppEventType_type; last_compiled_at?: string; project_description?: string; project_name: string; source_id: string; type: 'modeling_app_event'; user_id: string; }; export interface Export_type { files: ExportFile_type[]; } export interface Export2d_type { files: ExportFile_type[]; } export interface Export3d_type { files: ExportFile_type[]; } export interface ExportFile_type { contents: string; name: string; } export interface ExtendPath_type { } export interface ExtendedUser_type { block?: BlockReason_type; can_train_on_data: boolean; company: string; created_at: string; discord: string; email: string; email_verified?: string; first_name: string; github: string; hubspot_contact_id?: string; id: Uuid_type; image: string; is_service_account: boolean; last_name: string; name: string; phone: string; stripe_id?: string; updated_at: string; } export interface ExtendedUserResultsPage_type { items: ExtendedUser_type[]; next_page?: string; } export interface Extrude_type { } export interface ExtrudedFaceInfo_type { bottom?: string; sides: SideFace_type[]; top: string; } export declare type ExtrusionFaceCapType_type = 'none' | 'top' | 'bottom' | 'both'; export interface ExtrusionFaceInfo_type { cap: ExtrusionFaceCapType_type; curve_id?: string; face_id?: string; } export interface FaceGetCenter_type { pos: Point3d_type; } export interface FaceGetGradient_type { df_du: Point3d_type; df_dv: Point3d_type; normal: Point3d_type; } export interface FaceGetPosition_type { pos: Point3d_type; } export interface FaceIsPlanar_type { origin?: Point3d_type; x_axis?: Point3d_type; y_axis?: Point3d_type; z_axis?: Point3d_type; } export interface FailureWebSocketResponse_type { errors: ApiError_type[]; request_id?: string; success: false; } export declare type FbxStorage_type = 'ascii' | 'binary'; export interface FileCenterOfMass_type { center_of_mass?: Point3d_type; completed_at?: string; created_at: string; error?: string; id: Uuid_type; output_unit: UnitLength_type; src_format: FileImportFormat_type; started_at?: string; status: ApiCallStatus_type; updated_at: string; user_id: Uuid_type; } export interface FileConversion_type { completed_at?: string; created_at: string; error?: string; id: Uuid_type; output_format: FileExportFormat_type; output_format_options?: OutputFormat3d_type; outputs: { [key: string]: string; }; src_format: FileImportFormat_type; src_format_options?: InputFormat3d_type; started_at?: string; status: ApiCallStatus_type; updated_at: string; user_id: Uuid_type; } export interface FileDensity_type { completed_at?: string; created_at: string; density?: number; error?: string; id: Uuid_type; material_mass: number; material_mass_unit: UnitMass_type; output_unit: UnitDensity_type; src_format: FileImportFormat_type; started_at?: string; status: ApiCallStatus_type; updated_at: string; user_id: Uuid_type; } export declare type FileExportFormat_type = 'fbx' | 'glb' | 'gltf' | 'obj' | 'ply' | 'step' | 'stl'; export declare type FileImportFormat_type = 'fbx' | 'gltf' | 'obj' | 'ply' | 'sldprt' | 'step' | 'stl'; export interface FileMass_type { completed_at?: string; created_at: string; error?: string; id: Uuid_type; mass?: number; material_density: number; material_density_unit: UnitDensity_type; output_unit: UnitMass_type; src_format: FileImportFormat_type; started_at?: string; status: ApiCallStatus_type; updated_at: string; user_id: Uuid_type; } export interface FileSurfaceArea_type { completed_at?: string; created_at: string; error?: string; id: Uuid_type; output_unit: UnitArea_type; src_format: FileImportFormat_type; started_at?: string; status: ApiCallStatus_type; surface_area?: number; updated_at: string; user_id: Uuid_type; } export interface FileSystemMetadata_type { ok: boolean; } export interface FileVolume_type { completed_at?: string; created_at: string; error?: string; id: Uuid_type; output_unit: UnitVolume_type; src_format: FileImportFormat_type; started_at?: string; status: ApiCallStatus_type; updated_at: string; user_id: Uuid_type; volume?: number; } export interface Gateway_type { auth_timeout: number; host: string; name: string; port: number; tls_timeout: number; } export interface GetEntityType_type { entity_type: EntityType_type; } export interface GetNumObjects_type { num_objects: number; } export interface GetSketchModePlane_type { origin: Point3d_type; x_axis: Point3d_type; y_axis: Point3d_type; z_axis: Point3d_type; } export declare type GlobalAxis_type = 'x' | 'y' | 'z'; export declare type GltfPresentation_type = 'compact' | 'pretty'; export declare type GltfStorage_type = 'binary' | 'standard' | 'embedded'; export interface HandleMouseDragEnd_type { } export interface HandleMouseDragMove_type { } export interface HandleMouseDragStart_type { } export interface HighlightSetEntities_type { } export interface HighlightSetEntity_type { entity_id?: string; sequence?: number; } export interface IceServer_type { credential?: string; urls: string[]; username?: string; } export declare type IdpMetadataSource_type = { type: 'url'; url: string; } | { data: string; type: 'base64_encoded_xml'; }; export declare type ImageFormat_type = 'png' | 'jpeg'; export interface ImportFile_type { data: number[]; path: string; } export interface ImportFiles_type { object_id: string; } export interface ImportedGeometry_type { id: string; value: string[]; } export declare type InputFormat3d_type = { type: 'fbx'; } | { type: 'gltf'; } | { coords: System_type; type: 'obj'; units: UnitLength_type; } | { coords: System_type; type: 'ply'; units: UnitLength_type; } | { split_closed_faces: boolean; type: 'sldprt'; } | { split_closed_faces: boolean; type: 'step'; } | { coords: System_type; type: 'stl'; units: UnitLength_type; }; export interface Invoice_type { amount_due: number; amount_paid: number; amount_remaining: number; attempt_count: number; attempted: boolean; created_at: string; currency: Currency_type; customer_email: string; customer_id: string; default_payment_method: string; description: string; discounts: Discount_type[]; id: string; lines: InvoiceLineItem_type[]; metadata: { [key: string]: string; }; number: string; paid: boolean; pdf?: string; receipt_number: string; statement_descriptor: string; status?: InvoiceStatus_type; subtotal: number; tax: number; total: number; url?: string; } export interface InvoiceLineItem_type { amount: number; currency: Currency_type; description: string; id: string; invoice_item: string; metadata: { [key: string]: string; }; } export declare type InvoiceStatus_type = 'draft' | 'open' | 'paid' | 'uncollectible' | 'void'; export interface IpAddrInfo_type { asn?: number; city?: string; continent_code?: string; country?: string; country_code?: CountryCode_type; country_code3?: string; ip: string; is_in_european_union?: boolean; latitude?: number; longitude?: number; offset?: number; organization?: string; postal_code?: string; region?: string; region_code?: string; timezone?: string; } export interface Jetstream_type { config: JetstreamConfig_type; meta: MetaClusterInfo_type; stats: JetstreamStats_type; } export interface JetstreamApiStats_type { errors: number; inflight: number; total: number; } export interface JetstreamConfig_type { domain: string; max_memory: number; max_storage: number; store_dir: string; } export interface JetstreamStats_type { accounts: number; api: JetstreamApiStats_type; ha_assets: number; memory: number; reserved_memory: number; reserved_store: number; store: number; } export interface KclCodeCompletionParams_type { language: string; next_indent?: number; prompt_tokens?: number; suffix_tokens?: number; trim_by_indentation: boolean; } export interface KclCodeCompletionRequest_type { extra: KclCodeCompletionParams_type; max_tokens?: number; n?: number; nwo?: string; prompt: string; stop: string[]; stream: boolean; suffix: string; temperature?: number; top_p?: number; } export interface KclCodeCompletionResponse_type { completions: string[]; } export interface LeafNode_type { auth_timeout: number; host: string; port: number; tls_timeout: number; } export declare type LengthUnit_type = number; export interface Loft_type { solid_id: string; } export interface MakeAxesGizmo_type { } export interface MakeOffsetPath_type { entity_ids: string[]; } export interface MakePlane_type { } export interface Mass_type { mass: number; output_unit: UnitMass_type; } export interface MetaClusterInfo_type { cluster_size: number; leader: string; name: string; } export interface Metadata_type { cache: CacheMetadata_type; environment: Environment_type; fs: FileSystemMetadata_type; git_hash: string; pubsub: Connection_type; } export declare type Method_type = 'OPTIONS' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'TRACE' | 'CONNECT' | 'PATCH' | 'EXTENSION'; export declare type MlFeedback_type = 'thumbs_up' | 'thumbs_down' | 'accepted' | 'rejected'; export interface MlPrompt_type { completed_at?: string; created_at: string; error?: string; feedback?: MlFeedback_type; id: Uuid_type; kcl_version?: string; metadata?: MlPromptMetadata_type; model_version: string; output_file?: string; project_name?: string; prompt: string; started_at?: string; status: ApiCallStatus_type; type: MlPromptType_type; updated_at: string; user_id: Uuid_type; } export interface MlPromptMetadata_type { code?: string; original_source_code?: string; source_ranges: SourceRangePrompt_type[]; } export interface MlPromptResultsPage_type { items: MlPrompt_type[]; next_page?: string; } export declare type MlPromptType_type = 'text_to_cad' | 'text_to_kcl' | 'text_to_kcl_iteration' | 'text_to_kcl_multi_file_iteration'; export declare type ModelingAppEventType_type = 'successful_compile_before_close'; export declare type ModelingAppIndividualSubscriptionTier_type = 'free' | 'pro'; export declare type ModelingAppOrganizationSubscriptionTier_type = 'team' | 'enterprise'; export declare type ModelingAppShareLinks_type = 'public' | 'password_protected' | 'organization_only'; export interface ModelingAppSubscriptionTier_type { annual_discount?: number; description: string; endpoints_included: ApiEndpoint_type[]; features: SubscriptionTierFeature_type[]; name: ModelingAppSubscriptionTierName_type; pay_as_you_go_credits: number; price: SubscriptionTierPrice_type; share_links: ModelingAppShareLinks_type[]; support_tier: SupportTier_type; training_data_behavior: SubscriptionTrainingDataBehavior_type; type: SubscriptionTierType_type; zoo_tools_included: ZooTool_type[]; } export declare type ModelingAppSubscriptionTierName_type = 'free' | 'pro' | 'team' | 'enterprise'; export declare type ModelingCmd_type = { path_json: string; t: number; type: 'engine_util_evaluate_path'; } | { type: 'start_path'; } | { path: ModelingCmdId_type; to: Point3d_type; type: 'move_path_pen'; } | { path: ModelingCmdId_type; segment: PathSegment_type; type: 'extend_path'; } | { distance: LengthUnit_type; faces?: ExtrudedFaceInfo_type; target: ModelingCmdId_type; type: 'extrude'; } | { sectional: boolean; target: ModelingCmdId_type; tolerance: LengthUnit_type; trajectory: ModelingCmdId_type; type: 'sweep'; } | { angle: Angle_type; axis: Point3d_type; axis_is_2d: boolean; origin: Point3d_type; target: ModelingCmdId_type; tolerance: LengthUnit_type; type: 'revolve'; } | { face_ids: string[]; hollow: boolean; object_id: string; shell_thickness: LengthUnit_type; type: 'solid3d_shell_face'; } | { angle: Angle_type; edge_id: string; target: ModelingCmdId_type; tolerance: LengthUnit_type; type: 'revolve_about_edge'; } | { base_curve_index?: number; bez_approximate_rational: boolean; section_ids: string[]; tolerance: LengthUnit_type; type: 'loft'; v_degree: number; } | { path_id: string; type: 'close_path'; } | { interaction: CameraDragInteractionType_type; type: 'camera_drag_start'; window: Point2d_type; } | { interaction: CameraDragInteractionType_type; sequence?: number; type: 'camera_drag_move'; window: Point2d_type; } | { interaction: CameraDragInteractionType_type; type: 'camera_drag_end'; window: Point2d_type; } | { type: 'default_camera_get_settings'; } | { type: 'default_camera_get_view'; } | { type: 'default_camera_set_view'; view: CameraViewState_type; } | { center: Point3d_type; sequence?: number; type: 'default_camera_look_at'; up: Point3d_type; vantage: Point3d_type; } | { center: Point3d_type; fov_y?: number; sequence?: number; type: 'default_camera_perspective_settings'; up: Point3d_type; vantage: Point3d_type; z_far?: number; z_near?: number; } | { magnitude: number; type: 'default_camera_zoom'; } | { entity_ids: string[]; format: OutputFormat2d_type; type: 'export2d'; } | { entity_ids: string[]; format: OutputFormat3d_type; type: 'export3d'; } | { entity_ids: string[]; format: OutputFormat3d_type; type: 'export'; } | { entity_id: string; type: 'entity_get_parent_id'; } | { entity_id: string; type: 'entity_get_num_children'; } | { child_index: number; entity_id: string; type: 'entity_get_child_uuid'; } | { entity_id: string; type: 'entity_get_all_child_uuids'; } | { entity_id: string; type: 'entity_get_sketch_paths'; } | { distance_type: DistanceType_type; entity_id1: string; entity_id2: string; type: 'entity_get_distance'; } | { entity_id: string; type: 'entity_clone'; } | { entity_id: string; transform: Transform_type[]; transforms: Transform_type[][]; type: 'entity_linear_pattern_transform'; } | { axis: Point3d_type; entity_id: string; num_repetitions: number; spacing: LengthUnit_type; type: 'entity_linear_pattern'; } | { arc_degrees: number; axis: Point3d_type; center: Point3d_type; entity_id: string; num_repetitions: number; rotate_duplicates: boolean; type: 'entity_circular_pattern'; } | { cylinder_id: string; is_clockwise: boolean; length: LengthUnit_type; revolutions: number; start_angle: Angle_type; type: 'entity_make_helix'; } | { axis: Point3d_type; center: Point3d_type; is_clockwise: boolean; length: LengthUnit_type; radius: LengthUnit_type; revolutions: number; start_angle: Angle_type; type: 'entity_make_helix_from_params'; } | { edge_id: string; is_clockwise: boolean; length?: LengthUnit_type; radius: LengthUnit_type; revolutions: number; start_angle: Angle_type; type: 'entity_make_helix_from_edge'; } | { axis: Point3d_type; ids: string[]; point: Point3d_type; type: 'entity_mirror'; } | { edge_id: string; ids: string[]; type: 'entity_mirror_across_edge'; } | { selected_at_window: Point2d_type; selection_type: SceneSelectionType_type; type: 'select_with_point'; } | { entities: string[]; type: 'select_add'; } | { entities: string[]; type: 'select_remove'; } | { type: 'scene_clear_all'; } | { entities: string[]; type: 'select_replace'; } | { selected_at_window: Point2d_type; sequence?: number; type: 'highlight_set_entity'; } | { entities: string[]; type: 'highlight_set_entities'; } | { annotation_type: AnnotationType_type; clobber: boolean; options: AnnotationOptions_type; type: 'new_annotation'; } | { annotation_id: string; options: AnnotationOptions_type; type: 'update_annotation'; } | { hidden: boolean; type: 'edge_lines_visible'; } | { hidden: boolean; object_id: string; type: 'object_visible'; } | { object_id: string; type: 'object_bring_to_front'; } | { ambient_occlusion: number; color: Color_type; metalness: number; object_id: string; roughness: number; type: 'object_set_material_params_pbr'; } | { entity_id: string; type: 'get_entity_type'; } | { edge_id: string; object_id: string; type: 'solid3d_get_all_edge_faces'; } | { hole_id: string; object_id: string; type: 'solid2d_add_hole'; } | { along_vector?: Point3d_type; edge_id: string; object_id: string; type: 'solid3d_get_all_opposite_edges'; } | { edge_id: string; face_id: string; object_id: string; type: 'solid3d_get_opposite_edge'; } | { edge_id: string; face_id: string; object_id: string; type: 'solid3d_get_next_adjacent_edge'; } | { edge_id: string; face_id: string; object_id: string; type: 'solid3d_get_prev_adjacent_edge'; } | { face_ids: string[]; object_id: string; type: 'solid3d_get_common_edge'; } | { cut_type: CutType_type; edge_id: string; object_id: string; radius: LengthUnit_type; tolerance: LengthUnit_type; type: 'solid3d_fillet_edge'; } | { object_id: string; type: 'face_is_planar'; } | { object_id: string; type: 'face_get_position'; uv: Point2d_type; } | { object_id: string; type: 'face_get_center'; } | { object_id: string; type: 'face_get_gradient'; uv: Point2d_type; } | { front: boolean; object_id: string; type: 'send_object'; } | { entity_id: string; opacity: number; type: 'entity_set_opacity'; } | { duration_seconds: number; entity_id: string; fade_in: boolean; type: 'entity_fade'; } | { clobber: boolean; hide?: boolean; origin: Point3d_type; size: LengthUnit_type; type: 'make_plane'; x_axis: Point3d_type; y_axis: Point3d_type; } | { color: Color_type; plane_id: string; type: 'plane_set_color'; } | { tool: SceneToolType_type; type: 'set_tool'; } | { sequence?: number; type: 'mouse_move'; window: Point2d_type; } | { type: 'mouse_click'; window: Point2d_type; } | { type: 'sketch_mode_disable'; } | { type: 'get_sketch_mode_plane'; } | { constraint_bound: PathComponentConstraintBound_type; constraint_type: PathComponentConstraintType_type; object_id: string; type: 'curve_set_constraint'; } | { adjust_camera: boolean; animated: boolean; entity_id: string; ortho: boolean; planar_normal?: Point3d_type; type: 'enable_sketch_mode'; } | { type: 'enable_dry_run'; } | { type: 'disable_dry_run'; } | { color: Color_type; type: 'set_background_color'; } | { color?: Color_type; type: 'set_current_tool_properties'; } | { color?: Color_type; type: 'set_default_system_properties'; } | { curve_id: string; type: 'curve_get_type'; } | { curve_id: string; type: 'curve_get_control_points'; } | { entity_id: string; plane_id: string; type: 'project_entity_to_plane'; use_plane_coords: boolean; } | { plane_id: string; points: Point3d_type[]; type: 'project_points_to_plane'; use_plane_coords: boolean; } | { format: ImageFormat_type; type: 'take_snapshot'; } | { clobber: boolean; gizmo_mode: boolean; type: 'make_axes_gizmo'; } | { path_id: string; type: 'path_get_info'; } | { path_id: string; type: 'path_get_curve_uuids_for_vertices'; vertex_ids: string[]; } | { index: number; path_id: string; type: 'path_get_curve_uuid'; } | { path_id: string; type: 'path_get_vertex_uuids'; } | { path_id: string; type: 'path_get_sketch_target_uuid'; } | { type: 'handle_mouse_drag_start'; window: Point2d_type; } | { sequence?: number; type: 'handle_mouse_drag_move'; window: Point2d_type; } | { type: 'handle_mouse_drag_end'; window: Point2d_type; } | { object_ids: string[]; type: 'remove_scene_objects'; } | { plane_id: string; type: 'plane_intersect_and_project'; window: Point2d_type; } | { curve_id: string; type: 'curve_get_end_points'; } | { bitrate?: number; fps: number; height: number; type: 'reconfigure_stream'; width: number; } | { files: ImportFile_type[]; format: InputFormat3d_type; type: 'import_files'; } | { type: 'set_scene_units'; unit: UnitLength_type; } | { entity_ids: string[]; material_density: number; material_density_unit: UnitDensity_type; output_unit: UnitMass_type; type: 'mass'; } | { entity_ids: string[]; material_mass: number; material_mass_unit: UnitMass_type; output_unit: UnitDensity_type; type: 'density'; } | { entity_ids: string[]; output_unit: UnitVolume_type; type: 'volume'; } | { entity_ids: string[]; output_unit: UnitLength_type; type: 'center_of_mass'; } | { entity_ids: string[]; output_unit: UnitArea_type; type: 'surface_area'; } | { type: 'default_camera_focus_on'; uuid: string; } | { selection_type: SceneSelectionType_type; type: 'set_selection_type'; } | { filter: EntityType_type[]; type: 'set_selection_filter'; } | { type: 'default_camera_set_orthographic'; } | { parameters?: PerspectiveCameraParameters_type; type: 'default_camera_set_perspective'; } | { camera_movement: CameraMovement_type; type: 'default_camera_center_to_selection'; } | { camera_movement: CameraMovement_type; type: 'default_camera_center_to_scene'; } | { animated: boolean; object_ids: string[]; padding: number; type: 'zoom_to_fit'; } | { animated: boolean; face_id: string; padding: number; type: 'orient_to_face'; } | { padding: number; type: 'view_isometric'; } | { edge_id: string; object_id: string; type: 'solid3d_get_extrusion_face_info'; } | { type: 'select_clear'; } | { type: 'select_get'; } | { type: 'get_num_objects'; } | { object_id: string; transforms: ComponentTransform_type[]; type: 'set_object_transform'; } | { face_id?: string; object_id: string; offset: LengthUnit_type; type: 'make_offset_path'; } | { object_id: string; offset: LengthUnit_type; type: 'add_hole_from_offset'; } | { grid_id: string; reference_id: string; type: 'set_grid_reference_plane'; }; export declare type ModelingCmdId_type = string; export interface ModelingCmdReq_type { cmd: ModelingCmd_type; cmd_id: ModelingCmdId_type; } export interface ModelingSessionData_type { api_call_id: string; } export interface MouseClick_type { entities_modified: string[]; entities_selected: string[]; } export interface MouseMove_type { } export interface MovePathPen_type { } export interface NewAnnotation_type { } export interface OAuth2ClientInfo_type { csrf_token: string; pkce_code_verifier?: string; url: string; } export declare type OAuth2GrantType_type = 'urn:ietf:params:oauth:grant-type:device_code'; export interface ObjectBringToFront_type { } export interface ObjectSetMaterialParamsPbr_type { } export interface ObjectVisible_type { } export declare type OkModelingCmdResponse_type = { type: 'empty'; } | { data: EngineUtilEvaluatePath_type; type: 'engine_util_evaluate_path'; } | { data: StartPath_type; type: 'start_path'; } | { data: MovePathPen_type; type: 'move_path_pen'; } | { data: ExtendPath_type; type: 'extend_path'; } | { data: Extrude_type; type: 'extrude'; } | { data: Sweep_type; type: 'sweep'; } | { data: Revolve_type; type: 'revolve'; } | { data: Solid3dShellFace_type; type: 'solid3d_shell_face'; } | { data: RevolveAboutEdge_type; type: 'revolve_about_edge'; } | { data: CameraDragStart_type; type: 'camera_drag_start'; } | { data: DefaultCameraLookAt_type; type: 'default_camera_look_at'; } | { data: DefaultCameraPerspectiveSettings_type; type: 'default_camera_perspective_settings'; } | { data: SelectAdd_type; type: 'select_add'; } | { data: SelectRemove_type; type: 'select_remove'; } | { data: SceneClearAll_type; type: 'scene_clear_all'; } | { data: SelectReplace_type; type: 'select_replace'; } | { data: HighlightSetEntities_type; type: 'highlight_set_entities'; } | { data: NewAnnotation_type; type: 'new_annotation'; } | { data: UpdateAnnotation_type; type: 'update_annotation'; } | { data: EdgeLinesVisible_type; type: 'edge_lines_visible'; } | { data: ObjectVisible_type; type: 'object_visible'; } | { data: ObjectBringToFront_type; type: 'object_bring_to_front'; } | { data: ObjectSetMaterialParamsPbr_type; type: 'object_set_material_params_pbr'; } | { data: Solid2dAddHole_type; type: 'solid2d_add_hole'; } | { data: Solid3dFilletEdge_type; type: 'solid3d_fillet_edge'; } | { data: SendObject_type; type: 'send_object'; } | { data: EntitySetOpacity_type; type: 'entity_set_opacity'; } | { data: EntityFade_type; type: 'entity_fade'; } | { data: MakePlane_type; type: 'make_plane'; } | { data: PlaneSetColor_type; type: 'plane_set_color'; } | { data: SetTool_type; type: 'set_tool'; } | { data: MouseMove_type; type: 'mouse_move'; } | { data: SketchModeDisable_type; type: 'sketch_mode_disable'; } | { data: EnableDryRun_type; type: 'enable_dry_run'; } | { data: DisableDryRun_type; type: 'disable_dry_run'; } | { data: CurveSetConstraint_type; type: 'curve_set_constraint'; } | { data: EnableSketchMode_type; type: 'enable_sketch_mode'; } | { data: SetBackgroundColor_type; type: 'set_background_color'; } | { data: SetCurrentToolProperties_type; type: 'set_current_tool_properties'; } | { data: SetDefaultSystemProperties_type; type: 'set_default_system_properties'; } | { data: MakeAxesGizmo_type; type: 'make_axes_gizmo'; } | { data: HandleMouseDragStart_type; type: 'handle_mouse_drag_start'; } | { data: HandleMouseDragMove_type; type: 'handle_mouse_drag_move'; } | { data: HandleMouseDragEnd_type; type: 'handle_mouse_drag_end'; } | { data: RemoveSceneObjects_type; type: 'remove_scene_objects'; } | { data: ReconfigureStream_type; type: 'reconfigure_stream'; } | { data: SetSceneUnits_type; type: 'set_scene_units'; } | { data: SetSelectionType_type; type: 'set_selection_type'; } | { data: SetSelectionFilter_type; type: 'set_selection_filter'; } | { data: DefaultCameraSetOrthographic_type; type: 'default_camera_set_orthographic'; } | { data: DefaultCameraSetPerspective_type; type: 'default_camera_set_perspective'; } | { data: DefaultCameraCenterToSelection_type; type: 'default_camera_center_to_selection'; } | { data: DefaultCameraCenterToScene_type; type: 'default_camera_center_to_scene'; } | { data: SelectClear_type; type: 'select_clear'; } | { data: Export2d_type; type: 'export2d'; } | { data: Export3d_type; type: 'export3d'; } | { data: Export_type; type: 'export'; } | { data: SelectWithPoint_type; type: 'select_with_point'; } | { data: HighlightSetEntity_type; type: 'highlight_set_entity'; } | { data: EntityGetChildUuid_type; type: 'entity_get_child_uuid'; } | { data: EntityGetNumChildren_type; type: 'entity_get_num_children'; } | { data: EntityGetParentId_type; type: 'entity_get_parent_id'; } | { data: EntityGetAllChildUuids_type; type: 'entity_get_all_child_uuids'; } | { data: EntityGetSketchPaths_type; type: 'entity_get_sketch_paths'; } | { data: Loft_type; type: 'loft'; } | { data: ClosePath_type; type: 'close_path'; } | { data: CameraDragMove_type; type: 'camera_drag_move'; } | { data: CameraDragEnd_type; type: 'camera_drag_end'; } | { data: DefaultCameraGetSettings_type; type: 'default_camera_get_settings'; } | { data: DefaultCameraGetView_type; type: 'default_camera_get_view'; } | { data: DefaultCameraSetView_type; type: 'default_camera_set_view'; } | { data: DefaultCameraZoom_type; type: 'default_camera_zoom'; } | { data: ZoomToFit_type; type: 'zoom_to_fit'; } | { data: OrientToFace_type; type: 'orient_to_face'; } | { data: ViewIsometric_type; type: 'view_isometric'; } | { data: GetNumObjects_type; type: 'get_num_objects'; } | { data: MakeOffsetPath_type; type: 'make_offset_path'; } | { data: SetObjectTransform_type; type: 'set_object_transform'; } | { data: AddHoleFromOffset_type; type: 'add_hole_from_offset'; } | { data: DefaultCameraFocusOn_type; type: 'default_camera_focus_on'; } | { data: SelectGet_type; type: 'select_get'; } | { data: Solid3dGetAllEdgeFaces_type; type: 'solid3d_get_all_edge_faces'; } | { data: Solid3dGetAllOppositeEdges_type; type: 'solid3d_get_all_opposite_edges'; } | { data: Solid3dGetOppositeEdge_type; type: 'solid3d_get_opposite_edge'; } | { data: Solid3dGetNextAdjacentEdge_type; type: 'solid3d_get_next_adjacent_edge'; } | { data: Solid3dGetPrevAdjacentEdge_type; type: 'solid3d_get_prev_adjacent_edge'; } | { data: Solid3dGetCommonEdge_type; type: 'solid3d_get_common_edge'; } | { data: GetEntityType_type; type: 'get_entity_type'; } | { data: CurveGetControlPoints_type; type: 'curve_get_control_points'; } | { data: ProjectEntityToPlane_type; type: 'project_entity_to_plane'; } | { data: ProjectPointsToPlane_type; type: 'project_points_to_plane'; } | { data: CurveGetType_type; type: 'curve_get_type'; } | { data: MouseClick_type; type: 'mouse_click'; } | { data: TakeSnapshot_type; type: 'take_snapshot'; } | { data: PathGetInfo_type; type: 'path_get_info'; } | { data: PathSegmentInfo_type; type: 'path_segment_info'; } | { data: PathGetCurveUuidsForVertices_type; type: 'path_get_curve_uuids_for_vertices'; } | { data: PathGetCurveUuid_type; type: 'path_get_curve_uuid'; } | { data: PathGetVertexUuids_type; type: 'path_get_vertex_uuids'; } | { data: PathGetSketchTargetUuid_type; type: 'path_get_sketch_target_uuid'; } | { data: CurveGetEndPoints_type; type: 'curve_get_end_points'; } | { data: FaceIsPlanar_type; type: 'face_is_planar'; } | { data: FaceGetPosition_type; type: 'face_get_position'; } | { data: FaceGetCenter_type; type: 'face_get_center'; } | { data: FaceGetGradient_type; type: 'face_get_gradient'; } | { data: PlaneIntersectAndProject_type; type: 'plane_intersect_and_project'; } | { data: ImportFiles_type; type: 'import_files'; } | { data: ImportedGeometry_type; type: 'imported_geometry'; } | { data: Mass_type; type: 'mass'; } | { data: Volume_type; type: 'volume'; } | { data: Density_type; type: 'density'; } | { data: SurfaceArea_type; type: 'surface_area'; } | { data: CenterOfMass_type; type: 'center_of_mass'; } | { data: GetSketchModePlane_type; type: 'get_sketch_mode_plane'; } | { data: EntityGetDistance_type; type: 'entity_get_distance'; } | { data: EntityClone_type; type: 'entity_clone'; } | { data: EntityLinearPatternTransform_type; type: 'entity_linear_pattern_transform'; } | { data: EntityLinearPattern_type; type: 'entity_linear_pattern'; } | { data: EntityCircularPattern_type; type: 'entity_circular_pattern'; } | { data: EntityMirror_type; type: 'entity_mirror'; } | { data: EntityMirrorAcrossEdge_type; type: 'entity_mirror_acros