diff --git a/docs/html/.doctrees/api/kittycad.api.file.file_convert.asyncio.doctree b/docs/html/.doctrees/api/kittycad.api.file.file_convert.asyncio.doctree index b006c6f26..a7867c73b 100644 Binary files a/docs/html/.doctrees/api/kittycad.api.file.file_convert.asyncio.doctree and b/docs/html/.doctrees/api/kittycad.api.file.file_convert.asyncio.doctree differ diff --git a/docs/html/.doctrees/api/kittycad.api.file.file_convert.asyncio_detailed.doctree b/docs/html/.doctrees/api/kittycad.api.file.file_convert.asyncio_detailed.doctree index 0aee3ed05..2307c5742 100644 Binary files a/docs/html/.doctrees/api/kittycad.api.file.file_convert.asyncio_detailed.doctree and b/docs/html/.doctrees/api/kittycad.api.file.file_convert.asyncio_detailed.doctree differ diff --git a/docs/html/.doctrees/environment.pickle b/docs/html/.doctrees/environment.pickle index c6967673c..73964531a 100644 Binary files a/docs/html/.doctrees/environment.pickle and b/docs/html/.doctrees/environment.pickle differ diff --git a/docs/html/.doctrees/kittycad.api.file.file_convert.doctree b/docs/html/.doctrees/kittycad.api.file.file_convert.doctree index 0cf390b23..8fd5c7d62 100644 Binary files a/docs/html/.doctrees/kittycad.api.file.file_convert.doctree and b/docs/html/.doctrees/kittycad.api.file.file_convert.doctree differ diff --git a/docs/html/api/kittycad.api.file.file_convert.asyncio.html b/docs/html/api/kittycad.api.file.file_convert.asyncio.html index 9d2f85f65..6c40ea889 100644 --- a/docs/html/api/kittycad.api.file.file_convert.asyncio.html +++ b/docs/html/api/kittycad.api.file.file_convert.asyncio.html @@ -79,7 +79,7 @@

asyncio

-async kittycad.api.file.file_convert.asyncio(source_format, output_format, *, client)[source]
+async kittycad.api.file.file_convert.asyncio(source_format, output_format, content, *, client)[source]

Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously.

Return type
diff --git a/docs/html/api/kittycad.api.file.file_convert.asyncio_detailed.html b/docs/html/api/kittycad.api.file.file_convert.asyncio_detailed.html index 1d926bf97..8e2ad5be1 100644 --- a/docs/html/api/kittycad.api.file.file_convert.asyncio_detailed.html +++ b/docs/html/api/kittycad.api.file.file_convert.asyncio_detailed.html @@ -79,7 +79,7 @@

asyncio_detailed

-async kittycad.api.file.file_convert.asyncio_detailed(source_format, output_format, *, client)[source]
+async kittycad.api.file.file_convert.asyncio_detailed(source_format, output_format, content, *, client)[source]
Return type

Response[Union[Any, FileConversion]]

diff --git a/docs/html/kittycad.api.file.file_convert.html b/docs/html/kittycad.api.file.file_convert.html index b5eb8aaff..6417525fc 100644 --- a/docs/html/kittycad.api.file.file_convert.html +++ b/docs/html/kittycad.api.file.file_convert.html @@ -85,7 +85,7 @@ -

asyncio(source_format, output_format, *, client)

+

asyncio(source_format, output_format, ...)

Convert a CAD file from one format to another.

asyncio_detailed(source_format, ...)

diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js index 128438328..cfede16b0 100644 --- a/docs/html/searchindex.js +++ b/docs/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["api/kittycad.AuthenticatedClient","api/kittycad.Client","api/kittycad.api.file.file_conversion_by_id.asyncio","api/kittycad.api.file.file_conversion_by_id.asyncio_detailed","api/kittycad.api.file.file_conversion_by_id.sync","api/kittycad.api.file.file_conversion_by_id.sync_detailed","api/kittycad.api.file.file_convert.asyncio","api/kittycad.api.file.file_convert.asyncio_detailed","api/kittycad.api.file.file_convert.sync","api/kittycad.api.file.file_convert.sync_detailed","api/kittycad.api.meta.meta_debug_instance.asyncio","api/kittycad.api.meta.meta_debug_instance.asyncio_detailed","api/kittycad.api.meta.meta_debug_instance.sync","api/kittycad.api.meta.meta_debug_instance.sync_detailed","api/kittycad.api.meta.meta_debug_session.asyncio","api/kittycad.api.meta.meta_debug_session.asyncio_detailed","api/kittycad.api.meta.meta_debug_session.sync","api/kittycad.api.meta.meta_debug_session.sync_detailed","api/kittycad.api.meta.ping.asyncio","api/kittycad.api.meta.ping.asyncio_detailed","api/kittycad.api.meta.ping.sync","api/kittycad.api.meta.ping.sync_detailed","api/kittycad.client.AuthenticatedClient","api/kittycad.client.Client","api/kittycad.models.AuthSession","api/kittycad.models.Environment","api/kittycad.models.ErrorMessage","api/kittycad.models.FileConversion","api/kittycad.models.FileConversionStatus","api/kittycad.models.InstanceMetadata","api/kittycad.models.Message","api/kittycad.models.ValidFileTypes","api/kittycad.models.auth_session.AuthSession","api/kittycad.models.environment.Environment","api/kittycad.models.error_message.ErrorMessage","api/kittycad.models.file_conversion.FileConversion","api/kittycad.models.file_conversion.FileConversionStatus","api/kittycad.models.file_conversion_status.FileConversionStatus","api/kittycad.models.instance_metadata.InstanceMetadata","api/kittycad.models.message.Message","api/kittycad.models.valid_file_types.ValidFileTypes","api/kittycad.types.File","api/kittycad.types.Response","index","kittycad.api","kittycad.api.file.file_conversion_by_id","kittycad.api.file.file_convert","kittycad.api.meta","kittycad.api.meta.meta_debug_instance","kittycad.api.meta.meta_debug_session","kittycad.api.meta.ping","kittycad.client","kittycad.models","kittycad.models.auth_session","kittycad.models.environment","kittycad.models.error_message","kittycad.models.file_conversion","kittycad.models.file_conversion_status","kittycad.models.instance_metadata","kittycad.models.message","kittycad.models.valid_file_types","kittycad.types"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["api/kittycad.AuthenticatedClient.rst","api/kittycad.Client.rst","api/kittycad.api.file.file_conversion_by_id.asyncio.rst","api/kittycad.api.file.file_conversion_by_id.asyncio_detailed.rst","api/kittycad.api.file.file_conversion_by_id.sync.rst","api/kittycad.api.file.file_conversion_by_id.sync_detailed.rst","api/kittycad.api.file.file_convert.asyncio.rst","api/kittycad.api.file.file_convert.asyncio_detailed.rst","api/kittycad.api.file.file_convert.sync.rst","api/kittycad.api.file.file_convert.sync_detailed.rst","api/kittycad.api.meta.meta_debug_instance.asyncio.rst","api/kittycad.api.meta.meta_debug_instance.asyncio_detailed.rst","api/kittycad.api.meta.meta_debug_instance.sync.rst","api/kittycad.api.meta.meta_debug_instance.sync_detailed.rst","api/kittycad.api.meta.meta_debug_session.asyncio.rst","api/kittycad.api.meta.meta_debug_session.asyncio_detailed.rst","api/kittycad.api.meta.meta_debug_session.sync.rst","api/kittycad.api.meta.meta_debug_session.sync_detailed.rst","api/kittycad.api.meta.ping.asyncio.rst","api/kittycad.api.meta.ping.asyncio_detailed.rst","api/kittycad.api.meta.ping.sync.rst","api/kittycad.api.meta.ping.sync_detailed.rst","api/kittycad.client.AuthenticatedClient.rst","api/kittycad.client.Client.rst","api/kittycad.models.AuthSession.rst","api/kittycad.models.Environment.rst","api/kittycad.models.ErrorMessage.rst","api/kittycad.models.FileConversion.rst","api/kittycad.models.FileConversionStatus.rst","api/kittycad.models.InstanceMetadata.rst","api/kittycad.models.Message.rst","api/kittycad.models.ValidFileTypes.rst","api/kittycad.models.auth_session.AuthSession.rst","api/kittycad.models.environment.Environment.rst","api/kittycad.models.error_message.ErrorMessage.rst","api/kittycad.models.file_conversion.FileConversion.rst","api/kittycad.models.file_conversion.FileConversionStatus.rst","api/kittycad.models.file_conversion_status.FileConversionStatus.rst","api/kittycad.models.instance_metadata.InstanceMetadata.rst","api/kittycad.models.message.Message.rst","api/kittycad.models.valid_file_types.ValidFileTypes.rst","api/kittycad.types.File.rst","api/kittycad.types.Response.rst","index.rst","kittycad.api.rst","kittycad.api.file.file_conversion_by_id.rst","kittycad.api.file.file_convert.rst","kittycad.api.meta.rst","kittycad.api.meta.meta_debug_instance.rst","kittycad.api.meta.meta_debug_session.rst","kittycad.api.meta.ping.rst","kittycad.client.rst","kittycad.models.rst","kittycad.models.auth_session.rst","kittycad.models.environment.rst","kittycad.models.error_message.rst","kittycad.models.file_conversion.rst","kittycad.models.file_conversion_status.rst","kittycad.models.instance_metadata.rst","kittycad.models.message.rst","kittycad.models.valid_file_types.rst","kittycad.types.rst"],objects:{"":[[43,0,0,"-","kittycad"]],"kittycad.AuthenticatedClient":[[0,2,1,"","get_headers"]],"kittycad.Client":[[1,2,1,"","get_cookies"],[1,2,1,"","get_headers"],[1,2,1,"","get_timeout"],[1,2,1,"","with_cookies"],[1,2,1,"","with_headers"],[1,2,1,"","with_timeout"]],"kittycad.api":[[47,0,0,"-","meta"]],"kittycad.api.file":[[45,0,0,"-","file_conversion_by_id"],[46,0,0,"-","file_convert"]],"kittycad.api.file.file_conversion_by_id":[[2,3,1,"","asyncio"],[3,3,1,"","asyncio_detailed"],[4,3,1,"","sync"],[5,3,1,"","sync_detailed"]],"kittycad.api.file.file_convert":[[6,3,1,"","asyncio"],[7,3,1,"","asyncio_detailed"],[8,3,1,"","sync"],[9,3,1,"","sync_detailed"]],"kittycad.api.meta":[[48,0,0,"-","meta_debug_instance"],[49,0,0,"-","meta_debug_session"],[50,0,0,"-","ping"]],"kittycad.api.meta.meta_debug_instance":[[10,3,1,"","asyncio"],[11,3,1,"","asyncio_detailed"],[12,3,1,"","sync"],[13,3,1,"","sync_detailed"]],"kittycad.api.meta.meta_debug_session":[[14,3,1,"","asyncio"],[15,3,1,"","asyncio_detailed"],[16,3,1,"","sync"],[17,3,1,"","sync_detailed"]],"kittycad.api.meta.ping":[[18,3,1,"","asyncio"],[19,3,1,"","asyncio_detailed"],[20,3,1,"","sync"],[21,3,1,"","sync_detailed"]],"kittycad.client":[[22,1,1,"","AuthenticatedClient"],[23,1,1,"","Client"]],"kittycad.client.AuthenticatedClient":[[22,2,1,"","get_headers"]],"kittycad.client.Client":[[23,2,1,"","get_cookies"],[23,2,1,"","get_headers"],[23,2,1,"","get_timeout"],[23,2,1,"","with_cookies"],[23,2,1,"","with_headers"],[23,2,1,"","with_timeout"]],"kittycad.models":[[24,1,1,"","AuthSession"],[25,1,1,"","Environment"],[26,1,1,"","ErrorMessage"],[27,1,1,"","FileConversion"],[28,1,1,"","FileConversionStatus"],[29,1,1,"","InstanceMetadata"],[30,1,1,"","Message"],[31,1,1,"","ValidFileTypes"],[53,0,0,"-","auth_session"],[54,0,0,"-","environment"],[55,0,0,"-","error_message"],[56,0,0,"-","file_conversion"],[57,0,0,"-","file_conversion_status"],[58,0,0,"-","instance_metadata"],[59,0,0,"-","message"],[60,0,0,"-","valid_file_types"]],"kittycad.models.AuthSession":[[24,4,1,"","additional_keys"],[24,2,1,"","from_dict"],[24,2,1,"","to_dict"]],"kittycad.models.Environment":[[25,4,1,"","DEVELOPMENT"],[25,4,1,"","PREVIEW"],[25,4,1,"","PRODUCTION"]],"kittycad.models.ErrorMessage":[[26,4,1,"","additional_keys"],[26,2,1,"","from_dict"],[26,2,1,"","to_dict"]],"kittycad.models.FileConversion":[[27,4,1,"","additional_keys"],[27,2,1,"","from_dict"],[27,2,1,"","to_dict"]],"kittycad.models.FileConversionStatus":[[28,4,1,"","COMPLETED"],[28,4,1,"","FAILED"],[28,4,1,"","IN_PROGRESS"],[28,4,1,"","QUEUED"],[28,4,1,"","UPLOADED"]],"kittycad.models.InstanceMetadata":[[29,4,1,"","additional_keys"],[29,2,1,"","from_dict"],[29,2,1,"","to_dict"]],"kittycad.models.Message":[[30,4,1,"","additional_keys"],[30,2,1,"","from_dict"],[30,2,1,"","to_dict"]],"kittycad.models.ValidFileTypes":[[31,4,1,"","DWG"],[31,4,1,"","DXF"],[31,4,1,"","OBJ"],[31,4,1,"","STEP"],[31,4,1,"","STL"]],"kittycad.models.auth_session":[[32,1,1,"","AuthSession"]],"kittycad.models.auth_session.AuthSession":[[32,4,1,"","additional_keys"],[32,2,1,"","from_dict"],[32,2,1,"","to_dict"]],"kittycad.models.environment":[[33,1,1,"","Environment"]],"kittycad.models.environment.Environment":[[33,4,1,"","DEVELOPMENT"],[33,4,1,"","PREVIEW"],[33,4,1,"","PRODUCTION"]],"kittycad.models.error_message":[[34,1,1,"","ErrorMessage"]],"kittycad.models.error_message.ErrorMessage":[[34,4,1,"","additional_keys"],[34,2,1,"","from_dict"],[34,2,1,"","to_dict"]],"kittycad.models.file_conversion":[[35,1,1,"","FileConversion"],[36,1,1,"","FileConversionStatus"]],"kittycad.models.file_conversion.FileConversion":[[35,4,1,"","additional_keys"],[35,2,1,"","from_dict"],[35,2,1,"","to_dict"]],"kittycad.models.file_conversion.FileConversionStatus":[[36,4,1,"","COMPLETED"],[36,4,1,"","FAILED"],[36,4,1,"","IN_PROGRESS"],[36,4,1,"","QUEUED"],[36,4,1,"","UPLOADED"]],"kittycad.models.file_conversion_status":[[37,1,1,"","FileConversionStatus"]],"kittycad.models.file_conversion_status.FileConversionStatus":[[37,4,1,"","COMPLETED"],[37,4,1,"","FAILED"],[37,4,1,"","IN_PROGRESS"],[37,4,1,"","QUEUED"],[37,4,1,"","UPLOADED"]],"kittycad.models.instance_metadata":[[38,1,1,"","InstanceMetadata"]],"kittycad.models.instance_metadata.InstanceMetadata":[[38,4,1,"","additional_keys"],[38,2,1,"","from_dict"],[38,2,1,"","to_dict"]],"kittycad.models.message":[[39,1,1,"","Message"]],"kittycad.models.message.Message":[[39,4,1,"","additional_keys"],[39,2,1,"","from_dict"],[39,2,1,"","to_dict"]],"kittycad.models.valid_file_types":[[40,1,1,"","ValidFileTypes"]],"kittycad.models.valid_file_types.ValidFileTypes":[[40,4,1,"","DWG"],[40,4,1,"","DXF"],[40,4,1,"","OBJ"],[40,4,1,"","STEP"],[40,4,1,"","STL"]],"kittycad.types":[[41,1,1,"","File"],[42,1,1,"","Response"]],"kittycad.types.File":[[41,2,1,"","to_tuple"]],kittycad:[[0,1,1,"","AuthenticatedClient"],[1,1,1,"","Client"],[44,0,0,"-","api"],[51,0,0,"-","client"],[52,0,0,"-","models"],[61,0,0,"-","types"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function","4":"py:attribute"},terms:{"0":[0,1,22,23],"5":[0,1,22,23],"class":[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42],"enum":[25,28,31,33,36,37,40],"float":[1,23],"function":47,"new":[1,23],"return":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,26,27,29,30,32,34,35,38,39,41],"true":[0,1,22,23],A:[0,1,22,23,42,43],If:[6,8],In:[28,36,37],about:[10,12,14,16],accept:41,access:[43,44],addit:[1,23],additional_kei:[24,26,27,29,30,32,34,35,38,39],all:[1,23,52],an:[25,28,31,33,36,37,40,42],ani:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,24,26,27,29,30,32,34,35,38,39],anoth:[6,8],api:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,43],async:[2,3,6,7,10,11,14,15,18,19],asynchron:[6,8],attribut:[24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],auth_sess:[32,43,52],authent:[0,22],authenticatedcli:43,authsess:[14,15,16,17,43],base:[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42],base_url:[0,1,22,23],been:[0,22],being:[6,8],binaryio:41,cad:[6,8],certain:[6,8],classmethod:[24,26,27,29,30,32,34,35,38,39],client:[0,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,43],complet:[28,36,37],completed_at:[27,35],contain:[41,44,52,61],content:[8,9,42],convers:[2,4],convert:[6,8],cooki:[0,1,22,23],cpu_platform:[29,38],created_at:[24,27,32,35],data:[1,23,41,52],debug:[10,12,14,16],descript:[29,38],develop:[25,33],dict:[0,1,22,23,24,26,27,29,30,32,34,35,38,39],document:[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41],dwg:[31,40],dxf:[31,40],email:[24,32],endpoint:[0,1,22,23,42],enumer:[25,28,31,33,36,37,40],environ:[29,38,43,52],error_messag:[34,43,52],errormessag:43,fail:[28,36,37],fals:[24,32],file:[2,3,4,5,6,7,8,9,43],file_convers:[35,36,43,52],file_conversion_by_id:[2,3,4,5],file_conversion_statu:[37,43,52],file_convert:[6,7,8,9],file_nam:41,fileconvers:[2,3,4,5,6,7,8,9,43],fileconversionstatu:43,form:41,format:[6,8],from:[6,8,42],from_dict:[24,26,27,29,30,32,34,35,38,39],gener:42,get:[0,1,2,4,10,12,14,16,22,23],get_cooki:[1,23],get_head:[0,1,22,23],get_timeout:[1,23],git_hash:[29,38],ha:[0,22],header:[0,1,22,23,42],hostnam:[29,38],http:[0,1,22,23],httpx:41,id:[2,3,4,5,24,27,29,32,35,38],imag:[29,38],in_progress:[28,36,37],index:43,inform:[10,12,14,16,41],input:52,instanc:[10,12],instance_metadata:[38,43,52],instancemetadata:[10,11,12,13,43],io:[0,1,22,23],ip_address:[24,29,32,38],is_valid:[24,32],keep:[1,23],kittycad:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42],larger:[6,8],librari:43,list:[24,26,27,29,30,32,34,35,38,39],machine_typ:[29,38],match:[1,23],messag:[18,19,20,21,26,34,43,52],meta:[10,11,12,13,14,15,16,17,18,19,20,21,43,44],meta_debug_inst:[10,11,12,13,43,44,47],meta_debug_sess:[14,15,16,17,43,44,47],method:[0,1,22,23,24,26,27,29,30,32,34,35,38,39,41,44],mime_typ:41,model:[24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43],modul:[43,44,47,52],multipart:41,name:[29,38],none:[2,4,6,8,10,12,14,16,18,20,41],noth:[0,1,22,23],obj:[31,40],object:[1,23,24,26,27,29,30,32,34,35,38,39,41],one:[1,6,8,23],option:[18,20,41],output:[27,35,52],output_format:[6,7,8,9,27,35],page:43,pars:42,payload:41,perform:[6,8],ping:[18,19,20,21,43,44,47],preview:[25,33],primarili:[10,12,14,16],product:[25,33],progress:[28,36,37],properti:61,queu:[28,36,37],relat:[1,23],represent:41,request:[14,16],respons:[3,5,7,9,11,13,15,17,19,21,43],search:43,second:[1,23],secur:[0,22],server:[10,12,18,20],session:[14,16],share:61,simpl:[18,20],size:[6,8],some:61,sourc:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42],source_format:[6,7,8,9],specif:[10,12],src_dict:[24,26,27,29,30,32,34,35,38,39],src_format:[27,35],statu:[2,4,27,35],status_cod:42,step:[31,40],stl:[31,40],str:[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41],summari:[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41],t:[24,26,27,29,30,32,34,35,38,39,42],textio:41,than:[6,8],thi:[1,10,12,14,16,23],timeout:[0,1,22,23],to_dict:[24,26,27,29,30,32,34,35,38,39],to_tupl:41,token:[0,22,24,32],track:[1,23],tupl:41,type:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,26,27,29,30,32,34,35,38,39,41,42,43],union:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,41],unset:[24,26,27,29,30,32,34,35,38,39],upload:[28,36,37,41],us:[0,1,10,12,14,16,22,23,52],user_id:[24,32],valid_file_typ:[40,43,52],validfiletyp:43,valu:[25,28,31,33,36,37,40],verify_ssl:[0,1,22,23],which:[0,22],with_cooki:[1,23],with_head:[1,23],with_timeout:[1,23],your:[14,16],zone:[29,38]},titles:["AuthenticatedClient","Client","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","AuthenticatedClient","Client","AuthSession","Environment","ErrorMessage","FileConversion","FileConversionStatus","InstanceMetadata","Message","ValidFileTypes","AuthSession","Environment","ErrorMessage","FileConversion","FileConversionStatus","FileConversionStatus","InstanceMetadata","Message","ValidFileTypes","File","Response","Welcome to kittycad\u2019s documentation!","kittycad.api Package","kittycad.api.file.file_conversion_by_id Module","kittycad.api.file.file_convert Module","kittycad.api.meta Package","kittycad.api.meta.meta_debug_instance Module","kittycad.api.meta.meta_debug_session Module","kittycad.api.meta.ping Module","kittycad.client Module","kittycad.models Package","kittycad.models.auth_session Module","kittycad.models.environment Module","kittycad.models.error_message Module","kittycad.models.file_conversion Module","kittycad.models.file_conversion_status Module","kittycad.models.instance_metadata Module","kittycad.models.message Module","kittycad.models.valid_file_types Module","kittycad.types Module"],titleterms:{"class":[43,51,52,53,54,55,56,57,58,59,60,61],"function":[45,46,48,49,50],api:[44,45,46,47,48,49,50],asyncio:[2,6,10,14,18],asyncio_detail:[3,7,11,15,19],auth_sess:53,authenticatedcli:[0,22],authsess:[24,32],client:[1,23,51],content:[43,44,47,52],document:43,environ:[25,33,54],error_messag:55,errormessag:[26,34],file:[41,45,46],file_convers:56,file_conversion_by_id:45,file_conversion_statu:57,file_convert:46,fileconvers:[27,35],fileconversionstatu:[28,36,37],indic:43,instance_metadata:58,instancemetadata:[29,38],kittycad:[43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61],messag:[30,39,59],meta:[47,48,49,50],meta_debug_inst:48,meta_debug_sess:49,model:[52,53,54,55,56,57,58,59,60],modul:[45,46,48,49,50,51,53,54,55,56,57,58,59,60,61],packag:[43,44,47,52],ping:50,respons:42,s:43,sync:[4,8,12,16,20],sync_detail:[5,9,13,17,21],tabl:43,type:61,valid_file_typ:60,validfiletyp:[31,40],welcom:43}}) \ No newline at end of file +Search.setIndex({docnames:["api/kittycad.AuthenticatedClient","api/kittycad.Client","api/kittycad.api.file.file_conversion_by_id.asyncio","api/kittycad.api.file.file_conversion_by_id.asyncio_detailed","api/kittycad.api.file.file_conversion_by_id.sync","api/kittycad.api.file.file_conversion_by_id.sync_detailed","api/kittycad.api.file.file_convert.asyncio","api/kittycad.api.file.file_convert.asyncio_detailed","api/kittycad.api.file.file_convert.sync","api/kittycad.api.file.file_convert.sync_detailed","api/kittycad.api.meta.meta_debug_instance.asyncio","api/kittycad.api.meta.meta_debug_instance.asyncio_detailed","api/kittycad.api.meta.meta_debug_instance.sync","api/kittycad.api.meta.meta_debug_instance.sync_detailed","api/kittycad.api.meta.meta_debug_session.asyncio","api/kittycad.api.meta.meta_debug_session.asyncio_detailed","api/kittycad.api.meta.meta_debug_session.sync","api/kittycad.api.meta.meta_debug_session.sync_detailed","api/kittycad.api.meta.ping.asyncio","api/kittycad.api.meta.ping.asyncio_detailed","api/kittycad.api.meta.ping.sync","api/kittycad.api.meta.ping.sync_detailed","api/kittycad.client.AuthenticatedClient","api/kittycad.client.Client","api/kittycad.models.AuthSession","api/kittycad.models.Environment","api/kittycad.models.ErrorMessage","api/kittycad.models.FileConversion","api/kittycad.models.FileConversionStatus","api/kittycad.models.InstanceMetadata","api/kittycad.models.Message","api/kittycad.models.ValidFileTypes","api/kittycad.models.auth_session.AuthSession","api/kittycad.models.environment.Environment","api/kittycad.models.error_message.ErrorMessage","api/kittycad.models.file_conversion.FileConversion","api/kittycad.models.file_conversion.FileConversionStatus","api/kittycad.models.file_conversion_status.FileConversionStatus","api/kittycad.models.instance_metadata.InstanceMetadata","api/kittycad.models.message.Message","api/kittycad.models.valid_file_types.ValidFileTypes","api/kittycad.types.File","api/kittycad.types.Response","index","kittycad.api","kittycad.api.file.file_conversion_by_id","kittycad.api.file.file_convert","kittycad.api.meta","kittycad.api.meta.meta_debug_instance","kittycad.api.meta.meta_debug_session","kittycad.api.meta.ping","kittycad.client","kittycad.models","kittycad.models.auth_session","kittycad.models.environment","kittycad.models.error_message","kittycad.models.file_conversion","kittycad.models.file_conversion_status","kittycad.models.instance_metadata","kittycad.models.message","kittycad.models.valid_file_types","kittycad.types"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["api/kittycad.AuthenticatedClient.rst","api/kittycad.Client.rst","api/kittycad.api.file.file_conversion_by_id.asyncio.rst","api/kittycad.api.file.file_conversion_by_id.asyncio_detailed.rst","api/kittycad.api.file.file_conversion_by_id.sync.rst","api/kittycad.api.file.file_conversion_by_id.sync_detailed.rst","api/kittycad.api.file.file_convert.asyncio.rst","api/kittycad.api.file.file_convert.asyncio_detailed.rst","api/kittycad.api.file.file_convert.sync.rst","api/kittycad.api.file.file_convert.sync_detailed.rst","api/kittycad.api.meta.meta_debug_instance.asyncio.rst","api/kittycad.api.meta.meta_debug_instance.asyncio_detailed.rst","api/kittycad.api.meta.meta_debug_instance.sync.rst","api/kittycad.api.meta.meta_debug_instance.sync_detailed.rst","api/kittycad.api.meta.meta_debug_session.asyncio.rst","api/kittycad.api.meta.meta_debug_session.asyncio_detailed.rst","api/kittycad.api.meta.meta_debug_session.sync.rst","api/kittycad.api.meta.meta_debug_session.sync_detailed.rst","api/kittycad.api.meta.ping.asyncio.rst","api/kittycad.api.meta.ping.asyncio_detailed.rst","api/kittycad.api.meta.ping.sync.rst","api/kittycad.api.meta.ping.sync_detailed.rst","api/kittycad.client.AuthenticatedClient.rst","api/kittycad.client.Client.rst","api/kittycad.models.AuthSession.rst","api/kittycad.models.Environment.rst","api/kittycad.models.ErrorMessage.rst","api/kittycad.models.FileConversion.rst","api/kittycad.models.FileConversionStatus.rst","api/kittycad.models.InstanceMetadata.rst","api/kittycad.models.Message.rst","api/kittycad.models.ValidFileTypes.rst","api/kittycad.models.auth_session.AuthSession.rst","api/kittycad.models.environment.Environment.rst","api/kittycad.models.error_message.ErrorMessage.rst","api/kittycad.models.file_conversion.FileConversion.rst","api/kittycad.models.file_conversion.FileConversionStatus.rst","api/kittycad.models.file_conversion_status.FileConversionStatus.rst","api/kittycad.models.instance_metadata.InstanceMetadata.rst","api/kittycad.models.message.Message.rst","api/kittycad.models.valid_file_types.ValidFileTypes.rst","api/kittycad.types.File.rst","api/kittycad.types.Response.rst","index.rst","kittycad.api.rst","kittycad.api.file.file_conversion_by_id.rst","kittycad.api.file.file_convert.rst","kittycad.api.meta.rst","kittycad.api.meta.meta_debug_instance.rst","kittycad.api.meta.meta_debug_session.rst","kittycad.api.meta.ping.rst","kittycad.client.rst","kittycad.models.rst","kittycad.models.auth_session.rst","kittycad.models.environment.rst","kittycad.models.error_message.rst","kittycad.models.file_conversion.rst","kittycad.models.file_conversion_status.rst","kittycad.models.instance_metadata.rst","kittycad.models.message.rst","kittycad.models.valid_file_types.rst","kittycad.types.rst"],objects:{"":[[43,0,0,"-","kittycad"]],"kittycad.AuthenticatedClient":[[0,2,1,"","get_headers"]],"kittycad.Client":[[1,2,1,"","get_cookies"],[1,2,1,"","get_headers"],[1,2,1,"","get_timeout"],[1,2,1,"","with_cookies"],[1,2,1,"","with_headers"],[1,2,1,"","with_timeout"]],"kittycad.api":[[47,0,0,"-","meta"]],"kittycad.api.file":[[45,0,0,"-","file_conversion_by_id"],[46,0,0,"-","file_convert"]],"kittycad.api.file.file_conversion_by_id":[[2,3,1,"","asyncio"],[3,3,1,"","asyncio_detailed"],[4,3,1,"","sync"],[5,3,1,"","sync_detailed"]],"kittycad.api.file.file_convert":[[6,3,1,"","asyncio"],[7,3,1,"","asyncio_detailed"],[8,3,1,"","sync"],[9,3,1,"","sync_detailed"]],"kittycad.api.meta":[[48,0,0,"-","meta_debug_instance"],[49,0,0,"-","meta_debug_session"],[50,0,0,"-","ping"]],"kittycad.api.meta.meta_debug_instance":[[10,3,1,"","asyncio"],[11,3,1,"","asyncio_detailed"],[12,3,1,"","sync"],[13,3,1,"","sync_detailed"]],"kittycad.api.meta.meta_debug_session":[[14,3,1,"","asyncio"],[15,3,1,"","asyncio_detailed"],[16,3,1,"","sync"],[17,3,1,"","sync_detailed"]],"kittycad.api.meta.ping":[[18,3,1,"","asyncio"],[19,3,1,"","asyncio_detailed"],[20,3,1,"","sync"],[21,3,1,"","sync_detailed"]],"kittycad.client":[[22,1,1,"","AuthenticatedClient"],[23,1,1,"","Client"]],"kittycad.client.AuthenticatedClient":[[22,2,1,"","get_headers"]],"kittycad.client.Client":[[23,2,1,"","get_cookies"],[23,2,1,"","get_headers"],[23,2,1,"","get_timeout"],[23,2,1,"","with_cookies"],[23,2,1,"","with_headers"],[23,2,1,"","with_timeout"]],"kittycad.models":[[24,1,1,"","AuthSession"],[25,1,1,"","Environment"],[26,1,1,"","ErrorMessage"],[27,1,1,"","FileConversion"],[28,1,1,"","FileConversionStatus"],[29,1,1,"","InstanceMetadata"],[30,1,1,"","Message"],[31,1,1,"","ValidFileTypes"],[53,0,0,"-","auth_session"],[54,0,0,"-","environment"],[55,0,0,"-","error_message"],[56,0,0,"-","file_conversion"],[57,0,0,"-","file_conversion_status"],[58,0,0,"-","instance_metadata"],[59,0,0,"-","message"],[60,0,0,"-","valid_file_types"]],"kittycad.models.AuthSession":[[24,4,1,"","additional_keys"],[24,2,1,"","from_dict"],[24,2,1,"","to_dict"]],"kittycad.models.Environment":[[25,4,1,"","DEVELOPMENT"],[25,4,1,"","PREVIEW"],[25,4,1,"","PRODUCTION"]],"kittycad.models.ErrorMessage":[[26,4,1,"","additional_keys"],[26,2,1,"","from_dict"],[26,2,1,"","to_dict"]],"kittycad.models.FileConversion":[[27,4,1,"","additional_keys"],[27,2,1,"","from_dict"],[27,2,1,"","to_dict"]],"kittycad.models.FileConversionStatus":[[28,4,1,"","COMPLETED"],[28,4,1,"","FAILED"],[28,4,1,"","IN_PROGRESS"],[28,4,1,"","QUEUED"],[28,4,1,"","UPLOADED"]],"kittycad.models.InstanceMetadata":[[29,4,1,"","additional_keys"],[29,2,1,"","from_dict"],[29,2,1,"","to_dict"]],"kittycad.models.Message":[[30,4,1,"","additional_keys"],[30,2,1,"","from_dict"],[30,2,1,"","to_dict"]],"kittycad.models.ValidFileTypes":[[31,4,1,"","DWG"],[31,4,1,"","DXF"],[31,4,1,"","OBJ"],[31,4,1,"","STEP"],[31,4,1,"","STL"]],"kittycad.models.auth_session":[[32,1,1,"","AuthSession"]],"kittycad.models.auth_session.AuthSession":[[32,4,1,"","additional_keys"],[32,2,1,"","from_dict"],[32,2,1,"","to_dict"]],"kittycad.models.environment":[[33,1,1,"","Environment"]],"kittycad.models.environment.Environment":[[33,4,1,"","DEVELOPMENT"],[33,4,1,"","PREVIEW"],[33,4,1,"","PRODUCTION"]],"kittycad.models.error_message":[[34,1,1,"","ErrorMessage"]],"kittycad.models.error_message.ErrorMessage":[[34,4,1,"","additional_keys"],[34,2,1,"","from_dict"],[34,2,1,"","to_dict"]],"kittycad.models.file_conversion":[[35,1,1,"","FileConversion"],[36,1,1,"","FileConversionStatus"]],"kittycad.models.file_conversion.FileConversion":[[35,4,1,"","additional_keys"],[35,2,1,"","from_dict"],[35,2,1,"","to_dict"]],"kittycad.models.file_conversion.FileConversionStatus":[[36,4,1,"","COMPLETED"],[36,4,1,"","FAILED"],[36,4,1,"","IN_PROGRESS"],[36,4,1,"","QUEUED"],[36,4,1,"","UPLOADED"]],"kittycad.models.file_conversion_status":[[37,1,1,"","FileConversionStatus"]],"kittycad.models.file_conversion_status.FileConversionStatus":[[37,4,1,"","COMPLETED"],[37,4,1,"","FAILED"],[37,4,1,"","IN_PROGRESS"],[37,4,1,"","QUEUED"],[37,4,1,"","UPLOADED"]],"kittycad.models.instance_metadata":[[38,1,1,"","InstanceMetadata"]],"kittycad.models.instance_metadata.InstanceMetadata":[[38,4,1,"","additional_keys"],[38,2,1,"","from_dict"],[38,2,1,"","to_dict"]],"kittycad.models.message":[[39,1,1,"","Message"]],"kittycad.models.message.Message":[[39,4,1,"","additional_keys"],[39,2,1,"","from_dict"],[39,2,1,"","to_dict"]],"kittycad.models.valid_file_types":[[40,1,1,"","ValidFileTypes"]],"kittycad.models.valid_file_types.ValidFileTypes":[[40,4,1,"","DWG"],[40,4,1,"","DXF"],[40,4,1,"","OBJ"],[40,4,1,"","STEP"],[40,4,1,"","STL"]],"kittycad.types":[[41,1,1,"","File"],[42,1,1,"","Response"]],"kittycad.types.File":[[41,2,1,"","to_tuple"]],kittycad:[[0,1,1,"","AuthenticatedClient"],[1,1,1,"","Client"],[44,0,0,"-","api"],[51,0,0,"-","client"],[52,0,0,"-","models"],[61,0,0,"-","types"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function","4":"py:attribute"},terms:{"0":[0,1,22,23],"5":[0,1,22,23],"class":[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42],"enum":[25,28,31,33,36,37,40],"float":[1,23],"function":47,"new":[1,23],"return":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,26,27,29,30,32,34,35,38,39,41],"true":[0,1,22,23],A:[0,1,22,23,42,43],If:[6,8],In:[28,36,37],about:[10,12,14,16],accept:41,access:[43,44],addit:[1,23],additional_kei:[24,26,27,29,30,32,34,35,38,39],all:[1,23,52],an:[25,28,31,33,36,37,40,42],ani:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,24,26,27,29,30,32,34,35,38,39],anoth:[6,8],api:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,43],async:[2,3,6,7,10,11,14,15,18,19],asynchron:[6,8],attribut:[24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40],auth_sess:[32,43,52],authent:[0,22],authenticatedcli:43,authsess:[14,15,16,17,43],base:[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42],base_url:[0,1,22,23],been:[0,22],being:[6,8],binaryio:41,cad:[6,8],certain:[6,8],classmethod:[24,26,27,29,30,32,34,35,38,39],client:[0,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,43],complet:[28,36,37],completed_at:[27,35],contain:[41,44,52,61],content:[6,7,8,9,42],convers:[2,4],convert:[6,8],cooki:[0,1,22,23],cpu_platform:[29,38],created_at:[24,27,32,35],data:[1,23,41,52],debug:[10,12,14,16],descript:[29,38],develop:[25,33],dict:[0,1,22,23,24,26,27,29,30,32,34,35,38,39],document:[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41],dwg:[31,40],dxf:[31,40],email:[24,32],endpoint:[0,1,22,23,42],enumer:[25,28,31,33,36,37,40],environ:[29,38,43,52],error_messag:[34,43,52],errormessag:43,fail:[28,36,37],fals:[24,32],file:[2,3,4,5,6,7,8,9,43],file_convers:[35,36,43,52],file_conversion_by_id:[2,3,4,5],file_conversion_statu:[37,43,52],file_convert:[6,7,8,9],file_nam:41,fileconvers:[2,3,4,5,6,7,8,9,43],fileconversionstatu:43,form:41,format:[6,8],from:[6,8,42],from_dict:[24,26,27,29,30,32,34,35,38,39],gener:42,get:[0,1,2,4,10,12,14,16,22,23],get_cooki:[1,23],get_head:[0,1,22,23],get_timeout:[1,23],git_hash:[29,38],ha:[0,22],header:[0,1,22,23,42],hostnam:[29,38],http:[0,1,22,23],httpx:41,id:[2,3,4,5,24,27,29,32,35,38],imag:[29,38],in_progress:[28,36,37],index:43,inform:[10,12,14,16,41],input:52,instanc:[10,12],instance_metadata:[38,43,52],instancemetadata:[10,11,12,13,43],io:[0,1,22,23],ip_address:[24,29,32,38],is_valid:[24,32],keep:[1,23],kittycad:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42],larger:[6,8],librari:43,list:[24,26,27,29,30,32,34,35,38,39],machine_typ:[29,38],match:[1,23],messag:[18,19,20,21,26,34,43,52],meta:[10,11,12,13,14,15,16,17,18,19,20,21,43,44],meta_debug_inst:[10,11,12,13,43,44,47],meta_debug_sess:[14,15,16,17,43,44,47],method:[0,1,22,23,24,26,27,29,30,32,34,35,38,39,41,44],mime_typ:41,model:[24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,43],modul:[43,44,47,52],multipart:41,name:[29,38],none:[2,4,6,8,10,12,14,16,18,20,41],noth:[0,1,22,23],obj:[31,40],object:[1,23,24,26,27,29,30,32,34,35,38,39,41],one:[1,6,8,23],option:[18,20,41],output:[27,35,52],output_format:[6,7,8,9,27,35],page:43,pars:42,payload:41,perform:[6,8],ping:[18,19,20,21,43,44,47],preview:[25,33],primarili:[10,12,14,16],product:[25,33],progress:[28,36,37],properti:61,queu:[28,36,37],relat:[1,23],represent:41,request:[14,16],respons:[3,5,7,9,11,13,15,17,19,21,43],search:43,second:[1,23],secur:[0,22],server:[10,12,18,20],session:[14,16],share:61,simpl:[18,20],size:[6,8],some:61,sourc:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42],source_format:[6,7,8,9],specif:[10,12],src_dict:[24,26,27,29,30,32,34,35,38,39],src_format:[27,35],statu:[2,4,27,35],status_cod:42,step:[31,40],stl:[31,40],str:[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41],summari:[0,1,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41],t:[24,26,27,29,30,32,34,35,38,39,42],textio:41,than:[6,8],thi:[1,10,12,14,16,23],timeout:[0,1,22,23],to_dict:[24,26,27,29,30,32,34,35,38,39],to_tupl:41,token:[0,22,24,32],track:[1,23],tupl:41,type:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,26,27,29,30,32,34,35,38,39,41,42,43],union:[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,41],unset:[24,26,27,29,30,32,34,35,38,39],upload:[28,36,37,41],us:[0,1,10,12,14,16,22,23,52],user_id:[24,32],valid_file_typ:[40,43,52],validfiletyp:43,valu:[25,28,31,33,36,37,40],verify_ssl:[0,1,22,23],which:[0,22],with_cooki:[1,23],with_head:[1,23],with_timeout:[1,23],your:[14,16],zone:[29,38]},titles:["AuthenticatedClient","Client","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","asyncio","asyncio_detailed","sync","sync_detailed","AuthenticatedClient","Client","AuthSession","Environment","ErrorMessage","FileConversion","FileConversionStatus","InstanceMetadata","Message","ValidFileTypes","AuthSession","Environment","ErrorMessage","FileConversion","FileConversionStatus","FileConversionStatus","InstanceMetadata","Message","ValidFileTypes","File","Response","Welcome to kittycad\u2019s documentation!","kittycad.api Package","kittycad.api.file.file_conversion_by_id Module","kittycad.api.file.file_convert Module","kittycad.api.meta Package","kittycad.api.meta.meta_debug_instance Module","kittycad.api.meta.meta_debug_session Module","kittycad.api.meta.ping Module","kittycad.client Module","kittycad.models Package","kittycad.models.auth_session Module","kittycad.models.environment Module","kittycad.models.error_message Module","kittycad.models.file_conversion Module","kittycad.models.file_conversion_status Module","kittycad.models.instance_metadata Module","kittycad.models.message Module","kittycad.models.valid_file_types Module","kittycad.types Module"],titleterms:{"class":[43,51,52,53,54,55,56,57,58,59,60,61],"function":[45,46,48,49,50],api:[44,45,46,47,48,49,50],asyncio:[2,6,10,14,18],asyncio_detail:[3,7,11,15,19],auth_sess:53,authenticatedcli:[0,22],authsess:[24,32],client:[1,23,51],content:[43,44,47,52],document:43,environ:[25,33,54],error_messag:55,errormessag:[26,34],file:[41,45,46],file_convers:56,file_conversion_by_id:45,file_conversion_statu:57,file_convert:46,fileconvers:[27,35],fileconversionstatu:[28,36,37],indic:43,instance_metadata:58,instancemetadata:[29,38],kittycad:[43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61],messag:[30,39,59],meta:[47,48,49,50],meta_debug_inst:48,meta_debug_sess:49,model:[52,53,54,55,56,57,58,59,60],modul:[45,46,48,49,50,51,53,54,55,56,57,58,59,60,61],packag:[43,44,47,52],ping:50,respons:42,s:43,sync:[4,8,12,16,20],sync_detail:[5,9,13,17,21],tabl:43,type:61,valid_file_typ:60,validfiletyp:[31,40],welcom:43}}) \ No newline at end of file diff --git a/kittycad.api.file.file_conversion_by_id.html b/kittycad.api.file.file_conversion_by_id.html new file mode 100644 index 000000000..67f8ddaa2 --- /dev/null +++ b/kittycad.api.file.file_conversion_by_id.html @@ -0,0 +1,43 @@ + +Python: module kittycad.api.file.file_conversion_by_id + + + + + +
 
