From f3d080d9717396b5c9b19b40f9c28137847745ba Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 15 Dec 2021 10:04:26 +0000 Subject: [PATCH] I HAVE GENERATED YOUR NEW DOCS! --- ...ttycad.api.file.file_conversion_by_id.html | 43 +++++++ docs/html/kittycad.api.file.file_convert.html | 43 +++++++ docs/html/kittycad.api.file.html | 23 ++++ docs/html/kittycad.api.meta.html | 24 ++++ ...kittycad.api.meta.meta_debug_instance.html | 43 +++++++ .../kittycad.api.meta.meta_debug_session.html | 43 +++++++ docs/html/kittycad.api.meta.ping.html | 42 +++++++ docs/html/kittycad.models.auth_session.html | 113 ++++++++++++++++++ docs/html/kittycad.models.environment.html | 76 ++++++++++++ docs/html/kittycad.models.error_message.html | 112 +++++++++++++++++ .../html/kittycad.models.file_conversion.html | 113 ++++++++++++++++++ ...ittycad.models.file_conversion_status.html | 80 +++++++++++++ .../kittycad.models.instance_metadata.html | 112 +++++++++++++++++ docs/html/kittycad.models.message.html | 112 +++++++++++++++++ .../kittycad.models.valid_file_types.html | 80 +++++++++++++ 15 files changed, 1059 insertions(+) create mode 100644 docs/html/kittycad.api.file.file_conversion_by_id.html create mode 100644 docs/html/kittycad.api.file.file_convert.html create mode 100644 docs/html/kittycad.api.file.html create mode 100644 docs/html/kittycad.api.meta.html create mode 100644 docs/html/kittycad.api.meta.meta_debug_instance.html create mode 100644 docs/html/kittycad.api.meta.meta_debug_session.html create mode 100644 docs/html/kittycad.api.meta.ping.html create mode 100644 docs/html/kittycad.models.auth_session.html create mode 100644 docs/html/kittycad.models.environment.html create mode 100644 docs/html/kittycad.models.error_message.html create mode 100644 docs/html/kittycad.models.file_conversion.html create mode 100644 docs/html/kittycad.models.file_conversion_status.html create mode 100644 docs/html/kittycad.models.instance_metadata.html create mode 100644 docs/html/kittycad.models.message.html create mode 100644 docs/html/kittycad.models.valid_file_types.html diff --git a/docs/html/kittycad.api.file.file_conversion_by_id.html b/docs/html/kittycad.api.file.file_conversion_by_id.html new file mode 100644 index 000000000..67f8ddaa2 --- /dev/null +++ b/docs/html/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/docs/html/kittycad.api.file.file_convert.html b/docs/html/kittycad.api.file.file_convert.html new file mode 100644 index 000000000..bcd9ab5b4 --- /dev/null +++ b/docs/html/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, *, 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, *, 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/docs/html/kittycad.api.file.html b/docs/html/kittycad.api.file.html new file mode 100644 index 000000000..d7cbbe011 --- /dev/null +++ b/docs/html/kittycad.api.file.html @@ -0,0 +1,23 @@ + +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
+
+ \ No newline at end of file diff --git a/docs/html/kittycad.api.meta.html b/docs/html/kittycad.api.meta.html new file mode 100644 index 000000000..e15bee581 --- /dev/null +++ b/docs/html/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/docs/html/kittycad.api.meta.meta_debug_instance.html b/docs/html/kittycad.api.meta.meta_debug_instance.html new file mode 100644 index 000000000..ce7f9dee5 --- /dev/null +++ b/docs/html/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/docs/html/kittycad.api.meta.meta_debug_session.html b/docs/html/kittycad.api.meta.meta_debug_session.html new file mode 100644 index 000000000..237a0a514 --- /dev/null +++ b/docs/html/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/docs/html/kittycad.api.meta.ping.html b/docs/html/kittycad.api.meta.ping.html new file mode 100644 index 000000000..31eff1cc0 --- /dev/null +++ b/docs/html/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/docs/html/kittycad.models.auth_session.html b/docs/html/kittycad.models.auth_session.html new file mode 100644 index 000000000..e02029336 --- /dev/null +++ b/docs/html/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] = <kittycad.types.Unset object at 0x7fd2cbf1ddb0>, email: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd2cbf1ddb0>, id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd2cbf1ddb0>, ip_address: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd2cbf1ddb0>, is_valid: Union[kittycad.types.Unset, bool] = False, token: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd2cbf1ddb0>, user_id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd2cbf1ddb0>) -> 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 0x7fd2cbf1ddb0>, email: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd2cbf1ddb0>, id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd2cbf1ddb0>, ip_address: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd2cbf1ddb0>, is_valid: Union[kittycad.types.Unset, bool] = False, token: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd2cbf1ddb0>, user_id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd2cbf1ddb0>) -> 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/docs/html/kittycad.models.environment.html b/docs/html/kittycad.models.environment.html new file mode 100644 index 000000000..be9615223 --- /dev/null +++ b/docs/html/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/docs/html/kittycad.models.error_message.html b/docs/html/kittycad.models.error_message.html new file mode 100644 index 000000000..9a84898ac --- /dev/null +++ b/docs/html/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 0x7f36b5e59de0&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 0x7f36b5e59de0>) -> 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/docs/html/kittycad.models.file_conversion.html b/docs/html/kittycad.models.file_conversion.html new file mode 100644 index 000000000..1355e6a59 --- /dev/null +++ b/docs/html/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 0x7f6b204d9de0&gt;, created_at: Union[kittycad.types.Unset, datetime.datetime] = &lt;kittycad.types.Unset object at 0x7f6b204d9de0&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f6b204d9de0&gt;, output: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f6b204d9de0&gt;, output_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = &lt;kittycad.types.Unset object at 0x7f6b204d9de0&gt;, src_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = &lt;kittycad.types.Unset object at 0x7f6b204d9de0&gt;, status: Union[kittycad.types.Unset, kittycad.models.file_conversion_status.FileConversionStatus] = &lt;kittycad.types.Unset object at 0x7f6b204d9de0&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 0x7f6b204d9de0>, created_at: Union[kittycad.types.Unset, datetime.datetime] = <kittycad.types.Unset object at 0x7f6b204d9de0>, id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f6b204d9de0>, output: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7f6b204d9de0>, output_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = <kittycad.types.Unset object at 0x7f6b204d9de0>, src_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = <kittycad.types.Unset object at 0x7f6b204d9de0>, status: Union[kittycad.types.Unset, kittycad.models.file_conversion_status.FileConversionStatus] = <kittycad.types.Unset object at 0x7f6b204d9de0>) -> 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/docs/html/kittycad.models.file_conversion_status.html b/docs/html/kittycad.models.file_conversion_status.html new file mode 100644 index 000000000..eb624a391 --- /dev/null +++ b/docs/html/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/docs/html/kittycad.models.instance_metadata.html b/docs/html/kittycad.models.instance_metadata.html new file mode 100644 index 000000000..96fca1eae --- /dev/null +++ b/docs/html/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 0x7fd00a5cdd80&gt;, description: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, environment: Union[kittycad.types.Unset, kittycad.models.environment.Environment] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, git_hash: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, hostname: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, image: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, ip_address: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, machine_type: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, name: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, zone: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&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 0x7fd00a5cdd80>, description: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd00a5cdd80>, environment: Union[kittycad.types.Unset, kittycad.models.environment.Environment] = <kittycad.types.Unset object at 0x7fd00a5cdd80>, git_hash: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd00a5cdd80>, hostname: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd00a5cdd80>, id: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd00a5cdd80>, image: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd00a5cdd80>, ip_address: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd00a5cdd80>, machine_type: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd00a5cdd80>, name: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd00a5cdd80>, zone: Union[kittycad.types.Unset, str] = <kittycad.types.Unset object at 0x7fd00a5cdd80>) -> 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/docs/html/kittycad.models.message.html b/docs/html/kittycad.models.message.html new file mode 100644 index 000000000..d22e47175 --- /dev/null +++ b/docs/html/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 0x7f4b3f289d50&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 0x7f4b3f289d50>) -> 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/docs/html/kittycad.models.valid_file_types.html b/docs/html/kittycad.models.valid_file_types.html new file mode 100644 index 000000000..ba855fc93 --- /dev/null +++ b/docs/html/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