diff --git a/kittycad.py.patch.json b/kittycad.py.patch.json index c831fed55..e333fae15 100644 --- a/kittycad.py.patch.json +++ b/kittycad.py.patch.json @@ -1,146 +1,50 @@ [ { "op": "add", - "path": "/paths/~1users~1{id}~1api-calls/get/x-python", + "path": "/info/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import list_api_calls_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPriceResultsPage, Error\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_api_calls_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPriceResultsPage, Error]] = (\n list_api_calls_for_user.sync(\n client=client,\n id=\"\",\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPriceResultsPage = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.list_api_calls_for_user.html" + "client": "# Create a client with your token.\nfrom kittycad.client import Client\n\nclient = Client(token=\"$TOKEN\")\n\n# - OR -\n\n# Create a new client with your token parsed from the environment variable:\n# `KITTYCAD_API_TOKEN`.\nfrom kittycad.client import ClientFromEnv\n\nclient = ClientFromEnv()\n\n# NOTE: The python library additionally implements asyncio, however all the code samples we\n# show below use the sync functions for ease of use and understanding.\n# Check out the library docs at:\n# https://python.api.docs.kittycad.io/_autosummary/kittycad.api.html#module-kittycad.api\n# for more details.", + "install": "pip install kittycad" } }, { "op": "add", - "path": "/paths/~1auth~1saml~1provider~1{provider_id}~1login/post/x-python", + "path": "/paths/~1users-extended~1{id}/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.hidden import post_auth_saml\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_post_auth_saml():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = post_auth_saml.sync(\n client=client,\n provider_id=Uuid(\"\"),\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.hidden.post_auth_saml.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import get_user_extended\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ExtendedUser\nfrom kittycad.types import Response\n\n\ndef example_get_user_extended():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ExtendedUser, Error]] = get_user_extended.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ExtendedUser = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.get_user_extended.html" } }, { "op": "add", - "path": "/paths/~1auth~1saml~1provider~1{provider_id}~1login/get/x-python", + "path": "/paths/~1org~1members/post/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.hidden import get_auth_saml\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_get_auth_saml():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = get_auth_saml.sync(\n client=client,\n provider_id=Uuid(\"\"),\n callback_url=None, # Optional[str]\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.hidden.get_auth_saml.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import create_org_member\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, OrgMember\nfrom kittycad.models.add_org_member import AddOrgMember\nfrom kittycad.models.user_org_role import UserOrgRole\nfrom kittycad.types import Response\n\n\ndef example_create_org_member():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[OrgMember, Error]] = create_org_member.sync(\n client=client,\n body=AddOrgMember(\n email=\"\",\n role=UserOrgRole.ADMIN,\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: OrgMember = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.create_org_member.html" } }, { "op": "add", - "path": "/paths/~1user~1payment~1methods~1{id}/delete/x-python", + "path": "/paths/~1org~1members/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import delete_payment_method_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_delete_payment_method_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_payment_method_for_user.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.delete_payment_method_for_user.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import list_org_members\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, OrgMemberResultsPage\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.models.user_org_role import UserOrgRole\nfrom kittycad.types import Response\n\n\ndef example_list_org_members():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[OrgMemberResultsPage, Error]] = list_org_members.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n role=UserOrgRole.ADMIN,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: OrgMemberResultsPage = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.list_org_members.html" } }, { "op": "add", - "path": "/paths/~1debug~1uploads/post/x-python", + "path": "/paths/~1/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.meta import create_debug_uploads\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_create_debug_uploads():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[str], Error]] = create_debug_uploads.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[str] = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.create_debug_uploads.html" + "example": "from kittycad.api.meta import get_schema\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.types import Response\n\n\ndef example_get_schema():\n # Create our client.\n client = ClientFromEnv()\n\n get_schema.sync(\n client=client,\n )\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.get_schema.html" } }, { "op": "add", - "path": "/paths/~1unit~1conversion~1area~1{input_unit}~1{output_unit}/get/x-python", + "path": "/paths/~1user~1payment~1methods/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_area_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitAreaConversion\nfrom kittycad.models.unit_area import UnitArea\nfrom kittycad.types import Response\n\n\ndef example_get_area_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitAreaConversion, Error]] = (\n get_area_unit_conversion.sync(\n client=client,\n input_unit=UnitArea.CM2,\n output_unit=UnitArea.CM2,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitAreaConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_area_unit_conversion.html" - } - }, - { - "op": "add", - "path": "/paths/~1orgs~1{id}~1payment~1balance/put/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import update_payment_balance_for_any_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import CustomerBalance, Error\nfrom kittycad.models.update_payment_balance import UpdatePaymentBalance\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_update_payment_balance_for_any_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[CustomerBalance, Error]] = (\n update_payment_balance_for_any_org.sync(\n client=client,\n id=Uuid(\"\"),\n body=UpdatePaymentBalance(),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: CustomerBalance = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.update_payment_balance_for_any_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1orgs~1{id}~1payment~1balance/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_payment_balance_for_any_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import CustomerBalance, Error\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_get_payment_balance_for_any_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[CustomerBalance, Error]] = (\n get_payment_balance_for_any_org.sync(\n client=client,\n id=Uuid(\"\"),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: CustomerBalance = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_payment_balance_for_any_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1payment/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import create_payment_information_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Customer, Error\nfrom kittycad.models.billing_info import BillingInfo\nfrom kittycad.types import Response\n\n\ndef example_create_payment_information_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Customer, Error]] = (\n create_payment_information_for_user.sync(\n client=client,\n body=BillingInfo(\n name=\"\",\n phone=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Customer = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.create_payment_information_for_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1payment/delete/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import delete_payment_information_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_delete_payment_information_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_payment_information_for_user.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.delete_payment_information_for_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1payment/put/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import update_payment_information_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Customer, Error\nfrom kittycad.models.billing_info import BillingInfo\nfrom kittycad.types import Response\n\n\ndef example_update_payment_information_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Customer, Error]] = (\n update_payment_information_for_user.sync(\n client=client,\n body=BillingInfo(\n name=\"\",\n phone=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Customer = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.update_payment_information_for_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1payment/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_payment_information_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Customer, Error\nfrom kittycad.types import Response\n\n\ndef example_get_payment_information_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Customer, Error]] = (\n get_payment_information_for_user.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Customer = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_payment_information_for_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1api-call-metrics/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import get_api_call_metrics\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallQueryGroup, Error\nfrom kittycad.models.api_call_query_group_by import ApiCallQueryGroupBy\nfrom kittycad.types import Response\n\n\ndef example_get_api_call_metrics():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[ApiCallQueryGroup], Error]] = (\n get_api_call_metrics.sync(\n client=client,\n group_by=ApiCallQueryGroupBy.EMAIL,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[ApiCallQueryGroup] = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.get_api_call_metrics.html" - } - }, - { - "op": "add", - "path": "/paths/~1ws~1executor~1term/get/x-python", - "value": { - "example": "from kittycad.api.executor import create_executor_term\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.types import Response\n\n\ndef example_create_executor_term():\n # Create our client.\n client = ClientFromEnv()\n\n # Connect to the websocket.\n with create_executor_term.sync(\n client=client,\n ) as websocket:\n\n # Send a message.\n websocket.send(\"{}\")\n\n # Get the messages.\n for message in websocket:\n print(message)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.executor.create_executor_term.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1privacy/put/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import update_org_privacy_settings\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.privacy_settings import PrivacySettings\nfrom kittycad.types import Response\n\n\ndef example_update_org_privacy_settings():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[PrivacySettings, Error]] = (\n update_org_privacy_settings.sync(\n client=client,\n body=PrivacySettings(\n can_train_on_data=False,\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: PrivacySettings = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.update_org_privacy_settings.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1privacy/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import get_org_privacy_settings\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_get_org_privacy_settings():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[PrivacySettings, Error]] = (\n get_org_privacy_settings.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: PrivacySettings = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.get_org_privacy_settings.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1api-calls/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import org_list_api_calls\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPriceResultsPage, Error\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_org_list_api_calls():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPriceResultsPage, Error]] = (\n org_list_api_calls.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPriceResultsPage = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.org_list_api_calls.html" - } - }, - { - "op": "add", - "path": "/paths/~1unit~1conversion~1power~1{input_unit}~1{output_unit}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_power_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitPowerConversion\nfrom kittycad.models.unit_power import UnitPower\nfrom kittycad.types import Response\n\n\ndef example_get_power_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitPowerConversion, Error]] = (\n get_power_unit_conversion.sync(\n client=client,\n input_unit=UnitPower.BTU_PER_MINUTE,\n output_unit=UnitPower.BTU_PER_MINUTE,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitPowerConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_power_unit_conversion.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import list_payment_methods_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, PaymentMethod\nfrom kittycad.types import Response\n\n\ndef example_list_payment_methods_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[PaymentMethod], Error]] = (\n list_payment_methods_for_user.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[PaymentMethod] = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.list_payment_methods_for_user.html" } }, { @@ -153,10 +57,210 @@ }, { "op": "add", - "path": "/paths/~1ai~1text-to-cad~1{output_format}/post/x-python", + "path": "/paths/~1user~1api-tokens~1{token}/delete/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import create_text_to_cad\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, TextToCad\nfrom kittycad.models.file_export_format import FileExportFormat\nfrom kittycad.models.text_to_cad_create_body import TextToCadCreateBody\nfrom kittycad.types import Response\n\n\ndef example_create_text_to_cad():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[TextToCad, Error]] = create_text_to_cad.sync(\n client=client,\n output_format=FileExportFormat.FBX,\n kcl=None, # Optional[bool]\n body=TextToCadCreateBody(\n prompt=\"\",\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: TextToCad = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.create_text_to_cad.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_tokens import delete_api_token_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.api_token_uuid import ApiTokenUuid\nfrom kittycad.types import Response\n\n\ndef example_delete_api_token_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_api_token_for_user.sync(\n client=client,\n token=ApiTokenUuid(\"\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_tokens.delete_api_token_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1api-tokens~1{token}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_tokens import get_api_token_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiToken, Error\nfrom kittycad.models.api_token_uuid import ApiTokenUuid\nfrom kittycad.types import Response\n\n\ndef example_get_api_token_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiToken, Error]] = get_api_token_for_user.sync(\n client=client,\n token=ApiTokenUuid(\"\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiToken = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_tokens.get_api_token_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1org/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import create_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Org\nfrom kittycad.models.org_details import OrgDetails\nfrom kittycad.types import Response\n\n\ndef example_create_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Org, Error]] = create_org.sync(\n client=client,\n body=OrgDetails(\n billing_email=\"\",\n name=\"\",\n phone=\"\",\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Org = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.create_org.html" + } + }, + { + "op": "add", + "path": "/paths/~1org/put/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import update_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Org\nfrom kittycad.models.org_details import OrgDetails\nfrom kittycad.types import Response\n\n\ndef example_update_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Org, Error]] = update_org.sync(\n client=client,\n body=OrgDetails(\n billing_email=\"\",\n name=\"\",\n phone=\"\",\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Org = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.update_org.html" + } + }, + { + "op": "add", + "path": "/paths/~1org/delete/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import delete_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_delete_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_org.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.delete_org.html" + } + }, + { + "op": "add", + "path": "/paths/~1org/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import get_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Org\nfrom kittycad.types import Response\n\n\ndef example_get_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Org, Error]] = get_org.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Org = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.get_org.html" + } + }, + { + "op": "add", + "path": "/paths/~1users~1{id}~1payment~1balance/put/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import update_payment_balance_for_any_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import CustomerBalance, Error\nfrom kittycad.models.update_payment_balance import UpdatePaymentBalance\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_update_payment_balance_for_any_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[CustomerBalance, Error]] = (\n update_payment_balance_for_any_user.sync(\n client=client,\n id=Uuid(\"\"),\n body=UpdatePaymentBalance(),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: CustomerBalance = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.update_payment_balance_for_any_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1users~1{id}~1payment~1balance/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_payment_balance_for_any_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import CustomerBalance, Error\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_get_payment_balance_for_any_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[CustomerBalance, Error]] = (\n get_payment_balance_for_any_user.sync(\n client=client,\n id=Uuid(\"\"),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: CustomerBalance = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_payment_balance_for_any_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1users-extended/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import list_users_extended\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ExtendedUserResultsPage\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_users_extended():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ExtendedUserResultsPage, Error]] = (\n list_users_extended.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ExtendedUserResultsPage = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.list_users_extended.html" + } + }, + { + "op": "add", + "path": "/paths/~1apps~1github~1callback/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.apps import apps_github_callback\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_apps_github_callback():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = apps_github_callback.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.apps.apps_github_callback.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1text-to-cad~1{id}/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import create_text_to_cad_model_feedback\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.ml_feedback import MlFeedback\nfrom kittycad.types import Response\n\n\ndef example_create_text_to_cad_model_feedback():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = create_text_to_cad_model_feedback.sync(\n client=client,\n id=\"\",\n feedback=MlFeedback.THUMBS_UP,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.create_text_to_cad_model_feedback.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1text-to-cad~1{id}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import get_text_to_cad_model_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, TextToCad\nfrom kittycad.types import Response\n\n\ndef example_get_text_to_cad_model_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[TextToCad, Error]] = (\n get_text_to_cad_model_for_user.sync(\n client=client,\n id=\"\",\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: TextToCad = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.get_text_to_cad_model_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1ml~1text-to-cad~1iteration/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import create_text_to_cad_iteration\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, TextToCadIteration\nfrom kittycad.models.source_position import SourcePosition\nfrom kittycad.models.source_range import SourceRange\nfrom kittycad.models.source_range_prompt import SourceRangePrompt\nfrom kittycad.models.text_to_cad_iteration_body import TextToCadIterationBody\nfrom kittycad.types import Response\n\n\ndef example_create_text_to_cad_iteration():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[TextToCadIteration, Error]] = (\n create_text_to_cad_iteration.sync(\n client=client,\n body=TextToCadIterationBody(\n original_source_code=\"\",\n source_ranges=[\n SourceRangePrompt(\n prompt=\"\",\n range=SourceRange(\n end=SourcePosition(\n column=10,\n line=10,\n ),\n start=SourcePosition(\n column=10,\n line=10,\n ),\n ),\n )\n ],\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: TextToCadIteration = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.create_text_to_cad_iteration.html" + } + }, + { + "op": "add", + "path": "/paths/~1file~1volume/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.file import create_file_volume\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, FileVolume\nfrom kittycad.models.file_import_format import FileImportFormat\nfrom kittycad.models.unit_volume import UnitVolume\nfrom kittycad.types import Response\n\n\ndef example_create_file_volume():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[FileVolume, Error]] = create_file_volume.sync(\n client=client,\n output_unit=UnitVolume.CM3,\n src_format=FileImportFormat.FBX,\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: FileVolume = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.file.create_file_volume.html" + } + }, + { + "op": "add", + "path": "/paths/~1logout/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.hidden import logout\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_logout():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = logout.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.hidden.logout.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1payment/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import create_payment_information_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Customer, Error\nfrom kittycad.models.billing_info import BillingInfo\nfrom kittycad.types import Response\n\n\ndef example_create_payment_information_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Customer, Error]] = (\n create_payment_information_for_user.sync(\n client=client,\n body=BillingInfo(\n name=\"\",\n phone=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Customer = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.create_payment_information_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1payment/put/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import update_payment_information_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Customer, Error\nfrom kittycad.models.billing_info import BillingInfo\nfrom kittycad.types import Response\n\n\ndef example_update_payment_information_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Customer, Error]] = (\n update_payment_information_for_user.sync(\n client=client,\n body=BillingInfo(\n name=\"\",\n phone=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Customer = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.update_payment_information_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1payment/delete/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import delete_payment_information_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_delete_payment_information_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_payment_information_for_user.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.delete_payment_information_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1payment/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_payment_information_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Customer, Error\nfrom kittycad.types import Response\n\n\ndef example_get_payment_information_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Customer, Error]] = (\n get_payment_information_for_user.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Customer = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_payment_information_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1ping/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.meta import ping\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Pong\nfrom kittycad.types import Response\n\n\ndef example_ping():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Pong, Error]] = ping.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Pong = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.ping.html" + } + }, + { + "op": "add", + "path": "/paths/~1org~1payment~1invoices/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import list_invoices_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Invoice\nfrom kittycad.types import Response\n\n\ndef example_list_invoices_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[Invoice], Error]] = list_invoices_for_org.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[Invoice] = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.list_invoices_for_org.html" + } + }, + { + "op": "add", + "path": "/paths/~1unit~1conversion~1volume~1{input_unit}~1{output_unit}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_volume_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitVolumeConversion\nfrom kittycad.models.unit_volume import UnitVolume\nfrom kittycad.types import Response\n\n\ndef example_get_volume_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitVolumeConversion, Error]] = (\n get_volume_unit_conversion.sync(\n client=client,\n input_unit=UnitVolume.CM3,\n output_unit=UnitVolume.CM3,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitVolumeConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_volume_unit_conversion.html" + } + }, + { + "op": "add", + "path": "/paths/~1file~1conversion~1{src_format}~1{output_format}/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.file import create_file_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, FileConversion\nfrom kittycad.models.file_export_format import FileExportFormat\nfrom kittycad.models.file_import_format import FileImportFormat\nfrom kittycad.types import Response\n\n\ndef example_create_file_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[FileConversion, Error]] = create_file_conversion.sync(\n client=client,\n output_format=FileExportFormat.FBX,\n src_format=FileImportFormat.FBX,\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: FileConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.file.create_file_conversion.html" + } + }, + { + "op": "add", + "path": "/paths/~1ml~1kcl~1completions/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import create_kcl_code_completions\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, KclCodeCompletionResponse\nfrom kittycad.models.kcl_code_completion_params import KclCodeCompletionParams\nfrom kittycad.models.kcl_code_completion_request import KclCodeCompletionRequest\nfrom kittycad.types import Response\n\n\ndef example_create_kcl_code_completions():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[KclCodeCompletionResponse, Error]] = (\n create_kcl_code_completions.sync(\n client=client,\n body=KclCodeCompletionRequest(\n extra=KclCodeCompletionParams(\n language=\"\",\n trim_by_indentation=False,\n ),\n prompt=\"\",\n stop=[\"\"],\n stream=False,\n suffix=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: KclCodeCompletionResponse = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.create_kcl_code_completions.html" + } + }, + { + "op": "add", + "path": "/paths/~1users~1{id}~1api-calls/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import list_api_calls_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPriceResultsPage, Error\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_api_calls_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPriceResultsPage, Error]] = (\n list_api_calls_for_user.sync(\n client=client,\n id=\"\",\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPriceResultsPage = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.list_api_calls_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1unit~1conversion~1power~1{input_unit}~1{output_unit}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_power_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitPowerConversion\nfrom kittycad.models.unit_power import UnitPower\nfrom kittycad.types import Response\n\n\ndef example_get_power_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitPowerConversion, Error]] = (\n get_power_unit_conversion.sync(\n client=client,\n input_unit=UnitPower.BTU_PER_MINUTE,\n output_unit=UnitPower.BTU_PER_MINUTE,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitPowerConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_power_unit_conversion.html" } }, { @@ -185,82 +289,18 @@ }, { "op": "add", - "path": "/paths/~1user~1payment~1subscriptions/post/x-python", + "path": "/paths/~1user~1payment~1balance/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import create_user_subscription\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.models.modeling_app_individual_subscription_tier import (\n ModelingAppIndividualSubscriptionTier,\n)\nfrom kittycad.models.zoo_product_subscriptions_user_request import (\n ZooProductSubscriptionsUserRequest,\n)\nfrom kittycad.types import Response\n\n\ndef example_create_user_subscription():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n create_user_subscription.sync(\n client=client,\n body=ZooProductSubscriptionsUserRequest(\n modeling_app=ModelingAppIndividualSubscriptionTier.FREE,\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.create_user_subscription.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_payment_balance_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import CustomerBalance, Error\nfrom kittycad.types import Response\n\n\ndef example_get_payment_balance_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[CustomerBalance, Error]] = (\n get_payment_balance_for_user.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: CustomerBalance = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_payment_balance_for_user.html" } }, { "op": "add", - "path": "/paths/~1user~1payment~1subscriptions/put/x-python", + "path": "/paths/~1auth~1email~1callback/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import update_user_subscription\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.models.modeling_app_individual_subscription_tier import (\n ModelingAppIndividualSubscriptionTier,\n)\nfrom kittycad.models.zoo_product_subscriptions_user_request import (\n ZooProductSubscriptionsUserRequest,\n)\nfrom kittycad.types import Response\n\n\ndef example_update_user_subscription():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n update_user_subscription.sync(\n client=client,\n body=ZooProductSubscriptionsUserRequest(\n modeling_app=ModelingAppIndividualSubscriptionTier.FREE,\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.update_user_subscription.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1payment~1subscriptions/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_user_subscription\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.types import Response\n\n\ndef example_get_user_subscription():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n get_user_subscription.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_user_subscription.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1payment~1invoices/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import list_invoices_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Invoice\nfrom kittycad.types import Response\n\n\ndef example_list_invoices_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[Invoice], Error]] = list_invoices_for_user.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[Invoice] = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.list_invoices_for_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1ml-prompts/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import list_ml_prompts\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, MlPromptResultsPage\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_ml_prompts():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[MlPromptResultsPage, Error]] = list_ml_prompts.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: MlPromptResultsPage = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.list_ml_prompts.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1oauth2~1providers/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import get_oauth2_providers_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import AccountProvider, Error\nfrom kittycad.types import Response\n\n\ndef example_get_oauth2_providers_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[AccountProvider], Error]] = (\n get_oauth2_providers_for_user.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[AccountProvider] = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.get_oauth2_providers_for_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1unit~1conversion~1energy~1{input_unit}~1{output_unit}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_energy_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitEnergyConversion\nfrom kittycad.models.unit_energy import UnitEnergy\nfrom kittycad.types import Response\n\n\ndef example_get_energy_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitEnergyConversion, Error]] = (\n get_energy_unit_conversion.sync(\n client=client,\n input_unit=UnitEnergy.BTU,\n output_unit=UnitEnergy.BTU,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitEnergyConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_energy_unit_conversion.html" - } - }, - { - "op": "add", - "path": "/paths/~1logout/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.hidden import logout\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_logout():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = logout.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.hidden.logout.html" - } - }, - { - "op": "add", - "path": "/paths/~1unit~1conversion~1force~1{input_unit}~1{output_unit}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_force_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitForceConversion\nfrom kittycad.models.unit_force import UnitForce\nfrom kittycad.types import Response\n\n\ndef example_get_force_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitForceConversion, Error]] = (\n get_force_unit_conversion.sync(\n client=client,\n input_unit=UnitForce.DYNES,\n output_unit=UnitForce.DYNES,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitForceConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_force_unit_conversion.html" - } - }, - { - "op": "add", - "path": "/paths/~1users-extended/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import list_users_extended\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ExtendedUserResultsPage\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_users_extended():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ExtendedUserResultsPage, Error]] = (\n list_users_extended.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ExtendedUserResultsPage = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.list_users_extended.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.hidden import auth_email_callback\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_auth_email_callback():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = auth_email_callback.sync(\n client=client,\n email=\"\",\n token=\"\",\n callback_url=None, # Optional[str]\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.hidden.auth_email_callback.html" } }, { @@ -273,10 +313,18 @@ }, { "op": "add", - "path": "/paths/~1org~1payment~1invoices/get/x-python", + "path": "/paths/~1user~1payment~1tax/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import list_invoices_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Invoice\nfrom kittycad.types import Response\n\n\ndef example_list_invoices_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[Invoice], Error]] = list_invoices_for_org.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[Invoice] = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.list_invoices_for_org.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import validate_customer_tax_information_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_validate_customer_tax_information_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = validate_customer_tax_information_for_user.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.validate_customer_tax_information_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1unit~1conversion~1area~1{input_unit}~1{output_unit}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_area_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitAreaConversion\nfrom kittycad.models.unit_area import UnitArea\nfrom kittycad.types import Response\n\n\ndef example_get_area_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitAreaConversion, Error]] = (\n get_area_unit_conversion.sync(\n client=client,\n input_unit=UnitArea.CM2,\n output_unit=UnitArea.CM2,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitAreaConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_area_unit_conversion.html" } }, { @@ -289,186 +337,50 @@ }, { "op": "add", - "path": "/paths/~1user~1session~1{token}/get/x-python", + "path": "/paths/~1auth~1email/post/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import get_session_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Session\nfrom kittycad.models.session_uuid import SessionUuid\nfrom kittycad.types import Response\n\n\ndef example_get_session_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Session, Error]] = get_session_for_user.sync(\n client=client,\n token=SessionUuid(\"\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Session = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.get_session_for_user.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.hidden import auth_email\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, VerificationTokenResponse\nfrom kittycad.models.email_authentication_form import EmailAuthenticationForm\nfrom kittycad.types import Response\n\n\ndef example_auth_email():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[VerificationTokenResponse, Error]] = auth_email.sync(\n client=client,\n body=EmailAuthenticationForm(\n email=\"\",\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: VerificationTokenResponse = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.hidden.auth_email.html" } }, { "op": "add", - "path": "/paths/~1users~1{id}~1payment~1balance/put/x-python", + "path": "/paths/~1unit~1conversion~1energy~1{input_unit}~1{output_unit}/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import update_payment_balance_for_any_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import CustomerBalance, Error\nfrom kittycad.models.update_payment_balance import UpdatePaymentBalance\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_update_payment_balance_for_any_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[CustomerBalance, Error]] = (\n update_payment_balance_for_any_user.sync(\n client=client,\n id=Uuid(\"\"),\n body=UpdatePaymentBalance(),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: CustomerBalance = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.update_payment_balance_for_any_user.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_energy_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitEnergyConversion\nfrom kittycad.models.unit_energy import UnitEnergy\nfrom kittycad.types import Response\n\n\ndef example_get_energy_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitEnergyConversion, Error]] = (\n get_energy_unit_conversion.sync(\n client=client,\n input_unit=UnitEnergy.BTU,\n output_unit=UnitEnergy.BTU,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitEnergyConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_energy_unit_conversion.html" } }, { "op": "add", - "path": "/paths/~1users~1{id}~1payment~1balance/get/x-python", + "path": "/paths/~1org~1payment~1intent/post/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_payment_balance_for_any_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import CustomerBalance, Error\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_get_payment_balance_for_any_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[CustomerBalance, Error]] = (\n get_payment_balance_for_any_user.sync(\n client=client,\n id=Uuid(\"\"),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: CustomerBalance = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_payment_balance_for_any_user.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import create_payment_intent_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, PaymentIntent\nfrom kittycad.types import Response\n\n\ndef example_create_payment_intent_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[PaymentIntent, Error]] = (\n create_payment_intent_for_org.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: PaymentIntent = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.create_payment_intent_for_org.html" } }, { "op": "add", - "path": "/paths/~1org~1members/post/x-python", + "path": "/paths/~1api-call-metrics/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import create_org_member\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, OrgMember\nfrom kittycad.models.add_org_member import AddOrgMember\nfrom kittycad.models.user_org_role import UserOrgRole\nfrom kittycad.types import Response\n\n\ndef example_create_org_member():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[OrgMember, Error]] = create_org_member.sync(\n client=client,\n body=AddOrgMember(\n email=\"\",\n role=UserOrgRole.ADMIN,\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: OrgMember = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.create_org_member.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import get_api_call_metrics\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallQueryGroup, Error\nfrom kittycad.models.api_call_query_group_by import ApiCallQueryGroupBy\nfrom kittycad.types import Response\n\n\ndef example_get_api_call_metrics():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[ApiCallQueryGroup], Error]] = (\n get_api_call_metrics.sync(\n client=client,\n group_by=ApiCallQueryGroupBy.EMAIL,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[ApiCallQueryGroup] = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.get_api_call_metrics.html" } }, { "op": "add", - "path": "/paths/~1org~1members/get/x-python", + "path": "/paths/~1user~1oauth2~1providers/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import list_org_members\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, OrgMemberResultsPage\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.models.user_org_role import UserOrgRole\nfrom kittycad.types import Response\n\n\ndef example_list_org_members():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[OrgMemberResultsPage, Error]] = list_org_members.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n role=UserOrgRole.ADMIN,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: OrgMemberResultsPage = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.list_org_members.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import get_oauth2_providers_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import AccountProvider, Error\nfrom kittycad.types import Response\n\n\ndef example_get_oauth2_providers_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[AccountProvider], Error]] = (\n get_oauth2_providers_for_user.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[AccountProvider] = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.get_oauth2_providers_for_user.html" } }, { "op": "add", - "path": "/paths/~1file~1center-of-mass/post/x-python", + "path": "/paths/~1_meta~1ipinfo/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.file import create_file_center_of_mass\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, FileCenterOfMass\nfrom kittycad.models.file_import_format import FileImportFormat\nfrom kittycad.models.unit_length import UnitLength\nfrom kittycad.types import Response\n\n\ndef example_create_file_center_of_mass():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[FileCenterOfMass, Error]] = (\n create_file_center_of_mass.sync(\n client=client,\n output_unit=UnitLength.CM,\n src_format=FileImportFormat.FBX,\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: FileCenterOfMass = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.file.create_file_center_of_mass.html" - } - }, - { - "op": "add", - "path": "/paths/~1unit~1conversion~1frequency~1{input_unit}~1{output_unit}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_frequency_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitFrequencyConversion\nfrom kittycad.models.unit_frequency import UnitFrequency\nfrom kittycad.types import Response\n\n\ndef example_get_frequency_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitFrequencyConversion, Error]] = (\n get_frequency_unit_conversion.sync(\n client=client,\n input_unit=UnitFrequency.GIGAHERTZ,\n output_unit=UnitFrequency.GIGAHERTZ,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitFrequencyConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_frequency_unit_conversion.html" - } - }, - { - "op": "add", - "path": "/paths/~1unit~1conversion~1pressure~1{input_unit}~1{output_unit}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_pressure_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitPressureConversion\nfrom kittycad.models.unit_pressure import UnitPressure\nfrom kittycad.types import Response\n\n\ndef example_get_pressure_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitPressureConversion, Error]] = (\n get_pressure_unit_conversion.sync(\n client=client,\n input_unit=UnitPressure.ATMOSPHERES,\n output_unit=UnitPressure.ATMOSPHERES,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitPressureConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_pressure_unit_conversion.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1api-calls/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import user_list_api_calls\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPriceResultsPage, Error\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_user_list_api_calls():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPriceResultsPage, Error]] = (\n user_list_api_calls.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPriceResultsPage = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.user_list_api_calls.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1service-accounts/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.service_accounts import create_service_account_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ServiceAccount\nfrom kittycad.types import Response\n\n\ndef example_create_service_account_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ServiceAccount, Error]] = (\n create_service_account_for_org.sync(\n client=client,\n label=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ServiceAccount = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.service_accounts.create_service_account_for_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1service-accounts/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.service_accounts import list_service_accounts_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ServiceAccountResultsPage\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_service_accounts_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ServiceAccountResultsPage, Error]] = (\n list_service_accounts_for_org.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ServiceAccountResultsPage = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.service_accounts.list_service_accounts_for_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1unit~1conversion~1angle~1{input_unit}~1{output_unit}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_angle_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitAngleConversion\nfrom kittycad.models.unit_angle import UnitAngle\nfrom kittycad.types import Response\n\n\ndef example_get_angle_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitAngleConversion, Error]] = (\n get_angle_unit_conversion.sync(\n client=client,\n input_unit=UnitAngle.DEGREES,\n output_unit=UnitAngle.DEGREES,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitAngleConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_angle_unit_conversion.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1payment~1tax/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import validate_customer_tax_information_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_validate_customer_tax_information_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = validate_customer_tax_information_for_user.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.validate_customer_tax_information_for_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1api-calls~1{id}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import get_api_call_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPrice, Error\nfrom kittycad.types import Response\n\n\ndef example_get_api_call_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPrice, Error]] = get_api_call_for_user.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPrice = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.get_api_call_for_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1store~1coupon/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.store import create_store_coupon\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import DiscountCode, Error\nfrom kittycad.models.store_coupon_params import StoreCouponParams\nfrom kittycad.types import Response\n\n\ndef example_create_store_coupon():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[DiscountCode, Error]] = create_store_coupon.sync(\n client=client,\n body=StoreCouponParams(\n percent_off=10,\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: DiscountCode = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.store.create_store_coupon.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1payment~1intent/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import create_payment_intent_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, PaymentIntent\nfrom kittycad.types import Response\n\n\ndef example_create_payment_intent_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[PaymentIntent, Error]] = (\n create_payment_intent_for_user.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: PaymentIntent = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.create_payment_intent_for_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1apps~1github~1webhook/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.apps import apps_github_webhook\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_apps_github_webhook():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = apps_github_webhook.sync(\n client=client,\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.apps.apps_github_webhook.html" - } - }, - { - "op": "add", - "path": "/paths/~1ml~1text-to-cad~1iteration/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import create_text_to_cad_iteration\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, TextToCadIteration\nfrom kittycad.models.source_position import SourcePosition\nfrom kittycad.models.source_range import SourceRange\nfrom kittycad.models.source_range_prompt import SourceRangePrompt\nfrom kittycad.models.text_to_cad_iteration_body import TextToCadIterationBody\nfrom kittycad.types import Response\n\n\ndef example_create_text_to_cad_iteration():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[TextToCadIteration, Error]] = (\n create_text_to_cad_iteration.sync(\n client=client,\n body=TextToCadIterationBody(\n original_source_code=\"\",\n source_ranges=[\n SourceRangePrompt(\n prompt=\"\",\n range=SourceRange(\n end=SourcePosition(\n column=10,\n line=10,\n ),\n start=SourcePosition(\n column=10,\n line=10,\n ),\n ),\n )\n ],\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: TextToCadIteration = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.create_text_to_cad_iteration.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1payment~1subscriptions/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import create_org_subscription\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.models.modeling_app_organization_subscription_tier import (\n ModelingAppOrganizationSubscriptionTier,\n)\nfrom kittycad.models.zoo_product_subscriptions_org_request import (\n ZooProductSubscriptionsOrgRequest,\n)\nfrom kittycad.types import Response\n\n\ndef example_create_org_subscription():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n create_org_subscription.sync(\n client=client,\n body=ZooProductSubscriptionsOrgRequest(\n modeling_app=ModelingAppOrganizationSubscriptionTier.TEAM,\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.create_org_subscription.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1payment~1subscriptions/put/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import update_org_subscription\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.models.modeling_app_organization_subscription_tier import (\n ModelingAppOrganizationSubscriptionTier,\n)\nfrom kittycad.models.zoo_product_subscriptions_org_request import (\n ZooProductSubscriptionsOrgRequest,\n)\nfrom kittycad.types import Response\n\n\ndef example_update_org_subscription():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n update_org_subscription.sync(\n client=client,\n body=ZooProductSubscriptionsOrgRequest(\n modeling_app=ModelingAppOrganizationSubscriptionTier.TEAM,\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.update_org_subscription.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1payment~1subscriptions/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_org_subscription\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.types import Response\n\n\ndef example_get_org_subscription():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n get_org_subscription.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_org_subscription.html" - } - }, - { - "op": "add", - "path": "/paths/~1users/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import list_users\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UserResultsPage\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_users():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UserResultsPage, Error]] = list_users.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UserResultsPage = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.list_users.html" - } - }, - { - "op": "add", - "path": "/paths/~1file~1conversion~1{src_format}~1{output_format}/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.file import create_file_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, FileConversion\nfrom kittycad.models.file_export_format import FileExportFormat\nfrom kittycad.models.file_import_format import FileImportFormat\nfrom kittycad.types import Response\n\n\ndef example_create_file_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[FileConversion, Error]] = create_file_conversion.sync(\n client=client,\n output_format=FileExportFormat.FBX,\n src_format=FileImportFormat.FBX,\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: FileConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.file.create_file_conversion.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.meta import get_ipinfo\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, IpAddrInfo\nfrom kittycad.types import Response\n\n\ndef example_get_ipinfo():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[IpAddrInfo, Error]] = get_ipinfo.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: IpAddrInfo = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.get_ipinfo.html" } }, { @@ -481,10 +393,314 @@ }, { "op": "add", - "path": "/paths/~1file~1execute~1{lang}/post/x-python", + "path": "/paths/~1org~1api-calls~1{id}/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.executor import create_file_execution\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import CodeOutput, Error\nfrom kittycad.models.code_language import CodeLanguage\nfrom kittycad.types import Response\n\n\ndef example_create_file_execution():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[CodeOutput, Error]] = create_file_execution.sync(\n client=client,\n lang=CodeLanguage.GO,\n output=None, # Optional[str]\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: CodeOutput = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.executor.create_file_execution.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import get_api_call_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPrice, Error\nfrom kittycad.types import Response\n\n\ndef example_get_api_call_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPrice, Error]] = get_api_call_for_org.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPrice = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.get_api_call_for_org.html" + } + }, + { + "op": "add", + "path": "/paths/~1users/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import list_users\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UserResultsPage\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_users():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UserResultsPage, Error]] = list_users.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UserResultsPage = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.list_users.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1api-calls/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import user_list_api_calls\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPriceResultsPage, Error\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_user_list_api_calls():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPriceResultsPage, Error]] = (\n user_list_api_calls.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPriceResultsPage = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.user_list_api_calls.html" + } + }, + { + "op": "add", + "path": "/paths/~1ws~1executor~1term/get/x-python", + "value": { + "example": "from kittycad.api.executor import create_executor_term\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.types import Response\n\n\ndef example_create_executor_term():\n # Create our client.\n client = ClientFromEnv()\n\n # Connect to the websocket.\n with create_executor_term.sync(\n client=client,\n ) as websocket:\n\n # Send a message.\n websocket.send(\"{}\")\n\n # Get the messages.\n for message in websocket:\n print(message)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.executor.create_executor_term.html" + } + }, + { + "op": "add", + "path": "/paths/~1async~1operations/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import list_async_operations\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import AsyncApiCallResultsPage, Error\nfrom kittycad.models.api_call_status import ApiCallStatus\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_async_operations():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[AsyncApiCallResultsPage, Error]] = (\n list_async_operations.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n status=ApiCallStatus.QUEUED,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: AsyncApiCallResultsPage = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.list_async_operations.html" + } + }, + { + "op": "add", + "path": "/paths/~1api-calls/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import list_api_calls\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPriceResultsPage, Error\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_api_calls():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPriceResultsPage, Error]] = (\n list_api_calls.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPriceResultsPage = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.list_api_calls.html" + } + }, + { + "op": "add", + "path": "/paths/~1file~1center-of-mass/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.file import create_file_center_of_mass\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, FileCenterOfMass\nfrom kittycad.models.file_import_format import FileImportFormat\nfrom kittycad.models.unit_length import UnitLength\nfrom kittycad.types import Response\n\n\ndef example_create_file_center_of_mass():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[FileCenterOfMass, Error]] = (\n create_file_center_of_mass.sync(\n client=client,\n output_unit=UnitLength.CM,\n src_format=FileImportFormat.FBX,\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: FileCenterOfMass = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.file.create_file_center_of_mass.html" + } + }, + { + "op": "add", + "path": "/paths/~1org~1privacy/put/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import update_org_privacy_settings\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.privacy_settings import PrivacySettings\nfrom kittycad.types import Response\n\n\ndef example_update_org_privacy_settings():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[PrivacySettings, Error]] = (\n update_org_privacy_settings.sync(\n client=client,\n body=PrivacySettings(\n can_train_on_data=False,\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: PrivacySettings = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.update_org_privacy_settings.html" + } + }, + { + "op": "add", + "path": "/paths/~1org~1privacy/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import get_org_privacy_settings\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_get_org_privacy_settings():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[PrivacySettings, Error]] = (\n get_org_privacy_settings.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: PrivacySettings = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.get_org_privacy_settings.html" + } + }, + { + "op": "add", + "path": "/paths/~1unit~1conversion~1torque~1{input_unit}~1{output_unit}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_torque_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitTorqueConversion\nfrom kittycad.models.unit_torque import UnitTorque\nfrom kittycad.types import Response\n\n\ndef example_get_torque_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitTorqueConversion, Error]] = (\n get_torque_unit_conversion.sync(\n client=client,\n input_unit=UnitTorque.NEWTON_METRES,\n output_unit=UnitTorque.NEWTON_METRES,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitTorqueConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_torque_unit_conversion.html" + } + }, + { + "op": "add", + "path": "/paths/~1async~1operations~1{id}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import get_async_operation\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import (\n Error,\n FileCenterOfMass,\n FileConversion,\n FileDensity,\n FileMass,\n FileSurfaceArea,\n FileVolume,\n TextToCad,\n TextToCadIteration,\n)\nfrom kittycad.types import Response\n\n\ndef example_get_async_operation():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[\n Union[\n FileConversion,\n FileCenterOfMass,\n FileMass,\n FileVolume,\n FileDensity,\n FileSurfaceArea,\n TextToCad,\n TextToCadIteration,\n Error,\n ]\n ] = get_async_operation.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Union[\n FileConversion,\n FileCenterOfMass,\n FileMass,\n FileVolume,\n FileDensity,\n FileSurfaceArea,\n TextToCad,\n TextToCadIteration,\n ] = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.get_async_operation.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1session~1{token}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import get_session_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Session\nfrom kittycad.models.session_uuid import SessionUuid\nfrom kittycad.types import Response\n\n\ndef example_get_session_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Session, Error]] = get_session_for_user.sync(\n client=client,\n token=SessionUuid(\"\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Session = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.get_session_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1unit~1conversion~1pressure~1{input_unit}~1{output_unit}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_pressure_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitPressureConversion\nfrom kittycad.models.unit_pressure import UnitPressure\nfrom kittycad.types import Response\n\n\ndef example_get_pressure_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitPressureConversion, Error]] = (\n get_pressure_unit_conversion.sync(\n client=client,\n input_unit=UnitPressure.ATMOSPHERES,\n output_unit=UnitPressure.ATMOSPHERES,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitPressureConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_pressure_unit_conversion.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1privacy/put/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import update_user_privacy_settings\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.privacy_settings import PrivacySettings\nfrom kittycad.types import Response\n\n\ndef example_update_user_privacy_settings():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[PrivacySettings, Error]] = (\n update_user_privacy_settings.sync(\n client=client,\n body=PrivacySettings(\n can_train_on_data=False,\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: PrivacySettings = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.update_user_privacy_settings.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1privacy/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import get_user_privacy_settings\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_get_user_privacy_settings():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[PrivacySettings, Error]] = (\n get_user_privacy_settings.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: PrivacySettings = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.get_user_privacy_settings.html" + } + }, + { + "op": "add", + "path": "/paths/~1ai~1text-to-cad~1{output_format}/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import create_text_to_cad\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, TextToCad\nfrom kittycad.models.file_export_format import FileExportFormat\nfrom kittycad.models.text_to_cad_create_body import TextToCadCreateBody\nfrom kittycad.types import Response\n\n\ndef example_create_text_to_cad():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[TextToCad, Error]] = create_text_to_cad.sync(\n client=client,\n output_format=FileExportFormat.FBX,\n kcl=None, # Optional[bool]\n body=TextToCadCreateBody(\n prompt=\"\",\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: TextToCad = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.create_text_to_cad.html" + } + }, + { + "op": "add", + "path": "/paths/~1api-calls~1{id}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import get_api_call\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPrice, Error\nfrom kittycad.types import Response\n\n\ndef example_get_api_call():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPrice, Error]] = get_api_call.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPrice = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.get_api_call.html" + } + }, + { + "op": "add", + "path": "/paths/~1unit~1conversion~1temperature~1{input_unit}~1{output_unit}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_temperature_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitTemperatureConversion\nfrom kittycad.models.unit_temperature import UnitTemperature\nfrom kittycad.types import Response\n\n\ndef example_get_temperature_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitTemperatureConversion, Error]] = (\n get_temperature_unit_conversion.sync(\n client=client,\n input_unit=UnitTemperature.CELSIUS,\n output_unit=UnitTemperature.CELSIUS,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitTemperatureConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_temperature_unit_conversion.html" + } + }, + { + "op": "add", + "path": "/paths/~1users~1{id}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import get_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, User\nfrom kittycad.types import Response\n\n\ndef example_get_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[User, Error]] = get_user.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: User = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.get_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1unit~1conversion~1length~1{input_unit}~1{output_unit}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_length_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitLengthConversion\nfrom kittycad.models.unit_length import UnitLength\nfrom kittycad.types import Response\n\n\ndef example_get_length_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitLengthConversion, Error]] = (\n get_length_unit_conversion.sync(\n client=client,\n input_unit=UnitLength.CM,\n output_unit=UnitLength.CM,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitLengthConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_length_unit_conversion.html" + } + }, + { + "op": "add", + "path": "/paths/~1apps~1github~1consent/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.apps import apps_github_consent\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import AppClientInfo, Error\nfrom kittycad.types import Response\n\n\ndef example_apps_github_consent():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[AppClientInfo, Error]] = apps_github_consent.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: AppClientInfo = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.apps.apps_github_consent.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1payment~1intent/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import create_payment_intent_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, PaymentIntent\nfrom kittycad.types import Response\n\n\ndef example_create_payment_intent_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[PaymentIntent, Error]] = (\n create_payment_intent_for_user.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: PaymentIntent = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.create_payment_intent_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1extended/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import get_user_self_extended\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ExtendedUser\nfrom kittycad.types import Response\n\n\ndef example_get_user_self_extended():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ExtendedUser, Error]] = get_user_self_extended.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ExtendedUser = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.get_user_self_extended.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1payment~1subscriptions/put/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import update_user_subscription\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.models.modeling_app_individual_subscription_tier import (\n ModelingAppIndividualSubscriptionTier,\n)\nfrom kittycad.models.zoo_product_subscriptions_user_request import (\n ZooProductSubscriptionsUserRequest,\n)\nfrom kittycad.types import Response\n\n\ndef example_update_user_subscription():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n update_user_subscription.sync(\n client=client,\n body=ZooProductSubscriptionsUserRequest(\n modeling_app=ModelingAppIndividualSubscriptionTier.FREE,\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.update_user_subscription.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1payment~1subscriptions/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import create_user_subscription\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.models.modeling_app_individual_subscription_tier import (\n ModelingAppIndividualSubscriptionTier,\n)\nfrom kittycad.models.zoo_product_subscriptions_user_request import (\n ZooProductSubscriptionsUserRequest,\n)\nfrom kittycad.types import Response\n\n\ndef example_create_user_subscription():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n create_user_subscription.sync(\n client=client,\n body=ZooProductSubscriptionsUserRequest(\n modeling_app=ModelingAppIndividualSubscriptionTier.FREE,\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.create_user_subscription.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1payment~1subscriptions/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_user_subscription\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.types import Response\n\n\ndef example_get_user_subscription():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n get_user_subscription.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_user_subscription.html" + } + }, + { + "op": "add", + "path": "/paths/~1org~1payment~1subscriptions/put/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import update_org_subscription\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.models.modeling_app_organization_subscription_tier import (\n ModelingAppOrganizationSubscriptionTier,\n)\nfrom kittycad.models.zoo_product_subscriptions_org_request import (\n ZooProductSubscriptionsOrgRequest,\n)\nfrom kittycad.types import Response\n\n\ndef example_update_org_subscription():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n update_org_subscription.sync(\n client=client,\n body=ZooProductSubscriptionsOrgRequest(\n modeling_app=ModelingAppOrganizationSubscriptionTier.TEAM,\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.update_org_subscription.html" + } + }, + { + "op": "add", + "path": "/paths/~1org~1payment~1subscriptions/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import create_org_subscription\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.models.modeling_app_organization_subscription_tier import (\n ModelingAppOrganizationSubscriptionTier,\n)\nfrom kittycad.models.zoo_product_subscriptions_org_request import (\n ZooProductSubscriptionsOrgRequest,\n)\nfrom kittycad.types import Response\n\n\ndef example_create_org_subscription():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n create_org_subscription.sync(\n client=client,\n body=ZooProductSubscriptionsOrgRequest(\n modeling_app=ModelingAppOrganizationSubscriptionTier.TEAM,\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.create_org_subscription.html" + } + }, + { + "op": "add", + "path": "/paths/~1org~1payment~1subscriptions/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_org_subscription\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.types import Response\n\n\ndef example_get_org_subscription():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n get_org_subscription.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_org_subscription.html" + } + }, + { + "op": "add", + "path": "/paths/~1ml-prompts~1{id}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import get_ml_prompt\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, MlPrompt\nfrom kittycad.types import Response\n\n\ndef example_get_ml_prompt():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[MlPrompt, Error]] = get_ml_prompt.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: MlPrompt = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.get_ml_prompt.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1api-calls~1{id}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import get_api_call_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPrice, Error\nfrom kittycad.types import Response\n\n\ndef example_get_api_call_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPrice, Error]] = get_api_call_for_user.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPrice = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.get_api_call_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1org~1payment~1methods/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import list_payment_methods_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, PaymentMethod\nfrom kittycad.types import Response\n\n\ndef example_list_payment_methods_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[PaymentMethod], Error]] = (\n list_payment_methods_for_org.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[PaymentMethod] = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.list_payment_methods_for_org.html" + } + }, + { + "op": "add", + "path": "/paths/~1file~1density/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.file import create_file_density\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, FileDensity\nfrom kittycad.models.file_import_format import FileImportFormat\nfrom kittycad.models.unit_density import UnitDensity\nfrom kittycad.models.unit_mass import UnitMass\nfrom kittycad.types import Response\n\n\ndef example_create_file_density():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[FileDensity, Error]] = create_file_density.sync(\n client=client,\n material_mass=3.14,\n material_mass_unit=UnitMass.G,\n output_unit=UnitDensity.LB_FT3,\n src_format=FileImportFormat.FBX,\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: FileDensity = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.file.create_file_density.html" + } + }, + { + "op": "add", + "path": "/paths/~1orgs~1{id}~1enterprise~1pricing/put/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import update_enterprise_pricing_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.models.plan_interval import PlanInterval\nfrom kittycad.models.subscription_tier_price import (\n OptionPerUser,\n SubscriptionTierPrice,\n)\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_update_enterprise_pricing_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n update_enterprise_pricing_for_org.sync(\n client=client,\n id=Uuid(\"\"),\n body=SubscriptionTierPrice(\n OptionPerUser(\n interval=PlanInterval.DAY,\n price=3.14,\n )\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.update_enterprise_pricing_for_org.html" + } + }, + { + "op": "add", + "path": "/paths/~1org~1payment~1methods~1{id}/delete/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import delete_payment_method_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_delete_payment_method_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_payment_method_for_org.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.delete_payment_method_for_org.html" + } + }, + { + "op": "add", + "path": "/paths/~1auth~1saml~1provider~1{provider_id}~1login/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.hidden import post_auth_saml\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_post_auth_saml():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = post_auth_saml.sync(\n client=client,\n provider_id=Uuid(\"\"),\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.hidden.post_auth_saml.html" + } + }, + { + "op": "add", + "path": "/paths/~1auth~1saml~1provider~1{provider_id}~1login/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.hidden import get_auth_saml\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_get_auth_saml():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = get_auth_saml.sync(\n client=client,\n provider_id=Uuid(\"\"),\n callback_url=None, # Optional[str]\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.hidden.get_auth_saml.html" + } + }, + { + "op": "add", + "path": "/paths/~1debug~1uploads/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.meta import create_debug_uploads\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_create_debug_uploads():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[str], Error]] = create_debug_uploads.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[str] = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.create_debug_uploads.html" + } + }, + { + "op": "add", + "path": "/paths/~1file~1surface-area/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.file import create_file_surface_area\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, FileSurfaceArea\nfrom kittycad.models.file_import_format import FileImportFormat\nfrom kittycad.models.unit_area import UnitArea\nfrom kittycad.types import Response\n\n\ndef example_create_file_surface_area():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[FileSurfaceArea, Error]] = (\n create_file_surface_area.sync(\n client=client,\n output_unit=UnitArea.CM2,\n src_format=FileImportFormat.FBX,\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: FileSurfaceArea = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.file.create_file_surface_area.html" } }, { @@ -513,90 +729,58 @@ }, { "op": "add", - "path": "/paths/~1async~1operations/get/x-python", + "path": "/paths/~1orgs~1{id}~1payment~1balance/put/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import list_async_operations\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import AsyncApiCallResultsPage, Error\nfrom kittycad.models.api_call_status import ApiCallStatus\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_async_operations():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[AsyncApiCallResultsPage, Error]] = (\n list_async_operations.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n status=ApiCallStatus.QUEUED,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: AsyncApiCallResultsPage = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.list_async_operations.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import update_payment_balance_for_any_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import CustomerBalance, Error\nfrom kittycad.models.update_payment_balance import UpdatePaymentBalance\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_update_payment_balance_for_any_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[CustomerBalance, Error]] = (\n update_payment_balance_for_any_org.sync(\n client=client,\n id=Uuid(\"\"),\n body=UpdatePaymentBalance(),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: CustomerBalance = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.update_payment_balance_for_any_org.html" } }, { "op": "add", - "path": "/paths/~1user~1api-tokens/post/x-python", + "path": "/paths/~1orgs~1{id}~1payment~1balance/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_tokens import create_api_token_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiToken, Error\nfrom kittycad.types import Response\n\n\ndef example_create_api_token_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiToken, Error]] = create_api_token_for_user.sync(\n client=client,\n label=None, # Optional[str]\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiToken = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_tokens.create_api_token_for_user.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_payment_balance_for_any_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import CustomerBalance, Error\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_get_payment_balance_for_any_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[CustomerBalance, Error]] = (\n get_payment_balance_for_any_org.sync(\n client=client,\n id=Uuid(\"\"),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: CustomerBalance = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_payment_balance_for_any_org.html" } }, { "op": "add", - "path": "/paths/~1user~1api-tokens/get/x-python", + "path": "/paths/~1unit~1conversion~1current~1{input_unit}~1{output_unit}/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_tokens import list_api_tokens_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiTokenResultsPage, Error\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_api_tokens_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiTokenResultsPage, Error]] = (\n list_api_tokens_for_user.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiTokenResultsPage = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_tokens.list_api_tokens_for_user.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_current_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitCurrentConversion\nfrom kittycad.models.unit_current import UnitCurrent\nfrom kittycad.types import Response\n\n\ndef example_get_current_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitCurrentConversion, Error]] = (\n get_current_unit_conversion.sync(\n client=client,\n input_unit=UnitCurrent.AMPERES,\n output_unit=UnitCurrent.AMPERES,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitCurrentConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_current_unit_conversion.html" } }, { "op": "add", - "path": "/paths/~1user~1extended/get/x-python", + "path": "/paths/~1org~1service-accounts/post/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import get_user_self_extended\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ExtendedUser\nfrom kittycad.types import Response\n\n\ndef example_get_user_self_extended():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ExtendedUser, Error]] = get_user_self_extended.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ExtendedUser = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.get_user_self_extended.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.service_accounts import create_service_account_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ServiceAccount\nfrom kittycad.types import Response\n\n\ndef example_create_service_account_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ServiceAccount, Error]] = (\n create_service_account_for_org.sync(\n client=client,\n label=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ServiceAccount = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.service_accounts.create_service_account_for_org.html" } }, { "op": "add", - "path": "/paths/~1api-calls~1{id}/get/x-python", + "path": "/paths/~1org~1service-accounts/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import get_api_call\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPrice, Error\nfrom kittycad.types import Response\n\n\ndef example_get_api_call():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPrice, Error]] = get_api_call.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPrice = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.get_api_call.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.service_accounts import list_service_accounts_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ServiceAccountResultsPage\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_service_accounts_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ServiceAccountResultsPage, Error]] = (\n list_service_accounts_for_org.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ServiceAccountResultsPage = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.service_accounts.list_service_accounts_for_org.html" } }, { "op": "add", - "path": "/paths/~1ws~1modeling~1commands/get/x-python", + "path": "/paths/~1apps~1github~1webhook/post/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.modeling import modeling_commands_ws\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, WebSocketRequest, WebSocketResponse\nfrom kittycad.models.post_effect_type import PostEffectType\nfrom kittycad.models.rtc_sdp_type import RtcSdpType\nfrom kittycad.models.rtc_session_description import RtcSessionDescription\nfrom kittycad.models.web_socket_request import OptionSdpOffer\nfrom kittycad.types import Response\n\n\ndef example_modeling_commands_ws():\n # Create our client.\n client = ClientFromEnv()\n\n # Connect to the websocket.\n with modeling_commands_ws.WebSocket(\n client=client,\n fps=10,\n post_effect=PostEffectType.PHOSPHOR,\n show_grid=False,\n unlocked_framerate=False,\n video_res_height=10,\n video_res_width=10,\n webrtc=False,\n pool=None, # Optional[str]\n replay=None, # Optional[str]\n ) as websocket:\n\n # Send a message.\n websocket.send(\n WebSocketRequest(\n OptionSdpOffer(\n offer=RtcSessionDescription(\n sdp=\"\",\n type=RtcSdpType.UNSPECIFIED,\n ),\n )\n )\n )\n\n # Get a message.\n message = websocket.recv()\n print(message)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.modeling.modeling_commands_ws.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.apps import apps_github_webhook\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_apps_github_webhook():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = apps_github_webhook.sync(\n client=client,\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.apps.apps_github_webhook.html" } }, { "op": "add", - "path": "/paths/~1apps~1github~1consent/get/x-python", + "path": "/paths/~1unit~1conversion~1angle~1{input_unit}~1{output_unit}/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.apps import apps_github_consent\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import AppClientInfo, Error\nfrom kittycad.types import Response\n\n\ndef example_apps_github_consent():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[AppClientInfo, Error]] = apps_github_consent.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: AppClientInfo = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.apps.apps_github_consent.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1payment~1methods/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import list_payment_methods_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, PaymentMethod\nfrom kittycad.types import Response\n\n\ndef example_list_payment_methods_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[PaymentMethod], Error]] = (\n list_payment_methods_for_org.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[PaymentMethod] = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.list_payment_methods_for_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1text-to-cad~1{id}/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import create_text_to_cad_model_feedback\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.ml_feedback import MlFeedback\nfrom kittycad.types import Response\n\n\ndef example_create_text_to_cad_model_feedback():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = create_text_to_cad_model_feedback.sync(\n client=client,\n id=\"\",\n feedback=MlFeedback.THUMBS_UP,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.create_text_to_cad_model_feedback.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1text-to-cad~1{id}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import get_text_to_cad_model_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, TextToCad\nfrom kittycad.types import Response\n\n\ndef example_get_text_to_cad_model_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[TextToCad, Error]] = (\n get_text_to_cad_model_for_user.sync(\n client=client,\n id=\"\",\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: TextToCad = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.get_text_to_cad_model_for_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1_meta~1info/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.meta import get_metadata\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Metadata\nfrom kittycad.types import Response\n\n\ndef example_get_metadata():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Metadata, Error]] = get_metadata.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Metadata = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.get_metadata.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_angle_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitAngleConversion\nfrom kittycad.models.unit_angle import UnitAngle\nfrom kittycad.types import Response\n\n\ndef example_get_angle_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitAngleConversion, Error]] = (\n get_angle_unit_conversion.sync(\n client=client,\n input_unit=UnitAngle.DEGREES,\n output_unit=UnitAngle.DEGREES,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitAngleConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_angle_unit_conversion.html" } }, { @@ -617,330 +801,10 @@ }, { "op": "add", - "path": "/paths/~1ml~1kcl~1completions/post/x-python", + "path": "/paths/~1user~1payment~1methods~1{id}/delete/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import create_kcl_code_completions\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, KclCodeCompletionResponse\nfrom kittycad.models.kcl_code_completion_params import KclCodeCompletionParams\nfrom kittycad.models.kcl_code_completion_request import KclCodeCompletionRequest\nfrom kittycad.types import Response\n\n\ndef example_create_kcl_code_completions():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[KclCodeCompletionResponse, Error]] = (\n create_kcl_code_completions.sync(\n client=client,\n body=KclCodeCompletionRequest(\n extra=KclCodeCompletionParams(\n language=\"\",\n trim_by_indentation=False,\n ),\n prompt=\"\",\n stop=[\"\"],\n stream=False,\n suffix=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: KclCodeCompletionResponse = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.create_kcl_code_completions.html" - } - }, - { - "op": "add", - "path": "/paths/~1file~1density/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.file import create_file_density\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, FileDensity\nfrom kittycad.models.file_import_format import FileImportFormat\nfrom kittycad.models.unit_density import UnitDensity\nfrom kittycad.models.unit_mass import UnitMass\nfrom kittycad.types import Response\n\n\ndef example_create_file_density():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[FileDensity, Error]] = create_file_density.sync(\n client=client,\n material_mass=3.14,\n material_mass_unit=UnitMass.G,\n output_unit=UnitDensity.LB_FT3,\n src_format=FileImportFormat.FBX,\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: FileDensity = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.file.create_file_density.html" - } - }, - { - "op": "add", - "path": "/paths/~1ml-prompts~1{id}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import get_ml_prompt\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, MlPrompt\nfrom kittycad.types import Response\n\n\ndef example_get_ml_prompt():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[MlPrompt, Error]] = get_ml_prompt.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: MlPrompt = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.get_ml_prompt.html" - } - }, - { - "op": "add", - "path": "/paths/~1file~1surface-area/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.file import create_file_surface_area\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, FileSurfaceArea\nfrom kittycad.models.file_import_format import FileImportFormat\nfrom kittycad.models.unit_area import UnitArea\nfrom kittycad.types import Response\n\n\ndef example_create_file_surface_area():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[FileSurfaceArea, Error]] = (\n create_file_surface_area.sync(\n client=client,\n output_unit=UnitArea.CM2,\n src_format=FileImportFormat.FBX,\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: FileSurfaceArea = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.file.create_file_surface_area.html" - } - }, - { - "op": "add", - "path": "/paths/~1api-calls/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import list_api_calls\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPriceResultsPage, Error\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_api_calls():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPriceResultsPage, Error]] = (\n list_api_calls.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPriceResultsPage = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.list_api_calls.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1payment/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import create_payment_information_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Customer, Error\nfrom kittycad.models.billing_info import BillingInfo\nfrom kittycad.types import Response\n\n\ndef example_create_payment_information_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Customer, Error]] = (\n create_payment_information_for_org.sync(\n client=client,\n body=BillingInfo(\n name=\"\",\n phone=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Customer = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.create_payment_information_for_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1payment/delete/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import delete_payment_information_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_delete_payment_information_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_payment_information_for_org.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.delete_payment_information_for_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1payment/put/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import update_payment_information_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Customer, Error\nfrom kittycad.models.billing_info import BillingInfo\nfrom kittycad.types import Response\n\n\ndef example_update_payment_information_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Customer, Error]] = (\n update_payment_information_for_org.sync(\n client=client,\n body=BillingInfo(\n name=\"\",\n phone=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Customer = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.update_payment_information_for_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1payment/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_payment_information_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Customer, Error\nfrom kittycad.types import Response\n\n\ndef example_get_payment_information_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Customer, Error]] = (\n get_payment_information_for_org.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Customer = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_payment_information_for_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1payment~1methods/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import list_payment_methods_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, PaymentMethod\nfrom kittycad.types import Response\n\n\ndef example_list_payment_methods_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[PaymentMethod], Error]] = (\n list_payment_methods_for_user.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[PaymentMethod] = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.list_payment_methods_for_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1unit~1conversion~1volume~1{input_unit}~1{output_unit}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_volume_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitVolumeConversion\nfrom kittycad.models.unit_volume import UnitVolume\nfrom kittycad.types import Response\n\n\ndef example_get_volume_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitVolumeConversion, Error]] = (\n get_volume_unit_conversion.sync(\n client=client,\n input_unit=UnitVolume.CM3,\n output_unit=UnitVolume.CM3,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitVolumeConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_volume_unit_conversion.html" - } - }, - { - "op": "add", - "path": "/paths/~1apps~1github~1callback/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.apps import apps_github_callback\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_apps_github_callback():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = apps_github_callback.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.apps.apps_github_callback.html" - } - }, - { - "op": "add", - "path": "/paths/~1pricing~1subscriptions/get/x-python", - "value": { - "example": "from kittycad.api.meta import get_pricing_subscriptions\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.types import Response\n\n\ndef example_get_pricing_subscriptions():\n # Create our client.\n client = ClientFromEnv()\n\n get_pricing_subscriptions.sync(\n client=client,\n )\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.get_pricing_subscriptions.html" - } - }, - { - "op": "add", - "path": "/paths/~1internal~1discord~1api-token~1{discord_id}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.meta import internal_get_api_token_for_discord_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiToken, Error\nfrom kittycad.types import Response\n\n\ndef example_internal_get_api_token_for_discord_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiToken, Error]] = (\n internal_get_api_token_for_discord_user.sync(\n client=client,\n discord_id=\"\",\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiToken = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.internal_get_api_token_for_discord_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1unit~1conversion~1temperature~1{input_unit}~1{output_unit}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_temperature_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitTemperatureConversion\nfrom kittycad.models.unit_temperature import UnitTemperature\nfrom kittycad.types import Response\n\n\ndef example_get_temperature_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitTemperatureConversion, Error]] = (\n get_temperature_unit_conversion.sync(\n client=client,\n input_unit=UnitTemperature.CELSIUS,\n output_unit=UnitTemperature.CELSIUS,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitTemperatureConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_temperature_unit_conversion.html" - } - }, - { - "op": "add", - "path": "/paths/~1unit~1conversion~1mass~1{input_unit}~1{output_unit}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_mass_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitMassConversion\nfrom kittycad.models.unit_mass import UnitMass\nfrom kittycad.types import Response\n\n\ndef example_get_mass_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitMassConversion, Error]] = (\n get_mass_unit_conversion.sync(\n client=client,\n input_unit=UnitMass.G,\n output_unit=UnitMass.G,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitMassConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_mass_unit_conversion.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1payment~1methods~1{id}/delete/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import delete_payment_method_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_delete_payment_method_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_payment_method_for_org.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.delete_payment_method_for_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1file~1volume/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.file import create_file_volume\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, FileVolume\nfrom kittycad.models.file_import_format import FileImportFormat\nfrom kittycad.models.unit_volume import UnitVolume\nfrom kittycad.types import Response\n\n\ndef example_create_file_volume():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[FileVolume, Error]] = create_file_volume.sync(\n client=client,\n output_unit=UnitVolume.CM3,\n src_format=FileImportFormat.FBX,\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: FileVolume = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.file.create_file_volume.html" - } - }, - { - "op": "add", - "path": "/paths/~1unit~1conversion~1current~1{input_unit}~1{output_unit}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_current_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitCurrentConversion\nfrom kittycad.models.unit_current import UnitCurrent\nfrom kittycad.types import Response\n\n\ndef example_get_current_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitCurrentConversion, Error]] = (\n get_current_unit_conversion.sync(\n client=client,\n input_unit=UnitCurrent.AMPERES,\n output_unit=UnitCurrent.AMPERES,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitCurrentConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_current_unit_conversion.html" - } - }, - { - "op": "add", - "path": "/paths/~1auth~1email~1callback/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.hidden import auth_email_callback\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_auth_email_callback():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = auth_email_callback.sync(\n client=client,\n email=\"\",\n token=\"\",\n callback_url=None, # Optional[str]\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.hidden.auth_email_callback.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1saml~1idp/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import create_org_saml_idp\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, SamlIdentityProvider\nfrom kittycad.models.base64data import Base64Data\nfrom kittycad.models.idp_metadata_source import (\n IdpMetadataSource,\n OptionBase64EncodedXml,\n)\nfrom kittycad.models.saml_identity_provider_create import (\n SamlIdentityProviderCreate,\n)\nfrom kittycad.types import Response\n\n\ndef example_create_org_saml_idp():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[SamlIdentityProvider, Error]] = (\n create_org_saml_idp.sync(\n client=client,\n body=SamlIdentityProviderCreate(\n idp_entity_id=\"\",\n idp_metadata_source=IdpMetadataSource(\n OptionBase64EncodedXml(\n data=Base64Data(b\"\"),\n )\n ),\n technical_contact_email=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: SamlIdentityProvider = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.create_org_saml_idp.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1saml~1idp/delete/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import delete_org_saml_idp\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_delete_org_saml_idp():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_org_saml_idp.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.delete_org_saml_idp.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1saml~1idp/put/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import update_org_saml_idp\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, SamlIdentityProvider\nfrom kittycad.models.base64data import Base64Data\nfrom kittycad.models.idp_metadata_source import (\n IdpMetadataSource,\n OptionBase64EncodedXml,\n)\nfrom kittycad.models.saml_identity_provider_create import (\n SamlIdentityProviderCreate,\n)\nfrom kittycad.types import Response\n\n\ndef example_update_org_saml_idp():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[SamlIdentityProvider, Error]] = (\n update_org_saml_idp.sync(\n client=client,\n body=SamlIdentityProviderCreate(\n idp_entity_id=\"\",\n idp_metadata_source=IdpMetadataSource(\n OptionBase64EncodedXml(\n data=Base64Data(b\"\"),\n )\n ),\n technical_contact_email=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: SamlIdentityProvider = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.update_org_saml_idp.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1saml~1idp/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import get_org_saml_idp\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, SamlIdentityProvider\nfrom kittycad.types import Response\n\n\ndef example_get_org_saml_idp():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[SamlIdentityProvider, Error]] = get_org_saml_idp.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: SamlIdentityProvider = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.get_org_saml_idp.html" - } - }, - { - "op": "add", - "path": "/paths/~1org/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import create_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Org\nfrom kittycad.models.org_details import OrgDetails\nfrom kittycad.types import Response\n\n\ndef example_create_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Org, Error]] = create_org.sync(\n client=client,\n body=OrgDetails(\n billing_email=\"\",\n name=\"\",\n phone=\"\",\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Org = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.create_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1org/delete/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import delete_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_delete_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_org.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.delete_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1org/put/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import update_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Org\nfrom kittycad.models.org_details import OrgDetails\nfrom kittycad.types import Response\n\n\ndef example_update_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Org, Error]] = update_org.sync(\n client=client,\n body=OrgDetails(\n billing_email=\"\",\n name=\"\",\n phone=\"\",\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Org = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.update_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1org/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import get_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Org\nfrom kittycad.types import Response\n\n\ndef example_get_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Org, Error]] = get_org.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Org = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.get_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1ping/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.meta import ping\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Pong\nfrom kittycad.types import Response\n\n\ndef example_ping():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Pong, Error]] = ping.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Pong = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.ping.html" - } - }, - { - "op": "add", - "path": "/paths/~1users~1{id}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import get_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, User\nfrom kittycad.types import Response\n\n\ndef example_get_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[User, Error]] = get_user.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: User = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.get_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1text-to-cad/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import list_text_to_cad_models_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, TextToCadResultsPage\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_text_to_cad_models_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[TextToCadResultsPage, Error]] = (\n list_text_to_cad_models_for_user.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n no_models=None, # Optional[bool]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: TextToCadResultsPage = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.list_text_to_cad_models_for_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1user~1payment~1balance/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_payment_balance_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import CustomerBalance, Error\nfrom kittycad.types import Response\n\n\ndef example_get_payment_balance_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[CustomerBalance, Error]] = (\n get_payment_balance_for_user.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: CustomerBalance = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_payment_balance_for_user.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1payment~1intent/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import create_payment_intent_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, PaymentIntent\nfrom kittycad.types import Response\n\n\ndef example_create_payment_intent_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[PaymentIntent, Error]] = (\n create_payment_intent_for_org.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: PaymentIntent = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.create_payment_intent_for_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1org~1payment~1tax/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import validate_customer_tax_information_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_validate_customer_tax_information_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = validate_customer_tax_information_for_org.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.validate_customer_tax_information_for_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1unit~1conversion~1torque~1{input_unit}~1{output_unit}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_torque_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitTorqueConversion\nfrom kittycad.models.unit_torque import UnitTorque\nfrom kittycad.types import Response\n\n\ndef example_get_torque_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitTorqueConversion, Error]] = (\n get_torque_unit_conversion.sync(\n client=client,\n input_unit=UnitTorque.NEWTON_METRES,\n output_unit=UnitTorque.NEWTON_METRES,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitTorqueConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_torque_unit_conversion.html" - } - }, - { - "op": "add", - "path": "/paths/~1_meta~1ipinfo/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.meta import get_ipinfo\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, IpAddrInfo\nfrom kittycad.types import Response\n\n\ndef example_get_ipinfo():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[IpAddrInfo, Error]] = get_ipinfo.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: IpAddrInfo = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.get_ipinfo.html" - } - }, - { - "op": "add", - "path": "/paths/~1users-extended~1{id}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import get_user_extended\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ExtendedUser\nfrom kittycad.types import Response\n\n\ndef example_get_user_extended():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ExtendedUser, Error]] = get_user_extended.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ExtendedUser = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.get_user_extended.html" - } - }, - { - "op": "add", - "path": "/paths/~1async~1operations~1{id}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import get_async_operation\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import (\n Error,\n FileCenterOfMass,\n FileConversion,\n FileDensity,\n FileMass,\n FileSurfaceArea,\n FileVolume,\n TextToCad,\n TextToCadIteration,\n)\nfrom kittycad.types import Response\n\n\ndef example_get_async_operation():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[\n Union[\n FileConversion,\n FileCenterOfMass,\n FileMass,\n FileVolume,\n FileDensity,\n FileSurfaceArea,\n TextToCad,\n TextToCadIteration,\n Error,\n ]\n ] = get_async_operation.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Union[\n FileConversion,\n FileCenterOfMass,\n FileMass,\n FileVolume,\n FileDensity,\n FileSurfaceArea,\n TextToCad,\n TextToCadIteration,\n ] = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.get_async_operation.html" - } - }, - { - "op": "add", - "path": "/paths/~1auth~1email/post/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.hidden import auth_email\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, VerificationTokenResponse\nfrom kittycad.models.email_authentication_form import EmailAuthenticationForm\nfrom kittycad.types import Response\n\n\ndef example_auth_email():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[VerificationTokenResponse, Error]] = auth_email.sync(\n client=client,\n body=EmailAuthenticationForm(\n email=\"\",\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: VerificationTokenResponse = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.hidden.auth_email.html" - } - }, - { - "op": "add", - "path": "/paths/~1orgs~1{id}~1enterprise~1pricing/put/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import update_enterprise_pricing_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, ZooProductSubscriptions\nfrom kittycad.models.plan_interval import PlanInterval\nfrom kittycad.models.subscription_tier_price import (\n OptionPerUser,\n SubscriptionTierPrice,\n)\nfrom kittycad.models.uuid import Uuid\nfrom kittycad.types import Response\n\n\ndef example_update_enterprise_pricing_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ZooProductSubscriptions, Error]] = (\n update_enterprise_pricing_for_org.sync(\n client=client,\n id=Uuid(\"\"),\n body=SubscriptionTierPrice(\n OptionPerUser(\n interval=PlanInterval.DAY,\n price=3.14,\n )\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ZooProductSubscriptions = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.update_enterprise_pricing_for_org.html" - } - }, - { - "op": "add", - "path": "/paths/~1unit~1conversion~1length~1{input_unit}~1{output_unit}/get/x-python", - "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_length_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitLengthConversion\nfrom kittycad.models.unit_length import UnitLength\nfrom kittycad.types import Response\n\n\ndef example_get_length_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitLengthConversion, Error]] = (\n get_length_unit_conversion.sync(\n client=client,\n input_unit=UnitLength.CM,\n output_unit=UnitLength.CM,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitLengthConversion = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_length_unit_conversion.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import delete_payment_method_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_delete_payment_method_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_payment_method_for_user.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.delete_payment_method_for_user.html" } }, { @@ -953,50 +817,58 @@ }, { "op": "add", - "path": "/paths/~1events/post/x-python", + "path": "/paths/~1org~1api-calls/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.meta import create_event\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.event import Event, OptionModelingAppEvent\nfrom kittycad.models.modeling_app_event_type import ModelingAppEventType\nfrom kittycad.types import Response\n\n\ndef example_create_event():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = create_event.sync(\n client=client,\n body=Event(\n OptionModelingAppEvent(\n created_at=datetime.datetime.now(),\n event_type=ModelingAppEventType.SUCCESSFUL_COMPILE_BEFORE_CLOSE,\n project_name=\"\",\n source_id=\"\",\n user_id=\"\",\n )\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.create_event.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import org_list_api_calls\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPriceResultsPage, Error\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_org_list_api_calls():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPriceResultsPage, Error]] = (\n org_list_api_calls.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPriceResultsPage = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.org_list_api_calls.html" } }, { "op": "add", - "path": "/paths/~1/get/x-python", + "path": "/paths/~1unit~1conversion~1frequency~1{input_unit}~1{output_unit}/get/x-python", "value": { - "example": "from kittycad.api.meta import get_schema\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.types import Response\n\n\ndef example_get_schema():\n # Create our client.\n client = ClientFromEnv()\n\n get_schema.sync(\n client=client,\n )\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.get_schema.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_frequency_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitFrequencyConversion\nfrom kittycad.models.unit_frequency import UnitFrequency\nfrom kittycad.types import Response\n\n\ndef example_get_frequency_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitFrequencyConversion, Error]] = (\n get_frequency_unit_conversion.sync(\n client=client,\n input_unit=UnitFrequency.GIGAHERTZ,\n output_unit=UnitFrequency.GIGAHERTZ,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitFrequencyConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_frequency_unit_conversion.html" } }, { "op": "add", - "path": "/paths/~1user~1privacy/put/x-python", + "path": "/paths/~1user~1payment~1invoices/get/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import update_user_privacy_settings\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.privacy_settings import PrivacySettings\nfrom kittycad.types import Response\n\n\ndef example_update_user_privacy_settings():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[PrivacySettings, Error]] = (\n update_user_privacy_settings.sync(\n client=client,\n body=PrivacySettings(\n can_train_on_data=False,\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: PrivacySettings = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.update_user_privacy_settings.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import list_invoices_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Invoice\nfrom kittycad.types import Response\n\n\ndef example_list_invoices_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[List[Invoice], Error]] = list_invoices_for_user.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: List[Invoice] = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.list_invoices_for_user.html" } }, { "op": "add", - "path": "/paths/~1user~1privacy/get/x-python", + "path": "/paths/~1org~1payment/post/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.users import get_user_privacy_settings\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_get_user_privacy_settings():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[PrivacySettings, Error]] = (\n get_user_privacy_settings.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: PrivacySettings = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.users.get_user_privacy_settings.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import create_payment_information_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Customer, Error\nfrom kittycad.models.billing_info import BillingInfo\nfrom kittycad.types import Response\n\n\ndef example_create_payment_information_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Customer, Error]] = (\n create_payment_information_for_org.sync(\n client=client,\n body=BillingInfo(\n name=\"\",\n phone=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Customer = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.create_payment_information_for_org.html" } }, { "op": "add", - "path": "/paths/~1user~1api-tokens~1{token}/delete/x-python", + "path": "/paths/~1org~1payment/put/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_tokens import delete_api_token_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.api_token_uuid import ApiTokenUuid\nfrom kittycad.types import Response\n\n\ndef example_delete_api_token_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_api_token_for_user.sync(\n client=client,\n token=ApiTokenUuid(\"\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_tokens.delete_api_token_for_user.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import update_payment_information_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Customer, Error\nfrom kittycad.models.billing_info import BillingInfo\nfrom kittycad.types import Response\n\n\ndef example_update_payment_information_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Customer, Error]] = (\n update_payment_information_for_org.sync(\n client=client,\n body=BillingInfo(\n name=\"\",\n phone=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Customer = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.update_payment_information_for_org.html" } }, { "op": "add", - "path": "/paths/~1user~1api-tokens~1{token}/get/x-python", + "path": "/paths/~1org~1payment/delete/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_tokens import get_api_token_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiToken, Error\nfrom kittycad.models.api_token_uuid import ApiTokenUuid\nfrom kittycad.types import Response\n\n\ndef example_get_api_token_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiToken, Error]] = get_api_token_for_user.sync(\n client=client,\n token=ApiTokenUuid(\"\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiToken = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_tokens.get_api_token_for_user.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import delete_payment_information_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_delete_payment_information_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_payment_information_for_org.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.delete_payment_information_for_org.html" + } + }, + { + "op": "add", + "path": "/paths/~1org~1payment/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import get_payment_information_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Customer, Error\nfrom kittycad.types import Response\n\n\ndef example_get_payment_information_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Customer, Error]] = (\n get_payment_information_for_org.sync(\n client=client,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Customer = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.get_payment_information_for_org.html" } }, { @@ -1009,18 +881,146 @@ }, { "op": "add", - "path": "/paths/~1org~1api-calls~1{id}/get/x-python", + "path": "/paths/~1store~1coupon/post/x-python", "value": { - "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_calls import get_api_call_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiCallWithPrice, Error\nfrom kittycad.types import Response\n\n\ndef example_get_api_call_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiCallWithPrice, Error]] = get_api_call_for_org.sync(\n client=client,\n id=\"\",\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiCallWithPrice = result\n print(body)\n", - "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_calls.get_api_call_for_org.html" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.store import create_store_coupon\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import DiscountCode, Error\nfrom kittycad.models.store_coupon_params import StoreCouponParams\nfrom kittycad.types import Response\n\n\ndef example_create_store_coupon():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[DiscountCode, Error]] = create_store_coupon.sync(\n client=client,\n body=StoreCouponParams(\n percent_off=10,\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: DiscountCode = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.store.create_store_coupon.html" } }, { "op": "add", - "path": "/info/x-python", + "path": "/paths/~1org~1payment~1tax/get/x-python", "value": { - "client": "# Create a client with your token.\nfrom kittycad.client import Client\n\nclient = Client(token=\"$TOKEN\")\n\n# - OR -\n\n# Create a new client with your token parsed from the environment variable:\n# `KITTYCAD_API_TOKEN`.\nfrom kittycad.client import ClientFromEnv\n\nclient = ClientFromEnv()\n\n# NOTE: The python library additionally implements asyncio, however all the code samples we\n# show below use the sync functions for ease of use and understanding.\n# Check out the library docs at:\n# https://python.api.docs.kittycad.io/_autosummary/kittycad.api.html#module-kittycad.api\n# for more details.", - "install": "pip install kittycad" + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.payments import validate_customer_tax_information_for_org\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_validate_customer_tax_information_for_org():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = validate_customer_tax_information_for_org.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.payments.validate_customer_tax_information_for_org.html" + } + }, + { + "op": "add", + "path": "/paths/~1internal~1discord~1api-token~1{discord_id}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.meta import internal_get_api_token_for_discord_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiToken, Error\nfrom kittycad.types import Response\n\n\ndef example_internal_get_api_token_for_discord_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiToken, Error]] = (\n internal_get_api_token_for_discord_user.sync(\n client=client,\n discord_id=\"\",\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiToken = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.internal_get_api_token_for_discord_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1ml-prompts/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import list_ml_prompts\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, MlPromptResultsPage\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_ml_prompts():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[MlPromptResultsPage, Error]] = list_ml_prompts.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: MlPromptResultsPage = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.list_ml_prompts.html" + } + }, + { + "op": "add", + "path": "/paths/~1unit~1conversion~1force~1{input_unit}~1{output_unit}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_force_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitForceConversion\nfrom kittycad.models.unit_force import UnitForce\nfrom kittycad.types import Response\n\n\ndef example_get_force_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitForceConversion, Error]] = (\n get_force_unit_conversion.sync(\n client=client,\n input_unit=UnitForce.DYNES,\n output_unit=UnitForce.DYNES,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitForceConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_force_unit_conversion.html" + } + }, + { + "op": "add", + "path": "/paths/~1events/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.meta import create_event\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.models.event import Event, OptionModelingAppEvent\nfrom kittycad.models.modeling_app_event_type import ModelingAppEventType\nfrom kittycad.types import Response\n\n\ndef example_create_event():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = create_event.sync(\n client=client,\n body=Event(\n OptionModelingAppEvent(\n created_at=datetime.datetime.now(),\n event_type=ModelingAppEventType.SUCCESSFUL_COMPILE_BEFORE_CLOSE,\n project_name=\"\",\n source_id=\"\",\n user_id=\"\",\n )\n ),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.create_event.html" + } + }, + { + "op": "add", + "path": "/paths/~1org~1saml~1idp/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import create_org_saml_idp\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, SamlIdentityProvider\nfrom kittycad.models.base64data import Base64Data\nfrom kittycad.models.idp_metadata_source import (\n IdpMetadataSource,\n OptionBase64EncodedXml,\n)\nfrom kittycad.models.saml_identity_provider_create import (\n SamlIdentityProviderCreate,\n)\nfrom kittycad.types import Response\n\n\ndef example_create_org_saml_idp():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[SamlIdentityProvider, Error]] = (\n create_org_saml_idp.sync(\n client=client,\n body=SamlIdentityProviderCreate(\n idp_entity_id=\"\",\n idp_metadata_source=IdpMetadataSource(\n OptionBase64EncodedXml(\n data=Base64Data(b\"\"),\n )\n ),\n technical_contact_email=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: SamlIdentityProvider = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.create_org_saml_idp.html" + } + }, + { + "op": "add", + "path": "/paths/~1org~1saml~1idp/put/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import update_org_saml_idp\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, SamlIdentityProvider\nfrom kittycad.models.base64data import Base64Data\nfrom kittycad.models.idp_metadata_source import (\n IdpMetadataSource,\n OptionBase64EncodedXml,\n)\nfrom kittycad.models.saml_identity_provider_create import (\n SamlIdentityProviderCreate,\n)\nfrom kittycad.types import Response\n\n\ndef example_update_org_saml_idp():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[SamlIdentityProvider, Error]] = (\n update_org_saml_idp.sync(\n client=client,\n body=SamlIdentityProviderCreate(\n idp_entity_id=\"\",\n idp_metadata_source=IdpMetadataSource(\n OptionBase64EncodedXml(\n data=Base64Data(b\"\"),\n )\n ),\n technical_contact_email=\"\",\n ),\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: SamlIdentityProvider = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.update_org_saml_idp.html" + } + }, + { + "op": "add", + "path": "/paths/~1org~1saml~1idp/delete/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import delete_org_saml_idp\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error\nfrom kittycad.types import Response\n\n\ndef example_delete_org_saml_idp():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Error] = delete_org_saml_idp.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Error = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.delete_org_saml_idp.html" + } + }, + { + "op": "add", + "path": "/paths/~1org~1saml~1idp/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.orgs import get_org_saml_idp\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, SamlIdentityProvider\nfrom kittycad.types import Response\n\n\ndef example_get_org_saml_idp():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[SamlIdentityProvider, Error]] = get_org_saml_idp.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: SamlIdentityProvider = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.orgs.get_org_saml_idp.html" + } + }, + { + "op": "add", + "path": "/paths/~1file~1execute~1{lang}/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.executor import create_file_execution\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import CodeOutput, Error\nfrom kittycad.models.code_language import CodeLanguage\nfrom kittycad.types import Response\n\n\ndef example_create_file_execution():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[CodeOutput, Error]] = create_file_execution.sync(\n client=client,\n lang=CodeLanguage.GO,\n output=None, # Optional[str]\n body=bytes(\"some bytes\", \"utf-8\"),\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: CodeOutput = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.executor.create_file_execution.html" + } + }, + { + "op": "add", + "path": "/paths/~1pricing~1subscriptions/get/x-python", + "value": { + "example": "from kittycad.api.meta import get_pricing_subscriptions\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.types import Response\n\n\ndef example_get_pricing_subscriptions():\n # Create our client.\n client = ClientFromEnv()\n\n get_pricing_subscriptions.sync(\n client=client,\n )\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.get_pricing_subscriptions.html" + } + }, + { + "op": "add", + "path": "/paths/~1unit~1conversion~1mass~1{input_unit}~1{output_unit}/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.unit import get_mass_unit_conversion\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, UnitMassConversion\nfrom kittycad.models.unit_mass import UnitMass\nfrom kittycad.types import Response\n\n\ndef example_get_mass_unit_conversion():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[UnitMassConversion, Error]] = (\n get_mass_unit_conversion.sync(\n client=client,\n input_unit=UnitMass.G,\n output_unit=UnitMass.G,\n value=3.14,\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: UnitMassConversion = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.unit.get_mass_unit_conversion.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1api-tokens/post/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_tokens import create_api_token_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiToken, Error\nfrom kittycad.types import Response\n\n\ndef example_create_api_token_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiToken, Error]] = create_api_token_for_user.sync(\n client=client,\n label=None, # Optional[str]\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiToken = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_tokens.create_api_token_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1api-tokens/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.api_tokens import list_api_tokens_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import ApiTokenResultsPage, Error\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_api_tokens_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[ApiTokenResultsPage, Error]] = (\n list_api_tokens_for_user.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: ApiTokenResultsPage = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.api_tokens.list_api_tokens_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1_meta~1info/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.meta import get_metadata\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, Metadata\nfrom kittycad.types import Response\n\n\ndef example_get_metadata():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[Metadata, Error]] = get_metadata.sync(\n client=client,\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: Metadata = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.meta.get_metadata.html" + } + }, + { + "op": "add", + "path": "/paths/~1user~1text-to-cad/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.ml import list_text_to_cad_models_for_user\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, TextToCadResultsPage\nfrom kittycad.models.created_at_sort_mode import CreatedAtSortMode\nfrom kittycad.types import Response\n\n\ndef example_list_text_to_cad_models_for_user():\n # Create our client.\n client = ClientFromEnv()\n\n result: Optional[Union[TextToCadResultsPage, Error]] = (\n list_text_to_cad_models_for_user.sync(\n client=client,\n sort_by=CreatedAtSortMode.CREATED_AT_ASCENDING,\n limit=None, # Optional[int]\n page_token=None, # Optional[str]\n no_models=None, # Optional[bool]\n )\n )\n\n if isinstance(result, Error) or result is None:\n print(result)\n raise Exception(\"Error in response\")\n\n body: TextToCadResultsPage = result\n print(body)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.ml.list_text_to_cad_models_for_user.html" + } + }, + { + "op": "add", + "path": "/paths/~1ws~1modeling~1commands/get/x-python", + "value": { + "example": "from typing import Any, List, Optional, Tuple, Union\n\nfrom kittycad.api.modeling import modeling_commands_ws\nfrom kittycad.client import ClientFromEnv\nfrom kittycad.models import Error, WebSocketRequest, WebSocketResponse\nfrom kittycad.models.post_effect_type import PostEffectType\nfrom kittycad.models.rtc_sdp_type import RtcSdpType\nfrom kittycad.models.rtc_session_description import RtcSessionDescription\nfrom kittycad.models.web_socket_request import OptionSdpOffer\nfrom kittycad.types import Response\n\n\ndef example_modeling_commands_ws():\n # Create our client.\n client = ClientFromEnv()\n\n # Connect to the websocket.\n with modeling_commands_ws.WebSocket(\n client=client,\n fps=10,\n post_effect=PostEffectType.PHOSPHOR,\n show_grid=False,\n unlocked_framerate=False,\n video_res_height=10,\n video_res_width=10,\n webrtc=False,\n pool=None, # Optional[str]\n replay=None, # Optional[str]\n ) as websocket:\n\n # Send a message.\n websocket.send(\n WebSocketRequest(\n OptionSdpOffer(\n offer=RtcSessionDescription(\n sdp=\"\",\n type=RtcSdpType.UNSPECIFIED,\n ),\n )\n )\n )\n\n # Get a message.\n message = websocket.recv()\n print(message)\n", + "libDocsLink": "https://python.api.docs.kittycad.io/_autosummary/kittycad.api.modeling.modeling_commands_ws.html" } } ] \ No newline at end of file diff --git a/kittycad/api/api_calls/get_api_call.py b/kittycad/api/api_calls/get_api_call.py index cbf8b0f9f..cb356d6f4 100644 --- a/kittycad/api/api_calls/get_api_call.py +++ b/kittycad/api/api_calls/get_api_call.py @@ -79,7 +79,9 @@ def sync( client: Client, ) -> Optional[Union[ApiCallWithPrice, Error]]: """This endpoint requires authentication by any Zoo user. It returns details of the requested API call for the user. + If the user is not authenticated to view the specified API call, then it is not returned. + Only Zoo employees can view API calls for other users.""" # noqa: E501 return sync_detailed( @@ -110,7 +112,9 @@ async def asyncio( client: Client, ) -> Optional[Union[ApiCallWithPrice, Error]]: """This endpoint requires authentication by any Zoo user. It returns details of the requested API call for the user. + If the user is not authenticated to view the specified API call, then it is not returned. + Only Zoo employees can view API calls for other users.""" # noqa: E501 return ( diff --git a/kittycad/api/api_calls/get_async_operation.py b/kittycad/api/api_calls/get_async_operation.py index 72e966021..e59d92ed0 100644 --- a/kittycad/api/api_calls/get_async_operation.py +++ b/kittycad/api/api_calls/get_async_operation.py @@ -209,8 +209,11 @@ def sync( ] ]: """Get the status and output of an async operation. + This endpoint requires authentication by any Zoo user. It returns details of the requested async operation for the user. + If the user is not authenticated to view the specified async operation, then it is not returned. + Only Zoo employees with the proper access can view async operations for other users.""" # noqa: E501 return sync_detailed( @@ -267,8 +270,11 @@ async def asyncio( ] ]: """Get the status and output of an async operation. + This endpoint requires authentication by any Zoo user. It returns details of the requested async operation for the user. + If the user is not authenticated to view the specified async operation, then it is not returned. + Only Zoo employees with the proper access can view async operations for other users.""" # noqa: E501 return ( diff --git a/kittycad/api/api_calls/list_api_calls_for_user.py b/kittycad/api/api_calls/list_api_calls_for_user.py index 90dad94b9..909b7895a 100644 --- a/kittycad/api/api_calls/list_api_calls_for_user.py +++ b/kittycad/api/api_calls/list_api_calls_for_user.py @@ -110,8 +110,11 @@ def sync( page_token: Optional[str] = None, ) -> Optional[Union[ApiCallWithPriceResultsPage, Error]]: """This endpoint requires authentication by any Zoo user. It returns the API calls for the authenticated user if "me" is passed as the user id. + Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user. + If the authenticated user is a Zoo employee, then the API calls are returned for the user specified by the user id. + The API calls are returned in order of creation, with the most recently created API calls first.""" # noqa: E501 return sync_detailed( @@ -154,8 +157,11 @@ async def asyncio( page_token: Optional[str] = None, ) -> Optional[Union[ApiCallWithPriceResultsPage, Error]]: """This endpoint requires authentication by any Zoo user. It returns the API calls for the authenticated user if "me" is passed as the user id. + Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user. + If the authenticated user is a Zoo employee, then the API calls are returned for the user specified by the user id. + The API calls are returned in order of creation, with the most recently created API calls first.""" # noqa: E501 return ( diff --git a/kittycad/api/api_calls/list_async_operations.py b/kittycad/api/api_calls/list_async_operations.py index 715228850..ea9fd871a 100644 --- a/kittycad/api/api_calls/list_async_operations.py +++ b/kittycad/api/api_calls/list_async_operations.py @@ -116,6 +116,7 @@ def sync( page_token: Optional[str] = None, ) -> Optional[Union[AsyncApiCallResultsPage, Error]]: """For async file conversion operations, this endpoint does not return the contents of converted files (`output`). To get the contents use the `/async/operations/{id}` endpoint. + This endpoint requires authentication by a Zoo employee.""" # noqa: E501 return sync_detailed( @@ -158,6 +159,7 @@ async def asyncio( page_token: Optional[str] = None, ) -> Optional[Union[AsyncApiCallResultsPage, Error]]: """For async file conversion operations, this endpoint does not return the contents of converted files (`output`). To get the contents use the `/async/operations/{id}` endpoint. + This endpoint requires authentication by a Zoo employee.""" # noqa: E501 return ( diff --git a/kittycad/api/api_calls/org_list_api_calls.py b/kittycad/api/api_calls/org_list_api_calls.py index 70de3a4e8..0f8dc2845 100644 --- a/kittycad/api/api_calls/org_list_api_calls.py +++ b/kittycad/api/api_calls/org_list_api_calls.py @@ -105,7 +105,9 @@ def sync( page_token: Optional[str] = None, ) -> Optional[Union[ApiCallWithPriceResultsPage, Error]]: """This includes all API calls that were made by users in the org. + This endpoint requires authentication by an org admin. It returns the API calls for the authenticated user's org. + The API calls are returned in order of creation, with the most recently created API calls first.""" # noqa: E501 return sync_detailed( @@ -144,7 +146,9 @@ async def asyncio( page_token: Optional[str] = None, ) -> Optional[Union[ApiCallWithPriceResultsPage, Error]]: """This includes all API calls that were made by users in the org. + This endpoint requires authentication by an org admin. It returns the API calls for the authenticated user's org. + The API calls are returned in order of creation, with the most recently created API calls first.""" # noqa: E501 return ( diff --git a/kittycad/api/api_calls/user_list_api_calls.py b/kittycad/api/api_calls/user_list_api_calls.py index 4c8166faf..c9658bf4a 100644 --- a/kittycad/api/api_calls/user_list_api_calls.py +++ b/kittycad/api/api_calls/user_list_api_calls.py @@ -105,6 +105,7 @@ def sync( page_token: Optional[str] = None, ) -> Optional[Union[ApiCallWithPriceResultsPage, Error]]: """This endpoint requires authentication by any Zoo user. It returns the API calls for the authenticated user. + The API calls are returned in order of creation, with the most recently created API calls first.""" # noqa: E501 return sync_detailed( @@ -143,6 +144,7 @@ async def asyncio( page_token: Optional[str] = None, ) -> Optional[Union[ApiCallWithPriceResultsPage, Error]]: """This endpoint requires authentication by any Zoo user. It returns the API calls for the authenticated user. + The API calls are returned in order of creation, with the most recently created API calls first.""" # noqa: E501 return ( diff --git a/kittycad/api/api_tokens/delete_api_token_for_user.py b/kittycad/api/api_tokens/delete_api_token_for_user.py index 3ac2d8f73..ee143c481 100644 --- a/kittycad/api/api_tokens/delete_api_token_for_user.py +++ b/kittycad/api/api_tokens/delete_api_token_for_user.py @@ -73,6 +73,7 @@ def sync( client: Client, ) -> Optional[Error]: """This endpoint requires authentication by any Zoo user. It deletes the requested API token for the user. + This endpoint does not actually delete the API token from the database. It merely marks the token as invalid. We still want to keep the token in the database for historical purposes.""" # noqa: E501 return sync_detailed( @@ -103,6 +104,7 @@ async def asyncio( client: Client, ) -> Optional[Error]: """This endpoint requires authentication by any Zoo user. It deletes the requested API token for the user. + This endpoint does not actually delete the API token from the database. It merely marks the token as invalid. We still want to keep the token in the database for historical purposes.""" # noqa: E501 return ( diff --git a/kittycad/api/api_tokens/list_api_tokens_for_user.py b/kittycad/api/api_tokens/list_api_tokens_for_user.py index fa6139db0..2a0d9ec7a 100644 --- a/kittycad/api/api_tokens/list_api_tokens_for_user.py +++ b/kittycad/api/api_tokens/list_api_tokens_for_user.py @@ -105,6 +105,7 @@ def sync( page_token: Optional[str] = None, ) -> Optional[Union[ApiTokenResultsPage, Error]]: """This endpoint requires authentication by any Zoo user. It returns the API tokens for the authenticated user. + The API tokens are returned in order of creation, with the most recently created API tokens first.""" # noqa: E501 return sync_detailed( @@ -143,6 +144,7 @@ async def asyncio( page_token: Optional[str] = None, ) -> Optional[Union[ApiTokenResultsPage, Error]]: """This endpoint requires authentication by any Zoo user. It returns the API tokens for the authenticated user. + The API tokens are returned in order of creation, with the most recently created API tokens first.""" # noqa: E501 return ( diff --git a/kittycad/api/apps/apps_github_callback.py b/kittycad/api/apps/apps_github_callback.py index 4bfabc799..15e4bcf83 100644 --- a/kittycad/api/apps/apps_github_callback.py +++ b/kittycad/api/apps/apps_github_callback.py @@ -67,6 +67,7 @@ def sync( client: Client, ) -> Optional[Error]: """This is different than OAuth 2.0 authentication for users. This endpoint grants access for Zoo to access user's repos. + The user doesn't need Zoo OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.""" # noqa: E501 return sync_detailed( @@ -93,6 +94,7 @@ async def asyncio( client: Client, ) -> Optional[Error]: """This is different than OAuth 2.0 authentication for users. This endpoint grants access for Zoo to access user's repos. + The user doesn't need Zoo OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.""" # noqa: E501 return ( diff --git a/kittycad/api/apps/apps_github_consent.py b/kittycad/api/apps/apps_github_consent.py index bcd85f0cf..17f63f6b0 100644 --- a/kittycad/api/apps/apps_github_consent.py +++ b/kittycad/api/apps/apps_github_consent.py @@ -74,6 +74,7 @@ def sync( client: Client, ) -> Optional[Union[AppClientInfo, Error]]: """This is different than OAuth 2.0 authentication for users. This endpoint grants access for Zoo to access user's repos. + The user doesn't need Zoo OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.""" # noqa: E501 return sync_detailed( @@ -100,6 +101,7 @@ async def asyncio( client: Client, ) -> Optional[Union[AppClientInfo, Error]]: """This is different than OAuth 2.0 authentication for users. This endpoint grants access for Zoo to access user's repos. + The user doesn't need Zoo OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.""" # noqa: E501 return ( diff --git a/kittycad/api/file/create_file_center_of_mass.py b/kittycad/api/file/create_file_center_of_mass.py index 6b3bfd367..375664f0c 100644 --- a/kittycad/api/file/create_file_center_of_mass.py +++ b/kittycad/api/file/create_file_center_of_mass.py @@ -101,9 +101,13 @@ def sync( client: Client, ) -> Optional[Union[FileCenterOfMass, Error]]: """We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. + This endpoint returns the cartesian coordinate in world space measure units. + In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. + Get the center of mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. + If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.""" # noqa: E501 return sync_detailed( @@ -142,9 +146,13 @@ async def asyncio( client: Client, ) -> Optional[Union[FileCenterOfMass, Error]]: """We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. + This endpoint returns the cartesian coordinate in world space measure units. + In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. + Get the center of mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. + If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.""" # noqa: E501 return ( diff --git a/kittycad/api/file/create_file_conversion.py b/kittycad/api/file/create_file_conversion.py index 383308bcc..4274a96d2 100644 --- a/kittycad/api/file/create_file_conversion.py +++ b/kittycad/api/file/create_file_conversion.py @@ -91,8 +91,11 @@ def sync( client: Client, ) -> Optional[Union[FileConversion, Error]]: """If you wish to specify the conversion options, use the `/file/conversion` endpoint instead. + Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously. + If the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string. + If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.""" # noqa: E501 return sync_detailed( @@ -131,8 +134,11 @@ async def asyncio( client: Client, ) -> Optional[Union[FileConversion, Error]]: """If you wish to specify the conversion options, use the `/file/conversion` endpoint instead. + Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously. + If the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string. + If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.""" # noqa: E501 return ( diff --git a/kittycad/api/file/create_file_density.py b/kittycad/api/file/create_file_density.py index 5ec0a55f0..b413a6e49 100644 --- a/kittycad/api/file/create_file_density.py +++ b/kittycad/api/file/create_file_density.py @@ -120,9 +120,13 @@ def sync( client: Client, ) -> Optional[Union[FileDensity, Error]]: """We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. + This endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit. + In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. + Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. + If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.""" # noqa: E501 return sync_detailed( @@ -169,9 +173,13 @@ async def asyncio( client: Client, ) -> Optional[Union[FileDensity, Error]]: """We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. + This endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit. + In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. + Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. + If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.""" # noqa: E501 return ( diff --git a/kittycad/api/file/create_file_mass.py b/kittycad/api/file/create_file_mass.py index 36298e89d..820a20ec6 100644 --- a/kittycad/api/file/create_file_mass.py +++ b/kittycad/api/file/create_file_mass.py @@ -120,9 +120,13 @@ def sync( client: Client, ) -> Optional[Union[FileMass, Error]]: """We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. + This endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density. + In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. + Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. + If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.""" # noqa: E501 return sync_detailed( @@ -169,9 +173,13 @@ async def asyncio( client: Client, ) -> Optional[Union[FileMass, Error]]: """We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. + This endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density. + In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. + Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. + If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.""" # noqa: E501 return ( diff --git a/kittycad/api/file/create_file_surface_area.py b/kittycad/api/file/create_file_surface_area.py index 69e81854f..f40284dec 100644 --- a/kittycad/api/file/create_file_surface_area.py +++ b/kittycad/api/file/create_file_surface_area.py @@ -101,9 +101,13 @@ def sync( client: Client, ) -> Optional[Union[FileSurfaceArea, Error]]: """We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. + This endpoint returns the square measure units. + In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. + Get the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. + If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.""" # noqa: E501 return sync_detailed( @@ -142,9 +146,13 @@ async def asyncio( client: Client, ) -> Optional[Union[FileSurfaceArea, Error]]: """We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. + This endpoint returns the square measure units. + In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. + Get the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. + If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.""" # noqa: E501 return ( diff --git a/kittycad/api/file/create_file_volume.py b/kittycad/api/file/create_file_volume.py index 422b51b7c..cd3ad62d0 100644 --- a/kittycad/api/file/create_file_volume.py +++ b/kittycad/api/file/create_file_volume.py @@ -99,9 +99,13 @@ def sync( client: Client, ) -> Optional[Union[FileVolume, Error]]: """We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. + This endpoint returns the cubic measure units. + In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. + Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. + If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.""" # noqa: E501 return sync_detailed( @@ -140,9 +144,13 @@ async def asyncio( client: Client, ) -> Optional[Union[FileVolume, Error]]: """We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale. + This endpoint returns the cubic measure units. + In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported. + Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously. + If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.""" # noqa: E501 return ( diff --git a/kittycad/api/meta/get_metadata.py b/kittycad/api/meta/get_metadata.py index d70b96cc6..15d331f3c 100644 --- a/kittycad/api/meta/get_metadata.py +++ b/kittycad/api/meta/get_metadata.py @@ -72,6 +72,7 @@ def sync( client: Client, ) -> Optional[Union[Metadata, Error]]: """This includes information on any of our other distributed systems it is connected to. + You must be a Zoo employee to perform this request.""" # noqa: E501 return sync_detailed( @@ -98,6 +99,7 @@ async def asyncio( client: Client, ) -> Optional[Union[Metadata, Error]]: """This includes information on any of our other distributed systems it is connected to. + You must be a Zoo employee to perform this request.""" # noqa: E501 return ( diff --git a/kittycad/api/meta/internal_get_api_token_for_discord_user.py b/kittycad/api/meta/internal_get_api_token_for_discord_user.py index 7b5674ef2..2132e8793 100644 --- a/kittycad/api/meta/internal_get_api_token_for_discord_user.py +++ b/kittycad/api/meta/internal_get_api_token_for_discord_user.py @@ -77,6 +77,7 @@ def sync( client: Client, ) -> Optional[Union[ApiToken, Error]]: """This endpoint allows us to run API calls from our discord bot on behalf of a user. The user must have a discord account linked to their Zoo Account via oauth2 for this to work. + You must be a Zoo employee to use this endpoint.""" # noqa: E501 return sync_detailed( @@ -107,6 +108,7 @@ async def asyncio( client: Client, ) -> Optional[Union[ApiToken, Error]]: """This endpoint allows us to run API calls from our discord bot on behalf of a user. The user must have a discord account linked to their Zoo Account via oauth2 for this to work. + You must be a Zoo employee to use this endpoint.""" # noqa: E501 return ( diff --git a/kittycad/api/ml/create_text_to_cad.py b/kittycad/api/ml/create_text_to_cad.py index 008c9db16..a30763373 100644 --- a/kittycad/api/ml/create_text_to_cad.py +++ b/kittycad/api/ml/create_text_to_cad.py @@ -94,7 +94,9 @@ def sync( kcl: Optional[bool] = None, ) -> Optional[Union[TextToCad, Error]]: """Because our source of truth for the resulting model is a STEP file, you will always have STEP file contents when you list your generated models. Any other formats you request here will also be returned when you list your generated models. + This operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint. + One thing to note, if you hit the cache, this endpoint will return right away. So you only have to wait if the status is not `Completed` or `Failed`.""" # noqa: E501 return sync_detailed( @@ -133,7 +135,9 @@ async def asyncio( kcl: Optional[bool] = None, ) -> Optional[Union[TextToCad, Error]]: """Because our source of truth for the resulting model is a STEP file, you will always have STEP file contents when you list your generated models. Any other formats you request here will also be returned when you list your generated models. + This operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint. + One thing to note, if you hit the cache, this endpoint will return right away. So you only have to wait if the status is not `Completed` or `Failed`.""" # noqa: E501 return ( diff --git a/kittycad/api/ml/list_ml_prompts.py b/kittycad/api/ml/list_ml_prompts.py index 6f2ff2fa8..35c364092 100644 --- a/kittycad/api/ml/list_ml_prompts.py +++ b/kittycad/api/ml/list_ml_prompts.py @@ -105,7 +105,9 @@ def sync( page_token: Optional[str] = None, ) -> Optional[Union[MlPromptResultsPage, Error]]: """For text-to-cad prompts, this will always return the STEP file contents as well as the format the user originally requested. + This endpoint requires authentication by a Zoo employee. + The ML prompts are returned in order of creation, with the most recently created ML prompts first.""" # noqa: E501 return sync_detailed( @@ -144,7 +146,9 @@ async def asyncio( page_token: Optional[str] = None, ) -> Optional[Union[MlPromptResultsPage, Error]]: """For text-to-cad prompts, this will always return the STEP file contents as well as the format the user originally requested. + This endpoint requires authentication by a Zoo employee. + The ML prompts are returned in order of creation, with the most recently created ML prompts first.""" # noqa: E501 return ( diff --git a/kittycad/api/ml/list_text_to_cad_models_for_user.py b/kittycad/api/ml/list_text_to_cad_models_for_user.py index 952cca3ea..25a1c3a81 100644 --- a/kittycad/api/ml/list_text_to_cad_models_for_user.py +++ b/kittycad/api/ml/list_text_to_cad_models_for_user.py @@ -115,7 +115,9 @@ def sync( no_models: Optional[bool] = None, ) -> Optional[Union[TextToCadResultsPage, Error]]: """This will always return the STEP file contents as well as the format the user originally requested. + This endpoint requires authentication by any Zoo user. It returns the text-to-CAD models for the authenticated user. + The text-to-CAD models are returned in order of creation, with the most recently created text-to-CAD models first.""" # noqa: E501 return sync_detailed( @@ -158,7 +160,9 @@ async def asyncio( no_models: Optional[bool] = None, ) -> Optional[Union[TextToCadResultsPage, Error]]: """This will always return the STEP file contents as well as the format the user originally requested. + This endpoint requires authentication by any Zoo user. It returns the text-to-CAD models for the authenticated user. + The text-to-CAD models are returned in order of creation, with the most recently created text-to-CAD models first.""" # noqa: E501 return ( diff --git a/kittycad/api/orgs/create_org_member.py b/kittycad/api/orgs/create_org_member.py index 353cfcd0c..715a51de7 100644 --- a/kittycad/api/orgs/create_org_member.py +++ b/kittycad/api/orgs/create_org_member.py @@ -78,9 +78,13 @@ def sync( client: Client, ) -> Optional[Union[OrgMember, Error]]: """If the user exists, this will add them to your org. If they do not exist, this will create a new user and add them to your org. + In both cases the user gets an email that they have been added to the org. + If the user is already in your org, this will return a 400 and a message. + If the user is already in a different org, this will return a 400 and a message. + This endpoint requires authentication by an org admin. It adds the specified member to the authenticated user's org.""" # noqa: E501 return sync_detailed( @@ -111,9 +115,13 @@ async def asyncio( client: Client, ) -> Optional[Union[OrgMember, Error]]: """If the user exists, this will add them to your org. If they do not exist, this will create a new user and add them to your org. + In both cases the user gets an email that they have been added to the org. + If the user is already in your org, this will return a 400 and a message. + If the user is already in a different org, this will return a 400 and a message. + This endpoint requires authentication by an org admin. It adds the specified member to the authenticated user's org.""" # noqa: E501 return ( diff --git a/kittycad/api/orgs/delete_org.py b/kittycad/api/orgs/delete_org.py index cb7e36a8b..401fe7f9c 100644 --- a/kittycad/api/orgs/delete_org.py +++ b/kittycad/api/orgs/delete_org.py @@ -67,7 +67,9 @@ def sync( client: Client, ) -> Optional[Error]: """In order to delete an org, you must first delete all of its members, except yourself. + You must also have no outstanding invoices or unpaid balances. + This endpoint requires authentication by an org admin. It deletes the authenticated user's org.""" # noqa: E501 return sync_detailed( @@ -94,7 +96,9 @@ async def asyncio( client: Client, ) -> Optional[Error]: """In order to delete an org, you must first delete all of its members, except yourself. + You must also have no outstanding invoices or unpaid balances. + This endpoint requires authentication by an org admin. It deletes the authenticated user's org.""" # noqa: E501 return ( diff --git a/kittycad/api/orgs/get_user_org.py b/kittycad/api/orgs/get_user_org.py index e36a5305e..b0c4d1448 100644 --- a/kittycad/api/orgs/get_user_org.py +++ b/kittycad/api/orgs/get_user_org.py @@ -72,6 +72,7 @@ def sync( client: Client, ) -> Optional[Union[UserOrgInfo, Error]]: """This endpoint requires authentication by any Zoo user. It gets the authenticated user's org. + If the user is not a member of an org, this endpoint will return a 404.""" # noqa: E501 return sync_detailed( @@ -98,6 +99,7 @@ async def asyncio( client: Client, ) -> Optional[Union[UserOrgInfo, Error]]: """This endpoint requires authentication by any Zoo user. It gets the authenticated user's org. + If the user is not a member of an org, this endpoint will return a 404.""" # noqa: E501 return ( diff --git a/kittycad/api/payments/create_payment_information_for_org.py b/kittycad/api/payments/create_payment_information_for_org.py index 5015e6659..40367ad4c 100644 --- a/kittycad/api/payments/create_payment_information_for_org.py +++ b/kittycad/api/payments/create_payment_information_for_org.py @@ -78,6 +78,7 @@ def sync( client: Client, ) -> Optional[Union[Customer, Error]]: """This includes billing address, phone, and name. + This endpoint requires authentication by the org admin. It creates the payment information for the authenticated user's org.""" # noqa: E501 return sync_detailed( @@ -108,6 +109,7 @@ async def asyncio( client: Client, ) -> Optional[Union[Customer, Error]]: """This includes billing address, phone, and name. + This endpoint requires authentication by the org admin. It creates the payment information for the authenticated user's org.""" # noqa: E501 return ( diff --git a/kittycad/api/payments/create_payment_information_for_user.py b/kittycad/api/payments/create_payment_information_for_user.py index 0e22b1845..2a1bfe6e3 100644 --- a/kittycad/api/payments/create_payment_information_for_user.py +++ b/kittycad/api/payments/create_payment_information_for_user.py @@ -78,6 +78,7 @@ def sync( client: Client, ) -> Optional[Union[Customer, Error]]: """This includes billing address, phone, and name. + This endpoint requires authentication by any Zoo user. It creates the payment information for the authenticated user.""" # noqa: E501 return sync_detailed( @@ -108,6 +109,7 @@ async def asyncio( client: Client, ) -> Optional[Union[Customer, Error]]: """This includes billing address, phone, and name. + This endpoint requires authentication by any Zoo user. It creates the payment information for the authenticated user.""" # noqa: E501 return ( diff --git a/kittycad/api/payments/delete_payment_information_for_org.py b/kittycad/api/payments/delete_payment_information_for_org.py index dbebb47a2..2e81ab8d4 100644 --- a/kittycad/api/payments/delete_payment_information_for_org.py +++ b/kittycad/api/payments/delete_payment_information_for_org.py @@ -67,6 +67,7 @@ def sync( client: Client, ) -> Optional[Error]: """This includes billing address, phone, and name. + This endpoint requires authentication by an org admin. It deletes the payment information for the authenticated user's org.""" # noqa: E501 return sync_detailed( @@ -93,6 +94,7 @@ async def asyncio( client: Client, ) -> Optional[Error]: """This includes billing address, phone, and name. + This endpoint requires authentication by an org admin. It deletes the payment information for the authenticated user's org.""" # noqa: E501 return ( diff --git a/kittycad/api/payments/delete_payment_information_for_user.py b/kittycad/api/payments/delete_payment_information_for_user.py index fb745b0f0..b7ef5cf2e 100644 --- a/kittycad/api/payments/delete_payment_information_for_user.py +++ b/kittycad/api/payments/delete_payment_information_for_user.py @@ -67,6 +67,7 @@ def sync( client: Client, ) -> Optional[Error]: """This includes billing address, phone, and name. + This endpoint requires authentication by any Zoo user. It deletes the payment information for the authenticated user.""" # noqa: E501 return sync_detailed( @@ -93,6 +94,7 @@ async def asyncio( client: Client, ) -> Optional[Error]: """This includes billing address, phone, and name. + This endpoint requires authentication by any Zoo user. It deletes the payment information for the authenticated user.""" # noqa: E501 return ( diff --git a/kittycad/api/payments/get_payment_information_for_org.py b/kittycad/api/payments/get_payment_information_for_org.py index b47c0ad55..f45d170bd 100644 --- a/kittycad/api/payments/get_payment_information_for_org.py +++ b/kittycad/api/payments/get_payment_information_for_org.py @@ -72,6 +72,7 @@ def sync( client: Client, ) -> Optional[Union[Customer, Error]]: """This includes billing address, phone, and name. + This endpoint requires authentication by an org admin. It gets the payment information for the authenticated user's org.""" # noqa: E501 return sync_detailed( @@ -98,6 +99,7 @@ async def asyncio( client: Client, ) -> Optional[Union[Customer, Error]]: """This includes billing address, phone, and name. + This endpoint requires authentication by an org admin. It gets the payment information for the authenticated user's org.""" # noqa: E501 return ( diff --git a/kittycad/api/payments/get_payment_information_for_user.py b/kittycad/api/payments/get_payment_information_for_user.py index 39dbfe032..ff7f145cb 100644 --- a/kittycad/api/payments/get_payment_information_for_user.py +++ b/kittycad/api/payments/get_payment_information_for_user.py @@ -72,6 +72,7 @@ def sync( client: Client, ) -> Optional[Union[Customer, Error]]: """This includes billing address, phone, and name. + This endpoint requires authentication by any Zoo user. It gets the payment information for the authenticated user.""" # noqa: E501 return sync_detailed( @@ -98,6 +99,7 @@ async def asyncio( client: Client, ) -> Optional[Union[Customer, Error]]: """This includes billing address, phone, and name. + This endpoint requires authentication by any Zoo user. It gets the payment information for the authenticated user.""" # noqa: E501 return ( diff --git a/kittycad/api/payments/update_payment_information_for_org.py b/kittycad/api/payments/update_payment_information_for_org.py index ef43139a0..2fcc6f2d0 100644 --- a/kittycad/api/payments/update_payment_information_for_org.py +++ b/kittycad/api/payments/update_payment_information_for_org.py @@ -78,6 +78,7 @@ def sync( client: Client, ) -> Optional[Union[Customer, Error]]: """This includes billing address, phone, and name. + This endpoint requires authentication by an org admin. It updates the payment information for the authenticated user's org.""" # noqa: E501 return sync_detailed( @@ -108,6 +109,7 @@ async def asyncio( client: Client, ) -> Optional[Union[Customer, Error]]: """This includes billing address, phone, and name. + This endpoint requires authentication by an org admin. It updates the payment information for the authenticated user's org.""" # noqa: E501 return ( diff --git a/kittycad/api/payments/update_payment_information_for_user.py b/kittycad/api/payments/update_payment_information_for_user.py index ba3db61d3..cf272e854 100644 --- a/kittycad/api/payments/update_payment_information_for_user.py +++ b/kittycad/api/payments/update_payment_information_for_user.py @@ -78,6 +78,7 @@ def sync( client: Client, ) -> Optional[Union[Customer, Error]]: """This includes billing address, phone, and name. + This endpoint requires authentication by any Zoo user. It updates the payment information for the authenticated user.""" # noqa: E501 return sync_detailed( @@ -108,6 +109,7 @@ async def asyncio( client: Client, ) -> Optional[Union[Customer, Error]]: """This includes billing address, phone, and name. + This endpoint requires authentication by any Zoo user. It updates the payment information for the authenticated user.""" # noqa: E501 return ( diff --git a/kittycad/api/service_accounts/delete_service_account_for_org.py b/kittycad/api/service_accounts/delete_service_account_for_org.py index eaae08347..0729d70b3 100644 --- a/kittycad/api/service_accounts/delete_service_account_for_org.py +++ b/kittycad/api/service_accounts/delete_service_account_for_org.py @@ -73,6 +73,7 @@ def sync( client: Client, ) -> Optional[Error]: """This endpoint requires authentication by an org admin. It deletes the requested service account for the organization. + This endpoint does not actually delete the service account from the database. It merely marks the token as invalid. We still want to keep the service account in the database for historical purposes.""" # noqa: E501 return sync_detailed( @@ -103,6 +104,7 @@ async def asyncio( client: Client, ) -> Optional[Error]: """This endpoint requires authentication by an org admin. It deletes the requested service account for the organization. + This endpoint does not actually delete the service account from the database. It merely marks the token as invalid. We still want to keep the service account in the database for historical purposes.""" # noqa: E501 return ( diff --git a/kittycad/api/service_accounts/list_service_accounts_for_org.py b/kittycad/api/service_accounts/list_service_accounts_for_org.py index 92bef583f..2b8da2dfe 100644 --- a/kittycad/api/service_accounts/list_service_accounts_for_org.py +++ b/kittycad/api/service_accounts/list_service_accounts_for_org.py @@ -105,6 +105,7 @@ def sync( page_token: Optional[str] = None, ) -> Optional[Union[ServiceAccountResultsPage, Error]]: """This endpoint requires authentication by an org admin. It returns the service accounts for the organization. + The service accounts are returned in order of creation, with the most recently created service accounts first.""" # noqa: E501 return sync_detailed( @@ -143,6 +144,7 @@ async def asyncio( page_token: Optional[str] = None, ) -> Optional[Union[ServiceAccountResultsPage, Error]]: """This endpoint requires authentication by an org admin. It returns the service accounts for the organization. + The service accounts are returned in order of creation, with the most recently created service accounts first.""" # noqa: E501 return ( diff --git a/kittycad/api/users/delete_user_self.py b/kittycad/api/users/delete_user_self.py index 993998794..c4f8d3a5c 100644 --- a/kittycad/api/users/delete_user_self.py +++ b/kittycad/api/users/delete_user_self.py @@ -67,6 +67,7 @@ def sync( client: Client, ) -> Optional[Error]: """This endpoint requires authentication by any Zoo user. It deletes the authenticated user from Zoo's database. + This call will only succeed if all invoices associated with the user have been paid in full and there is no outstanding balance.""" # noqa: E501 return sync_detailed( @@ -93,6 +94,7 @@ async def asyncio( client: Client, ) -> Optional[Error]: """This endpoint requires authentication by any Zoo user. It deletes the authenticated user from Zoo's database. + This call will only succeed if all invoices associated with the user have been paid in full and there is no outstanding balance.""" # noqa: E501 return ( diff --git a/kittycad/api/users/get_oauth2_providers_for_user.py b/kittycad/api/users/get_oauth2_providers_for_user.py index b72569bce..96ab411ba 100644 --- a/kittycad/api/users/get_oauth2_providers_for_user.py +++ b/kittycad/api/users/get_oauth2_providers_for_user.py @@ -74,6 +74,7 @@ def sync( client: Client, ) -> Optional[Union[List[AccountProvider], Error]]: """If this returns an empty array, then the user has not connected any OAuth2 providers and uses raw email authentication. + This endpoint requires authentication by any Zoo user. It gets the providers for the authenticated user.""" # noqa: E501 return sync_detailed( @@ -100,6 +101,7 @@ async def asyncio( client: Client, ) -> Optional[Union[List[AccountProvider], Error]]: """If this returns an empty array, then the user has not connected any OAuth2 providers and uses raw email authentication. + This endpoint requires authentication by any Zoo user. It gets the providers for the authenticated user.""" # noqa: E501 return ( diff --git a/kittycad/api/users/get_user.py b/kittycad/api/users/get_user.py index 3f89eeff4..0829d0500 100644 --- a/kittycad/api/users/get_user.py +++ b/kittycad/api/users/get_user.py @@ -77,7 +77,9 @@ def sync( client: Client, ) -> Optional[Union[User, Error]]: """To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user. + Alternatively, to get information about the authenticated user, use `/user` endpoint. + To get information about any Zoo user, you must be a Zoo employee.""" # noqa: E501 return sync_detailed( @@ -108,7 +110,9 @@ async def asyncio( client: Client, ) -> Optional[Union[User, Error]]: """To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user. + Alternatively, to get information about the authenticated user, use `/user` endpoint. + To get information about any Zoo user, you must be a Zoo employee.""" # noqa: E501 return ( diff --git a/kittycad/api/users/get_user_extended.py b/kittycad/api/users/get_user_extended.py index 2ed0fa2c0..4fdc829b9 100644 --- a/kittycad/api/users/get_user_extended.py +++ b/kittycad/api/users/get_user_extended.py @@ -79,7 +79,9 @@ def sync( client: Client, ) -> Optional[Union[ExtendedUser, Error]]: """To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user. + Alternatively, to get information about the authenticated user, use `/user/extended` endpoint. + To get information about any Zoo user, you must be a Zoo employee.""" # noqa: E501 return sync_detailed( @@ -110,7 +112,9 @@ async def asyncio( client: Client, ) -> Optional[Union[ExtendedUser, Error]]: """To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user. + Alternatively, to get information about the authenticated user, use `/user/extended` endpoint. + To get information about any Zoo user, you must be a Zoo employee.""" # noqa: E501 return ( diff --git a/kittycad/api/users/get_user_self.py b/kittycad/api/users/get_user_self.py index 56a00612c..89464815e 100644 --- a/kittycad/api/users/get_user_self.py +++ b/kittycad/api/users/get_user_self.py @@ -72,6 +72,7 @@ def sync( client: Client, ) -> Optional[Union[User, Error]]: """Get the user information for the authenticated user. + Alternatively, you can also use the `/users/me` endpoint.""" # noqa: E501 return sync_detailed( @@ -98,6 +99,7 @@ async def asyncio( client: Client, ) -> Optional[Union[User, Error]]: """Get the user information for the authenticated user. + Alternatively, you can also use the `/users/me` endpoint.""" # noqa: E501 return ( diff --git a/kittycad/api/users/get_user_self_extended.py b/kittycad/api/users/get_user_self_extended.py index 7bbf7fecf..4112d8653 100644 --- a/kittycad/api/users/get_user_self_extended.py +++ b/kittycad/api/users/get_user_self_extended.py @@ -74,6 +74,7 @@ def sync( client: Client, ) -> Optional[Union[ExtendedUser, Error]]: """Get the user information for the authenticated user. + Alternatively, you can also use the `/users-extended/me` endpoint.""" # noqa: E501 return sync_detailed( @@ -100,6 +101,7 @@ async def asyncio( client: Client, ) -> Optional[Union[ExtendedUser, Error]]: """Get the user information for the authenticated user. + Alternatively, you can also use the `/users-extended/me` endpoint.""" # noqa: E501 return ( diff --git a/kittycad/models/__init__.py b/kittycad/models/__init__.py index 7ed0b055b..a2cebd79a 100644 --- a/kittycad/models/__init__.py +++ b/kittycad/models/__init__.py @@ -58,6 +58,7 @@ from .curve_type import CurveType from .customer import Customer from .customer_balance import CustomerBalance from .cut_type import CutType +from .default_camera_center_to_selection import DefaultCameraCenterToSelection from .default_camera_focus_on import DefaultCameraFocusOn from .default_camera_get_settings import DefaultCameraGetSettings from .default_camera_look_at import DefaultCameraLookAt @@ -72,14 +73,14 @@ from .device_access_token_uuid import DeviceAccessTokenUuid from .device_auth_request_form import DeviceAuthRequestForm from .device_auth_verify_params import DeviceAuthVerifyParams from .direction import Direction +from .disable_dry_run import DisableDryRun from .discount import Discount from .discount_code import DiscountCode from .distance_type import DistanceType from .edge_lines_visible import EdgeLinesVisible -from .edit_mode_enter import EditModeEnter -from .edit_mode_exit import EditModeExit from .email_authentication_form import EmailAuthenticationForm from .empty import Empty +from .enable_dry_run import EnableDryRun from .enable_sketch_mode import EnableSketchMode from .entity_circular_pattern import EntityCircularPattern from .entity_fade import EntityFade diff --git a/kittycad/models/default_camera_center_to_selection.py b/kittycad/models/default_camera_center_to_selection.py new file mode 100644 index 000000000..c6349b075 --- /dev/null +++ b/kittycad/models/default_camera_center_to_selection.py @@ -0,0 +1,7 @@ +from pydantic import BaseModel, ConfigDict + + +class DefaultCameraCenterToSelection(BaseModel): + """The response from the `DefaultCameraCenterToSelection` endpoint.""" + + model_config = ConfigDict(protected_namespaces=()) diff --git a/kittycad/models/edit_mode_enter.py b/kittycad/models/disable_dry_run.py similarity index 52% rename from kittycad/models/edit_mode_enter.py rename to kittycad/models/disable_dry_run.py index cf827b06a..5b1ca6d1c 100644 --- a/kittycad/models/edit_mode_enter.py +++ b/kittycad/models/disable_dry_run.py @@ -1,7 +1,7 @@ from pydantic import BaseModel, ConfigDict -class EditModeEnter(BaseModel): - """The response from the `EditModeEnter` endpoint.""" +class DisableDryRun(BaseModel): + """The response from the `DisableDryRun` endpoint.""" model_config = ConfigDict(protected_namespaces=()) diff --git a/kittycad/models/edit_mode_exit.py b/kittycad/models/enable_dry_run.py similarity index 53% rename from kittycad/models/edit_mode_exit.py rename to kittycad/models/enable_dry_run.py index b21f98954..8aa783bd8 100644 --- a/kittycad/models/edit_mode_exit.py +++ b/kittycad/models/enable_dry_run.py @@ -1,7 +1,7 @@ from pydantic import BaseModel, ConfigDict -class EditModeExit(BaseModel): - """The response from the `EditModeExit` endpoint.""" +class EnableDryRun(BaseModel): + """The response from the `EnableDryRun` endpoint.""" model_config = ConfigDict(protected_namespaces=()) diff --git a/kittycad/models/extended_user.py b/kittycad/models/extended_user.py index 168859ff8..2062f7532 100644 --- a/kittycad/models/extended_user.py +++ b/kittycad/models/extended_user.py @@ -10,7 +10,7 @@ from ..models.uuid import Uuid class ExtendedUser(BaseModel): """Extended user information. - This is mostly used for internal purposes. It returns a mapping of the user's information, including that of our third party services we use for users: MailChimp | Stripe""" + This is mostly used for internal purposes. It returns a mapping of the user's information, including that of our third party services we use for users: Stripe""" block: Optional[BlockReason] = None @@ -40,8 +40,6 @@ class ExtendedUser(BaseModel): last_name: Optional[str] = None - mailchimp_id: Optional[str] = None - name: Optional[str] = None phone: str = "" diff --git a/kittycad/models/modeling_cmd.py b/kittycad/models/modeling_cmd.py index 4aa65322a..d2708d5c0 100644 --- a/kittycad/models/modeling_cmd.py +++ b/kittycad/models/modeling_cmd.py @@ -423,16 +423,6 @@ class OptionEntityMirrorAcrossEdge(BaseModel): model_config = ConfigDict(protected_namespaces=()) -class OptionEditModeEnter(BaseModel): - """Enter edit mode""" - - target: str - - type: Literal["edit_mode_enter"] = "edit_mode_enter" - - model_config = ConfigDict(protected_namespaces=()) - - class OptionSelectWithPoint(BaseModel): """Modifies the selection by simulating a \"mouse click\" at the given x,y window coordinate Returns ID of whatever was selected.""" @@ -885,6 +875,22 @@ class OptionEnableSketchMode(BaseModel): model_config = ConfigDict(protected_namespaces=()) +class OptionEnableDryRun(BaseModel): + """Sets whether or not changes to the scene or its objects will be done as a \"dry run\" In a dry run, successful commands won't actually change the model. This is useful for catching errors before actually making the change.""" + + type: Literal["enable_dry_run"] = "enable_dry_run" + + model_config = ConfigDict(protected_namespaces=()) + + +class OptionDisableDryRun(BaseModel): + """Sets whether or not changes to the scene or its objects will be done as a \"dry run\" In a dry run, successful commands won't actually change the model. This is useful for catching errors before actually making the change.""" + + type: Literal["disable_dry_run"] = "disable_dry_run" + + model_config = ConfigDict(protected_namespaces=()) + + class OptionSetBackgroundColor(BaseModel): """Set the background color of the scene.""" @@ -1229,6 +1235,16 @@ class OptionDefaultCameraSetPerspective(BaseModel): model_config = ConfigDict(protected_namespaces=()) +class OptionDefaultCameraCenterToSelection(BaseModel): + """Updates the camera to center to the center of the current selection (or the origin if nothing is selected)""" + + type: Literal["default_camera_center_to_selection"] = ( + "default_camera_center_to_selection" + ) + + model_config = ConfigDict(protected_namespaces=()) + + class OptionZoomToFit(BaseModel): """Fit the view to the specified object(s).""" @@ -1265,14 +1281,6 @@ class OptionSolid3DGetExtrusionFaceInfo(BaseModel): model_config = ConfigDict(protected_namespaces=()) -class OptionEditModeExit(BaseModel): - """Exit edit mode""" - - type: Literal["edit_mode_exit"] = "edit_mode_exit" - - model_config = ConfigDict(protected_namespaces=()) - - class OptionSelectClear(BaseModel): """Clear the selection""" @@ -1329,7 +1337,6 @@ ModelingCmd = RootModel[ OptionEntityMakeHelix, OptionEntityMirror, OptionEntityMirrorAcrossEdge, - OptionEditModeEnter, OptionSelectWithPoint, OptionSelectAdd, OptionSelectRemove, @@ -1367,6 +1374,8 @@ ModelingCmd = RootModel[ OptionGetSketchModePlane, OptionCurveSetConstraint, OptionEnableSketchMode, + OptionEnableDryRun, + OptionDisableDryRun, OptionSetBackgroundColor, OptionSetCurrentToolProperties, OptionSetDefaultSystemProperties, @@ -1398,10 +1407,10 @@ ModelingCmd = RootModel[ OptionSetSelectionFilter, OptionDefaultCameraSetOrthographic, OptionDefaultCameraSetPerspective, + OptionDefaultCameraCenterToSelection, OptionZoomToFit, OptionViewIsometric, OptionSolid3DGetExtrusionFaceInfo, - OptionEditModeExit, OptionSelectClear, OptionSelectGet, OptionGetNumObjects, diff --git a/kittycad/models/ok_modeling_cmd_response.py b/kittycad/models/ok_modeling_cmd_response.py index e07ae7819..e72feaf07 100644 --- a/kittycad/models/ok_modeling_cmd_response.py +++ b/kittycad/models/ok_modeling_cmd_response.py @@ -12,6 +12,7 @@ from ..models.curve_get_control_points import CurveGetControlPoints from ..models.curve_get_end_points import CurveGetEndPoints from ..models.curve_get_type import CurveGetType from ..models.curve_set_constraint import CurveSetConstraint +from ..models.default_camera_center_to_selection import DefaultCameraCenterToSelection from ..models.default_camera_focus_on import DefaultCameraFocusOn from ..models.default_camera_get_settings import DefaultCameraGetSettings from ..models.default_camera_look_at import DefaultCameraLookAt @@ -22,9 +23,9 @@ from ..models.default_camera_set_orthographic import DefaultCameraSetOrthographi from ..models.default_camera_set_perspective import DefaultCameraSetPerspective from ..models.default_camera_zoom import DefaultCameraZoom from ..models.density import Density +from ..models.disable_dry_run import DisableDryRun from ..models.edge_lines_visible import EdgeLinesVisible -from ..models.edit_mode_enter import EditModeEnter -from ..models.edit_mode_exit import EditModeExit +from ..models.enable_dry_run import EnableDryRun from ..models.enable_sketch_mode import EnableSketchMode from ..models.entity_circular_pattern import EntityCircularPattern from ..models.entity_fade import EntityFade @@ -255,16 +256,6 @@ class OptionEntityMirrorAcrossEdge(BaseModel): model_config = ConfigDict(protected_namespaces=()) -class OptionEditModeEnter(BaseModel): - """""" - - data: EditModeEnter - - type: Literal["edit_mode_enter"] = "edit_mode_enter" - - model_config = ConfigDict(protected_namespaces=()) - - class OptionSelectAdd(BaseModel): """""" @@ -475,6 +466,26 @@ class OptionSketchModeDisable(BaseModel): model_config = ConfigDict(protected_namespaces=()) +class OptionEnableDryRun(BaseModel): + """""" + + data: EnableDryRun + + type: Literal["enable_dry_run"] = "enable_dry_run" + + model_config = ConfigDict(protected_namespaces=()) + + +class OptionDisableDryRun(BaseModel): + """""" + + data: DisableDryRun + + type: Literal["disable_dry_run"] = "disable_dry_run" + + model_config = ConfigDict(protected_namespaces=()) + + class OptionCurveSetConstraint(BaseModel): """""" @@ -635,12 +646,14 @@ class OptionDefaultCameraSetPerspective(BaseModel): model_config = ConfigDict(protected_namespaces=()) -class OptionEditModeExit(BaseModel): +class OptionDefaultCameraCenterToSelection(BaseModel): """""" - data: EditModeExit + data: DefaultCameraCenterToSelection - type: Literal["edit_mode_exit"] = "edit_mode_exit" + type: Literal["default_camera_center_to_selection"] = ( + "default_camera_center_to_selection" + ) model_config = ConfigDict(protected_namespaces=()) @@ -1224,7 +1237,6 @@ OkModelingCmdResponse = RootModel[ OptionEntityMakeHelix, OptionEntityMirror, OptionEntityMirrorAcrossEdge, - OptionEditModeEnter, OptionSelectAdd, OptionSelectRemove, OptionSceneClearAll, @@ -1246,6 +1258,8 @@ OkModelingCmdResponse = RootModel[ OptionSetTool, OptionMouseMove, OptionSketchModeDisable, + OptionEnableDryRun, + OptionDisableDryRun, OptionCurveSetConstraint, OptionEnableSketchMode, OptionSetBackgroundColor, @@ -1262,7 +1276,7 @@ OkModelingCmdResponse = RootModel[ OptionSetSelectionFilter, OptionDefaultCameraSetOrthographic, OptionDefaultCameraSetPerspective, - OptionEditModeExit, + OptionDefaultCameraCenterToSelection, OptionSelectClear, OptionExport, OptionSelectWithPoint, diff --git a/spec.json b/spec.json index 09994a52f..89d8cba90 100644 --- a/spec.json +++ b/spec.json @@ -84,7 +84,7 @@ "hidden" ], "summary": "Get the metadata about our currently running server.", - "description": "This includes information on any of our other distributed systems it is connected to.\nYou must be a Zoo employee to perform this request.", + "description": "This includes information on any of our other distributed systems it is connected to.\n\nYou must be a Zoo employee to perform this request.", "operationId": "get_metadata", "responses": { "200": { @@ -224,7 +224,7 @@ "ml" ], "summary": "Generate a CAD model from text.", - "description": "Because our source of truth for the resulting model is a STEP file, you will always have STEP file contents when you list your generated models. Any other formats you request here will also be returned when you list your generated models.\nThis operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\nOne thing to note, if you hit the cache, this endpoint will return right away. So you only have to wait if the status is not `Completed` or `Failed`.", + "description": "Because our source of truth for the resulting model is a STEP file, you will always have STEP file contents when you list your generated models. Any other formats you request here will also be returned when you list your generated models.\n\nThis operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.\n\nOne thing to note, if you hit the cache, this endpoint will return right away. So you only have to wait if the status is not `Completed` or `Failed`.", "operationId": "create_text_to_cad", "parameters": [ { @@ -586,7 +586,7 @@ "hidden" ], "summary": "Get details of an API call.", - "description": "This endpoint requires authentication by any Zoo user. It returns details of the requested API call for the user.\nIf the user is not authenticated to view the specified API call, then it is not returned.\nOnly Zoo employees can view API calls for other users.", + "description": "This endpoint requires authentication by any Zoo user. It returns details of the requested API call for the user.\n\nIf the user is not authenticated to view the specified API call, then it is not returned.\n\nOnly Zoo employees can view API calls for other users.", "operationId": "get_api_call", "parameters": [ { @@ -669,7 +669,7 @@ "hidden" ], "summary": "Listen for callbacks to GitHub app authentication.", - "description": "This is different than OAuth 2.0 authentication for users. This endpoint grants access for Zoo to access user's repos.\nThe user doesn't need Zoo OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.", + "description": "This is different than OAuth 2.0 authentication for users. This endpoint grants access for Zoo to access user's repos.\n\nThe user doesn't need Zoo OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.", "operationId": "apps_github_callback", "requestBody": { "content": { @@ -741,7 +741,7 @@ "hidden" ], "summary": "Get the consent URL for GitHub app authentication.", - "description": "This is different than OAuth 2.0 authentication for users. This endpoint grants access for Zoo to access user's repos.\nThe user doesn't need Zoo OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.", + "description": "This is different than OAuth 2.0 authentication for users. This endpoint grants access for Zoo to access user's repos.\n\nThe user doesn't need Zoo OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.", "operationId": "apps_github_consent", "responses": { "200": { @@ -888,7 +888,7 @@ "operationId": "options_apps_github_webhook", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -948,7 +948,7 @@ "hidden" ], "summary": "List async operations.", - "description": "For async file conversion operations, this endpoint does not return the contents of converted files (`output`). To get the contents use the `/async/operations/{id}` endpoint.\nThis endpoint requires authentication by a Zoo employee.", + "description": "For async file conversion operations, this endpoint does not return the contents of converted files (`output`). To get the contents use the `/async/operations/{id}` endpoint.\n\nThis endpoint requires authentication by a Zoo employee.", "operationId": "list_async_operations", "parameters": [ { @@ -1058,7 +1058,7 @@ "api-calls" ], "summary": "Get an async operation.", - "description": "Get the status and output of an async operation.\nThis endpoint requires authentication by any Zoo user. It returns details of the requested async operation for the user.\nIf the user is not authenticated to view the specified async operation, then it is not returned.\nOnly Zoo employees with the proper access can view async operations for other users.", + "description": "Get the status and output of an async operation.\n\nThis endpoint requires authentication by any Zoo user. It returns details of the requested async operation for the user.\n\nIf the user is not authenticated to view the specified async operation, then it is not returned.\n\nOnly Zoo employees with the proper access can view async operations for other users.", "operationId": "get_async_operation", "parameters": [ { @@ -1221,7 +1221,7 @@ "operationId": "options_auth_email", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -1700,7 +1700,7 @@ "operationId": "options_create_debug_uploads", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -1836,7 +1836,7 @@ "operationId": "options_create_event", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -1895,7 +1895,7 @@ "file" ], "summary": "Get CAD file center of mass.", - "description": "We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\nThis endpoint returns the cartesian coordinate in world space measure units.\nIn the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\nGet the center of mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\nIf the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.", + "description": "We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n\nThis endpoint returns the cartesian coordinate in world space measure units.\n\nIn the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n\nGet the center of mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n\nIf the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.", "operationId": "create_file_center_of_mass", "parameters": [ { @@ -1997,7 +1997,7 @@ "operationId": "options_file_center_of_mass", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -2056,7 +2056,7 @@ "file" ], "summary": "Convert CAD file with defaults.", - "description": "If you wish to specify the conversion options, use the `/file/conversion` endpoint instead.\nConvert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.\nIf the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string.\nIf the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.", + "description": "If you wish to specify the conversion options, use the `/file/conversion` endpoint instead.\n\nConvert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.\n\nIf the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string.\n\nIf the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.", "operationId": "create_file_conversion", "parameters": [ { @@ -2238,7 +2238,7 @@ "file" ], "summary": "Get CAD file density.", - "description": "We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\nThis endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit.\nIn the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\nGet the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\nIf the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.", + "description": "We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n\nThis endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit.\n\nIn the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n\nGet the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n\nIf the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.", "operationId": "create_file_density", "parameters": [ { @@ -2358,7 +2358,7 @@ "operationId": "options_file_density", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -2590,7 +2590,7 @@ "file" ], "summary": "Get CAD file mass.", - "description": "We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\nThis endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density.\nIn the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\nGet the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\nIf the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.", + "description": "We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n\nThis endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density.\n\nIn the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n\nGet the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n\nIf the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.", "operationId": "create_file_mass", "parameters": [ { @@ -2710,7 +2710,7 @@ "operationId": "options_file_mass", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -2769,7 +2769,7 @@ "file" ], "summary": "Get CAD file surface area.", - "description": "We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\nThis endpoint returns the square measure units.\nIn the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\nGet the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\nIf the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.", + "description": "We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n\nThis endpoint returns the square measure units.\n\nIn the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n\nGet the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n\nIf the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.", "operationId": "create_file_surface_area", "parameters": [ { @@ -2871,7 +2871,7 @@ "operationId": "options_file_surface_area", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -2930,7 +2930,7 @@ "file" ], "summary": "Get CAD file volume.", - "description": "We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\nThis endpoint returns the cubic measure units.\nIn the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\nGet the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\nIf the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.", + "description": "We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.\n\nThis endpoint returns the cubic measure units.\n\nIn the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.\n\nGet the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n\nIf the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.", "operationId": "create_file_volume", "parameters": [ { @@ -3032,7 +3032,7 @@ "operationId": "options_file_volume", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -3092,7 +3092,7 @@ "hidden" ], "summary": "Get an API token for a user by their discord id.", - "description": "This endpoint allows us to run API calls from our discord bot on behalf of a user. The user must have a discord account linked to their Zoo Account via oauth2 for this to work.\nYou must be a Zoo employee to use this endpoint.", + "description": "This endpoint allows us to run API calls from our discord bot on behalf of a user. The user must have a discord account linked to their Zoo Account via oauth2 for this to work.\n\nYou must be a Zoo employee to use this endpoint.", "operationId": "internal_get_api_token_for_discord_user", "parameters": [ { @@ -3238,7 +3238,7 @@ "operationId": "options_logout", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -3298,7 +3298,7 @@ "hidden" ], "summary": "List all ML prompts.", - "description": "For text-to-cad prompts, this will always return the STEP file contents as well as the format the user originally requested.\nThis endpoint requires authentication by a Zoo employee.\nThe ML prompts are returned in order of creation, with the most recently created ML prompts first.", + "description": "For text-to-cad prompts, this will always return the STEP file contents as well as the format the user originally requested.\n\nThis endpoint requires authentication by a Zoo employee.\n\nThe ML prompts are returned in order of creation, with the most recently created ML prompts first.", "operationId": "list_ml_prompts", "parameters": [ { @@ -3565,7 +3565,7 @@ "operationId": "options_kcl_code_completions", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -3707,7 +3707,7 @@ "operationId": "options_text_to_cad_iteration", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -3799,7 +3799,7 @@ "operationId": "options_device_auth_request", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -3934,7 +3934,7 @@ "operationId": "options_device_auth_confirm", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -4026,7 +4026,7 @@ "operationId": "options_device_access_token", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -4546,7 +4546,7 @@ "operationId": "options_oauth2_token_revoke", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -4830,7 +4830,7 @@ "hidden" ], "summary": "Delete an org.", - "description": "In order to delete an org, you must first delete all of its members, except yourself.\nYou must also have no outstanding invoices or unpaid balances.\nThis endpoint requires authentication by an org admin. It deletes the authenticated user's org.", + "description": "In order to delete an org, you must first delete all of its members, except yourself.\n\nYou must also have no outstanding invoices or unpaid balances.\n\nThis endpoint requires authentication by an org admin. It deletes the authenticated user's org.", "operationId": "delete_org", "responses": { "204": { @@ -4895,7 +4895,7 @@ "operationId": "options_org", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -4954,7 +4954,7 @@ "api-calls" ], "summary": "List API calls for your org.", - "description": "This includes all API calls that were made by users in the org.\nThis endpoint requires authentication by an org admin. It returns the API calls for the authenticated user's org.\nThe API calls are returned in order of creation, with the most recently created API calls first.", + "description": "This includes all API calls that were made by users in the org.\n\nThis endpoint requires authentication by an org admin. It returns the API calls for the authenticated user's org.\n\nThe API calls are returned in order of creation, with the most recently created API calls first.", "operationId": "org_list_api_calls", "parameters": [ { @@ -5246,7 +5246,7 @@ "orgs" ], "summary": "Add a member to your org.", - "description": "If the user exists, this will add them to your org. If they do not exist, this will create a new user and add them to your org.\nIn both cases the user gets an email that they have been added to the org.\nIf the user is already in your org, this will return a 400 and a message.\nIf the user is already in a different org, this will return a 400 and a message.\nThis endpoint requires authentication by an org admin. It adds the specified member to the authenticated user's org.", + "description": "If the user exists, this will add them to your org. If they do not exist, this will create a new user and add them to your org.\n\nIn both cases the user gets an email that they have been added to the org.\n\nIf the user is already in your org, this will return a 400 and a message.\n\nIf the user is already in a different org, this will return a 400 and a message.\n\nThis endpoint requires authentication by an org admin. It adds the specified member to the authenticated user's org.", "operationId": "create_org_member", "requestBody": { "content": { @@ -5328,7 +5328,7 @@ "operationId": "options_org_member", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -5701,7 +5701,7 @@ "payments" ], "summary": "Get payment info about your org.", - "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by an org admin. It gets the payment information for the authenticated user's org.", + "description": "This includes billing address, phone, and name.\n\nThis endpoint requires authentication by an org admin. It gets the payment information for the authenticated user's org.", "operationId": "get_payment_information_for_org", "responses": { "200": { @@ -5769,7 +5769,7 @@ "payments" ], "summary": "Update payment info for your org.", - "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by an org admin. It updates the payment information for the authenticated user's org.", + "description": "This includes billing address, phone, and name.\n\nThis endpoint requires authentication by an org admin. It updates the payment information for the authenticated user's org.", "operationId": "update_payment_information_for_org", "requestBody": { "content": { @@ -5847,7 +5847,7 @@ "payments" ], "summary": "Create payment info for your org.", - "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by the org admin. It creates the payment information for the authenticated user's org.", + "description": "This includes billing address, phone, and name.\n\nThis endpoint requires authentication by the org admin. It creates the payment information for the authenticated user's org.", "operationId": "create_payment_information_for_org", "requestBody": { "content": { @@ -5925,7 +5925,7 @@ "payments" ], "summary": "Delete payment info for your org.", - "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by an org admin. It deletes the payment information for the authenticated user's org.", + "description": "This includes billing address, phone, and name.\n\nThis endpoint requires authentication by an org admin. It deletes the payment information for the authenticated user's org.", "operationId": "delete_payment_information_for_org", "responses": { "204": { @@ -5990,7 +5990,7 @@ "operationId": "options_payment_information_for_org", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -6192,7 +6192,7 @@ "operationId": "options_payment_intent_for_org", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -6774,7 +6774,7 @@ "operationId": "options_org_subscription", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -7047,7 +7047,7 @@ "operationId": "options_org_privacy_settings", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -7395,7 +7395,7 @@ "operationId": "options_org_saml_idp", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -7454,7 +7454,7 @@ "service-accounts" ], "summary": "List service accounts for your org.", - "description": "This endpoint requires authentication by an org admin. It returns the service accounts for the organization.\nThe service accounts are returned in order of creation, with the most recently created service accounts first.", + "description": "This endpoint requires authentication by an org admin. It returns the service accounts for the organization.\n\nThe service accounts are returned in order of creation, with the most recently created service accounts first.", "operationId": "list_service_accounts_for_org", "parameters": [ { @@ -7637,7 +7637,7 @@ "operationId": "options_create_service_account_for_org", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -7775,7 +7775,7 @@ "service-accounts" ], "summary": "Delete an service account for your org.", - "description": "This endpoint requires authentication by an org admin. It deletes the requested service account for the organization.\nThis endpoint does not actually delete the service account from the database. It merely marks the token as invalid. We still want to keep the service account in the database for historical purposes.", + "description": "This endpoint requires authentication by an org admin. It deletes the requested service account for the organization.\n\nThis endpoint does not actually delete the service account from the database. It merely marks the token as invalid. We still want to keep the service account in the database for historical purposes.", "operationId": "delete_service_account_for_org", "parameters": [ { @@ -8744,7 +8744,7 @@ "operationId": "options_store_coupon", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -10103,7 +10103,7 @@ "users" ], "summary": "Get your user.", - "description": "Get the user information for the authenticated user.\nAlternatively, you can also use the `/users/me` endpoint.", + "description": "Get the user information for the authenticated user.\n\nAlternatively, you can also use the `/users/me` endpoint.", "operationId": "get_user_self", "responses": { "200": { @@ -10249,7 +10249,7 @@ "users" ], "summary": "Delete your user.", - "description": "This endpoint requires authentication by any Zoo user. It deletes the authenticated user from Zoo's database.\nThis call will only succeed if all invoices associated with the user have been paid in full and there is no outstanding balance.", + "description": "This endpoint requires authentication by any Zoo user. It deletes the authenticated user from Zoo's database.\n\nThis call will only succeed if all invoices associated with the user have been paid in full and there is no outstanding balance.", "operationId": "delete_user_self", "responses": { "204": { @@ -10314,7 +10314,7 @@ "operationId": "options_user_self", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -10373,7 +10373,7 @@ "api-calls" ], "summary": "List API calls for your user.", - "description": "This endpoint requires authentication by any Zoo user. It returns the API calls for the authenticated user.\nThe API calls are returned in order of creation, with the most recently created API calls first.", + "description": "This endpoint requires authentication by any Zoo user. It returns the API calls for the authenticated user.\n\nThe API calls are returned in order of creation, with the most recently created API calls first.", "operationId": "user_list_api_calls", "parameters": [ { @@ -10557,7 +10557,7 @@ "api-tokens" ], "summary": "List API tokens for your user.", - "description": "This endpoint requires authentication by any Zoo user. It returns the API tokens for the authenticated user.\nThe API tokens are returned in order of creation, with the most recently created API tokens first.", + "description": "This endpoint requires authentication by any Zoo user. It returns the API tokens for the authenticated user.\n\nThe API tokens are returned in order of creation, with the most recently created API tokens first.", "operationId": "list_api_tokens_for_user", "parameters": [ { @@ -10740,7 +10740,7 @@ "operationId": "options_create_api_token_for_user", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -10878,7 +10878,7 @@ "api-tokens" ], "summary": "Delete an API token for your user.", - "description": "This endpoint requires authentication by any Zoo user. It deletes the requested API token for the user.\nThis endpoint does not actually delete the API token from the database. It merely marks the token as invalid. We still want to keep the token in the database for historical purposes.", + "description": "This endpoint requires authentication by any Zoo user. It deletes the requested API token for the user.\n\nThis endpoint does not actually delete the API token from the database. It merely marks the token as invalid. We still want to keep the token in the database for historical purposes.", "operationId": "delete_api_token_for_user", "parameters": [ { @@ -11024,7 +11024,7 @@ "users" ], "summary": "Get extended information about your user.", - "description": "Get the user information for the authenticated user.\nAlternatively, you can also use the `/users-extended/me` endpoint.", + "description": "Get the user information for the authenticated user.\n\nAlternatively, you can also use the `/users-extended/me` endpoint.", "operationId": "get_user_self_extended", "responses": { "200": { @@ -11094,7 +11094,7 @@ "users" ], "summary": "Get the OAuth2 providers for your user.", - "description": "If this returns an empty array, then the user has not connected any OAuth2 providers and uses raw email authentication.\nThis endpoint requires authentication by any Zoo user. It gets the providers for the authenticated user.", + "description": "If this returns an empty array, then the user has not connected any OAuth2 providers and uses raw email authentication.\n\nThis endpoint requires authentication by any Zoo user. It gets the providers for the authenticated user.", "operationId": "get_oauth2_providers_for_user", "responses": { "200": { @@ -11240,7 +11240,7 @@ "users" ], "summary": "Get a user's org.", - "description": "This endpoint requires authentication by any Zoo user. It gets the authenticated user's org.\nIf the user is not a member of an org, this endpoint will return a 404.", + "description": "This endpoint requires authentication by any Zoo user. It gets the authenticated user's org.\n\nIf the user is not a member of an org, this endpoint will return a 404.", "operationId": "get_user_org", "responses": { "200": { @@ -11310,7 +11310,7 @@ "payments" ], "summary": "Get payment info about your user.", - "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by any Zoo user. It gets the payment information for the authenticated user.", + "description": "This includes billing address, phone, and name.\n\nThis endpoint requires authentication by any Zoo user. It gets the payment information for the authenticated user.", "operationId": "get_payment_information_for_user", "responses": { "200": { @@ -11378,7 +11378,7 @@ "payments" ], "summary": "Update payment info for your user.", - "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by any Zoo user. It updates the payment information for the authenticated user.", + "description": "This includes billing address, phone, and name.\n\nThis endpoint requires authentication by any Zoo user. It updates the payment information for the authenticated user.", "operationId": "update_payment_information_for_user", "requestBody": { "content": { @@ -11456,7 +11456,7 @@ "payments" ], "summary": "Create payment info for your user.", - "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by any Zoo user. It creates the payment information for the authenticated user.", + "description": "This includes billing address, phone, and name.\n\nThis endpoint requires authentication by any Zoo user. It creates the payment information for the authenticated user.", "operationId": "create_payment_information_for_user", "requestBody": { "content": { @@ -11534,7 +11534,7 @@ "payments" ], "summary": "Delete payment info for your user.", - "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by any Zoo user. It deletes the payment information for the authenticated user.", + "description": "This includes billing address, phone, and name.\n\nThis endpoint requires authentication by any Zoo user. It deletes the payment information for the authenticated user.", "operationId": "delete_payment_information_for_user", "responses": { "204": { @@ -11599,7 +11599,7 @@ "operationId": "options_payment_information_for_user", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -11801,7 +11801,7 @@ "operationId": "options_payment_intent_for_user", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -12383,7 +12383,7 @@ "operationId": "options_user_subscription", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -12656,7 +12656,7 @@ "operationId": "options_user_privacy_settings", "responses": { "204": { - "description": "successful operation, no content", + "description": "resource updated", "headers": { "Access-Control-Allow-Credentials": { "description": "Access-Control-Allow-Credentials header.", @@ -12796,7 +12796,7 @@ "ml" ], "summary": "List text-to-CAD models you've generated.", - "description": "This will always return the STEP file contents as well as the format the user originally requested.\nThis endpoint requires authentication by any Zoo user. It returns the text-to-CAD models for the authenticated user.\nThe text-to-CAD models are returned in order of creation, with the most recently created text-to-CAD models first.", + "description": "This will always return the STEP file contents as well as the format the user originally requested.\n\nThis endpoint requires authentication by any Zoo user. It returns the text-to-CAD models for the authenticated user.\n\nThe text-to-CAD models are returned in order of creation, with the most recently created text-to-CAD models first.", "operationId": "list_text_to_cad_models_for_user", "parameters": [ { @@ -13351,7 +13351,7 @@ "hidden" ], "summary": "Get extended information about a user.", - "description": "To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user.\nAlternatively, to get information about the authenticated user, use `/user/extended` endpoint.\nTo get information about any Zoo user, you must be a Zoo employee.", + "description": "To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user.\n\nAlternatively, to get information about the authenticated user, use `/user/extended` endpoint.\n\nTo get information about any Zoo user, you must be a Zoo employee.", "operationId": "get_user_extended", "parameters": [ { @@ -13433,7 +13433,7 @@ "hidden" ], "summary": "Get a user.", - "description": "To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.\nAlternatively, to get information about the authenticated user, use `/user` endpoint.\nTo get information about any Zoo user, you must be a Zoo employee.", + "description": "To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.\n\nAlternatively, to get information about the authenticated user, use `/user` endpoint.\n\nTo get information about any Zoo user, you must be a Zoo employee.", "operationId": "get_user", "parameters": [ { @@ -13515,7 +13515,7 @@ "hidden" ], "summary": "List API calls for a user.", - "description": "This endpoint requires authentication by any Zoo user. It returns the API calls for the authenticated user if \"me\" is passed as the user id.\nAlternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.\nIf the authenticated user is a Zoo employee, then the API calls are returned for the user specified by the user id.\nThe API calls are returned in order of creation, with the most recently created API calls first.", + "description": "This endpoint requires authentication by any Zoo user. It returns the API calls for the authenticated user if \"me\" is passed as the user id.\n\nAlternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.\n\nIf the authenticated user is a Zoo employee, then the API calls are returned for the user specified by the user id.\n\nThe API calls are returned in order of creation, with the most recently created API calls first.", "operationId": "list_api_calls_for_user", "parameters": [ { @@ -16984,6 +16984,10 @@ } ] }, + "DefaultCameraCenterToSelection": { + "description": "The response from the `DefaultCameraCenterToSelection` endpoint.", + "type": "object" + }, "DefaultCameraFocusOn": { "description": "The response from the `DefaultCameraFocusOn` command.", "type": "object" @@ -17162,6 +17166,10 @@ } ] }, + "DisableDryRun": { + "description": "The response from the `DisableDryRun` endpoint.", + "type": "object" + }, "Discount": { "description": "The resource representing a Discount.", "type": "object", @@ -17253,14 +17261,6 @@ "description": "The response from the `EdgeLinesVisible` endpoint.", "type": "object" }, - "EditModeEnter": { - "description": "The response from the `EditModeEnter` endpoint.", - "type": "object" - }, - "EditModeExit": { - "description": "The response from the `EditModeExit` endpoint.", - "type": "object" - }, "EmailAuthenticationForm": { "description": "The body of the form for email authentication.", "type": "object", @@ -17281,6 +17281,10 @@ "email" ] }, + "EnableDryRun": { + "description": "The response from the `EnableDryRun` endpoint.", + "type": "object" + }, "EnableSketchMode": { "description": "The response from the `EnableSketchMode` endpoint.", "type": "object" @@ -17710,7 +17714,7 @@ "type": "object" }, "ExtendedUser": { - "description": "Extended user information.\n\nThis is mostly used for internal purposes. It returns a mapping of the user's information, including that of our third party services we use for users: MailChimp | Stripe", + "description": "Extended user information.\n\nThis is mostly used for internal purposes. It returns a mapping of the user's information, including that of our third party services we use for users: Stripe", "type": "object", "properties": { "block": { @@ -17789,11 +17793,6 @@ "description": "The user's last name.", "type": "string" }, - "mailchimp_id": { - "nullable": true, - "description": "The user's MailChimp ID. This is mostly used for internal mapping.", - "type": "string" - }, "name": { "description": "The name of the user. This is auto populated at first from the authentication provider (if there was a name). It can be updated by the user by updating their `first_name` and `last_name` fields.", "type": "string" @@ -21593,27 +21592,6 @@ "type" ] }, - { - "description": "Enter edit mode", - "type": "object", - "properties": { - "target": { - "description": "The edit target", - "type": "string", - "format": "uuid" - }, - "type": { - "type": "string", - "enum": [ - "edit_mode_enter" - ] - } - }, - "required": [ - "target", - "type" - ] - }, { "description": "Modifies the selection by simulating a \"mouse click\" at the given x,y window coordinate Returns ID of whatever was selected.", "type": "object", @@ -22713,6 +22691,36 @@ "type" ] }, + { + "description": "Sets whether or not changes to the scene or its objects will be done as a \"dry run\" In a dry run, successful commands won't actually change the model. This is useful for catching errors before actually making the change.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "enable_dry_run" + ] + } + }, + "required": [ + "type" + ] + }, + { + "description": "Sets whether or not changes to the scene or its objects will be done as a \"dry run\" In a dry run, successful commands won't actually change the model. This is useful for catching errors before actually making the change.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "disable_dry_run" + ] + } + }, + "required": [ + "type" + ] + }, { "description": "Set the background color of the scene.", "type": "object", @@ -23546,6 +23554,21 @@ "type" ] }, + { + "description": "Updates the camera to center to the center of the current selection (or the origin if nothing is selected)", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "default_camera_center_to_selection" + ] + } + }, + "required": [ + "type" + ] + }, { "description": "Fit the view to the specified object(s).", "type": "object", @@ -23629,21 +23652,6 @@ "type" ] }, - { - "description": "Exit edit mode", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "edit_mode_exit" - ] - } - }, - "required": [ - "type" - ] - }, { "description": "Clear the selection", "type": "object", @@ -24068,24 +24076,6 @@ "type" ] }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/EditModeEnter" - }, - "type": { - "type": "string", - "enum": [ - "edit_mode_enter" - ] - } - }, - "required": [ - "data", - "type" - ] - }, { "type": "object", "properties": { @@ -24464,6 +24454,42 @@ "type" ] }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/EnableDryRun" + }, + "type": { + "type": "string", + "enum": [ + "enable_dry_run" + ] + } + }, + "required": [ + "data", + "type" + ] + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DisableDryRun" + }, + "type": { + "type": "string", + "enum": [ + "disable_dry_run" + ] + } + }, + "required": [ + "data", + "type" + ] + }, { "type": "object", "properties": { @@ -24756,12 +24782,12 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/EditModeExit" + "$ref": "#/components/schemas/DefaultCameraCenterToSelection" }, "type": { "type": "string", "enum": [ - "edit_mode_exit" + "default_camera_center_to_selection" ] } },