+ 
kittycad.api.file.file_conversion_by_id		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_conversion_by_id.py
+

+

+ + + + + +
 
+Modules
       
httpx
+

+ + + + + +
 
+Functions
       
async asyncio(id: str, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]
Get the status of a file conversion.
+
async asyncio_detailed(id: str, *, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]
+
sync(id: str, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]
Get the status of a file conversion.
+
sync_detailed(id: str, *, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]
+

+ + + + + +
 
+Data
       Any = typing.Any
+Dict = typing.Dict
+Optional = typing.Optional
+Union = typing.Union
+ \ No newline at end of file diff --git a/kittycad.api.file.file_convert.html b/kittycad.api.file.file_convert.html new file mode 100644 index 000000000..67d74efca --- /dev/null +++ b/kittycad.api.file.file_convert.html @@ -0,0 +1,43 @@ + +Python: module kittycad.api.file.file_convert + + + + + +
 
+ 
kittycad.api.file.file_convert		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_convert.py
+

+

+ + + + + +
 
+Modules
       
httpx
+

+ + + + + +
 
+Functions
       
async asyncio(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]
Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously.
+
async asyncio_detailed(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]
+
sync(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]
Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously.
+
sync_detailed(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]
+

+ + + + + +
 
+Data
       Any = typing.Any
+Dict = typing.Dict
+Optional = typing.Optional
+Union = typing.Union
+ \ No newline at end of file diff --git a/kittycad.api.file.file_convert_with_base64_helper.html b/kittycad.api.file.file_convert_with_base64_helper.html new file mode 100644 index 000000000..f37c8969b --- /dev/null +++ b/kittycad.api.file.file_convert_with_base64_helper.html @@ -0,0 +1,41 @@ + +Python: module kittycad.api.file.file_convert_with_base64_helper + + + + + +
 
+ 
kittycad.api.file.file_convert_with_base64_helper		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_convert_with_base64_helper.py
+

+

+ + + + + +
 
+Modules
       
httpx
+

+ + + + + +
 
+Functions
       
async asyncio(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]
Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously. This function automatically base64 encodes the request body and base64 decodes the request output.
+
sync(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]
Convert a CAD file from one format to another. If the file being converted is larger than a certain size it will be performed asynchronously. This function automatically base64 encodes the request body and base64 decodes the request output.
+

+ + + + + +
 
+Data
       Any = typing.Any
+Dict = typing.Dict
+Optional = typing.Optional
+Union = typing.Union
+ \ No newline at end of file diff --git a/kittycad.api.file.html b/kittycad.api.file.html new file mode 100644 index 000000000..06a6bdc0b --- /dev/null +++ b/kittycad.api.file.html @@ -0,0 +1,24 @@ + +Python: package kittycad.api.file + + + + + +
 
+ 
kittycad.api.file		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/__init__.py
+

+

+ + + + + +
 
+Package Contents
       
file_conversion_by_id
+		file_convert
+		file_convert_with_base64_helper
+
+ \ No newline at end of file diff --git a/kittycad.api.html b/kittycad.api.html new file mode 100644 index 000000000..05ad564b2 --- /dev/null +++ b/kittycad.api.html @@ -0,0 +1,23 @@ + +Python: package kittycad.api + + + + + +
 
+ 
kittycad.api		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/__init__.py
+

Contains methods for accessing the API

+

+ + + + + +
 
+Package Contents
       
file (package)
+		meta (package)
+
+ \ No newline at end of file diff --git a/kittycad.api.meta.html b/kittycad.api.meta.html new file mode 100644 index 000000000..e15bee581 --- /dev/null +++ b/kittycad.api.meta.html @@ -0,0 +1,24 @@ + +Python: package kittycad.api.meta + + + + + +
 
+ 
kittycad.api.meta		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/__init__.py
+

+

+ + + + + +
 
+Package Contents
       
meta_debug_instance
+		meta_debug_session
+		ping
+
+ \ No newline at end of file diff --git a/kittycad.api.meta.meta_debug_instance.html b/kittycad.api.meta.meta_debug_instance.html new file mode 100644 index 000000000..ce7f9dee5 --- /dev/null +++ b/kittycad.api.meta.meta_debug_instance.html @@ -0,0 +1,43 @@ + +Python: module kittycad.api.meta.meta_debug_instance + + + + + +
 
+ 
kittycad.api.meta.meta_debug_instance		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/meta_debug_instance.py
+

+

+ + + + + +
 
+Modules
       
httpx
+

+ + + + + +
 
+Functions
       
async asyncio(*, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.instance_metadata.InstanceMetadata, NoneType]
Get information about this specific API server instance. This is primarily used for debugging.
+
async asyncio_detailed(*, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.instance_metadata.InstanceMetadata]]
+
sync(*, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.instance_metadata.InstanceMetadata, NoneType]
Get information about this specific API server instance. This is primarily used for debugging.
+
sync_detailed(*, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.instance_metadata.InstanceMetadata]]
+

+ + + + + +
 
+Data
       Any = typing.Any
+Dict = typing.Dict
+Optional = typing.Optional
+Union = typing.Union
+ \ No newline at end of file diff --git a/kittycad.api.meta.meta_debug_session.html b/kittycad.api.meta.meta_debug_session.html new file mode 100644 index 000000000..237a0a514 --- /dev/null +++ b/kittycad.api.meta.meta_debug_session.html @@ -0,0 +1,43 @@ + +Python: module kittycad.api.meta.meta_debug_session + + + + + +
 
+ 
kittycad.api.meta.meta_debug_session		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/meta_debug_session.py
+

+

+ + + + + +
 
+Modules
       
httpx
+

+ + + + + +
 
+Functions
       
async asyncio(*, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.auth_session.AuthSession, NoneType]
Get information about your API request session. This is primarily used for debugging.
+
async asyncio_detailed(*, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.auth_session.AuthSession]]
+
sync(*, client: kittycad.client.AuthenticatedClient) -> Union[Any, kittycad.models.auth_session.AuthSession, NoneType]
Get information about your API request session. This is primarily used for debugging.
+
sync_detailed(*, client: kittycad.client.AuthenticatedClient) -> kittycad.types.Response[typing.Union[typing.Any, kittycad.models.auth_session.AuthSession]]
+

+ + + + + +
 
+Data
       Any = typing.Any
+Dict = typing.Dict
+Optional = typing.Optional
+Union = typing.Union
+ \ No newline at end of file diff --git a/kittycad.api.meta.ping.html b/kittycad.api.meta.ping.html new file mode 100644 index 000000000..31eff1cc0 --- /dev/null +++ b/kittycad.api.meta.ping.html @@ -0,0 +1,42 @@ + +Python: module kittycad.api.meta.ping + + + + + +
 
+ 
kittycad.api.meta.ping		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/ping.py
+

+

+ + + + + +
 
+Modules
       
httpx
+

+ + + + + +
 
+Functions
       
async asyncio(*, client: kittycad.client.Client) -> Optional[kittycad.models.message.Message]
Simple ping to the server.
+
async asyncio_detailed(*, client: kittycad.client.Client) -> kittycad.types.Response[kittycad.models.message.Message]
+
sync(*, client: kittycad.client.Client) -> Optional[kittycad.models.message.Message]
Simple ping to the server.
+
sync_detailed(*, client: kittycad.client.Client) -> kittycad.types.Response[kittycad.models.message.Message]
+

+ + + + + +
 
+Data
       Any = typing.Any
+Dict = typing.Dict
+Optional = typing.Optional
+ \ No newline at end of file diff --git a/kittycad.client.html b/kittycad.client.html new file mode 100644 index 000000000..69f4c4eaa --- /dev/null +++ b/kittycad.client.html @@ -0,0 +1,171 @@ + +Python: module kittycad.client + + + + + +
 
+ 
kittycad.client		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/client.py
+

+

+ + + + + +
 
+Modules
       
attr
+		ssl
+

+ + + + + +
 
+Classes
       
+
builtins.object +
+
+
Client +
+
+
AuthenticatedClient +
+
+
+
+
+

+ + + + + + + +
 
+class AuthenticatedClient(Client)
   AuthenticatedClient(base_url: str = 'https://api.kittycad.io', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True, token: str) -> None
+ 
+A Client which has been authenticated for use on secured endpoints
 
 
Method resolution order:
+
AuthenticatedClient
+
Client
+
builtins.object
+
+
+Methods defined here:
+
__eq__(self, other)
Method generated by attrs for class AuthenticatedClient.
+ +
__ge__(self, other)
Method generated by attrs for class AuthenticatedClient.
+ +
__gt__(self, other)
Method generated by attrs for class AuthenticatedClient.
+ +
__init__(self, base_url: str = 'https://api.kittycad.io', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True, token: str) -> None
Method generated by attrs for class AuthenticatedClient.
+ +
__le__(self, other)
Method generated by attrs for class AuthenticatedClient.
+ +
__lt__(self, other)
Method generated by attrs for class AuthenticatedClient.
+ +
__ne__(self, other)
Method generated by attrs for class AuthenticatedClient.
+ +
__repr__(self)
Method generated by attrs for class AuthenticatedClient.
+ +
get_headers(self) -> Dict[str, str]
Get headers to be used in authenticated endpoints
+ +
+Data and other attributes defined here:
+
__annotations__ = {'token': <class 'str'>}
+ +
__attrs_attrs__ = (Attribute(name='base_url', default='https://api... kw_only=True, inherited=False, on_setattr=None))
+ +
__hash__ = None
+ +
+Methods inherited from Client:
+
get_cookies(self) -> Dict[str, str]
+ +
get_timeout(self) -> float
+ +
with_cookies(self, cookies: Dict[str, str]) -> 'Client'
Get a new client matching this one with additional cookies
+ +
with_headers(self, headers: Dict[str, str]) -> 'Client'
Get a new client matching this one with additional headers
+ +
with_timeout(self, timeout: float) -> 'Client'
Get a new client matching this one with a new timeout (in seconds)
+ +
+Data descriptors inherited from Client:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + + + +
 
+class Client(builtins.object)
   Client(base_url: str = 'https://api.kittycad.io', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True) -&gt; None
+ 
+A class for keeping track of data related to the API
 
 Methods defined here:
+
__eq__(self, other)
Method generated by attrs for class Client.
+ +
__ge__(self, other)
Method generated by attrs for class Client.
+ +
__gt__(self, other)
Method generated by attrs for class Client.
+ +
__init__(self, base_url: str = 'https://api.kittycad.io', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True) -> None
Method generated by attrs for class Client.
+ +
__le__(self, other)
Method generated by attrs for class Client.
+ +
__lt__(self, other)
Method generated by attrs for class Client.
+ +
__ne__(self, other)
Method generated by attrs for class Client.
+ +
__repr__(self)
Method generated by attrs for class Client.
+ +
get_cookies(self) -> Dict[str, str]
+ +
get_headers(self) -> Dict[str, str]
Get headers to be used in all endpoints
+ +
get_timeout(self) -> float
+ +
with_cookies(self, cookies: Dict[str, str]) -> 'Client'
Get a new client matching this one with additional cookies
+ +
with_headers(self, headers: Dict[str, str]) -> 'Client'
Get a new client matching this one with additional headers
+ +
with_timeout(self, timeout: float) -> 'Client'
Get a new client matching this one with a new timeout (in seconds)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
__annotations__ = {'base_url': <class 'str'>, 'cookies': typing.Dict[str, str], 'headers': typing.Dict[str, str], 'timeout': <class 'float'>, 'verify_ssl': typing.Union[str, bool, ssl.SSLContext]}
+ +
__attrs_attrs__ = (Attribute(name='base_url', default='https://api... kw_only=True, inherited=False, on_setattr=None))
+ +
__hash__ = None
+ +

+ + + + + +
 
+Data
       Dict = typing.Dict
+Union = typing.Union
+ \ No newline at end of file diff --git a/kittycad.html b/kittycad.html new file mode 100644 index 000000000..98ef3ed85 --- /dev/null +++ b/kittycad.html @@ -0,0 +1,25 @@ + +Python: package kittycad + + + + + +
 
+ 
kittycad		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/__init__.py
+

A client library for accessing KittyCAD

+

+ + + + + +
 
+Package Contents
       
api (package)
+		client
+		models (package)
+		types
+
+ \ No newline at end of file diff --git a/kittycad.models.auth_session.html b/kittycad.models.auth_session.html new file mode 100644 index 000000000..4ce414c90 --- /dev/null +++ b/kittycad.models.auth_session.html @@ -0,0 +1,113 @@ + +Python: module kittycad.models.auth_session + + + + + +
 
+ 
kittycad.models.auth_session		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/auth_session.py
+

+

+ + + + + +
 
+Modules
       
attr
+		datetime
+

+ + + + + +
 
+Classes
       
+
builtins.object +
+
+
AuthSession +
+
+
+

+ + + + + + + +
 
+class AuthSession(builtins.object)
   AuthSession(created_at: Union[kittycad.types.Unset, datetime.datetime] = &lt;kittycad.types.Unset object at 0x7f7de094df00&gt;, email: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f7de094df00&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f7de094df00&gt;, ip_address: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f7de094df00&gt;, is_valid: Union[kittycad.types.Unset, bool] = False, token: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f7de094df00&gt;, user_id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f7de094df00&gt;) -&gt; None
+ 
+
 
 Methods defined here:
+
__contains__(self, key: str) -> bool
+ +
__delitem__(self, key: str) -> None
+ +
__eq__(self, other)
Method generated by attrs for class AuthSession.
+ +
__ge__(self, other)
Method generated by attrs for class AuthSession.
+ +
__getitem__(self, key: str) -> Any
+ +
__gt__(self, other)
Method generated by attrs for class AuthSession.
+ +
__init__(self, created_at: Union[kittycad.types.Unset, datetime.datetime] = <kittycad.types.Unset object at 0x7f7de094df00>, email: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>, id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>, ip_address: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>, is_valid: Union[kittycad.types.Unset, bool] = False, token: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>, user_id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f7de094df00>) -> None
Method generated by attrs for class AuthSession.
+ +
__le__(self, other)
Method generated by attrs for class AuthSession.
+ +
__lt__(self, other)
Method generated by attrs for class AuthSession.
+ +
__ne__(self, other)
Method generated by attrs for class AuthSession.
+ +
__repr__(self)
Method generated by attrs for class AuthSession.
+ +
__setitem__(self, key: str, value: Any) -> None
+ +
to_dict(self) -> Dict[str, Any]
+ +
+Class methods defined here:
+
from_dict(src_dict: Dict[str, Any]) -> ~T from builtins.type
+ +
+Readonly properties defined here:
+
additional_keys
+
+
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
__annotations__ = {'additional_properties': typing.Dict[str, typing.Any], 'created_at': typing.Union[kittycad.types.Unset, datetime.datetime], 'email': typing.Union[kittycad.types.Unset, str], 'id': typing.Union[kittycad.types.Unset, str], 'ip_address': typing.Union[kittycad.types.Unset, str], 'is_valid': typing.Union[kittycad.types.Unset, bool], 'token': typing.Union[kittycad.types.Unset, str], 'user_id': typing.Union[kittycad.types.Unset, str]}
+ +
__attrs_attrs__ = (Attribute(name='created_at', default=<kittycad....kw_only=False, inherited=False, on_setattr=None))
+ +
__hash__ = None
+ +

+ + + + + +
 
+Data
       Any = typing.Any
+Dict = typing.Dict
+List = typing.List
+T = ~T
+Type = typing.Type
+UNSET = <kittycad.types.Unset object>
+Union = typing.Union
+ \ No newline at end of file diff --git a/kittycad.models.environment.html b/kittycad.models.environment.html new file mode 100644 index 000000000..be9615223 --- /dev/null +++ b/kittycad.models.environment.html @@ -0,0 +1,76 @@ + +Python: module kittycad.models.environment + + + + + +
 
+ 
kittycad.models.environment		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/environment.py
+

+

+ + + + + +
 
+Classes
       
+
builtins.str(builtins.object) +
+
+
Environment(builtins.str, enum.Enum) +
+
+
enum.Enum(builtins.object) +
+
+
Environment(builtins.str, enum.Enum) +
+
+
+

+ + + + + + + +
 
+class Environment(builtins.str, enum.Enum)
   Environment(value, names=None, *, module=None, qualname=None, type=None, start=1)
+ 
+An enumeration.
 
 
Method resolution order:
+
Environment
+
builtins.str
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
DEVELOPMENT = <Environment.DEVELOPMENT: 'DEVELOPMENT'>
+ +
PREVIEW = <Environment.PREVIEW: 'PREVIEW'>
+ +
PRODUCTION = <Environment.PRODUCTION: 'PRODUCTION'>
+ +
+Data descriptors inherited from enum.Enum:
+
name
+
The name of the Enum member.
+
+
value
+
The value of the Enum member.
+
+
+Readonly properties inherited from enum.EnumMeta:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases. Note that this
+is a read-only view of the internal mapping.
+
+

+ \ No newline at end of file diff --git a/kittycad.models.error_message.html b/kittycad.models.error_message.html new file mode 100644 index 000000000..a8e4d1ff0 --- /dev/null +++ b/kittycad.models.error_message.html @@ -0,0 +1,112 @@ + +Python: module kittycad.models.error_message + + + + + +
 
+ 
kittycad.models.error_message		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/error_message.py
+

+

+ + + + + +
 
+Modules
       
attr
+

+ + + + + +
 
+Classes
       
+
builtins.object +
+
+
ErrorMessage +
+
+
+

+ + + + + + + +
 
+class ErrorMessage(builtins.object)
   ErrorMessage(message: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7ffadb4edf60&gt;) -&gt; None
+ 
+
 
 Methods defined here:
+
__contains__(self, key: str) -> bool
+ +
__delitem__(self, key: str) -> None
+ +
__eq__(self, other)
Method generated by attrs for class ErrorMessage.
+ +
__ge__(self, other)
Method generated by attrs for class ErrorMessage.
+ +
__getitem__(self, key: str) -> Any
+ +
__gt__(self, other)
Method generated by attrs for class ErrorMessage.
+ +
__init__(self, message: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7ffadb4edf60>) -> None
Method generated by attrs for class ErrorMessage.
+ +
__le__(self, other)
Method generated by attrs for class ErrorMessage.
+ +
__lt__(self, other)
Method generated by attrs for class ErrorMessage.
+ +
__ne__(self, other)
Method generated by attrs for class ErrorMessage.
+ +
__repr__(self)
Method generated by attrs for class ErrorMessage.
+ +
__setitem__(self, key: str, value: Any) -> None
+ +
to_dict(self) -> Dict[str, Any]
+ +
+Class methods defined here:
+
from_dict(src_dict: Dict[str, Any]) -> ~T from builtins.type
+ +
+Readonly properties defined here:
+
additional_keys
+
+
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
__annotations__ = {'additional_properties': typing.Dict[str, typing.Any], 'message': typing.Union[kittycad.types.Unset, str]}
+ +
__attrs_attrs__ = (Attribute(name='message', default=<kittycad.typ...kw_only=False, inherited=False, on_setattr=None))
+ +
__hash__ = None
+ +

+ + + + + +
 
+Data
       Any = typing.Any
+Dict = typing.Dict
+List = typing.List
+T = ~T
+Type = typing.Type
+UNSET = <kittycad.types.Unset object>
+Union = typing.Union
+ \ No newline at end of file diff --git a/kittycad.models.file_conversion.html b/kittycad.models.file_conversion.html new file mode 100644 index 000000000..dd41c8651 --- /dev/null +++ b/kittycad.models.file_conversion.html @@ -0,0 +1,113 @@ + +Python: module kittycad.models.file_conversion + + + + + +
 
+ 
kittycad.models.file_conversion		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/file_conversion.py
+

+

+ + + + + +
 
+Modules
       
attr
+		datetime
+

+ + + + + +
 
+Classes
       
+
builtins.object +
+
+
FileConversion +
+
+
+

+ + + + + + + +
 
+class FileConversion(builtins.object)
   FileConversion(completed_at: Union[kittycad.types.Unset, datetime.datetime] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;, created_at: Union[kittycad.types.Unset, datetime.datetime] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;, output: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;, output_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;, src_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;, status: Union[kittycad.types.Unset, kittycad.models.file_conversion_status.FileConversionStatus] = &lt;kittycad.types.Unset object at 0x7f1916e0df60&gt;) -&gt; None
+ 
+
 
 Methods defined here:
+
__contains__(self, key: str) -> bool
+ +
__delitem__(self, key: str) -> None
+ +
__eq__(self, other)
Method generated by attrs for class FileConversion.
+ +
__ge__(self, other)
Method generated by attrs for class FileConversion.
+ +
__getitem__(self, key: str) -> Any
+ +
__gt__(self, other)
Method generated by attrs for class FileConversion.
+ +
__init__(self, completed_at: Union[kittycad.types.Unset, datetime.datetime] = <kittycad.types.Unset object at 0x7f1916e0df60>, created_at: Union[kittycad.types.Unset, datetime.datetime] = <kittycad.types.Unset object at 0x7f1916e0df60>, id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f1916e0df60>, output: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f1916e0df60>, output_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = <kittycad.types.Unset object at 0x7f1916e0df60>, src_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = <kittycad.types.Unset object at 0x7f1916e0df60>, status: Union[kittycad.types.Unset, kittycad.models.file_conversion_status.FileConversionStatus] = <kittycad.types.Unset object at 0x7f1916e0df60>) -> None
Method generated by attrs for class FileConversion.
+ +
__le__(self, other)
Method generated by attrs for class FileConversion.
+ +
__lt__(self, other)
Method generated by attrs for class FileConversion.
+ +
__ne__(self, other)
Method generated by attrs for class FileConversion.
+ +
__repr__(self)
Method generated by attrs for class FileConversion.
+ +
__setitem__(self, key: str, value: Any) -> None
+ +
to_dict(self) -> Dict[str, Any]
+ +
+Class methods defined here:
+
from_dict(src_dict: Dict[str, Any]) -> ~T from builtins.type
+ +
+Readonly properties defined here:
+
additional_keys
+
+
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
__annotations__ = {'additional_properties': typing.Dict[str, typing.Any], 'completed_at': typing.Union[kittycad.types.Unset, datetime.datetime], 'created_at': typing.Union[kittycad.types.Unset, datetime.datetime], 'id': typing.Union[kittycad.types.Unset, str], 'output': typing.Union[kittycad.types.Unset, str], 'output_format': typing.Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes], 'src_format': typing.Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes], 'status': typing.Union[kittycad.types.Unset, kittycad.models.file_conversion_status.FileConversionStatus]}
+ +
__attrs_attrs__ = (Attribute(name='completed_at', default=<kittyca...kw_only=False, inherited=False, on_setattr=None))
+ +
__hash__ = None
+ +

+ + + + + +
 
+Data
       Any = typing.Any
+Dict = typing.Dict
+List = typing.List
+T = ~T
+Type = typing.Type
+UNSET = <kittycad.types.Unset object>
+Union = typing.Union
+ \ No newline at end of file diff --git a/kittycad.models.file_conversion_status.html b/kittycad.models.file_conversion_status.html new file mode 100644 index 000000000..eb624a391 --- /dev/null +++ b/kittycad.models.file_conversion_status.html @@ -0,0 +1,80 @@ + +Python: module kittycad.models.file_conversion_status + + + + + +
 
+ 
kittycad.models.file_conversion_status		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/file_conversion_status.py
+

+

+ + + + + +
 
+Classes
       
+
builtins.str(builtins.object) +
+
+
FileConversionStatus(builtins.str, enum.Enum) +
+
+
enum.Enum(builtins.object) +
+
+
FileConversionStatus(builtins.str, enum.Enum) +
+
+
+

+ + + + + + + +
 
+class FileConversionStatus(builtins.str, enum.Enum)
   FileConversionStatus(value, names=None, *, module=None, qualname=None, type=None, start=1)
+ 
+An enumeration.
 
 
Method resolution order:
+
FileConversionStatus
+
builtins.str
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
COMPLETED = <FileConversionStatus.COMPLETED: 'Completed'>
+ +
FAILED = <FileConversionStatus.FAILED: 'Failed'>
+ +
IN_PROGRESS = <FileConversionStatus.IN_PROGRESS: 'In Progress'>
+ +
QUEUED = <FileConversionStatus.QUEUED: 'Queued'>
+ +
UPLOADED = <FileConversionStatus.UPLOADED: 'Uploaded'>
+ +
+Data descriptors inherited from enum.Enum:
+
name
+
The name of the Enum member.
+
+
value
+
The value of the Enum member.
+
+
+Readonly properties inherited from enum.EnumMeta:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases. Note that this
+is a read-only view of the internal mapping.
+
+

+ \ No newline at end of file diff --git a/kittycad.models.html b/kittycad.models.html new file mode 100644 index 000000000..bc4a7e757 --- /dev/null +++ b/kittycad.models.html @@ -0,0 +1,29 @@ + +Python: package kittycad.models + + + + + +
 
+ 
kittycad.models		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/__init__.py
+

Contains all the data models used in inputs/outputs

+

+ + + + + +
 
+Package Contents
       
auth_session
+environment
+		error_message
+file_conversion
+		file_conversion_status
+instance_metadata
+		message
+valid_file_types
+
+ \ No newline at end of file diff --git a/kittycad.models.instance_metadata.html b/kittycad.models.instance_metadata.html new file mode 100644 index 000000000..e5fe73625 --- /dev/null +++ b/kittycad.models.instance_metadata.html @@ -0,0 +1,112 @@ + +Python: module kittycad.models.instance_metadata + + + + + +
 
+ 
kittycad.models.instance_metadata		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/instance_metadata.py
+

+

+ + + + + +
 
+Modules
       
attr
+

+ + + + + +
 
+Classes
       
+
builtins.object +
+
+
InstanceMetadata +
+
+
+

+ + + + + + + +
 
+class InstanceMetadata(builtins.object)
   InstanceMetadata(cpu_platform: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, description: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, environment: Union[kittycad.types.Unset, kittycad.models.environment.Environment] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, git_hash: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, hostname: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, image: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, ip_address: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, machine_type: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, name: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;, zone: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f0df2f31f60&gt;) -&gt; None
+ 
+
 
 Methods defined here:
+
__contains__(self, key: str) -> bool
+ +
__delitem__(self, key: str) -> None
+ +
__eq__(self, other)
Method generated by attrs for class InstanceMetadata.
+ +
__ge__(self, other)
Method generated by attrs for class InstanceMetadata.
+ +
__getitem__(self, key: str) -> Any
+ +
__gt__(self, other)
Method generated by attrs for class InstanceMetadata.
+ +
__init__(self, cpu_platform: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, description: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, environment: Union[kittycad.types.Unset, kittycad.models.environment.Environment] = <kittycad.types.Unset object at 0x7f0df2f31f60>, git_hash: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, hostname: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, image: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, ip_address: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, machine_type: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, name: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>, zone: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f0df2f31f60>) -> None
Method generated by attrs for class InstanceMetadata.
+ +
__le__(self, other)
Method generated by attrs for class InstanceMetadata.
+ +
__lt__(self, other)
Method generated by attrs for class InstanceMetadata.
+ +
__ne__(self, other)
Method generated by attrs for class InstanceMetadata.
+ +
__repr__(self)
Method generated by attrs for class InstanceMetadata.
+ +
__setitem__(self, key: str, value: Any) -> None
+ +
to_dict(self) -> Dict[str, Any]
+ +
+Class methods defined here:
+
from_dict(src_dict: Dict[str, Any]) -> ~T from builtins.type
+ +
+Readonly properties defined here:
+
additional_keys
+
+
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
__annotations__ = {'additional_properties': typing.Dict[str, typing.Any], 'cpu_platform': typing.Union[kittycad.types.Unset, str], 'description': typing.Union[kittycad.types.Unset, str], 'environment': typing.Union[kittycad.types.Unset, kittycad.models.environment.Environment], 'git_hash': typing.Union[kittycad.types.Unset, str], 'hostname': typing.Union[kittycad.types.Unset, str], 'id': typing.Union[kittycad.types.Unset, str], 'image': typing.Union[kittycad.types.Unset, str], 'ip_address': typing.Union[kittycad.types.Unset, str], 'machine_type': typing.Union[kittycad.types.Unset, str], ...}
+ +
__attrs_attrs__ = (Attribute(name='cpu_platform', default=<kittyca...kw_only=False, inherited=False, on_setattr=None))
+ +
__hash__ = None
+ +

+ + + + + +
 
+Data
       Any = typing.Any
+Dict = typing.Dict
+List = typing.List
+T = ~T
+Type = typing.Type
+UNSET = <kittycad.types.Unset object>
+Union = typing.Union
+ \ No newline at end of file diff --git a/kittycad.models.message.html b/kittycad.models.message.html new file mode 100644 index 000000000..e6f511ee6 --- /dev/null +++ b/kittycad.models.message.html @@ -0,0 +1,112 @@ + +Python: module kittycad.models.message + + + + + +
 
+ 
kittycad.models.message		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/message.py
+

+

+ + + + + +
 
+Modules
       
attr
+

+ + + + + +
 
+Classes
       
+
builtins.object +
+
+
Message +
+
+
+

+ + + + + + + +
 
+class Message(builtins.object)
   Message(message: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f10e92f9f60&gt;) -&gt; None
+ 
+
 
 Methods defined here:
+
__contains__(self, key: str) -> bool
+ +
__delitem__(self, key: str) -> None
+ +
__eq__(self, other)
Method generated by attrs for class Message.
+ +
__ge__(self, other)
Method generated by attrs for class Message.
+ +
__getitem__(self, key: str) -> Any
+ +
__gt__(self, other)
Method generated by attrs for class Message.
+ +
__init__(self, message: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f10e92f9f60>) -> None
Method generated by attrs for class Message.
+ +
__le__(self, other)
Method generated by attrs for class Message.
+ +
__lt__(self, other)
Method generated by attrs for class Message.
+ +
__ne__(self, other)
Method generated by attrs for class Message.
+ +
__repr__(self)
Method generated by attrs for class Message.
+ +
__setitem__(self, key: str, value: Any) -> None
+ +
to_dict(self) -> Dict[str, Any]
+ +
+Class methods defined here:
+
from_dict(src_dict: Dict[str, Any]) -> ~T from builtins.type
+ +
+Readonly properties defined here:
+
additional_keys
+
+
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
__annotations__ = {'additional_properties': typing.Dict[str, typing.Any], 'message': typing.Union[kittycad.types.Unset, str]}
+ +
__attrs_attrs__ = (Attribute(name='message', default=<kittycad.typ...kw_only=False, inherited=False, on_setattr=None))
+ +
__hash__ = None
+ +

+ + + + + +
 
+Data
       Any = typing.Any
+Dict = typing.Dict
+List = typing.List
+T = ~T
+Type = typing.Type
+UNSET = <kittycad.types.Unset object>
+Union = typing.Union
+ \ No newline at end of file diff --git a/kittycad.models.valid_file_types.html b/kittycad.models.valid_file_types.html new file mode 100644 index 000000000..ba855fc93 --- /dev/null +++ b/kittycad.models.valid_file_types.html @@ -0,0 +1,80 @@ + +Python: module kittycad.models.valid_file_types + + + + + +
 
+ 
kittycad.models.valid_file_types		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/models/valid_file_types.py
+

+

+ + + + + +
 
+Classes
       
+
builtins.str(builtins.object) +
+
+
ValidFileTypes(builtins.str, enum.Enum) +
+
+
enum.Enum(builtins.object) +
+
+
ValidFileTypes(builtins.str, enum.Enum) +
+
+
+

+ + + + + + + +
 
+class ValidFileTypes(builtins.str, enum.Enum)
   ValidFileTypes(value, names=None, *, module=None, qualname=None, type=None, start=1)
+ 
+An enumeration.
 
 
Method resolution order:
+
ValidFileTypes
+
builtins.str
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
DWG = <ValidFileTypes.DWG: 'dwg'>
+ +
DXF = <ValidFileTypes.DXF: 'dxf'>
+ +
OBJ = <ValidFileTypes.OBJ: 'obj'>
+ +
STEP = <ValidFileTypes.STEP: 'step'>
+ +
STL = <ValidFileTypes.STL: 'stl'>
+ +
+Data descriptors inherited from enum.Enum:
+
name
+
The name of the Enum member.
+
+
value
+
The value of the Enum member.
+
+
+Readonly properties inherited from enum.EnumMeta:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases. Note that this
+is a read-only view of the internal mapping.
+
+

+ \ No newline at end of file diff --git a/kittycad.types.html b/kittycad.types.html new file mode 100644 index 000000000..29a61504f --- /dev/null +++ b/kittycad.types.html @@ -0,0 +1,161 @@ + +Python: module kittycad.types + + + + + +
 
+ 
kittycad.types		index
/home/runner/work/kittycad.py/kittycad.py/kittycad/types.py
+

Contains some shared types for properties

+

+ + + + + +
 
+Modules
       
attr
+

+ + + + + +
 
+Classes
       
+
builtins.object +
+
+
File +
+
+
typing.Generic(builtins.object) +
+
+
Response +
+
+
+

+ + + + + + + +
 
+class File(builtins.object)
   File(payload: Union[BinaryIO, TextIO], file_name: Optional[str] = None, mime_type: Optional[str] = None) -&gt; None
+ 
+Contains information for file uploads
 
 Methods defined here:
+
__eq__(self, other)
Method generated by attrs for class File.
+ +
__ge__(self, other)
Method generated by attrs for class File.
+ +
__gt__(self, other)
Method generated by attrs for class File.
+ +
__init__(self, payload: Union[BinaryIO, TextIO], file_name: Optional[str] = None, mime_type: Optional[str] = None) -> None
Method generated by attrs for class File.
+ +
__le__(self, other)
Method generated by attrs for class File.
+ +
__lt__(self, other)
Method generated by attrs for class File.
+ +
__ne__(self, other)
Method generated by attrs for class File.
+ +
__repr__(self)
Method generated by attrs for class File.
+ +
to_tuple(self) -> Tuple[Optional[str], Union[BinaryIO, TextIO], Optional[str]]
Return a tuple representation that httpx will accept for multipart/form-data
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
__annotations__ = {'file_name': typing.Optional[str], 'mime_type': typing.Optional[str], 'payload': typing.Union[typing.BinaryIO, typing.TextIO]}
+ +
__attrs_attrs__ = (Attribute(name='payload', default=NOTHING, vali...kw_only=False, inherited=False, on_setattr=None))
+ +
__hash__ = None
+ +

+ + + + + + + +
 
+class Response(typing.Generic)
   Response(status_code: int, content: bytes, headers: MutableMapping[str, str], parsed: Optional[~T]) -&gt; None
+ 
+A response from an endpoint
 
 
Method resolution order:
+
Response
+
typing.Generic
+
builtins.object
+
+
+Methods defined here:
+
__eq__(self, other)
Method generated by attrs for class Response.
+ +
__ge__(self, other)
Method generated by attrs for class Response.
+ +
__gt__(self, other)
Method generated by attrs for class Response.
+ +
__init__(self, status_code: int, content: bytes, headers: MutableMapping[str, str], parsed: Optional[~T]) -> None
Method generated by attrs for class Response.
+ +
__le__(self, other)
Method generated by attrs for class Response.
+ +
__lt__(self, other)
Method generated by attrs for class Response.
+ +
__ne__(self, other)
Method generated by attrs for class Response.
+ +
__repr__(self)
Method generated by attrs for class Response.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
__annotations__ = {'content': <class 'bytes'>, 'headers': typing.MutableMapping[str, str], 'parsed': typing.Optional[~T], 'status_code': <class 'int'>}
+ +
__attrs_attrs__ = (Attribute(name='status_code', default=NOTHING, ...kw_only=False, inherited=False, on_setattr=None))
+ +
__hash__ = None
+ +
__orig_bases__ = (typing.Generic[~T],)
+ +
__parameters__ = (~T,)
+ +
+Class methods inherited from typing.Generic:
+
__class_getitem__(params) from builtins.type
+ +
__init_subclass__(*args, **kwargs) from builtins.type
This method is called when a class is subclassed.
+ 
+The default implementation does nothing. It may be
+overridden to extend subclasses.
+ +

+ + + + + +
 
+Data
       FileJsonType = typing.Tuple[typing.Optional[str], typing.Union[...g.BinaryIO, typing.TextIO], typing.Optional[str]]
+__all__ = ['File', 'Response', 'FileJsonType']
+__annotations__ = {'UNSET': <class 'kittycad.types.Unset'>}
+ \ No newline at end of file