diff --git a/kittycad/models/__init__.py b/kittycad/models/__init__.py index 1116478c8..5725ba1be 100644 --- a/kittycad/models/__init__.py +++ b/kittycad/models/__init__.py @@ -56,6 +56,8 @@ from .phone_number import PhoneNumber from .pong import Pong from .session import Session from .status_code import StatusCode +from .unit_conversion import UnitConversion +from .unit_metric_format import UnitMetricFormat from .update_user import UpdateUser from .user import User from .user_results_page import UserResultsPage diff --git a/kittycad/models/code_output.py b/kittycad/models/code_output.py index 4ee55a41e..dc34d48df 100644 --- a/kittycad/models/code_output.py +++ b/kittycad/models/code_output.py @@ -10,7 +10,6 @@ T = TypeVar("T", bound="CodeOutput") @attr.s(auto_attribs=True) class CodeOutput: """ """ - output: Union[Unset, str] = UNSET from ..models.output_file import OutputFile output_files: Union[Unset, List[OutputFile]] = UNSET stderr: Union[Unset, str] = UNSET @@ -19,7 +18,6 @@ class CodeOutput: additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict) def to_dict(self) -> Dict[str, Any]: - output = self.output from ..models.output_file import OutputFile output_files: Union[Unset, List[OutputFile]] = UNSET if not isinstance(self.output_files, Unset): @@ -30,8 +28,6 @@ class CodeOutput: field_dict: Dict[str, Any] = {} field_dict.update(self.additional_properties) field_dict.update({}) - if output is not UNSET: - field_dict['output'] = output if output_files is not UNSET: field_dict['output_files'] = output_files if stderr is not UNSET: @@ -44,8 +40,6 @@ class CodeOutput: @classmethod def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: d = src_dict.copy() - output = d.pop("output", UNSET) - from ..models.output_file import OutputFile output_files = cast(List[OutputFile], d.pop("output_files", UNSET)) @@ -54,7 +48,6 @@ class CodeOutput: stdout = d.pop("stdout", UNSET) code_output = cls( - output=output, output_files=output_files, stderr=stderr, stdout=stdout, diff --git a/spec.json b/spec.json index a1463a58b..9126b5346 100644 --- a/spec.json +++ b/spec.json @@ -1,7 +1,4322 @@ { + "openapi": "3.0.3", + "info": { + "title": "KittyCAD API", + "description": "API server for KittyCAD", + "contact": { + "url": "https://kittycad.io", + "email": "api@kittycad.io" + }, + "version": "0.1.0", + "x-go": { + "client": "// Create a client with your token.\nclient, err := kittycad.NewClient(\"$TOKEN\", \"your apps user agent\")\nif err != nil {\n panic(err)\n}\n\n// - OR -\n\n// Create a new client with your token parsed from the environment\n// variable: KITTYCAD_API_TOKEN.\nclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\nif err != nil {\n panic(err)\n}", + "install": "go get github.com/kittycad/kittycad.go" + }, + "x-rust": { + "client": "use kittycad::Client;\n\n// Authenticate via an API token.\nlet client = Client::new(\"$KITTYCAD_API_TOKEN\");\n\n// - OR -\n\n// Authenticate with your token and host parsed from the environment variables:\n// KITTYCAD_API_TOKEN.\nlet client = Client::new_from_env();", + "install": "[dependencies]\nkittycad = \"0.1.0\"" + }, + "x-python": { + "client": "# Create a client with your token.\nfrom kittycad 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 import ClientFromEnv\n\nclient = ClientFromEnv()", + "install": "pip install kittycad" + } + }, + "paths": { + "/": { + "get": { + "tags": [ + "meta" + ], + "summary": "Get OpenAPI schema.", + "operationId": "get_schema", + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": {} + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// GetSchema: Get OpenAPI schema.\nresponseGetSchema, err := client.Meta.GetSchema()", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#MetaService.GetSchema" + }, + "x-rust": { + "example": "/**\n* Get OpenAPI schema.\n*\n* This function performs a `GET` to the `/` endpoint.\n*/\nclient.meta().get_schema().await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/meta/struct.Meta.html#method.get_schema" + }, + "x-python": { + "example": "from kittycad.models import dict\nfrom kittycad.api.meta import get_schema\nfrom kittycad.types import Response\n\nfc: dict = get_schema.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[dict] = get_schema.sync_detailed(client=client)\n\n# OR run async\nfc: dict = await get_schema.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[dict] = await get_schema.asyncio_detailed(client=client)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.meta.get_schema.html" + } + } + }, + "/_meta/info": { + "get": { + "tags": [ + "meta", + "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 KittyCAD employee to perform this request.", + "operationId": "get_metadata", + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Metadata", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// Getdata: Get the metadata about our currently running server.\n//\n// This includes information on any of our other distributed systems it is connected to.\n// You must be a KittyCAD employee to perform this request.\nmetadata, err := client.Meta.Getdata()", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#MetaService.Getdata" + }, + "x-rust": { + "example": "/**\n* Get the metadata about our currently running server.\n*\n* This function performs a `GET` to the `/_meta/info` endpoint.\n*\n* This includes information on any of our other distributed systems it is connected to.\n* You must be a KittyCAD employee to perform this request.\n*/\nlet metadata = client.meta().get_data().await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/meta/struct.Meta.html#method.get_data" + }, + "x-python": { + "example": "from kittycad.models import Metadata\nfrom kittycad.api.meta import get_metadata\nfrom kittycad.types import Response\n\nfc: Metadata = get_metadata.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Metadata] = get_metadata.sync_detailed(client=client)\n\n# OR run async\nfc: Metadata = await get_metadata.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[Metadata] = await get_metadata.asyncio_detailed(client=client)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.meta.get_metadata.html" + } + } + }, + "/api-call-metrics": { + "get": { + "tags": [ + "api-calls", + "hidden" + ], + "summary": "Get API call metrics.", + "description": "This endpoint requires authentication by a KittyCAD employee. The API calls are grouped by the parameter passed.", + "operationId": "get_api_call_metrics", + "parameters": [ + { + "in": "query", + "name": "group_by", + "description": "What field to group the metrics by.", + "required": true, + "schema": { + "$ref": "#/components/schemas/ApiCallQueryGroupBy", + "x-scope": [ + "" + ] + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "title": "Array_of_ApiCallQueryGroup", + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiCallQueryGroup", + "x-scope": [ + "" + ] + } + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// GetMetrics: Get API call metrics.\n//\n// This endpoint requires authentication by a KittyCAD employee. The API calls are grouped by the parameter passed.\n//\n// Parameters:\n//\t- `groupBy`: What field to group the metrics by.\nAPICallQueryGroup, err := client.APICall.GetMetrics(groupBy)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.GetMetrics" + }, + "x-rust": { + "example": "/**\n* Get API call metrics.\n*\n* This function performs a `GET` to the `/api-call-metrics` endpoint.\n*\n* This endpoint requires authentication by a KittyCAD employee. The API calls are grouped by the parameter passed.\n*\n* **Parameters:**\n*\n* * `group_by: crate::types::ApiCallQueryGroupBy` -- The field of an API call to group by.\n*/\nlet vec_crate_types_api_call_query_group = client.api_calls().get_call_metrics(group_by).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/api_calls/struct.ApiCalls.html#method.get_call_metrics" + }, + "x-python": { + "example": "from kittycad.models import [ApiCallQueryGroup]\nfrom kittycad.api.api-calls import get_api_call_metrics\nfrom kittycad.types import Response\n\nfc: [ApiCallQueryGroup] = get_api_call_metrics.sync(client=client, group_by=ApiCallQueryGroupBy)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[[ApiCallQueryGroup]] = get_api_call_metrics.sync_detailed(client=client, group_by=ApiCallQueryGroupBy)\n\n# OR run async\nfc: [ApiCallQueryGroup] = await get_api_call_metrics.asyncio(client=client, group_by=ApiCallQueryGroupBy)\n\n# OR run async with more info\nresponse: Response[[ApiCallQueryGroup]] = await get_api_call_metrics.asyncio_detailed(client=client, group_by=ApiCallQueryGroupBy)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.get_api_call_metrics.html" + } + } + }, + "/api-calls": { + "get": { + "tags": [ + "api-calls", + "hidden" + ], + "summary": "List API calls.", + "description": "This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first.", + "operationId": "list_api_calls", + "parameters": [ + { + "in": "query", + "name": "limit", + "description": "Maximum number of items returned by a single call", + "schema": { + "nullable": true, + "type": "integer", + "format": "uint32", + "minimum": 1 + }, + "style": "form" + }, + { + "in": "query", + "name": "page_token", + "description": "Token returned by previous call to retrieve the subsequent page", + "schema": { + "nullable": true, + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "$ref": "#/components/schemas/CreatedAtSortMode", + "x-scope": [ + "" + ] + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCallWithPriceResultsPage", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-dropshot-pagination": true, + "x-go": { + "example": "// List: List API calls.\n//\n// This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// To iterate over all pages, use the `ListAllPages` method, instead.\n//\n// Parameters:\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\naPICallWithPriceResultsPage, err := client.APICall.List(limit, pageToken, sortBy)\n\n// - OR -\n\n// ListAllPages: List API calls.\n//\n// This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// This method is a wrapper around the `List` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `sortBy`\nAPICallWithPrice, err := client.APICall.ListAllPages(sortBy)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.List" + }, + "x-rust": { + "example": "/**\n* List API calls.\n*\n* This function performs a `GET` to the `/api-calls` endpoint.\n*\n* This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first.\n*\n* **Parameters:**\n*\n* * `limit: u32` -- Maximum number of items returned by a single call.\n* * `page_token: &str` -- Token returned by previous call to retrieve the subsequent page.\n* * `sort_by: crate::types::CreatedAtSortMode` -- Supported set of sort modes for scanning by created_at only.\n* \n* Currently, we only support scanning in ascending order.\n*/\nlet vec_crate_types_api_call_with_price = client.api_calls().list_calls(limit, page_token, sort_by).await?;\n\n// - OR -\n\n/**\n* List API calls.\n*\n* This function performs a `GET` to the `/api-calls` endpoint.\n*\n* As opposed to `list_calls`, this function returns all the pages of the request at once.\n*\n* This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first.\n*/\nlet vec_crate_types_api_call_with_price = client.api_calls().list_all_calls(sort_by).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/api_calls/struct.ApiCalls.html#method.list_calls" + }, + "x-python": { + "example": "from kittycad.models import ApiCallWithPriceResultsPage\nfrom kittycad.api.api-calls import list_api_calls\nfrom kittycad.types import Response\n\nfc: ApiCallWithPriceResultsPage = list_api_calls.sync(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiCallWithPriceResultsPage] = list_api_calls.sync_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async\nfc: ApiCallWithPriceResultsPage = await list_api_calls.asyncio(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async with more info\nresponse: Response[ApiCallWithPriceResultsPage] = await list_api_calls.asyncio_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.list_api_calls.html" + } + } + }, + "/api-calls/{id}": { + "get": { + "tags": [ + "api-calls", + "hidden" + ], + "summary": "Get details of an API call.", + "description": "This endpoint requires authentication by any KittyCAD 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 KittyCAD employees can view API calls for other users.", + "operationId": "get_api_call", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the API call.", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCallWithPrice", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// Get: Get details of an API call.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.\n// If the user is not authenticated to view the specified API call, then it is not returned.\n// Only KittyCAD employees can view API calls for other users.\n//\n// Parameters:\n//\t- `id`: The ID of the API call.\naPICallWithPrice, err := client.APICall.Get(id)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.Get" + }, + "x-rust": { + "example": "/**\n* Get details of an API call.\n*\n* This function performs a `GET` to the `/api-calls/{id}` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.\n* If the user is not authenticated to view the specified API call, then it is not returned.\n* Only KittyCAD employees can view API calls for other users.\n*\n* **Parameters:**\n*\n* * `id: &str` -- The ID of the API call.\n*/\nlet api_call_with_price = client.api_calls().get_call(id).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/api_calls/struct.ApiCalls.html#method.get_call" + }, + "x-python": { + "example": "from kittycad.models import ApiCallWithPrice\nfrom kittycad.api.api-calls import get_api_call\nfrom kittycad.types import Response\n\nfc: ApiCallWithPrice = get_api_call.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiCallWithPrice] = get_api_call.sync_detailed(client=client, id=)\n\n# OR run async\nfc: ApiCallWithPrice = await get_api_call.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[ApiCallWithPrice] = await get_api_call.asyncio_detailed(client=client, id=)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.get_api_call.html" + } + } + }, + "/async/operations": { + "get": { + "tags": [ + "api-calls", + "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 KittyCAD employee.", + "operationId": "list_async_operations", + "parameters": [ + { + "in": "query", + "name": "limit", + "description": "Maximum number of items returned by a single call", + "schema": { + "nullable": true, + "type": "integer", + "format": "uint32", + "minimum": 1 + }, + "style": "form" + }, + { + "in": "query", + "name": "page_token", + "description": "Token returned by previous call to retrieve the subsequent page", + "schema": { + "nullable": true, + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "$ref": "#/components/schemas/CreatedAtSortMode", + "x-scope": [ + "" + ] + }, + "style": "form" + }, + { + "in": "query", + "name": "status", + "description": "The status to filter by.", + "schema": { + "$ref": "#/components/schemas/APICallStatus", + "x-scope": [ + "" + ] + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncApiCallResultsPage", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-dropshot-pagination": true, + "x-go": { + "example": "// ListAsyncOperations: List async operations.\n//\n// 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// This endpoint requires authentication by a KittyCAD employee.\n//\n// To iterate over all pages, use the `ListAsyncOperationsAllPages` method, instead.\n//\n// Parameters:\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\n//\t- `status`: The status to filter by.\nasyncAPICallResultsPage, err := client.APICall.ListAsyncOperations(limit, pageToken, sortBy, status)\n\n// - OR -\n\n// ListAsyncOperationsAllPages: List async operations.\n//\n// 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// This endpoint requires authentication by a KittyCAD employee.\n//\n// This method is a wrapper around the `ListAsyncOperations` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `sortBy`\n//\t- `status`: The status to filter by.\nAsyncAPICall, err := client.APICall.ListAsyncOperationsAllPages(sortBy, status)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.ListAsyncOperations" + }, + "x-rust": { + "example": "/**\n* List async operations.\n*\n* This function performs a `GET` to the `/async/operations` endpoint.\n*\n* 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* This endpoint requires authentication by a KittyCAD employee.\n*\n* **Parameters:**\n*\n* * `limit: u32` -- Maximum number of items returned by a single call.\n* * `page_token: &str` -- Token returned by previous call to retrieve the subsequent page.\n* * `sort_by: crate::types::CreatedAtSortMode` -- Supported set of sort modes for scanning by created_at only.\n* \n* Currently, we only support scanning in ascending order.\n* * `status: crate::types::ApiCallStatus` -- The status of an async API call.\n*/\nlet vec_crate_types_async_api_call = client.api_calls().list_async_operations(limit, page_token, sort_by, status).await?;\n\n// - OR -\n\n/**\n* List async operations.\n*\n* This function performs a `GET` to the `/async/operations` endpoint.\n*\n* As opposed to `list_async_operations`, this function returns all the pages of the request at once.\n*\n* 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* This endpoint requires authentication by a KittyCAD employee.\n*/\nlet vec_crate_types_async_api_call = client.api_calls().list_all_async_operations(sort_by, status).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/api_calls/struct.ApiCalls.html#method.list_async_operations" + }, + "x-python": { + "example": "from kittycad.models import AsyncApiCallResultsPage\nfrom kittycad.api.api-calls import list_async_operations\nfrom kittycad.types import Response\n\nfc: AsyncApiCallResultsPage = list_async_operations.sync(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode, status=APICallStatus)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[AsyncApiCallResultsPage] = list_async_operations.sync_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode, status=APICallStatus)\n\n# OR run async\nfc: AsyncApiCallResultsPage = await list_async_operations.asyncio(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode, status=APICallStatus)\n\n# OR run async with more info\nresponse: Response[AsyncApiCallResultsPage] = await list_async_operations.asyncio_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode, status=APICallStatus)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.list_async_operations.html" + } + } + }, + "/async/operations/{id}": { + "get": { + "tags": [ + "api-calls" + ], + "summary": "Get an async operation.", + "description": "Get the status and output of an async operation.\nThis endpoint requires authentication by any KittyCAD 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 KittyCAD employees with the proper access can view async operations for other users.", + "operationId": "get_async_operation", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the async operation.", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncApiCallOutput", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// GetAsyncOperation: Get an async operation.\n//\n// Get the status and output of an async operation.\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested async operation for the user.\n// If the user is not authenticated to view the specified async operation, then it is not returned.\n// Only KittyCAD employees with the proper access can view async operations for other users.\n//\n// Parameters:\n//\t- `id`: The ID of the async operation.\nasyncAPICallOutput, err := client.APICall.GetAsyncOperation(id)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.GetAsyncOperation" + }, + "x-rust": { + "example": "/**\n* Get an async operation.\n*\n* This function performs a `GET` to the `/async/operations/{id}` endpoint.\n*\n* Get the status and output of an async operation.\n* This endpoint requires authentication by any KittyCAD user. It returns details of the requested async operation for the user.\n* If the user is not authenticated to view the specified async operation, then it is not returned.\n* Only KittyCAD employees with the proper access can view async operations for other users.\n*\n* **Parameters:**\n*\n* * `id: &str` -- The ID of the async operation.\n*/\nlet async_api_call_output = client.api_calls().get_async_operation(id).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/api_calls/struct.ApiCalls.html#method.get_async_operation" + }, + "x-python": { + "example": "from kittycad.models import FileConversion\nfrom kittycad.api.api-calls import get_async_operation\nfrom kittycad.types import Response\n\nfc: FileConversion = get_async_operation.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileConversion] = get_async_operation.sync_detailed(client=client, id=)\n\n# OR run async\nfc: FileConversion = await get_async_operation.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[FileConversion] = await get_async_operation.asyncio_detailed(client=client, id=)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.get_async_operation.html" + } + } + }, + "/file/conversion/{src_format}/{output_format}": { + "post": { + "tags": [ + "file" + ], + "summary": "Convert CAD file.", + "description": "Convert 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.", + "operationId": "create_file_conversion", + "parameters": [ + { + "in": "path", + "name": "output_format", + "description": "The format the file should be converted to.", + "required": true, + "schema": { + "$ref": "#/components/schemas/FileOutputFormat", + "x-scope": [ + "" + ] + }, + "style": "simple" + }, + { + "in": "path", + "name": "src_format", + "description": "The format of the file to convert.", + "required": true, + "schema": { + "$ref": "#/components/schemas/FileSourceFormat", + "x-scope": [ + "" + ] + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "successful creation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileConversion", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// CreateConversion: Convert CAD file.\n//\n// Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.\n// If the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string.\n// 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.\n//\n// Parameters:\n//\t- `outputFormat`: The format the file should be converted to.\n//\t- `srcFormat`: The format of the file to convert.\nfileConversion, err := client.File.CreateConversion(outputFormat, srcFormat, body)\n\n// - OR -\n\n// CreateConversionWithBase64Helper will automatically base64 encode and decode the contents\n// of the file body.\n//\n// This function is a wrapper around the CreateConversion function.\nfileConversion, err := client.File.CreateConversionWithBase64Helper(outputFormat, srcFormat, body)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateConversion" + }, + "x-rust": { + "example": "/**\n* Convert CAD file.\n*\n* This function performs a `POST` to the `/file/conversion/{src_format}/{output_format}` endpoint.\n*\n* Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.\n* If the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string.\n* 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.\n*\n* **Parameters:**\n*\n* * `output_format: crate::types::FileOutputFormat` -- The format the file should be converted to.\n* * `src_format: crate::types::FileSourceFormat` -- The valid types of source file formats.\n*/\nlet file_conversion = client.file().create_conversion(output_format, src_format, body).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/file/struct.File.html#method.create_conversion" + }, + "x-python": { + "example": "from kittycad.models import FileConversion\nfrom kittycad.api.file import create_file_conversion_with_base64_helper\nfrom kittycad.types import Response\n\nfc: FileConversion = create_file_conversion_with_base64_helper.sync(client=client, output_format=FileOutputFormat, src_format=FileSourceFormat, body=bytes)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileConversion] = create_file_conversion_with_base64_helper.sync_detailed(client=client, output_format=FileOutputFormat, src_format=FileSourceFormat, body=bytes)\n\n# OR run async\nfc: FileConversion = await create_file_conversion_with_base64_helper.asyncio(client=client, output_format=FileOutputFormat, src_format=FileSourceFormat, body=bytes)\n\n# OR run async with more info\nresponse: Response[FileConversion] = await create_file_conversion_with_base64_helper.asyncio_detailed(client=client, output_format=FileOutputFormat, src_format=FileSourceFormat, body=bytes)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.create_file_conversion_with_base64_helper.html" + } + } + }, + "/file/conversions/{id}": { + "get": { + "tags": [ + "file" + ], + "summary": "Get a file conversion.", + "description": "Get the status and output of an async file conversion.\nThis endpoint requires authentication by any KittyCAD user. It returns details of the requested file conversion for the user.\nIf the user is not authenticated to view the specified file conversion, then it is not returned.\nOnly KittyCAD employees with the proper access can view file conversions for other users.", + "operationId": "get_file_conversion", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the async operation.", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncApiCallOutput", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// GetConversion: Get a file conversion.\n//\n// Get the status and output of an async file conversion.\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested file conversion for the user.\n// If the user is not authenticated to view the specified file conversion, then it is not returned.\n// Only KittyCAD employees with the proper access can view file conversions for other users.\n//\n// Parameters:\n//\t- `id`: The ID of the async operation.\nasyncAPICallOutput, err := client.File.GetConversion(id)\n\n// - OR -\n\n// GetConversionWithBase64Helper will automatically base64 encode and decode the contents\n// of the file body.\n//\n// This function is a wrapper around the GetConversion function.\nasyncAPICallOutput, err := client.File.GetConversionWithBase64Helper(id)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.GetConversion" + }, + "x-rust": { + "example": "/**\n* Get a file conversion.\n*\n* This function performs a `GET` to the `/file/conversions/{id}` endpoint.\n*\n* Get the status and output of an async file conversion.\n* This endpoint requires authentication by any KittyCAD user. It returns details of the requested file conversion for the user.\n* If the user is not authenticated to view the specified file conversion, then it is not returned.\n* Only KittyCAD employees with the proper access can view file conversions for other users.\n*\n* **Parameters:**\n*\n* * `id: &str` -- The ID of the async operation.\n*/\nlet async_api_call_output = client.file().get_conversion(id).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/file/struct.File.html#method.get_conversion" + }, + "x-python": { + "example": "from kittycad.models import FileConversion\nfrom kittycad.api.file import get_file_conversion_with_base64_helper\nfrom kittycad.types import Response\n\nfc: FileConversion = get_file_conversion_with_base64_helper.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileConversion] = get_file_conversion_with_base64_helper.sync_detailed(client=client, id=)\n\n# OR run async\nfc: FileConversion = await get_file_conversion_with_base64_helper.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[FileConversion] = await get_file_conversion_with_base64_helper.asyncio_detailed(client=client, id=)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.get_file_conversion_with_base64_helper.html" + } + } + }, + "/file/density": { + "post": { + "tags": [ + "file", + "beta" + ], + "summary": "Get CAD file density.", + "description": "Get 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.", + "operationId": "create_file_density", + "parameters": [ + { + "in": "query", + "name": "material_mass", + "description": "The material mass.", + "required": true, + "schema": { + "type": "number", + "format": "float" + }, + "style": "form" + }, + { + "in": "query", + "name": "src_format", + "description": "The format of the file.", + "required": true, + "schema": { + "$ref": "#/components/schemas/FileSourceFormat", + "x-scope": [ + "" + ] + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "successful creation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileDensity", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// CreateDensity: Get CAD file density.\n//\n// Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// 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.\n//\n// Parameters:\n//\t- `materialMass`: The material mass.\n//\t- `srcFormat`: The format of the file.\nfileDensity, err := client.File.CreateDensity(materialMass, srcFormat, body)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateDensity" + }, + "x-rust": { + "example": "/**\n* Get CAD file density.\n*\n* This function performs a `POST` to the `/file/density` endpoint.\n*\n* Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n* 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.\n*\n* **Parameters:**\n*\n* * `material_mass: f64` -- The material mass.\n* * `src_format: crate::types::FileSourceFormat` -- The valid types of source file formats.\n*/\nlet file_density = client.file().create_density(material_mass, src_format, body).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/file/struct.File.html#method.create_density" + }, + "x-python": { + "example": "from kittycad.models import FileDensity\nfrom kittycad.api.file import create_file_density\nfrom kittycad.types import Response\n\nfc: FileDensity = create_file_density.sync(client=client, material_mass=\"\", src_format=FileSourceFormat, body=bytes)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileDensity] = create_file_density.sync_detailed(client=client, material_mass=\"\", src_format=FileSourceFormat, body=bytes)\n\n# OR run async\nfc: FileDensity = await create_file_density.asyncio(client=client, material_mass=\"\", src_format=FileSourceFormat, body=bytes)\n\n# OR run async with more info\nresponse: Response[FileDensity] = await create_file_density.asyncio_detailed(client=client, material_mass=\"\", src_format=FileSourceFormat, body=bytes)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.create_file_density.html" + } + } + }, + "/file/execute/{lang}": { + "post": { + "tags": [ + "file", + "hidden" + ], + "summary": "Execute a KittyCAD program in a specific language.", + "operationId": "create_file_execution", + "parameters": [ + { + "in": "path", + "name": "lang", + "description": "The language of the code.", + "required": true, + "schema": { + "$ref": "#/components/schemas/CodeLanguage", + "x-scope": [ + "" + ] + }, + "style": "simple" + }, + { + "in": "query", + "name": "output", + "description": "The output file we want to get the contents for (the paths are relative to where in litterbox it is being run). You can denote more than one file with a comma separated list of string paths.", + "schema": { + "nullable": true, + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CodeOutput", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// CreateExecution: Execute a KittyCAD program in a specific language.\n//\n// Parameters:\n//\t- `lang`: The language of the code.\n//\t- `output`: The output file we want to get the contents for (the paths are relative to where in litterbox it is being run). You can denote more than one file with a comma separated list of string paths.\ncodeOutput, err := client.File.CreateExecution(lang, output, body)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateExecution" + }, + "x-rust": { + "example": "/**\n* Execute a KittyCAD program in a specific language.\n*\n* This function performs a `POST` to the `/file/execute/{lang}` endpoint.\n*\n* **Parameters:**\n*\n* * `lang: crate::types::CodeLanguage` -- The language code is written in.\n* * `output: &str` -- The output file we want to get the contents for (the paths are relative to where in litterbox it is being run). You can denote more than one file with a comma separated list of string paths.\n*/\nlet code_output = client.file().create_execution(lang, output, body).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/file/struct.File.html#method.create_execution" + }, + "x-python": { + "example": "from kittycad.models import CodeOutput\nfrom kittycad.api.file import create_file_execution\nfrom kittycad.types import Response\n\nfc: CodeOutput = create_file_execution.sync(client=client, lang=CodeLanguage, output=, body=bytes)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[CodeOutput] = create_file_execution.sync_detailed(client=client, lang=CodeLanguage, output=, body=bytes)\n\n# OR run async\nfc: CodeOutput = await create_file_execution.asyncio(client=client, lang=CodeLanguage, output=, body=bytes)\n\n# OR run async with more info\nresponse: Response[CodeOutput] = await create_file_execution.asyncio_detailed(client=client, lang=CodeLanguage, output=, body=bytes)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.create_file_execution.html" + } + } + }, + "/file/mass": { + "post": { + "tags": [ + "file", + "beta" + ], + "summary": "Get CAD file mass.", + "description": "Get 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.", + "operationId": "create_file_mass", + "parameters": [ + { + "in": "query", + "name": "material_density", + "description": "The material density.", + "required": true, + "schema": { + "type": "number", + "format": "float" + }, + "style": "form" + }, + { + "in": "query", + "name": "src_format", + "description": "The format of the file.", + "required": true, + "schema": { + "$ref": "#/components/schemas/FileSourceFormat", + "x-scope": [ + "" + ] + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "successful creation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileMass", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// CreateMass: Get CAD file mass.\n//\n// Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// 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.\n//\n// Parameters:\n//\t- `materialDensity`: The material density.\n//\t- `srcFormat`: The format of the file.\nfileMass, err := client.File.CreateMass(materialDensity, srcFormat, body)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateMass" + }, + "x-rust": { + "example": "/**\n* Get CAD file mass.\n*\n* This function performs a `POST` to the `/file/mass` endpoint.\n*\n* Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n* 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.\n*\n* **Parameters:**\n*\n* * `material_density: f64` -- The material density.\n* * `src_format: crate::types::FileSourceFormat` -- The valid types of source file formats.\n*/\nlet file_mass = client.file().create_mass(material_density, src_format, body).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/file/struct.File.html#method.create_mass" + }, + "x-python": { + "example": "from kittycad.models import FileMass\nfrom kittycad.api.file import create_file_mass\nfrom kittycad.types import Response\n\nfc: FileMass = create_file_mass.sync(client=client, material_density=\"\", src_format=FileSourceFormat, body=bytes)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileMass] = create_file_mass.sync_detailed(client=client, material_density=\"\", src_format=FileSourceFormat, body=bytes)\n\n# OR run async\nfc: FileMass = await create_file_mass.asyncio(client=client, material_density=\"\", src_format=FileSourceFormat, body=bytes)\n\n# OR run async with more info\nresponse: Response[FileMass] = await create_file_mass.asyncio_detailed(client=client, material_density=\"\", src_format=FileSourceFormat, body=bytes)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.create_file_mass.html" + } + } + }, + "/file/volume": { + "post": { + "tags": [ + "file", + "beta" + ], + "summary": "Get CAD file volume.", + "description": "Get 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.", + "operationId": "create_file_volume", + "parameters": [ + { + "in": "query", + "name": "src_format", + "description": "The format of the file.", + "required": true, + "schema": { + "$ref": "#/components/schemas/FileSourceFormat", + "x-scope": [ + "" + ] + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "successful creation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileVolume", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// CreateVolume: Get CAD file volume.\n//\n// Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// 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.\n//\n// Parameters:\n//\t- `srcFormat`: The format of the file.\nfileVolume, err := client.File.CreateVolume(srcFormat, body)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateVolume" + }, + "x-rust": { + "example": "/**\n* Get CAD file volume.\n*\n* This function performs a `POST` to the `/file/volume` endpoint.\n*\n* Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n* 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.\n*\n* **Parameters:**\n*\n* * `src_format: crate::types::FileSourceFormat` -- The valid types of source file formats.\n*/\nlet file_volume = client.file().create_volume(src_format, body).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/file/struct.File.html#method.create_volume" + }, + "x-python": { + "example": "from kittycad.models import FileVolume\nfrom kittycad.api.file import create_file_volume\nfrom kittycad.types import Response\n\nfc: FileVolume = create_file_volume.sync(client=client, src_format=FileSourceFormat, body=bytes)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileVolume] = create_file_volume.sync_detailed(client=client, src_format=FileSourceFormat, body=bytes)\n\n# OR run async\nfc: FileVolume = await create_file_volume.asyncio(client=client, src_format=FileSourceFormat, body=bytes)\n\n# OR run async with more info\nresponse: Response[FileVolume] = await create_file_volume.asyncio_detailed(client=client, src_format=FileSourceFormat, body=bytes)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.create_file_volume.html" + } + } + }, + "/login": { + "post": { + "tags": [ + "hidden" + ], + "summary": "This endpoint sets a session cookie for a user.", + "operationId": "login", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LoginParams", + "x-scope": [ + "" + ] + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "resource updated", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Set-Cookie": { + "description": "Set-Cookie header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// Login: This endpoint sets a session cookie for a user.\nif err := client.Hidden.Login(body); err != nil {\n\tpanic(err)\n}", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#HiddenService.Login" + }, + "x-rust": { + "example": "/**\n* This endpoint sets a session cookie for a user.\n*\n* This function performs a `POST` to the `/login` endpoint.\n*/\nclient.hidden().login(body).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/hidden/struct.Hidden.html#method.login" + }, + "x-python": { + "example": "from kittycad.models import Error\nfrom kittycad.api.hidden import login\nfrom kittycad.types import Response\n\nfc: Error = login.sync(client=client, body=LoginParams)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Error] = login.sync_detailed(client=client, body=LoginParams)\n\n# OR run async\nfc: Error = await login.asyncio(client=client, body=LoginParams)\n\n# OR run async with more info\nresponse: Response[Error] = await login.asyncio_detailed(client=client, body=LoginParams)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.hidden.login.html" + } + } + }, + "/ping": { + "get": { + "tags": [ + "meta" + ], + "summary": "Return pong.", + "operationId": "ping", + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pong", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// Ping: Return pong.\npong, err := client.Meta.Ping()", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#MetaService.Ping" + }, + "x-rust": { + "example": "/**\n* Return pong.\n*\n* This function performs a `GET` to the `/ping` endpoint.\n*/\nlet pong = client.meta().ping().await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/meta/struct.Meta.html#method.ping" + }, + "x-python": { + "example": "from kittycad.models import Pong\nfrom kittycad.api.meta import ping\nfrom kittycad.types import Response\n\nfc: Pong = ping.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Pong] = ping.sync_detailed(client=client)\n\n# OR run async\nfc: Pong = await ping.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[Pong] = await ping.asyncio_detailed(client=client)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.meta.ping.html" + } + } + }, + "/unit/conversion/{src_format}/{output_format}": { + "post": { + "tags": [ + "unit" + ], + "summary": "Convert units.", + "description": "Convert a metric unit value to another metric unit value. This is a nice endpoint to use for helper functions.", + "operationId": "create_unit_conversion", + "parameters": [ + { + "in": "path", + "name": "output_format", + "description": "The output format of the unit.", + "required": true, + "schema": { + "$ref": "#/components/schemas/UnitMetricFormat", + "x-scope": [ + "" + ] + }, + "style": "simple" + }, + { + "in": "path", + "name": "src_format", + "description": "The source format of the unit.", + "required": true, + "schema": { + "$ref": "#/components/schemas/UnitMetricFormat", + "x-scope": [ + "" + ] + }, + "style": "simple" + }, + { + "in": "query", + "name": "value", + "description": "The initial value.", + "required": true, + "schema": { + "type": "number", + "format": "float" + }, + "style": "form" + } + ], + "responses": { + "201": { + "description": "successful creation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnitConversion", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// CreateConversion: Convert units.\n//\n// Convert a metric unit value to another metric unit value. This is a nice endpoint to use for helper functions.\n//\n// Parameters:\n//\t- `outputFormat`: The output format of the unit.\n//\t- `srcFormat`: The source format of the unit.\n//\t- `value`: The initial value.\nunitConversion, err := client.Unit.CreateConversion(outputFormat, srcFormat, value)\n\n// - OR -\n\n// CreateConversionWithBase64Helper will automatically base64 encode and decode the contents\n// of the file body.\n//\n// This function is a wrapper around the CreateConversion function.\nunitConversion, err := client.Unit.CreateConversionWithBase64Helper(outputFormat, srcFormat, value)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UnitService.CreateConversion" + }, + "x-rust": { + "example": "/**\n* Convert units.\n*\n* This function performs a `POST` to the `/unit/conversion/{src_format}/{output_format}` endpoint.\n*\n* Convert a metric unit value to another metric unit value. This is a nice endpoint to use for helper functions.\n*\n* **Parameters:**\n*\n* * `output_format: crate::types::UnitMetricFormat` -- The valid types of metric unit formats.\n* * `src_format: crate::types::UnitMetricFormat` -- The valid types of metric unit formats.\n* * `value: f64` -- The initial value.\n*/\nlet unit_conversion = client.unit().create_conversion(output_format, src_format, value).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/unit/struct.Unit.html#method.create_conversion" + }, + "x-python": { + "example": "from kittycad.models import UnitConversion\nfrom kittycad.api.unit import create_unit_conversion\nfrom kittycad.types import Response\n\nfc: UnitConversion = create_unit_conversion.sync(client=client, output_format=UnitMetricFormat, src_format=UnitMetricFormat, value=\"\")\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[UnitConversion] = create_unit_conversion.sync_detailed(client=client, output_format=UnitMetricFormat, src_format=UnitMetricFormat, value=\"\")\n\n# OR run async\nfc: UnitConversion = await create_unit_conversion.asyncio(client=client, output_format=UnitMetricFormat, src_format=UnitMetricFormat, value=\"\")\n\n# OR run async with more info\nresponse: Response[UnitConversion] = await create_unit_conversion.asyncio_detailed(client=client, output_format=UnitMetricFormat, src_format=UnitMetricFormat, value=\"\")", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.unit.create_unit_conversion.html" + } + } + }, + "/user": { + "get": { + "tags": [ + "users" + ], + "summary": "Get your user.", + "description": "Get the user information for the authenticated user.\nAlternatively, you can also use the `/users/me` endpoint.", + "operationId": "get_user_self", + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// GetSelf: Get your user.\n//\n// Get the user information for the authenticated user.\n// Alternatively, you can also use the `/users/me` endpoint.\nuser, err := client.User.GetSelf()", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.GetSelf" + }, + "x-rust": { + "example": "/**\n* Get your user.\n*\n* This function performs a `GET` to the `/user` endpoint.\n*\n* Get the user information for the authenticated user.\n* Alternatively, you can also use the `/users/me` endpoint.\n*/\nlet user = client.users().get_self().await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/users/struct.Users.html#method.get_self" + }, + "x-python": { + "example": "from kittycad.models import User\nfrom kittycad.api.users import get_user_self\nfrom kittycad.types import Response\n\nfc: User = get_user_self.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[User] = get_user_self.sync_detailed(client=client)\n\n# OR run async\nfc: User = await get_user_self.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[User] = await get_user_self.asyncio_detailed(client=client)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.get_user_self.html" + } + }, + "put": { + "tags": [ + "users" + ], + "summary": "Update your user.", + "description": "This endpoint requires authentication by any KittyCAD user. It updates information about the authenticated user.", + "operationId": "update_user_self", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateUser", + "x-scope": [ + "" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// UpdateSelf: Update your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It updates information about the authenticated user.\nuser, err := client.User.UpdateSelf(body)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.UpdateSelf" + }, + "x-rust": { + "example": "/**\n* Update your user.\n*\n* This function performs a `PUT` to the `/user` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It updates information about the authenticated user.\n*/\nlet user = client.users().update_self(body).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/users/struct.Users.html#method.update_self" + }, + "x-python": { + "example": "from kittycad.models import User\nfrom kittycad.api.users import update_user_self\nfrom kittycad.types import Response\n\nfc: User = update_user_self.sync(client=client, body=UpdateUser)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[User] = update_user_self.sync_detailed(client=client, body=UpdateUser)\n\n# OR run async\nfc: User = await update_user_self.asyncio(client=client, body=UpdateUser)\n\n# OR run async with more info\nresponse: Response[User] = await update_user_self.asyncio_detailed(client=client, body=UpdateUser)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.update_user_self.html" + } + }, + "options": { + "tags": [ + "hidden" + ], + "summary": "OPTIONS endpoint for users.", + "description": "This is necessary for some preflight requests, specifically DELETE and PUT.", + "operationId": "options_user_self", + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "title": "Null", + "type": "string", + "enum": [ + null + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + } + } + }, + "/user/api-calls": { + "get": { + "tags": [ + "api-calls" + ], + "summary": "List API calls for your user.", + "description": "This endpoint requires authentication by any KittyCAD 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.", + "operationId": "user_list_api_calls", + "parameters": [ + { + "in": "query", + "name": "limit", + "description": "Maximum number of items returned by a single call", + "schema": { + "nullable": true, + "type": "integer", + "format": "uint32", + "minimum": 1 + }, + "style": "form" + }, + { + "in": "query", + "name": "page_token", + "description": "Token returned by previous call to retrieve the subsequent page", + "schema": { + "nullable": true, + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "$ref": "#/components/schemas/CreatedAtSortMode", + "x-scope": [ + "" + ] + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCallWithPriceResultsPage", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-dropshot-pagination": true, + "x-go": { + "example": "// UserList: List API calls for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// To iterate over all pages, use the `UserListAllPages` method, instead.\n//\n// Parameters:\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\naPICallWithPriceResultsPage, err := client.APICall.UserList(limit, pageToken, sortBy)\n\n// - OR -\n\n// UserListAllPages: List API calls for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// This method is a wrapper around the `UserList` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `sortBy`\nAPICallWithPrice, err := client.APICall.UserListAllPages(sortBy)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.UserList" + }, + "x-rust": { + "example": "/**\n* List API calls for your user.\n*\n* This function performs a `GET` to the `/user/api-calls` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user.\n* The API calls are returned in order of creation, with the most recently created API calls first.\n*\n* **Parameters:**\n*\n* * `limit: u32` -- Maximum number of items returned by a single call.\n* * `page_token: &str` -- Token returned by previous call to retrieve the subsequent page.\n* * `sort_by: crate::types::CreatedAtSortMode` -- Supported set of sort modes for scanning by created_at only.\n* \n* Currently, we only support scanning in ascending order.\n*/\nlet vec_crate_types_api_call_with_price = client.api_calls().user_list_calls(limit, page_token, sort_by).await?;\n\n// - OR -\n\n/**\n* List API calls for your user.\n*\n* This function performs a `GET` to the `/user/api-calls` endpoint.\n*\n* As opposed to `user_list_calls`, this function returns all the pages of the request at once.\n*\n* This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user.\n* The API calls are returned in order of creation, with the most recently created API calls first.\n*/\nlet vec_crate_types_api_call_with_price = client.api_calls().user_list_all_calls(sort_by).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/api_calls/struct.ApiCalls.html#method.user_list_calls" + }, + "x-python": { + "example": "from kittycad.models import ApiCallWithPriceResultsPage\nfrom kittycad.api.api-calls import user_list_api_calls\nfrom kittycad.types import Response\n\nfc: ApiCallWithPriceResultsPage = user_list_api_calls.sync(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiCallWithPriceResultsPage] = user_list_api_calls.sync_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async\nfc: ApiCallWithPriceResultsPage = await user_list_api_calls.asyncio(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async with more info\nresponse: Response[ApiCallWithPriceResultsPage] = await user_list_api_calls.asyncio_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.user_list_api_calls.html" + } + } + }, + "/user/api-calls/{id}": { + "get": { + "tags": [ + "api-calls" + ], + "summary": "Get an API call for a user.", + "description": "This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.", + "operationId": "get_api_call_for_user", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the API call.", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCallWithPrice", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// GetForUser: Get an API call for a user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.\n//\n// Parameters:\n//\t- `id`: The ID of the API call.\naPICallWithPrice, err := client.APICall.GetForUser(id)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.GetForUser" + }, + "x-rust": { + "example": "/**\n* Get an API call for a user.\n*\n* This function performs a `GET` to the `/user/api-calls/{id}` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.\n*\n* **Parameters:**\n*\n* * `id: &str` -- The ID of the API call.\n*/\nlet api_call_with_price = client.api_calls().get_call_for_user(id).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/api_calls/struct.ApiCalls.html#method.get_call_for_user" + }, + "x-python": { + "example": "from kittycad.models import ApiCallWithPrice\nfrom kittycad.api.api-calls import get_api_call_for_user\nfrom kittycad.types import Response\n\nfc: ApiCallWithPrice = get_api_call_for_user.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiCallWithPrice] = get_api_call_for_user.sync_detailed(client=client, id=)\n\n# OR run async\nfc: ApiCallWithPrice = await get_api_call_for_user.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[ApiCallWithPrice] = await get_api_call_for_user.asyncio_detailed(client=client, id=)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.get_api_call_for_user.html" + } + } + }, + "/user/api-tokens": { + "get": { + "tags": [ + "api-tokens" + ], + "summary": "List API tokens for your user.", + "description": "This endpoint requires authentication by any KittyCAD 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.", + "operationId": "list_api_tokens_for_user", + "parameters": [ + { + "in": "query", + "name": "limit", + "description": "Maximum number of items returned by a single call", + "schema": { + "nullable": true, + "type": "integer", + "format": "uint32", + "minimum": 1 + }, + "style": "form" + }, + { + "in": "query", + "name": "page_token", + "description": "Token returned by previous call to retrieve the subsequent page", + "schema": { + "nullable": true, + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "$ref": "#/components/schemas/CreatedAtSortMode", + "x-scope": [ + "" + ] + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiTokenResultsPage", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-dropshot-pagination": true, + "x-go": { + "example": "// ListForUser: List API tokens for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns the API tokens for the authenticated user.\n// The API tokens are returned in order of creation, with the most recently created API tokens first.\n//\n// To iterate over all pages, use the `ListForUserAllPages` method, instead.\n//\n// Parameters:\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\naPITokenResultsPage, err := client.APIToken.ListForUser(limit, pageToken, sortBy)\n\n// - OR -\n\n// ListForUserAllPages: List API tokens for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns the API tokens for the authenticated user.\n// The API tokens are returned in order of creation, with the most recently created API tokens first.\n//\n// This method is a wrapper around the `ListForUser` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `sortBy`\nAPIToken, err := client.APIToken.ListForUserAllPages(sortBy)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APITokenService.ListForUser" + }, + "x-rust": { + "example": "/**\n* List API tokens for your user.\n*\n* This function performs a `GET` to the `/user/api-tokens` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It returns the API tokens for the authenticated user.\n* The API tokens are returned in order of creation, with the most recently created API tokens first.\n*\n* **Parameters:**\n*\n* * `limit: u32` -- Maximum number of items returned by a single call.\n* * `page_token: &str` -- Token returned by previous call to retrieve the subsequent page.\n* * `sort_by: crate::types::CreatedAtSortMode` -- Supported set of sort modes for scanning by created_at only.\n* \n* Currently, we only support scanning in ascending order.\n*/\nlet vec_crate_types_api_token = client.api_tokens().list_tokens_for_user(limit, page_token, sort_by).await?;\n\n// - OR -\n\n/**\n* List API tokens for your user.\n*\n* This function performs a `GET` to the `/user/api-tokens` endpoint.\n*\n* As opposed to `list_tokens_for_user`, this function returns all the pages of the request at once.\n*\n* This endpoint requires authentication by any KittyCAD user. It returns the API tokens for the authenticated user.\n* The API tokens are returned in order of creation, with the most recently created API tokens first.\n*/\nlet vec_crate_types_api_token = client.api_tokens().list_all_tokens_for_user(sort_by).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/api_tokens/struct.ApiTokens.html#method.list_tokens_for_user" + }, + "x-python": { + "example": "from kittycad.models import ApiTokenResultsPage\nfrom kittycad.api.api-tokens import list_api_tokens_for_user\nfrom kittycad.types import Response\n\nfc: ApiTokenResultsPage = list_api_tokens_for_user.sync(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiTokenResultsPage] = list_api_tokens_for_user.sync_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async\nfc: ApiTokenResultsPage = await list_api_tokens_for_user.asyncio(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async with more info\nresponse: Response[ApiTokenResultsPage] = await list_api_tokens_for_user.asyncio_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-tokens.list_api_tokens_for_user.html" + } + }, + "post": { + "tags": [ + "api-tokens" + ], + "summary": "Create a new API token for your user.", + "description": "This endpoint requires authentication by any KittyCAD user. It creates a new API token for the authenticated user.", + "operationId": "create_api_token_for_user", + "responses": { + "201": { + "description": "successful creation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiToken", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// CreateForUser: Create a new API token for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It creates a new API token for the authenticated user.\naPIToken, err := client.APIToken.CreateForUser()", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APITokenService.CreateForUser" + }, + "x-rust": { + "example": "/**\n* Create a new API token for your user.\n*\n* This function performs a `POST` to the `/user/api-tokens` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It creates a new API token for the authenticated user.\n*/\nlet api_token = client.api_tokens().create_token_for_user().await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/api_tokens/struct.ApiTokens.html#method.create_token_for_user" + }, + "x-python": { + "example": "from kittycad.models import ApiToken\nfrom kittycad.api.api-tokens import create_api_token_for_user\nfrom kittycad.types import Response\n\nfc: ApiToken = create_api_token_for_user.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiToken] = create_api_token_for_user.sync_detailed(client=client)\n\n# OR run async\nfc: ApiToken = await create_api_token_for_user.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[ApiToken] = await create_api_token_for_user.asyncio_detailed(client=client)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-tokens.create_api_token_for_user.html" + } + } + }, + "/user/api-tokens/{token}": { + "get": { + "tags": [ + "api-tokens" + ], + "summary": "Get an API token for your user.", + "description": "This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.", + "operationId": "get_api_token_for_user", + "parameters": [ + { + "in": "path", + "name": "token", + "description": "The API token.", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiToken", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// GetForUser: Get an API token for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.\n//\n// Parameters:\n//\t- `token`: The API token.\naPIToken, err := client.APIToken.GetForUser(token)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APITokenService.GetForUser" + }, + "x-rust": { + "example": "/**\n* Get an API token for your user.\n*\n* This function performs a `GET` to the `/user/api-tokens/{token}` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.\n*\n* **Parameters:**\n*\n* * `token: &str` -- The API token.\n*/\nlet api_token = client.api_tokens().get_token_for_user(token).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/api_tokens/struct.ApiTokens.html#method.get_token_for_user" + }, + "x-python": { + "example": "from kittycad.models import ApiToken\nfrom kittycad.api.api-tokens import get_api_token_for_user\nfrom kittycad.types import Response\n\nfc: ApiToken = get_api_token_for_user.sync(client=client, token=\"\")\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiToken] = get_api_token_for_user.sync_detailed(client=client, token=\"\")\n\n# OR run async\nfc: ApiToken = await get_api_token_for_user.asyncio(client=client, token=\"\")\n\n# OR run async with more info\nresponse: Response[ApiToken] = await get_api_token_for_user.asyncio_detailed(client=client, token=\"\")", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-tokens.get_api_token_for_user.html" + } + }, + "delete": { + "tags": [ + "api-tokens" + ], + "summary": "Delete an API token for your user.", + "description": "This endpoint requires authentication by any KittyCAD 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.", + "operationId": "delete_api_token_for_user", + "parameters": [ + { + "in": "path", + "name": "token", + "description": "The API token.", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + }, + "style": "simple" + } + ], + "responses": { + "204": { + "description": "successful deletion", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// DeleteForUser: Delete an API token for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It deletes the requested API token for the user.\n// 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.\n//\n// Parameters:\n//\t- `token`: The API token.\nif err := client.APIToken.DeleteForUser(token); err != nil {\n\tpanic(err)\n}", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APITokenService.DeleteForUser" + }, + "x-rust": { + "example": "/**\n* Delete an API token for your user.\n*\n* This function performs a `DELETE` to the `/user/api-tokens/{token}` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It deletes the requested API token for the user.\n* 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.\n*\n* **Parameters:**\n*\n* * `token: &str` -- The API token.\n*/\nclient.api_tokens().delete_token_for_user(token).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/api_tokens/struct.ApiTokens.html#method.delete_token_for_user" + }, + "x-python": { + "example": "from kittycad.models import Error\nfrom kittycad.api.api-tokens import delete_api_token_for_user\nfrom kittycad.types import Response\n\nfc: Error = delete_api_token_for_user.sync(client=client, token=\"\")\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Error] = delete_api_token_for_user.sync_detailed(client=client, token=\"\")\n\n# OR run async\nfc: Error = await delete_api_token_for_user.asyncio(client=client, token=\"\")\n\n# OR run async with more info\nresponse: Response[Error] = await delete_api_token_for_user.asyncio_detailed(client=client, token=\"\")", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-tokens.delete_api_token_for_user.html" + } + }, + "options": { + "tags": [ + "hidden" + ], + "summary": "OPTIONS endpoint for API tokens.", + "description": "This is necessary for some preflight requests, specifically DELETE.", + "operationId": "options_api_token_for_user", + "parameters": [ + { + "in": "path", + "name": "token", + "description": "The API token.", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "title": "Null", + "type": "string", + "enum": [ + null + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + } + } + }, + "/user/extended": { + "get": { + "tags": [ + "users" + ], + "summary": "Get extended information about your user.", + "description": "Get the user information for the authenticated user.\nAlternatively, you can also use the `/users/me` endpoint.", + "operationId": "get_user_self_extended", + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedUser", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// GetSelfExtended: Get extended information about your user.\n//\n// Get the user information for the authenticated user.\n// Alternatively, you can also use the `/users/me` endpoint.\nextendedUser, err := client.User.GetSelfExtended()", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.GetSelfExtended" + }, + "x-rust": { + "example": "/**\n* Get extended information about your user.\n*\n* This function performs a `GET` to the `/user/extended` endpoint.\n*\n* Get the user information for the authenticated user.\n* Alternatively, you can also use the `/users/me` endpoint.\n*/\nlet extended_user = client.users().get_self_extended().await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/users/struct.Users.html#method.get_self_extended" + }, + "x-python": { + "example": "from kittycad.models import ExtendedUser\nfrom kittycad.api.users import get_user_self_extended\nfrom kittycad.types import Response\n\nfc: ExtendedUser = get_user_self_extended.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ExtendedUser] = get_user_self_extended.sync_detailed(client=client)\n\n# OR run async\nfc: ExtendedUser = await get_user_self_extended.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[ExtendedUser] = await get_user_self_extended.asyncio_detailed(client=client)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.get_user_self_extended.html" + } + } + }, + "/user/file/conversions/{id}": { + "get": { + "tags": [ + "file" + ], + "summary": "Get a file conversion for your user.", + "description": "Get the status and output of an async file conversion. If completed, the contents of the converted file (`output`) will be returned as a base64 encoded string.\nThis endpoint requires authentication by any KittyCAD user. It returns details of the requested file conversion for the user.", + "operationId": "get_file_conversion_for_user", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the async operation.", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncApiCallOutput", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// GetConversionForUser: Get a file conversion for your user.\n//\n// Get the status and output of an async file conversion. If completed, the contents of the converted file (`output`) will be returned as a base64 encoded string.\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested file conversion for the user.\n//\n// Parameters:\n//\t- `id`: The ID of the async operation.\nasyncAPICallOutput, err := client.File.GetConversionForUser(id)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.GetConversionForUser" + }, + "x-rust": { + "example": "/**\n* Get a file conversion for your user.\n*\n* This function performs a `GET` to the `/user/file/conversions/{id}` endpoint.\n*\n* Get the status and output of an async file conversion. If completed, the contents of the converted file (`output`) will be returned as a base64 encoded string.\n* This endpoint requires authentication by any KittyCAD user. It returns details of the requested file conversion for the user.\n*\n* **Parameters:**\n*\n* * `id: &str` -- The ID of the async operation.\n*/\nlet async_api_call_output = client.file().get_conversion_for_user(id).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/file/struct.File.html#method.get_conversion_for_user" + }, + "x-python": { + "example": "from kittycad.models import FileConversion\nfrom kittycad.api.file import get_file_conversion_for_user\nfrom kittycad.types import Response\n\nfc: FileConversion = get_file_conversion_for_user.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileConversion] = get_file_conversion_for_user.sync_detailed(client=client, id=)\n\n# OR run async\nfc: FileConversion = await get_file_conversion_for_user.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[FileConversion] = await get_file_conversion_for_user.asyncio_detailed(client=client, id=)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.get_file_conversion_for_user.html" + } + } + }, + "/user/payment": { + "get": { + "tags": [ + "payments" + ], + "summary": "Get payment info about your user.", + "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by any KittyCAD user. It gets the payment information for the authenticated user.", + "operationId": "get_payment_information_for_user", + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Customer", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// GetInformationForUser: Get payment info about your user.\n//\n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It gets the payment information for the authenticated user.\ncustomer, err := client.Payment.GetInformationForUser()", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.GetInformationForUser" + }, + "x-rust": { + "example": "/**\n* Get payment info about your user.\n*\n* This function performs a `GET` to the `/user/payment` endpoint.\n*\n* This includes billing address, phone, and name.\n* This endpoint requires authentication by any KittyCAD user. It gets the payment information for the authenticated user.\n*/\nlet customer = client.payments().get_information_for_user().await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/payments/struct.Payments.html#method.get_information_for_user" + }, + "x-python": { + "example": "from kittycad.models import Customer\nfrom kittycad.api.payments import get_payment_information_for_user\nfrom kittycad.types import Response\n\nfc: Customer = get_payment_information_for_user.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Customer] = get_payment_information_for_user.sync_detailed(client=client)\n\n# OR run async\nfc: Customer = await get_payment_information_for_user.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[Customer] = await get_payment_information_for_user.asyncio_detailed(client=client)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.get_payment_information_for_user.html" + } + }, + "put": { + "tags": [ + "payments" + ], + "summary": "Update payment info for your user.", + "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by any KittyCAD user. It updates the payment information for the authenticated user.", + "operationId": "update_payment_information_for_user", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BillingInfo", + "x-scope": [ + "" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Customer", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// UpdateInformationForUser: Update payment info for your user.\n//\n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It updates the payment information for the authenticated user.\ncustomer, err := client.Payment.UpdateInformationForUser(body)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.UpdateInformationForUser" + }, + "x-rust": { + "example": "/**\n* Update payment info for your user.\n*\n* This function performs a `PUT` to the `/user/payment` endpoint.\n*\n* This includes billing address, phone, and name.\n* This endpoint requires authentication by any KittyCAD user. It updates the payment information for the authenticated user.\n*/\nlet customer = client.payments().update_information_for_user(body).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/payments/struct.Payments.html#method.update_information_for_user" + }, + "x-python": { + "example": "from kittycad.models import Customer\nfrom kittycad.api.payments import update_payment_information_for_user\nfrom kittycad.types import Response\n\nfc: Customer = update_payment_information_for_user.sync(client=client, body=BillingInfo)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Customer] = update_payment_information_for_user.sync_detailed(client=client, body=BillingInfo)\n\n# OR run async\nfc: Customer = await update_payment_information_for_user.asyncio(client=client, body=BillingInfo)\n\n# OR run async with more info\nresponse: Response[Customer] = await update_payment_information_for_user.asyncio_detailed(client=client, body=BillingInfo)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.update_payment_information_for_user.html" + } + }, + "post": { + "tags": [ + "payments" + ], + "summary": "Create payment info for your user.", + "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by any KittyCAD user. It creates the payment information for the authenticated user.", + "operationId": "create_payment_information_for_user", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BillingInfo", + "x-scope": [ + "" + ] + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "successful creation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Customer", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// CreateInformationForUser: Create payment info for your user.\n//\n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It creates the payment information for the authenticated user.\ncustomer, err := client.Payment.CreateInformationForUser(body)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.CreateInformationForUser" + }, + "x-rust": { + "example": "/**\n* Create payment info for your user.\n*\n* This function performs a `POST` to the `/user/payment` endpoint.\n*\n* This includes billing address, phone, and name.\n* This endpoint requires authentication by any KittyCAD user. It creates the payment information for the authenticated user.\n*/\nlet customer = client.payments().create_information_for_user(body).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/payments/struct.Payments.html#method.create_information_for_user" + }, + "x-python": { + "example": "from kittycad.models import Customer\nfrom kittycad.api.payments import create_payment_information_for_user\nfrom kittycad.types import Response\n\nfc: Customer = create_payment_information_for_user.sync(client=client, body=BillingInfo)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Customer] = create_payment_information_for_user.sync_detailed(client=client, body=BillingInfo)\n\n# OR run async\nfc: Customer = await create_payment_information_for_user.asyncio(client=client, body=BillingInfo)\n\n# OR run async with more info\nresponse: Response[Customer] = await create_payment_information_for_user.asyncio_detailed(client=client, body=BillingInfo)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.create_payment_information_for_user.html" + } + }, + "delete": { + "tags": [ + "payments" + ], + "summary": "Delete payment info for your user.", + "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by any KittyCAD user. It deletes the payment information for the authenticated user.", + "operationId": "delete_payment_information_for_user", + "responses": { + "204": { + "description": "successful deletion", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// DeleteInformationForUser: Delete payment info for your user.\n//\n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It deletes the payment information for the authenticated user.\nif err := client.Payment.DeleteInformationForUser(); err != nil {\n\tpanic(err)\n}", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.DeleteInformationForUser" + }, + "x-rust": { + "example": "/**\n* Delete payment info for your user.\n*\n* This function performs a `DELETE` to the `/user/payment` endpoint.\n*\n* This includes billing address, phone, and name.\n* This endpoint requires authentication by any KittyCAD user. It deletes the payment information for the authenticated user.\n*/\nclient.payments().delete_information_for_user().await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/payments/struct.Payments.html#method.delete_information_for_user" + }, + "x-python": { + "example": "from kittycad.models import Error\nfrom kittycad.api.payments import delete_payment_information_for_user\nfrom kittycad.types import Response\n\nfc: Error = delete_payment_information_for_user.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Error] = delete_payment_information_for_user.sync_detailed(client=client)\n\n# OR run async\nfc: Error = await delete_payment_information_for_user.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[Error] = await delete_payment_information_for_user.asyncio_detailed(client=client)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.delete_payment_information_for_user.html" + } + }, + "options": { + "tags": [ + "hidden" + ], + "summary": "OPTIONS endpoint for user payment information.", + "description": "This is necessary for some preflight requests, specifically DELETE and PUT.", + "operationId": "options_payment_information_for_user", + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "title": "Null", + "type": "string", + "enum": [ + null + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + } + } + }, + "/user/payment/intent": { + "post": { + "tags": [ + "payments", + "hidden" + ], + "summary": "Create a payment intent for your user.", + "description": "This endpoint requires authentication by any KittyCAD user. It creates a new payment intent for the authenticated user.", + "operationId": "create_payment_intent_for_user", + "responses": { + "201": { + "description": "successful creation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentIntent", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// CreateIntentForUser: Create a payment intent for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It creates a new payment intent for the authenticated user.\npaymentIntent, err := client.Payment.CreateIntentForUser()", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.CreateIntentForUser" + }, + "x-rust": { + "example": "/**\n* Create a payment intent for your user.\n*\n* This function performs a `POST` to the `/user/payment/intent` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It creates a new payment intent for the authenticated user.\n*/\nlet payment_intent = client.payments().create_intent_for_user().await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/payments/struct.Payments.html#method.create_intent_for_user" + }, + "x-python": { + "example": "from kittycad.models import PaymentIntent\nfrom kittycad.api.payments import create_payment_intent_for_user\nfrom kittycad.types import Response\n\nfc: PaymentIntent = create_payment_intent_for_user.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[PaymentIntent] = create_payment_intent_for_user.sync_detailed(client=client)\n\n# OR run async\nfc: PaymentIntent = await create_payment_intent_for_user.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[PaymentIntent] = await create_payment_intent_for_user.asyncio_detailed(client=client)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.create_payment_intent_for_user.html" + } + } + }, + "/user/payment/invoices": { + "get": { + "tags": [ + "payments" + ], + "summary": "List invoices for your user.", + "description": "This endpoint requires authentication by any KittyCAD user. It lists invoices for the authenticated user.", + "operationId": "list_invoices_for_user", + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "title": "Array_of_Invoice", + "type": "array", + "items": { + "$ref": "#/components/schemas/Invoice", + "x-scope": [ + "" + ] + } + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// ListInvoicesForUser: List invoices for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It lists invoices for the authenticated user.\nInvoice, err := client.Payment.ListInvoicesForUser()", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.ListInvoicesForUser" + }, + "x-rust": { + "example": "/**\n* List invoices for your user.\n*\n* This function performs a `GET` to the `/user/payment/invoices` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It lists invoices for the authenticated user.\n*/\nlet vec_crate_types_invoice = client.payments().list_invoices_for_user().await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/payments/struct.Payments.html#method.list_invoices_for_user" + }, + "x-python": { + "example": "from kittycad.models import [Invoice]\nfrom kittycad.api.payments import list_invoices_for_user\nfrom kittycad.types import Response\n\nfc: [Invoice] = list_invoices_for_user.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[[Invoice]] = list_invoices_for_user.sync_detailed(client=client)\n\n# OR run async\nfc: [Invoice] = await list_invoices_for_user.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[[Invoice]] = await list_invoices_for_user.asyncio_detailed(client=client)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.list_invoices_for_user.html" + } + } + }, + "/user/payment/methods": { + "get": { + "tags": [ + "payments" + ], + "summary": "List payment methods for your user.", + "description": "This endpoint requires authentication by any KittyCAD user. It lists payment methods for the authenticated user.", + "operationId": "list_payment_methods_for_user", + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "title": "Array_of_PaymentMethod", + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod", + "x-scope": [ + "" + ] + } + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// ListMethodsForUser: List payment methods for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It lists payment methods for the authenticated user.\nPaymentMethod, err := client.Payment.ListMethodsForUser()", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.ListMethodsForUser" + }, + "x-rust": { + "example": "/**\n* List payment methods for your user.\n*\n* This function performs a `GET` to the `/user/payment/methods` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It lists payment methods for the authenticated user.\n*/\nlet vec_crate_types_payment_method = client.payments().list_methods_for_user().await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/payments/struct.Payments.html#method.list_methods_for_user" + }, + "x-python": { + "example": "from kittycad.models import [PaymentMethod]\nfrom kittycad.api.payments import list_payment_methods_for_user\nfrom kittycad.types import Response\n\nfc: [PaymentMethod] = list_payment_methods_for_user.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[[PaymentMethod]] = list_payment_methods_for_user.sync_detailed(client=client)\n\n# OR run async\nfc: [PaymentMethod] = await list_payment_methods_for_user.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[[PaymentMethod]] = await list_payment_methods_for_user.asyncio_detailed(client=client)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.list_payment_methods_for_user.html" + } + } + }, + "/user/payment/methods/{id}": { + "delete": { + "tags": [ + "payments", + "hidden" + ], + "summary": "Delete a payment method for your user.", + "description": "This endpoint requires authentication by any KittyCAD user. It deletes the specified payment method for the authenticated user.", + "operationId": "delete_payment_method_for_user", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the payment method.", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + ], + "responses": { + "204": { + "description": "successful deletion", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// DeleteMethodForUser: Delete a payment method for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It deletes the specified payment method for the authenticated user.\n//\n// Parameters:\n//\t- `id`: The ID of the payment method.\nif err := client.Payment.DeleteMethodForUser(id); err != nil {\n\tpanic(err)\n}", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.DeleteMethodForUser" + }, + "x-rust": { + "example": "/**\n* Delete a payment method for your user.\n*\n* This function performs a `DELETE` to the `/user/payment/methods/{id}` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It deletes the specified payment method for the authenticated user.\n*\n* **Parameters:**\n*\n* * `id: &str` -- The ID of the payment method.\n*/\nclient.payments().delete_method_for_user(id).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/payments/struct.Payments.html#method.delete_method_for_user" + }, + "x-python": { + "example": "from kittycad.models import Error\nfrom kittycad.api.payments import delete_payment_method_for_user\nfrom kittycad.types import Response\n\nfc: Error = delete_payment_method_for_user.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Error] = delete_payment_method_for_user.sync_detailed(client=client, id=)\n\n# OR run async\nfc: Error = await delete_payment_method_for_user.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[Error] = await delete_payment_method_for_user.asyncio_detailed(client=client, id=)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.delete_payment_method_for_user.html" + } + }, + "options": { + "tags": [ + "hidden" + ], + "summary": "OPTIONS endpoint for user payment methods.", + "description": "This is necessary for some preflight requests, specifically DELETE.", + "operationId": "options_payment_methods_for_user", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The ID of the payment method.", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "title": "Null", + "type": "string", + "enum": [ + null + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + } + } + }, + "/user/session/{token}": { + "get": { + "tags": [ + "sessions" + ], + "summary": "Get a session for your user.", + "description": "This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.", + "operationId": "get_session_for_user", + "parameters": [ + { + "in": "path", + "name": "token", + "description": "The API token.", + "required": true, + "schema": { + "type": "string", + "format": "uuid" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Session", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// GetForUser: Get a session for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.\n//\n// Parameters:\n//\t- `token`: The API token.\nsession, err := client.Session.GetForUser(token)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#SessionService.GetForUser" + }, + "x-rust": { + "example": "/**\n* Get a session for your user.\n*\n* This function performs a `GET` to the `/user/session/{token}` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.\n*\n* **Parameters:**\n*\n* * `token: &str` -- The API token.\n*/\nlet session = client.sessions().get_for_user(token).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/sessions/struct.Sessions.html#method.get_for_user" + }, + "x-python": { + "example": "from kittycad.models import Session\nfrom kittycad.api.sessions import get_session_for_user\nfrom kittycad.types import Response\n\nfc: Session = get_session_for_user.sync(client=client, token=\"\")\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Session] = get_session_for_user.sync_detailed(client=client, token=\"\")\n\n# OR run async\nfc: Session = await get_session_for_user.asyncio(client=client, token=\"\")\n\n# OR run async with more info\nresponse: Response[Session] = await get_session_for_user.asyncio_detailed(client=client, token=\"\")", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.sessions.get_session_for_user.html" + } + } + }, + "/users": { + "get": { + "tags": [ + "users", + "hidden" + ], + "summary": "List users.", + "description": "This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.", + "operationId": "list_users", + "parameters": [ + { + "in": "query", + "name": "limit", + "description": "Maximum number of items returned by a single call", + "schema": { + "nullable": true, + "type": "integer", + "format": "uint32", + "minimum": 1 + }, + "style": "form" + }, + { + "in": "query", + "name": "page_token", + "description": "Token returned by previous call to retrieve the subsequent page", + "schema": { + "nullable": true, + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "$ref": "#/components/schemas/CreatedAtSortMode", + "x-scope": [ + "" + ] + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserResultsPage", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-dropshot-pagination": true, + "x-go": { + "example": "// List: List users.\n//\n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n//\n// To iterate over all pages, use the `ListAllPages` method, instead.\n//\n// Parameters:\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\nuserResultsPage, err := client.User.List(limit, pageToken, sortBy)\n\n// - OR -\n\n// ListAllPages: List users.\n//\n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n//\n// This method is a wrapper around the `List` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `sortBy`\nUser, err := client.User.ListAllPages(sortBy)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.List" + }, + "x-rust": { + "example": "/**\n* List users.\n*\n* This function performs a `GET` to the `/users` endpoint.\n*\n* This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n*\n* **Parameters:**\n*\n* * `limit: u32` -- Maximum number of items returned by a single call.\n* * `page_token: &str` -- Token returned by previous call to retrieve the subsequent page.\n* * `sort_by: crate::types::CreatedAtSortMode` -- Supported set of sort modes for scanning by created_at only.\n* \n* Currently, we only support scanning in ascending order.\n*/\nlet vec_crate_types_user = client.users().list(limit, page_token, sort_by).await?;\n\n// - OR -\n\n/**\n* List users.\n*\n* This function performs a `GET` to the `/users` endpoint.\n*\n* As opposed to `list`, this function returns all the pages of the request at once.\n*\n* This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n*/\nlet vec_crate_types_user = client.users().list_all(sort_by).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/users/struct.Users.html#method.list" + }, + "x-python": { + "example": "from kittycad.models import UserResultsPage\nfrom kittycad.api.users import list_users\nfrom kittycad.types import Response\n\nfc: UserResultsPage = list_users.sync(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[UserResultsPage] = list_users.sync_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async\nfc: UserResultsPage = await list_users.asyncio(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async with more info\nresponse: Response[UserResultsPage] = await list_users.asyncio_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.list_users.html" + } + } + }, + "/users-extended": { + "get": { + "tags": [ + "users", + "hidden" + ], + "summary": "List users with extended information.", + "description": "This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.", + "operationId": "list_users_extended", + "parameters": [ + { + "in": "query", + "name": "limit", + "description": "Maximum number of items returned by a single call", + "schema": { + "nullable": true, + "type": "integer", + "format": "uint32", + "minimum": 1 + }, + "style": "form" + }, + { + "in": "query", + "name": "page_token", + "description": "Token returned by previous call to retrieve the subsequent page", + "schema": { + "nullable": true, + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "$ref": "#/components/schemas/CreatedAtSortMode", + "x-scope": [ + "" + ] + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedUserResultsPage", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-dropshot-pagination": true, + "x-go": { + "example": "// ListExtended: List users with extended information.\n//\n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n//\n// To iterate over all pages, use the `ListExtendedAllPages` method, instead.\n//\n// Parameters:\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\nextendedUserResultsPage, err := client.User.ListExtended(limit, pageToken, sortBy)\n\n// - OR -\n\n// ListExtendedAllPages: List users with extended information.\n//\n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n//\n// This method is a wrapper around the `ListExtended` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `sortBy`\nExtendedUser, err := client.User.ListExtendedAllPages(sortBy)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.ListExtended" + }, + "x-rust": { + "example": "/**\n* List users with extended information.\n*\n* This function performs a `GET` to the `/users-extended` endpoint.\n*\n* This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n*\n* **Parameters:**\n*\n* * `limit: u32` -- Maximum number of items returned by a single call.\n* * `page_token: &str` -- Token returned by previous call to retrieve the subsequent page.\n* * `sort_by: crate::types::CreatedAtSortMode` -- Supported set of sort modes for scanning by created_at only.\n* \n* Currently, we only support scanning in ascending order.\n*/\nlet vec_crate_types_extended_user = client.users().list_extended(limit, page_token, sort_by).await?;\n\n// - OR -\n\n/**\n* List users with extended information.\n*\n* This function performs a `GET` to the `/users-extended` endpoint.\n*\n* As opposed to `list_extended`, this function returns all the pages of the request at once.\n*\n* This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n*/\nlet vec_crate_types_extended_user = client.users().list_all_extended(sort_by).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/users/struct.Users.html#method.list_extended" + }, + "x-python": { + "example": "from kittycad.models import ExtendedUserResultsPage\nfrom kittycad.api.users import list_users_extended\nfrom kittycad.types import Response\n\nfc: ExtendedUserResultsPage = list_users_extended.sync(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ExtendedUserResultsPage] = list_users_extended.sync_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async\nfc: ExtendedUserResultsPage = await list_users_extended.asyncio(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async with more info\nresponse: Response[ExtendedUserResultsPage] = await list_users_extended.asyncio_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.list_users_extended.html" + } + } + }, + "/users-extended/{id}": { + "get": { + "tags": [ + "users", + "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 KittyCAD user, you must be a KittyCAD employee.", + "operationId": "get_user_extended", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The user ID.", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedUser", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// GetExtended: Get extended information about a user.\n//\n// 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// Alternatively, to get information about the authenticated user, use `/user/extended` endpoint.\n// To get information about any KittyCAD user, you must be a KittyCAD employee.\n//\n// Parameters:\n//\t- `id`: The user ID.\nextendedUser, err := client.User.GetExtended(id)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.GetExtended" + }, + "x-rust": { + "example": "/**\n* Get extended information about a user.\n*\n* This function performs a `GET` to the `/users-extended/{id}` endpoint.\n*\n* 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* Alternatively, to get information about the authenticated user, use `/user/extended` endpoint.\n* To get information about any KittyCAD user, you must be a KittyCAD employee.\n*\n* **Parameters:**\n*\n* * `id: &str` -- The user ID.\n*/\nlet extended_user = client.users().get_extended(id).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/users/struct.Users.html#method.get_extended" + }, + "x-python": { + "example": "from kittycad.models import ExtendedUser\nfrom kittycad.api.users import get_user_extended\nfrom kittycad.types import Response\n\nfc: ExtendedUser = get_user_extended.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ExtendedUser] = get_user_extended.sync_detailed(client=client, id=)\n\n# OR run async\nfc: ExtendedUser = await get_user_extended.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[ExtendedUser] = await get_user_extended.asyncio_detailed(client=client, id=)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.get_user_extended.html" + } + } + }, + "/users/{id}": { + "get": { + "tags": [ + "users", + "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 KittyCAD user, you must be a KittyCAD employee.", + "operationId": "get_user", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The user ID.", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-go": { + "example": "// Get: Get a user.\n//\n// 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// Alternatively, to get information about the authenticated user, use `/user` endpoint.\n// To get information about any KittyCAD user, you must be a KittyCAD employee.\n//\n// Parameters:\n//\t- `id`: The user ID.\nuser, err := client.User.Get(id)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.Get" + }, + "x-rust": { + "example": "/**\n* Get a user.\n*\n* This function performs a `GET` to the `/users/{id}` endpoint.\n*\n* 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* Alternatively, to get information about the authenticated user, use `/user` endpoint.\n* To get information about any KittyCAD user, you must be a KittyCAD employee.\n*\n* **Parameters:**\n*\n* * `id: &str` -- The user ID.\n*/\nlet user = client.users().get(id).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/users/struct.Users.html#method.get" + }, + "x-python": { + "example": "from kittycad.models import User\nfrom kittycad.api.users import get_user\nfrom kittycad.types import Response\n\nfc: User = get_user.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[User] = get_user.sync_detailed(client=client, id=)\n\n# OR run async\nfc: User = await get_user.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[User] = await get_user.asyncio_detailed(client=client, id=)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.get_user.html" + } + } + }, + "/users/{id}/api-calls": { + "get": { + "tags": [ + "api-calls", + "hidden" + ], + "summary": "List API calls for a user.", + "description": "This endpoint requires authentication by any KittyCAD 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 KittyCAD 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.", + "operationId": "list_api_calls_for_user", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "The user ID.", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + }, + { + "in": "query", + "name": "limit", + "description": "Maximum number of items returned by a single call", + "schema": { + "nullable": true, + "type": "integer", + "format": "uint32", + "minimum": 1 + }, + "style": "form" + }, + { + "in": "query", + "name": "page_token", + "description": "Token returned by previous call to retrieve the subsequent page", + "schema": { + "nullable": true, + "type": "string" + }, + "style": "form" + }, + { + "in": "query", + "name": "sort_by", + "schema": { + "$ref": "#/components/schemas/CreatedAtSortMode", + "x-scope": [ + "" + ] + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Headers": { + "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Methods": { + "description": "Access-Control-Allow-Methods header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + }, + "Access-Control-Allow-Origin": { + "description": "Access-Control-Allow-Origin header.", + "style": "simple", + "required": true, + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCallWithPriceResultsPage", + "x-scope": [ + "" + ] + } + } + } + }, + "4XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + }, + "5XX": { + "$ref": "#/components/responses/Error", + "x-scope": [ + "" + ] + } + }, + "x-dropshot-pagination": true, + "x-go": { + "example": "// ListForUser: List API calls for a user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user if \"me\" is passed as the user id.\n// Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.\n// If the authenticated user is a KittyCAD employee, then the API calls are returned for the user specified by the user id.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// To iterate over all pages, use the `ListForUserAllPages` method, instead.\n//\n// Parameters:\n//\t- `id`: The user ID.\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\naPICallWithPriceResultsPage, err := client.APICall.ListForUser(id, limit, pageToken, sortBy)\n\n// - OR -\n\n// ListForUserAllPages: List API calls for a user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user if \"me\" is passed as the user id.\n// Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.\n// If the authenticated user is a KittyCAD employee, then the API calls are returned for the user specified by the user id.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// This method is a wrapper around the `ListForUser` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `id`: The user ID.\n//\t- `sortBy`\nAPICallWithPrice, err := client.APICall.ListForUserAllPages(id , sortBy)", + "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.ListForUser" + }, + "x-rust": { + "example": "/**\n* List API calls for a user.\n*\n* This function performs a `GET` to the `/users/{id}/api-calls` endpoint.\n*\n* This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user if \"me\" is passed as the user id.\n* Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.\n* If the authenticated user is a KittyCAD employee, then the API calls are returned for the user specified by the user id.\n* The API calls are returned in order of creation, with the most recently created API calls first.\n*\n* **Parameters:**\n*\n* * `id: &str` -- The user ID.\n* * `limit: u32` -- Maximum number of items returned by a single call.\n* * `page_token: &str` -- Token returned by previous call to retrieve the subsequent page.\n* * `sort_by: crate::types::CreatedAtSortMode` -- Supported set of sort modes for scanning by created_at only.\n* \n* Currently, we only support scanning in ascending order.\n*/\nlet vec_crate_types_api_call_with_price = client.api_calls().list_calls_for_user(id, limit, page_token, sort_by).await?;\n\n// - OR -\n\n/**\n* List API calls for a user.\n*\n* This function performs a `GET` to the `/users/{id}/api-calls` endpoint.\n*\n* As opposed to `list_calls_for_user`, this function returns all the pages of the request at once.\n*\n* This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user if \"me\" is passed as the user id.\n* Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.\n* If the authenticated user is a KittyCAD employee, then the API calls are returned for the user specified by the user id.\n* The API calls are returned in order of creation, with the most recently created API calls first.\n*/\nlet vec_crate_types_api_call_with_price = client.api_calls().list_all_calls_for_user(id, sort_by).await?;", + "libDocsLink": "https://docs.rs/kittycad/latest/kittycad/api_calls/struct.ApiCalls.html#method.list_calls_for_user" + }, + "x-python": { + "example": "from kittycad.models import ApiCallWithPriceResultsPage\nfrom kittycad.api.api-calls import list_api_calls_for_user\nfrom kittycad.types import Response\n\nfc: ApiCallWithPriceResultsPage = list_api_calls_for_user.sync(client=client, id=, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiCallWithPriceResultsPage] = list_api_calls_for_user.sync_detailed(client=client, id=, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async\nfc: ApiCallWithPriceResultsPage = await list_api_calls_for_user.asyncio(client=client, id=, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async with more info\nresponse: Response[ApiCallWithPriceResultsPage] = await list_api_calls_for_user.asyncio_detailed(client=client, id=, limit=\"\", page_token=, sort_by=CreatedAtSortMode)", + "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.list_api_calls_for_user.html" + } + } + } + }, "components": { "responses": { "Error": { + "description": "Error", "content": { "application/json": { "schema": { @@ -12,24 +4327,24 @@ ] } } - }, - "description": "Error" + } } }, "schemas": { "APICallStatus": { "description": "The status of an async API call.", + "type": "string", "enum": [ "Queued", "Uploaded", "In Progress", "Completed", "Failed" - ], - "type": "string" + ] }, "Address": { "description": "An address.", + "type": "object", "properties": { "city": { "description": "The city component.", @@ -41,10 +4356,11 @@ }, "created_at": { "description": "The time and date the address was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "id": { + "description": "The unique identifier of the address.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -54,8 +4370,7 @@ "#/components/schemas/Address" ] } - ], - "description": "The unique identifier of the address." + ] }, "state": { "description": "The state component.", @@ -71,8 +4386,8 @@ }, "updated_at": { "description": "The time and date the address was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "user_id": { "description": "The user ID that this address belongs to.", @@ -87,15 +4402,15 @@ "created_at", "id", "updated_at" - ], - "type": "object" + ] }, "ApiCallQueryGroup": { "description": "A response for a query on the API call table that is grouped by something.", + "type": "object", "properties": { "count": { - "format": "int64", - "type": "integer" + "type": "integer", + "format": "int64" }, "query": { "type": "string" @@ -104,11 +4419,11 @@ "required": [ "count", "query" - ], - "type": "object" + ] }, "ApiCallQueryGroupBy": { "description": "The field of an API call to group by.", + "type": "string", "enum": [ "email", "method", @@ -116,39 +4431,40 @@ "user_id", "origin", "ip_address" - ], - "type": "string" + ] }, "ApiCallWithPrice": { "description": "An API call with the price.\n\nThis is a join of the `APICall` and `APICallPrice` tables.", + "type": "object", "properties": { "completed_at": { - "description": "The date and time the API call completed billing.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The date and time the API call completed billing.", + "type": "string", + "format": "partial-date-time" }, "created_at": { "description": "The date and time the API call was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "duration": { - "description": "The duration of the API call.", - "format": "int64", "nullable": true, - "type": "integer" + "description": "The duration of the API call.", + "type": "integer", + "format": "int64" }, "email": { "description": "The user's email address.", - "format": "email", - "type": "string" + "type": "string", + "format": "email" }, "endpoint": { "description": "The endpoint requested by the API call.", "type": "string" }, "id": { + "description": "The unique identifier for the API call.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -158,14 +4474,14 @@ "#/components/schemas/ApiCallWithPrice" ] } - ], - "description": "The unique identifier for the API call." + ] }, "ip_address": { "description": "The ip address of the origin.", "type": "string" }, "method": { + "description": "The HTTP method requsted by the API call.", "allOf": [ { "$ref": "#/components/schemas/Method", @@ -175,27 +4491,26 @@ "#/components/schemas/ApiCallWithPrice" ] } - ], - "description": "The HTTP method requsted by the API call." + ] }, "minutes": { - "description": "The number of minutes the API call was billed for.", - "format": "int32", "nullable": true, - "type": "integer" + "description": "The number of minutes the API call was billed for.", + "type": "integer", + "format": "int32" }, "origin": { "description": "The origin of the API call.", "type": "string" }, "price": { - "description": "The price of the API call.", "nullable": true, + "description": "The price of the API call.", "type": "number" }, "request_body": { - "description": "The request body sent by the API call.", "nullable": true, + "description": "The request body sent by the API call.", "type": "string" }, "request_query_params": { @@ -203,17 +4518,19 @@ "type": "string" }, "response_body": { - "description": "The response body returned by the API call. We do not store this information if it is above a certain size.", "nullable": true, + "description": "The response body returned by the API call. We do not store this information if it is above a certain size.", "type": "string" }, "started_at": { - "description": "The date and time the API call started billing.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The date and time the API call started billing.", + "type": "string", + "format": "partial-date-time" }, "status_code": { + "nullable": true, + "description": "The status code returned by the API call.", "allOf": [ { "$ref": "#/components/schemas/StatusCode", @@ -223,15 +4540,14 @@ "#/components/schemas/ApiCallWithPrice" ] } - ], - "description": "The status code returned by the API call.", - "nullable": true + ] }, "stripe_invoice_item_id": { "description": "The Stripe invoice item ID of the API call if it is billable.", "type": "string" }, "token": { + "description": "The API token that made the API call.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -241,13 +4557,12 @@ "#/components/schemas/ApiCallWithPrice" ] } - ], - "description": "The API token that made the API call." + ] }, "updated_at": { "description": "The date and time the API call was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "user_agent": { "description": "The user agent of the request.", @@ -265,41 +4580,41 @@ "token", "updated_at", "user_agent" - ], - "type": "object" + ] }, "ApiCallWithPriceResultsPage": { "description": "A single page of results", + "type": "object", "properties": { "items": { "description": "list of items on this page of results", + "type": "array", "items": { "$ref": "#/components/schemas/ApiCallWithPrice", "x-scope": [ "", "#/components/schemas/ApiCallWithPriceResultsPage" ] - }, - "type": "array" + } }, "next_page": { - "description": "token used to fetch the next page of results (if any)", "nullable": true, + "description": "token used to fetch the next page of results (if any)", "type": "string" } }, "required": [ "items" - ], - "type": "object" + ] }, "ApiToken": { "description": "An API token.\n\nThese are used to authenticate users with Bearer authentication.", + "type": "object", "properties": { "created_at": { "description": "The date and time the API token was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "id": { "description": "The unique identifier for the API token.", @@ -310,6 +4625,7 @@ "type": "boolean" }, "token": { + "description": "The API token itself.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -319,13 +4635,12 @@ "#/components/schemas/ApiToken" ] } - ], - "description": "The API token itself." + ] }, "updated_at": { "description": "The date and time the API token was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "user_id": { "description": "The ID of the user that owns the API token.", @@ -337,64 +4652,65 @@ "is_valid", "token", "updated_at" - ], - "type": "object" + ] }, "ApiTokenResultsPage": { "description": "A single page of results", + "type": "object", "properties": { "items": { "description": "list of items on this page of results", + "type": "array", "items": { "$ref": "#/components/schemas/ApiToken", "x-scope": [ "", "#/components/schemas/ApiTokenResultsPage" ] - }, - "type": "array" + } }, "next_page": { - "description": "token used to fetch the next page of results (if any)", "nullable": true, + "description": "token used to fetch the next page of results (if any)", "type": "string" } }, "required": [ "items" - ], - "type": "object" + ] }, "AsyncAPICallType": { "description": "The type of async API call.", + "type": "string", "enum": [ "FileConversion", "FileVolume", "FileMass", "FileDensity" - ], - "type": "string" + ] }, "AsyncApiCall": { "description": "An async API call.", + "type": "object", "properties": { "completed_at": { - "description": "The time and date the async API call was completed.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the async API call was completed.", + "type": "string", + "format": "partial-date-time" }, "created_at": { "description": "The time and date the async API call was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "error": { - "description": "The error the function returned, if any.", "nullable": true, + "description": "The error the function returned, if any.", "type": "string" }, "id": { + "description": "The unique identifier of the async API call.\n\nThis is the same as the API call ID.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -404,23 +4720,23 @@ "#/components/schemas/AsyncApiCall" ] } - ], - "description": "The unique identifier of the async API call.\n\nThis is the same as the API call ID." + ] }, "input": { "description": "The JSON input for the API call. These are determined by the endpoint that is run." }, "output": { - "description": "The JSON output for the API call. These are determined by the endpoint that is run.", - "nullable": true + "nullable": true, + "description": "The JSON output for the API call. These are determined by the endpoint that is run." }, "started_at": { - "description": "The time and date the async API call was started.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the async API call was started.", + "type": "string", + "format": "partial-date-time" }, "status": { + "description": "The status of the async API call.", "allOf": [ { "$ref": "#/components/schemas/APICallStatus", @@ -430,10 +4746,10 @@ "#/components/schemas/AsyncApiCall" ] } - ], - "description": "The status of the async API call." + ] }, "type": { + "description": "The type of async API call.", "allOf": [ { "$ref": "#/components/schemas/AsyncAPICallType", @@ -443,13 +4759,12 @@ "#/components/schemas/AsyncApiCall" ] } - ], - "description": "The type of async API call." + ] }, "updated_at": { "description": "The time and date the async API call was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "user_id": { "description": "The user ID of the user who created the async API call.", @@ -466,32 +4781,33 @@ "status", "type", "updated_at" - ], - "type": "object" + ] }, "AsyncApiCallOutput": { "description": "The output from the async API call.", "oneOf": [ { "description": "A file conversion.", + "type": "object", "properties": { "completed_at": { - "description": "The time and date the file conversion was completed.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the file conversion was completed.", + "type": "string", + "format": "partial-date-time" }, "created_at": { "description": "The time and date the file conversion was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "error": { - "description": "The error the function returned, if any.", "nullable": true, + "description": "The error the function returned, if any.", "type": "string" }, "id": { + "description": "The unique identifier of the file conversion.\n\nThis is the same as the API call ID.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -500,15 +4816,15 @@ "#/components/schemas/AsyncApiCallOutput" ] } - ], - "description": "The unique identifier of the file conversion.\n\nThis is the same as the API call ID." + ] }, "output": { - "description": "The converted file, if completed, base64 encoded.", "nullable": true, + "description": "The converted file, if completed, base64 encoded.", "type": "string" }, "output_format": { + "description": "The output format of the file conversion.", "allOf": [ { "$ref": "#/components/schemas/FileOutputFormat", @@ -517,10 +4833,10 @@ "#/components/schemas/AsyncApiCallOutput" ] } - ], - "description": "The output format of the file conversion." + ] }, "src_format": { + "description": "The source format of the file conversion.", "allOf": [ { "$ref": "#/components/schemas/FileSourceFormat", @@ -529,16 +4845,16 @@ "#/components/schemas/AsyncApiCallOutput" ] } - ], - "description": "The source format of the file conversion." + ] }, "started_at": { - "description": "The time and date the file conversion was started.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the file conversion was started.", + "type": "string", + "format": "partial-date-time" }, "status": { + "description": "The status of the file conversion.", "allOf": [ { "$ref": "#/components/schemas/APICallStatus", @@ -547,19 +4863,18 @@ "#/components/schemas/AsyncApiCallOutput" ] } - ], - "description": "The status of the file conversion." + ] }, "type": { + "type": "string", "enum": [ "FileConversion" - ], - "type": "string" + ] }, "updated_at": { "description": "The time and date the file conversion was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "user_id": { "description": "The user ID of the user who created the file conversion.", @@ -574,29 +4889,30 @@ "status", "type", "updated_at" - ], - "type": "object" + ] }, { "description": "A file mass.", + "type": "object", "properties": { "completed_at": { - "description": "The time and date the mass was completed.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the mass was completed.", + "type": "string", + "format": "partial-date-time" }, "created_at": { "description": "The time and date the mass was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "error": { - "description": "The error the function returned, if any.", "nullable": true, + "description": "The error the function returned, if any.", "type": "string" }, "id": { + "description": "The unique identifier of the mass request.\n\nThis is the same as the API call ID.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -605,22 +4921,22 @@ "#/components/schemas/AsyncApiCallOutput" ] } - ], - "description": "The unique identifier of the mass request.\n\nThis is the same as the API call ID." + ] }, "mass": { - "description": "The resulting mass.", - "format": "double", "nullable": true, - "type": "number" + "description": "The resulting mass.", + "type": "number", + "format": "double" }, "material_density": { - "default": 0, "description": "The material density as denoted by the user.", - "format": "float", - "type": "number" + "default": 0, + "type": "number", + "format": "float" }, "src_format": { + "description": "The source format of the file.", "allOf": [ { "$ref": "#/components/schemas/FileSourceFormat", @@ -629,16 +4945,16 @@ "#/components/schemas/AsyncApiCallOutput" ] } - ], - "description": "The source format of the file." + ] }, "started_at": { - "description": "The time and date the mass was started.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the mass was started.", + "type": "string", + "format": "partial-date-time" }, "status": { + "description": "The status of the mass.", "allOf": [ { "$ref": "#/components/schemas/APICallStatus", @@ -647,19 +4963,18 @@ "#/components/schemas/AsyncApiCallOutput" ] } - ], - "description": "The status of the mass." + ] }, "type": { + "type": "string", "enum": [ "FileMass" - ], - "type": "string" + ] }, "updated_at": { "description": "The time and date the mass was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "user_id": { "description": "The user ID of the user who created the mass.", @@ -673,29 +4988,30 @@ "status", "type", "updated_at" - ], - "type": "object" + ] }, { "description": "A file volume.", + "type": "object", "properties": { "completed_at": { - "description": "The time and date the volume was completed.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the volume was completed.", + "type": "string", + "format": "partial-date-time" }, "created_at": { "description": "The time and date the volume was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "error": { - "description": "The error the function returned, if any.", "nullable": true, + "description": "The error the function returned, if any.", "type": "string" }, "id": { + "description": "The unique identifier of the volume request.\n\nThis is the same as the API call ID.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -704,10 +5020,10 @@ "#/components/schemas/AsyncApiCallOutput" ] } - ], - "description": "The unique identifier of the volume request.\n\nThis is the same as the API call ID." + ] }, "src_format": { + "description": "The source format of the file.", "allOf": [ { "$ref": "#/components/schemas/FileSourceFormat", @@ -716,16 +5032,16 @@ "#/components/schemas/AsyncApiCallOutput" ] } - ], - "description": "The source format of the file." + ] }, "started_at": { - "description": "The time and date the volume was started.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the volume was started.", + "type": "string", + "format": "partial-date-time" }, "status": { + "description": "The status of the volume.", "allOf": [ { "$ref": "#/components/schemas/APICallStatus", @@ -734,29 +5050,28 @@ "#/components/schemas/AsyncApiCallOutput" ] } - ], - "description": "The status of the volume." + ] }, "type": { + "type": "string", "enum": [ "FileVolume" - ], - "type": "string" + ] }, "updated_at": { "description": "The time and date the volume was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "user_id": { "description": "The user ID of the user who created the volume.", "type": "string" }, "volume": { - "description": "The resulting volume.", - "format": "double", "nullable": true, - "type": "number" + "description": "The resulting volume.", + "type": "number", + "format": "double" } }, "required": [ @@ -766,35 +5081,36 @@ "status", "type", "updated_at" - ], - "type": "object" + ] }, { "description": "A file density.", + "type": "object", "properties": { "completed_at": { - "description": "The time and date the density was completed.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the density was completed.", + "type": "string", + "format": "partial-date-time" }, "created_at": { "description": "The time and date the density was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "density": { - "description": "The resulting density.", - "format": "double", "nullable": true, - "type": "number" + "description": "The resulting density.", + "type": "number", + "format": "double" }, "error": { - "description": "The error the function returned, if any.", "nullable": true, + "description": "The error the function returned, if any.", "type": "string" }, "id": { + "description": "The unique identifier of the density request.\n\nThis is the same as the API call ID.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -803,16 +5119,16 @@ "#/components/schemas/AsyncApiCallOutput" ] } - ], - "description": "The unique identifier of the density request.\n\nThis is the same as the API call ID." + ] }, "material_mass": { - "default": 0, "description": "The material mass as denoted by the user.", - "format": "float", - "type": "number" + "default": 0, + "type": "number", + "format": "float" }, "src_format": { + "description": "The source format of the file.", "allOf": [ { "$ref": "#/components/schemas/FileSourceFormat", @@ -821,16 +5137,16 @@ "#/components/schemas/AsyncApiCallOutput" ] } - ], - "description": "The source format of the file." + ] }, "started_at": { - "description": "The time and date the density was started.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the density was started.", + "type": "string", + "format": "partial-date-time" }, "status": { + "description": "The status of the density.", "allOf": [ { "$ref": "#/components/schemas/APICallStatus", @@ -839,19 +5155,18 @@ "#/components/schemas/AsyncApiCallOutput" ] } - ], - "description": "The status of the density." + ] }, "type": { + "type": "string", "enum": [ "FileDensity" - ], - "type": "string" + ] }, "updated_at": { "description": "The time and date the density was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "user_id": { "description": "The user ID of the user who created the density.", @@ -865,40 +5180,42 @@ "status", "type", "updated_at" - ], - "type": "object" + ] } ] }, "AsyncApiCallResultsPage": { "description": "A single page of results", + "type": "object", "properties": { "items": { "description": "list of items on this page of results", + "type": "array", "items": { "$ref": "#/components/schemas/AsyncApiCall", "x-scope": [ "", "#/components/schemas/AsyncApiCallResultsPage" ] - }, - "type": "array" + } }, "next_page": { - "description": "token used to fetch the next page of results (if any)", "nullable": true, + "description": "token used to fetch the next page of results (if any)", "type": "string" } }, "required": [ "items" - ], - "type": "object" + ] }, "BillingInfo": { "description": "The billing information for payments.", + "type": "object", "properties": { "address": { + "nullable": true, + "description": "The address of the customer.", "allOf": [ { "$ref": "#/components/schemas/Address", @@ -907,15 +5224,15 @@ "#/components/schemas/BillingInfo" ] } - ], - "description": "The address of the customer.", - "nullable": true + ] }, "name": { "description": "The name of the customer.", "type": "string" }, "phone": { + "description": "The phone for the customer.", + "default": "", "allOf": [ { "$ref": "#/components/schemas/PhoneNumber", @@ -924,15 +5241,13 @@ "#/components/schemas/BillingInfo" ] } - ], - "default": "", - "description": "The phone for the customer." + ] } - }, - "type": "object" + } }, "CacheMetadata": { "description": "Metadata about our cache.\n\nThis is mostly used for internal purposes and debugging.", + "type": "object", "properties": { "ok": { "description": "If the cache returned an ok response from ping.", @@ -941,17 +5256,19 @@ }, "required": [ "ok" - ], - "type": "object" + ] }, "CardDetails": { "description": "The card details of a payment method.", + "type": "object", "properties": { "brand": { "description": "Card brand.\n\nCan be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", "type": "string" }, "checks": { + "description": "Checks on Card address and CVC if provided.", + "default": {}, "allOf": [ { "$ref": "#/components/schemas/PaymentMethodCardChecks", @@ -961,25 +5278,23 @@ "#/components/schemas/CardDetails" ] } - ], - "default": {}, - "description": "Checks on Card address and CVC if provided." + ] }, "country": { "description": "Two-letter ISO code representing the country of the card.", "type": "string" }, "exp_month": { - "default": 0, "description": "Two-digit number representing the card's expiration month.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "exp_year": { - "default": 0, "description": "Four-digit number representing the card's expiration year.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "fingerprint": { "description": "Uniquely identifies this particular card number.", @@ -993,102 +5308,104 @@ "description": "The last four digits of the card.", "type": "string" } - }, - "type": "object" + } }, "Cluster": { "description": "Cluster information.", + "type": "object", "properties": { "addr": { - "description": "The IP address of the cluster.", "nullable": true, + "description": "The IP address of the cluster.", "type": "string" }, "auth_timeout": { - "default": 0, "description": "The auth timeout of the cluster.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "cluster_port": { - "default": 0, "description": "The port of the cluster.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "name": { - "default": "", "description": "The name of the cluster.", + "default": "", "type": "string" }, "tls_timeout": { - "default": 0, "description": "The TLS timeout for the cluster.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "urls": { "description": "The urls of the cluster.", + "type": "array", "items": { "type": "string" - }, - "type": "array" + } } - }, - "type": "object" + } }, "CodeLanguage": { "description": "The language code is written in.", + "type": "string", "enum": [ "go", "rust", "python", "node" - ], - "type": "string" + ] }, "CodeOutput": { "description": "Output of the code being executed.", + "type": "object", "properties": { - "output": { - "default": "", - "description": "The first files content. Remove after backwards compat (TODO).", - "type": "string" - }, "output_files": { "description": "The contents of the files requested if they were passed.", + "type": "array", "items": { "$ref": "#/components/schemas/OutputFile", "x-scope": [ "", "#/components/schemas/CodeOutput" ] - }, - "type": "array" + } }, "stderr": { - "default": "", "description": "The stderr of the code.", + "default": "", "type": "string" }, "stdout": { - "default": "", "description": "The stdout of the code.", + "default": "", "type": "string" } - }, - "type": "object" + } }, "Connection": { "description": "Metadata about a pub-sub connection.\n\nThis is mostly used for internal purposes and debugging.", + "type": "object", "properties": { "auth_timeout": { - "default": 0, "description": "The auth timeout of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "cluster": { + "description": "Information about the cluster.", + "default": { + "auth_timeout": 0, + "cluster_port": 0, + "name": "", + "tls_timeout": 0 + }, "allOf": [ { "$ref": "#/components/schemas/Cluster", @@ -1098,38 +5415,39 @@ "#/components/schemas/Connection" ] } - ], - "default": { - "auth_timeout": 0, - "cluster_port": 0, - "name": "", - "tls_timeout": 0 - }, - "description": "Information about the cluster." + ] }, "config_load_time": { "description": "The time the configuration was loaded.", - "format": "date-time", - "type": "string" + "type": "string", + "format": "date-time" }, "connections": { - "default": 0, "description": "The number of connections to the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "cores": { - "default": 0, "description": "The CPU core usage of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "cpu": { - "format": "double", "nullable": true, - "type": "number" + "type": "number", + "format": "double" }, "gateway": { + "description": "Information about the gateway.", + "default": { + "auth_timeout": 0, + "host": "", + "name": "", + "port": 0, + "tls_timeout": 0 + }, "allOf": [ { "$ref": "#/components/schemas/Gateway", @@ -1139,98 +5457,81 @@ "#/components/schemas/Connection" ] } - ], - "default": { - "auth_timeout": 0, - "host": "", - "name": "", - "port": 0, - "tls_timeout": 0 - }, - "description": "Information about the gateway." + ] }, "git_commit": { - "default": "", "description": "The git commit.", + "default": "", "type": "string" }, "go": { - "default": "", "description": "The go version.", + "default": "", "type": "string" }, "gomaxprocs": { - "default": 0, "description": "`GOMAXPROCS` of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "host": { "description": "The host of the server.", "type": "string" }, "http_base_path": { - "default": "", "description": "The http base path of the server.", + "default": "", "type": "string" }, "http_host": { - "default": "", "description": "The http host of the server.", + "default": "", "type": "string" }, "http_port": { - "default": 0, "description": "The http port of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "http_req_stats": { + "type": "object", "additionalProperties": { - "format": "int64", - "type": "integer" - }, - "type": "object" + "type": "integer", + "format": "int64" + } }, "https_port": { - "default": 0, "description": "The https port of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "id": { "description": "The ID as known by the most recently connected server.", + "type": "integer", "format": "uint64", - "minimum": 0, - "type": "integer" + "minimum": 0 }, "in_bytes": { - "default": 0, "description": "The count of inbound bytes for the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "in_msgs": { - "default": 0, "description": "The number of inbound messages for the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "ip": { "description": "The client IP as known by the most recently connected server.", "type": "string" }, "jetstream": { - "allOf": [ - { - "$ref": "#/components/schemas/Jetstream", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/Connection" - ] - } - ], + "description": "Jetstream information.", "default": { "config": { "domain": "", @@ -1257,9 +5558,25 @@ "store": 0 } }, - "description": "Jetstream information." + "allOf": [ + { + "$ref": "#/components/schemas/Jetstream", + "x-scope": [ + "", + "#/components/schemas/Metadata", + "#/components/schemas/Connection" + ] + } + ] }, "leaf": { + "description": "Information about leaf nodes.", + "default": { + "auth_timeout": 0, + "host": "", + "port": 0, + "tls_timeout": 0 + }, "allOf": [ { "$ref": "#/components/schemas/LeafNode", @@ -1269,105 +5586,99 @@ "#/components/schemas/Connection" ] } - ], - "default": { - "auth_timeout": 0, - "host": "", - "port": 0, - "tls_timeout": 0 - }, - "description": "Information about leaf nodes." + ] }, "leafnodes": { - "default": 0, "description": "The number of leaf nodes for the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "max_connections": { - "default": 0, "description": "The max connections of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "max_control_line": { - "default": 0, "description": "The max control line of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "max_payload": { - "default": 0, "description": "The max payload of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "max_pending": { - "default": 0, "description": "The max pending of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "mem": { - "default": 0, "description": "The memory usage of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "now": { "description": "The time now.", - "format": "date-time", - "type": "string" + "type": "string", + "format": "date-time" }, "out_bytes": { - "default": 0, "description": "The count of outbound bytes for the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "out_msgs": { - "default": 0, "description": "The number of outbound messages for the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "ping_interval": { - "default": 0, "description": "The ping interval of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "ping_max": { - "default": 0, "description": "The ping max of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "port": { - "default": 0, "description": "The port of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "proto": { - "default": 0, "description": "The protocol version.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "remotes": { - "default": 0, "description": "The number of remotes for the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "routes": { - "default": 0, "description": "The number of routes for the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "rtt": { + "description": "The round trip time between this client and the server.", "allOf": [ { "$ref": "#/components/schemas/Duration", @@ -1377,68 +5688,67 @@ "#/components/schemas/Connection" ] } - ], - "description": "The round trip time between this client and the server." + ] }, "server_id": { - "default": "", "description": "The server ID.", + "default": "", "type": "string" }, "server_name": { - "default": "", "description": "The server name.", + "default": "", "type": "string" }, "slow_consumers": { - "default": 0, "description": "The number of slow consumers for the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "start": { "description": "When the server was started.", - "format": "date-time", - "type": "string" + "type": "string", + "format": "date-time" }, "subscriptions": { - "default": 0, "description": "The number of subscriptions for the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "system_account": { - "default": "", "description": "The system account.", + "default": "", "type": "string" }, "tls_timeout": { - "default": 0, "description": "The TLS timeout of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "total_connections": { - "default": 0, "description": "The total number of connections to the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "uptime": { - "default": "", "description": "The uptime of the server.", + "default": "", "type": "string" }, "version": { - "default": "", "description": "The version of the service.", + "default": "", "type": "string" }, "write_deadline": { - "default": 0, "description": "The write deadline of the server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" } }, "required": [ @@ -1450,19 +5760,19 @@ "now", "rtt", "start" - ], - "type": "object" + ] }, "CreatedAtSortMode": { "description": "Supported set of sort modes for scanning by created_at only.\n\nCurrently, we only support scanning in ascending order.", + "type": "string", "enum": [ "created-at-ascending", "created-at-descending" - ], - "type": "string" + ] }, "Currency": { "description": "Currency is the list of supported currencies.\n\nFor more details see .", + "type": "string", "enum": [ "aed", "afn", @@ -1603,13 +5913,15 @@ "yer", "zar", "zmw" - ], - "type": "string" + ] }, "Customer": { "description": "The resource representing a payment \"Customer\".", + "type": "object", "properties": { "address": { + "nullable": true, + "description": "The customer's address.", "allOf": [ { "$ref": "#/components/schemas/Address", @@ -1618,22 +5930,21 @@ "#/components/schemas/Customer" ] } - ], - "description": "The customer's address.", - "nullable": true + ] }, "balance": { - "default": 0, "description": "Current balance, if any, being stored on the customer.\n\nIf negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "created_at": { "description": "Time at which the object was created.", - "format": "date-time", - "type": "string" + "type": "string", + "format": "date-time" }, "currency": { + "description": "Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.", "allOf": [ { "$ref": "#/components/schemas/Currency", @@ -1642,12 +5953,11 @@ "#/components/schemas/Customer" ] } - ], - "description": "Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes." + ] }, "delinquent": { - "default": false, "description": "When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed.\n\nWhen the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date. If an invoice is marked uncollectible by dunning, `delinquent` doesn't get reset to `false`.", + "default": false, "type": "boolean" }, "email": { @@ -1659,18 +5969,20 @@ "type": "string" }, "metadata": { + "description": "Set of key-value pairs.", + "default": {}, + "type": "object", "additionalProperties": { "type": "string" - }, - "default": {}, - "description": "Set of key-value pairs.", - "type": "object" + } }, "name": { "description": "The customer's full name or business name.", "type": "string" }, "phone": { + "description": "The customer's phone number.", + "default": "", "allOf": [ { "$ref": "#/components/schemas/PhoneNumber", @@ -1679,29 +5991,28 @@ "#/components/schemas/Customer" ] } - ], - "default": "", - "description": "The customer's phone number." + ] } }, "required": [ "created_at", "currency" - ], - "type": "object" + ] }, "Duration": { - "format": "int64", - "type": "integer" + "type": "integer", + "format": "int64" }, "EngineMetadata": { "description": "Metadata about our currently running server.\n\nThis is mostly used for internal purposes and debugging.", + "type": "object", "properties": { "async_jobs_running": { "description": "If any async job is currently running.", "type": "boolean" }, "cache": { + "description": "Metadata about our cache.", "allOf": [ { "$ref": "#/components/schemas/CacheMetadata", @@ -1711,10 +6022,10 @@ "#/components/schemas/EngineMetadata" ] } - ], - "description": "Metadata about our cache." + ] }, "environment": { + "description": "The environment we are running in.", "allOf": [ { "$ref": "#/components/schemas/Environment", @@ -1724,10 +6035,10 @@ "#/components/schemas/EngineMetadata" ] } - ], - "description": "The environment we are running in." + ] }, "fs": { + "description": "Metadata about our file system.", "allOf": [ { "$ref": "#/components/schemas/FileSystemMetadata", @@ -1737,14 +6048,14 @@ "#/components/schemas/EngineMetadata" ] } - ], - "description": "Metadata about our file system." + ] }, "git_hash": { "description": "The git hash of the server.", "type": "string" }, "pubsub": { + "description": "Metadata about our pub-sub connection.", "allOf": [ { "$ref": "#/components/schemas/Connection", @@ -1754,8 +6065,7 @@ "#/components/schemas/EngineMetadata" ] } - ], - "description": "Metadata about our pub-sub connection." + ] } }, "required": [ @@ -1765,20 +6075,20 @@ "fs", "git_hash", "pubsub" - ], - "type": "object" + ] }, "Environment": { "description": "The environment the server is running in.", + "type": "string", "enum": [ "DEVELOPMENT", "PREVIEW", "PRODUCTION" - ], - "type": "string" + ] }, "Error": { "description": "Error information from a response.", + "type": "object", "properties": { "error_code": { "type": "string" @@ -1793,11 +6103,11 @@ "required": [ "message", "request_id" - ], - "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, and Zendesk.", + "type": "object", "properties": { "company": { "description": "The user's company.", @@ -1805,8 +6115,8 @@ }, "created_at": { "description": "The date and time the user was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "discord": { "description": "The user's Discord handle.", @@ -1814,14 +6124,14 @@ }, "email": { "description": "The email address of the user.", - "format": "email", - "type": "string" + "type": "string", + "format": "email" }, "email_verified": { - "description": "The date and time the email address was verified.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The date and time the email address was verified.", + "type": "string", + "format": "partial-date-time" }, "first_name": { "description": "The user's first name.", @@ -1844,8 +6154,8 @@ "type": "string" }, "mailchimp_id": { - "description": "The user's MailChimp ID. This is mostly used for internal mapping.", "nullable": true, + "description": "The user's MailChimp ID. This is mostly used for internal mapping.", "type": "string" }, "name": { @@ -1853,6 +6163,8 @@ "type": "string" }, "phone": { + "description": "The user's phone number.", + "default": "", "allOf": [ { "$ref": "#/components/schemas/PhoneNumber", @@ -1861,77 +6173,76 @@ "#/components/schemas/ExtendedUser" ] } - ], - "default": "", - "description": "The user's phone number." + ] }, "stripe_id": { - "description": "The user's Stripe ID. This is mostly used for internal mapping.", "nullable": true, + "description": "The user's Stripe ID. This is mostly used for internal mapping.", "type": "string" }, "updated_at": { "description": "The date and time the user was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "zendesk_id": { - "description": "The user's Zendesk ID. This is mostly used for internal mapping.", "nullable": true, + "description": "The user's Zendesk ID. This is mostly used for internal mapping.", "type": "string" } }, "required": [ "created_at", "updated_at" - ], - "type": "object" + ] }, "ExtendedUserResultsPage": { "description": "A single page of results", + "type": "object", "properties": { "items": { "description": "list of items on this page of results", + "type": "array", "items": { "$ref": "#/components/schemas/ExtendedUser", "x-scope": [ "", "#/components/schemas/ExtendedUserResultsPage" ] - }, - "type": "array" + } }, "next_page": { - "description": "token used to fetch the next page of results (if any)", "nullable": true, + "description": "token used to fetch the next page of results (if any)", "type": "string" } }, "required": [ "items" - ], - "type": "object" + ] }, "FileConversion": { "description": "A file conversion.", + "type": "object", "properties": { "completed_at": { - "description": "The time and date the file conversion was completed.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the file conversion was completed.", + "type": "string", + "format": "partial-date-time" }, "created_at": { "description": "The time and date the file conversion was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "error": { - "description": "The error the function returned, if any.", "nullable": true, + "description": "The error the function returned, if any.", "type": "string" }, "id": { + "description": "The unique identifier of the file conversion.\n\nThis is the same as the API call ID.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -1940,15 +6251,15 @@ "#/components/schemas/FileConversion" ] } - ], - "description": "The unique identifier of the file conversion.\n\nThis is the same as the API call ID." + ] }, "output": { - "description": "The converted file, if completed, base64 encoded.", "nullable": true, + "description": "The converted file, if completed, base64 encoded.", "type": "string" }, "output_format": { + "description": "The output format of the file conversion.", "allOf": [ { "$ref": "#/components/schemas/FileOutputFormat", @@ -1957,10 +6268,10 @@ "#/components/schemas/FileConversion" ] } - ], - "description": "The output format of the file conversion." + ] }, "src_format": { + "description": "The source format of the file conversion.", "allOf": [ { "$ref": "#/components/schemas/FileSourceFormat", @@ -1969,16 +6280,16 @@ "#/components/schemas/FileConversion" ] } - ], - "description": "The source format of the file conversion." + ] }, "started_at": { - "description": "The time and date the file conversion was started.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the file conversion was started.", + "type": "string", + "format": "partial-date-time" }, "status": { + "description": "The status of the file conversion.", "allOf": [ { "$ref": "#/components/schemas/APICallStatus", @@ -1987,13 +6298,12 @@ "#/components/schemas/FileConversion" ] } - ], - "description": "The status of the file conversion." + ] }, "updated_at": { "description": "The time and date the file conversion was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "user_id": { "description": "The user ID of the user who created the file conversion.", @@ -2007,35 +6317,36 @@ "src_format", "status", "updated_at" - ], - "type": "object" + ] }, "FileDensity": { "description": "A file density result.", + "type": "object", "properties": { "completed_at": { - "description": "The time and date the density was completed.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the density was completed.", + "type": "string", + "format": "partial-date-time" }, "created_at": { "description": "The time and date the density was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "density": { - "description": "The resulting density.", - "format": "double", "nullable": true, - "type": "number" + "description": "The resulting density.", + "type": "number", + "format": "double" }, "error": { - "description": "The error the function returned, if any.", "nullable": true, + "description": "The error the function returned, if any.", "type": "string" }, "id": { + "description": "The unique identifier of the density request.\n\nThis is the same as the API call ID.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -2044,16 +6355,16 @@ "#/components/schemas/FileDensity" ] } - ], - "description": "The unique identifier of the density request.\n\nThis is the same as the API call ID." + ] }, "material_mass": { - "default": 0, "description": "The material mass as denoted by the user.", - "format": "float", - "type": "number" + "default": 0, + "type": "number", + "format": "float" }, "src_format": { + "description": "The source format of the file.", "allOf": [ { "$ref": "#/components/schemas/FileSourceFormat", @@ -2062,16 +6373,16 @@ "#/components/schemas/FileDensity" ] } - ], - "description": "The source format of the file." + ] }, "started_at": { - "description": "The time and date the density was started.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the density was started.", + "type": "string", + "format": "partial-date-time" }, "status": { + "description": "The status of the density.", "allOf": [ { "$ref": "#/components/schemas/APICallStatus", @@ -2080,13 +6391,12 @@ "#/components/schemas/FileDensity" ] } - ], - "description": "The status of the density." + ] }, "updated_at": { "description": "The time and date the density was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "user_id": { "description": "The user ID of the user who created the density.", @@ -2099,29 +6409,30 @@ "src_format", "status", "updated_at" - ], - "type": "object" + ] }, "FileMass": { "description": "A file mass result.", + "type": "object", "properties": { "completed_at": { - "description": "The time and date the mass was completed.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the mass was completed.", + "type": "string", + "format": "partial-date-time" }, "created_at": { "description": "The time and date the mass was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "error": { - "description": "The error the function returned, if any.", "nullable": true, + "description": "The error the function returned, if any.", "type": "string" }, "id": { + "description": "The unique identifier of the mass request.\n\nThis is the same as the API call ID.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -2130,22 +6441,22 @@ "#/components/schemas/FileMass" ] } - ], - "description": "The unique identifier of the mass request.\n\nThis is the same as the API call ID." + ] }, "mass": { - "description": "The resulting mass.", - "format": "double", "nullable": true, - "type": "number" + "description": "The resulting mass.", + "type": "number", + "format": "double" }, "material_density": { - "default": 0, "description": "The material density as denoted by the user.", - "format": "float", - "type": "number" + "default": 0, + "type": "number", + "format": "float" }, "src_format": { + "description": "The source format of the file.", "allOf": [ { "$ref": "#/components/schemas/FileSourceFormat", @@ -2154,16 +6465,16 @@ "#/components/schemas/FileMass" ] } - ], - "description": "The source format of the file." + ] }, "started_at": { - "description": "The time and date the mass was started.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the mass was started.", + "type": "string", + "format": "partial-date-time" }, "status": { + "description": "The status of the mass.", "allOf": [ { "$ref": "#/components/schemas/APICallStatus", @@ -2172,13 +6483,12 @@ "#/components/schemas/FileMass" ] } - ], - "description": "The status of the mass." + ] }, "updated_at": { "description": "The time and date the mass was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "user_id": { "description": "The user ID of the user who created the mass.", @@ -2191,11 +6501,11 @@ "src_format", "status", "updated_at" - ], - "type": "object" + ] }, "FileOutputFormat": { "description": "The valid types of output file formats.", + "type": "string", "enum": [ "stl", "obj", @@ -2203,22 +6513,22 @@ "step", "fbx", "fbxb" - ], - "type": "string" + ] }, "FileSourceFormat": { "description": "The valid types of source file formats.", + "type": "string", "enum": [ "stl", "obj", "dae", "step", "fbx" - ], - "type": "string" + ] }, "FileSystemMetadata": { "description": "Metadata about our file system.\n\nThis is mostly used for internal purposes and debugging.", + "type": "object", "properties": { "ok": { "description": "If the file system passed a sanity check.", @@ -2227,29 +6537,30 @@ }, "required": [ "ok" - ], - "type": "object" + ] }, "FileVolume": { "description": "A file volume result.", + "type": "object", "properties": { "completed_at": { - "description": "The time and date the volume was completed.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the volume was completed.", + "type": "string", + "format": "partial-date-time" }, "created_at": { "description": "The time and date the volume was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "error": { - "description": "The error the function returned, if any.", "nullable": true, + "description": "The error the function returned, if any.", "type": "string" }, "id": { + "description": "The unique identifier of the volume request.\n\nThis is the same as the API call ID.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -2258,10 +6569,10 @@ "#/components/schemas/FileVolume" ] } - ], - "description": "The unique identifier of the volume request.\n\nThis is the same as the API call ID." + ] }, "src_format": { + "description": "The source format of the file.", "allOf": [ { "$ref": "#/components/schemas/FileSourceFormat", @@ -2270,16 +6581,16 @@ "#/components/schemas/FileVolume" ] } - ], - "description": "The source format of the file." + ] }, "started_at": { - "description": "The time and date the volume was started.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The time and date the volume was started.", + "type": "string", + "format": "partial-date-time" }, "status": { + "description": "The status of the volume.", "allOf": [ { "$ref": "#/components/schemas/APICallStatus", @@ -2288,23 +6599,22 @@ "#/components/schemas/FileVolume" ] } - ], - "description": "The status of the volume." + ] }, "updated_at": { "description": "The time and date the volume was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "user_id": { "description": "The user ID of the user who created the volume.", "type": "string" }, "volume": { - "description": "The resulting volume.", - "format": "double", "nullable": true, - "type": "number" + "description": "The resulting volume.", + "type": "number", + "format": "double" } }, "required": [ @@ -2313,82 +6623,83 @@ "src_format", "status", "updated_at" - ], - "type": "object" + ] }, "Gateway": { "description": "Gateway information.", + "type": "object", "properties": { "auth_timeout": { - "default": 0, "description": "The auth timeout of the gateway.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "host": { - "default": "", "description": "The host of the gateway.", + "default": "", "type": "string" }, "name": { - "default": "", "description": "The name of the gateway.", + "default": "", "type": "string" }, "port": { - "default": 0, "description": "The port of the gateway.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "tls_timeout": { - "default": 0, "description": "The TLS timeout for the gateway.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" } - }, - "type": "object" + } }, "Invoice": { "description": "An invoice.", + "type": "object", "properties": { "amount_due": { - "default": 0, "description": "Final amount due at this time for this invoice.\n\nIf the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "amount_paid": { - "default": 0, "description": "The amount, in %s, that was paid.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "amount_remaining": { - "default": 0, "description": "The amount remaining, in %s, that is due.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "attempt_count": { - "default": 0, "description": "Number of payment attempts made for this invoice, from the perspective of the payment retry schedule.\n\nAny payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.", + "default": 0, + "type": "integer", "format": "uint64", - "minimum": 0, - "type": "integer" + "minimum": 0 }, "attempted": { - "default": false, "description": "Whether an attempt has been made to pay the invoice.\n\nAn invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.", + "default": false, "type": "boolean" }, "created_at": { "description": "Time at which the object was created.", - "format": "date-time", - "type": "string" + "type": "string", + "format": "date-time" }, "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.", "allOf": [ { "$ref": "#/components/schemas/Currency", @@ -2397,8 +6708,7 @@ "#/components/schemas/Invoice" ] } - ], - "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase." + ] }, "description": { "description": "Description of the invoice.", @@ -2418,30 +6728,30 @@ }, "lines": { "description": "The individual line items that make up the invoice.\n\n`lines` is sorted as follows: invoice items in reverse chronological order, followed by the subscription, if any.", + "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLineItem", "x-scope": [ "", "#/components/schemas/Invoice" ] - }, - "type": "array" + } }, "metadata": { + "description": "Set of key-value pairs.", + "default": {}, + "type": "object", "additionalProperties": { "type": "string" - }, - "default": {}, - "description": "Set of key-value pairs.", - "type": "object" + } }, "number": { "description": "A unique, identifying string that appears on emails sent to the customer for this invoice.", "type": "string" }, "paid": { - "default": false, "description": "Whether payment was successfully collected for this invoice.\n\nAn invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.", + "default": false, "type": "boolean" }, "receipt_number": { @@ -2453,6 +6763,8 @@ "type": "string" }, "status": { + "nullable": true, + "description": "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`.\n\n[Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview).", "allOf": [ { "$ref": "#/components/schemas/InvoiceStatus", @@ -2461,45 +6773,44 @@ "#/components/schemas/Invoice" ] } - ], - "description": "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`.\n\n[Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview).", - "nullable": true + ] }, "subtotal": { - "default": 0, "description": "Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied.\n\nItem discounts are already incorporated.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "tax": { - "default": 0, "description": "The amount of tax on this invoice.\n\nThis is the sum of all the tax amounts on this invoice.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "total": { - "default": 0, "description": "Total after discounts and taxes.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" } }, "required": [ "created_at", "currency" - ], - "type": "object" + ] }, "InvoiceLineItem": { "description": "An invoice line item.", + "type": "object", "properties": { "amount": { - "default": 0, "description": "The amount, in %s.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "currency": { + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.", "allOf": [ { "$ref": "#/components/schemas/Currency", @@ -2509,8 +6820,7 @@ "#/components/schemas/InvoiceLineItem" ] } - ], - "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase." + ] }, "description": { "description": "The description.", @@ -2525,21 +6835,21 @@ "type": "string" }, "metadata": { + "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.\n\nSet of key-value pairs.", + "default": {}, + "type": "object", "additionalProperties": { "type": "string" - }, - "default": {}, - "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.\n\nSet of key-value pairs.", - "type": "object" + } } }, "required": [ "currency" - ], - "type": "object" + ] }, "InvoiceStatus": { "description": "An enum representing the possible values of an `Invoice`'s `status` field.", + "type": "string", "enum": [ "deleted", "draft", @@ -2547,13 +6857,20 @@ "paid", "uncollectible", "void" - ], - "type": "string" + ] }, "Jetstream": { "description": "Jetstream information.", + "type": "object", "properties": { "config": { + "description": "The Jetstream config.", + "default": { + "domain": "", + "max_memory": 0, + "max_storage": 0, + "store_dir": "" + }, "allOf": [ { "$ref": "#/components/schemas/JetstreamConfig", @@ -2564,16 +6881,15 @@ "#/components/schemas/Jetstream" ] } - ], - "default": { - "domain": "", - "max_memory": 0, - "max_storage": 0, - "store_dir": "" - }, - "description": "The Jetstream config." + ] }, "meta": { + "description": "Meta information about the cluster.", + "default": { + "cluster_size": 0, + "leader": "", + "name": "" + }, "allOf": [ { "$ref": "#/components/schemas/MetaClusterInfo", @@ -2584,26 +6900,10 @@ "#/components/schemas/Jetstream" ] } - ], - "default": { - "cluster_size": 0, - "leader": "", - "name": "" - }, - "description": "Meta information about the cluster." + ] }, "stats": { - "allOf": [ - { - "$ref": "#/components/schemas/JetstreamStats", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/Connection", - "#/components/schemas/Jetstream" - ] - } - ], + "description": "Jetstream statistics.", "default": { "accounts": 0, "api": { @@ -2617,73 +6917,89 @@ "reserved_store": 0, "store": 0 }, - "description": "Jetstream statistics." + "allOf": [ + { + "$ref": "#/components/schemas/JetstreamStats", + "x-scope": [ + "", + "#/components/schemas/Metadata", + "#/components/schemas/Connection", + "#/components/schemas/Jetstream" + ] + } + ] } - }, - "type": "object" + } }, "JetstreamApiStats": { "description": "Jetstream API statistics.", + "type": "object", "properties": { "errors": { - "default": 0, "description": "The number of errors.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "inflight": { - "default": 0, "description": "The number of inflight requests.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "total": { - "default": 0, "description": "The number of requests.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" } - }, - "type": "object" + } }, "JetstreamConfig": { "description": "Jetstream configuration.", + "type": "object", "properties": { "domain": { - "default": "", "description": "The domain.", + "default": "", "type": "string" }, "max_memory": { - "default": 0, "description": "The max memory.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "max_storage": { - "default": 0, "description": "The max storage.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "store_dir": { - "default": "", "description": "The store directory.", + "default": "", "type": "string" } - }, - "type": "object" + } }, "JetstreamStats": { "description": "Jetstream statistics.", + "type": "object", "properties": { "accounts": { - "default": 0, "description": "The number of accounts.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "api": { + "description": "API stats.", + "default": { + "errors": 0, + "inflight": 0, + "total": 0 + }, "allOf": [ { "$ref": "#/components/schemas/JetstreamApiStats", @@ -2695,78 +7011,72 @@ "#/components/schemas/JetstreamStats" ] } - ], - "default": { - "errors": 0, - "inflight": 0, - "total": 0 - }, - "description": "API stats." + ] }, "ha_assets": { - "default": 0, "description": "The number of HA assets.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "memory": { - "default": 0, "description": "The memory used by the Jetstream server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "reserved_memory": { - "default": 0, "description": "The reserved memory for the Jetstream server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "reserved_store": { - "default": 0, "description": "The reserved storage for the Jetstream server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "store": { - "default": 0, "description": "The storage used by the Jetstream server.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" } - }, - "type": "object" + } }, "LeafNode": { "description": "Leaf node information.", + "type": "object", "properties": { "auth_timeout": { - "default": 0, "description": "The auth timeout of the leaf node.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "host": { - "default": "", "description": "The host of the leaf node.", + "default": "", "type": "string" }, "port": { - "default": 0, "description": "The port of the leaf node.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "tls_timeout": { - "default": 0, "description": "The TLS timeout for the leaf node.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" } - }, - "type": "object" + } }, "LoginParams": { "description": "The parameters passed to login.", + "type": "object", "properties": { "session": { "description": "The session token we should set as a cookie.", @@ -2775,35 +7085,36 @@ }, "required": [ "session" - ], - "type": "object" + ] }, "MetaClusterInfo": { "description": "Jetstream statistics.", + "type": "object", "properties": { "cluster_size": { - "default": 0, "description": "The size of the cluster.", - "format": "int64", - "type": "integer" + "default": 0, + "type": "integer", + "format": "int64" }, "leader": { - "default": "", "description": "The leader of the cluster.", + "default": "", "type": "string" }, "name": { - "default": "", "description": "The name of the cluster.", + "default": "", "type": "string" } - }, - "type": "object" + } }, "Metadata": { "description": "Metadata about our currently running server.\n\nThis is mostly used for internal purposes and debugging.", + "type": "object", "properties": { "cache": { + "description": "Metadata about our cache.", "allOf": [ { "$ref": "#/components/schemas/CacheMetadata", @@ -2812,10 +7123,10 @@ "#/components/schemas/Metadata" ] } - ], - "description": "Metadata about our cache." + ] }, "engine": { + "description": "Metadata about our engine API connection.", "allOf": [ { "$ref": "#/components/schemas/EngineMetadata", @@ -2824,10 +7135,10 @@ "#/components/schemas/Metadata" ] } - ], - "description": "Metadata about our engine API connection." + ] }, "environment": { + "description": "The environment we are running in.", "allOf": [ { "$ref": "#/components/schemas/Environment", @@ -2836,10 +7147,10 @@ "#/components/schemas/Metadata" ] } - ], - "description": "The environment we are running in." + ] }, "fs": { + "description": "Metadata about our file system.", "allOf": [ { "$ref": "#/components/schemas/FileSystemMetadata", @@ -2848,14 +7159,14 @@ "#/components/schemas/Metadata" ] } - ], - "description": "Metadata about our file system." + ] }, "git_hash": { "description": "The git hash of the server.", "type": "string" }, "pubsub": { + "description": "Metadata about our pub-sub connection.", "allOf": [ { "$ref": "#/components/schemas/Connection", @@ -2864,8 +7175,7 @@ "#/components/schemas/Metadata" ] } - ], - "description": "Metadata about our pub-sub connection." + ] } }, "required": [ @@ -2875,11 +7185,11 @@ "fs", "git_hash", "pubsub" - ], - "type": "object" + ] }, "Method": { "description": "The Request Method (VERB)\n\nThis type also contains constants for a number of common HTTP methods such as GET, POST, etc.\n\nCurrently includes 8 variants representing the 8 methods defined in [RFC 7230](https://tools.ietf.org/html/rfc7231#section-4.1), plus PATCH, and an Extension variant for all extensions.", + "type": "string", "enum": [ "OPTIONS", "GET", @@ -2891,26 +7201,26 @@ "CONNECT", "PATCH", "EXTENSION" - ], - "type": "string" + ] }, "OutputFile": { "description": "Output file contents.", + "type": "object", "properties": { "contents": { "description": "The contents of the file. This is base64 encoded so we can ensure it is UTF-8 for JSON.", "type": "string" }, "name": { - "default": "", "description": "The name of the file.", + "default": "", "type": "string" } - }, - "type": "object" + } }, "PaymentIntent": { "description": "A payment intent response.", + "type": "object", "properties": { "client_secret": { "description": "The client secret is used for client-side retrieval using a publishable key. The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.", @@ -2919,13 +7229,14 @@ }, "required": [ "client_secret" - ], - "type": "object" + ] }, "PaymentMethod": { "description": "A payment method.", + "type": "object", "properties": { "billing_info": { + "description": "The billing info for the payment method.", "allOf": [ { "$ref": "#/components/schemas/BillingInfo", @@ -2934,10 +7245,11 @@ "#/components/schemas/PaymentMethod" ] } - ], - "description": "The billing info for the payment method." + ] }, "card": { + "nullable": true, + "description": "The card, if it is one. For our purposes, this is the only type of payment method that we support.", "allOf": [ { "$ref": "#/components/schemas/CardDetails", @@ -2946,28 +7258,27 @@ "#/components/schemas/PaymentMethod" ] } - ], - "description": "The card, if it is one. For our purposes, this is the only type of payment method that we support.", - "nullable": true + ] }, "created_at": { "description": "Time at which the object was created.", - "format": "date-time", - "type": "string" + "type": "string", + "format": "date-time" }, "id": { "description": "Unique identifier for the object.", "type": "string" }, "metadata": { + "description": "Set of key-value pairs.", + "default": {}, + "type": "object", "additionalProperties": { "type": "string" - }, - "default": {}, - "description": "Set of key-value pairs.", - "type": "object" + } }, "type": { + "description": "The type of payment method.", "allOf": [ { "$ref": "#/components/schemas/PaymentMethodType", @@ -2976,19 +7287,18 @@ "#/components/schemas/PaymentMethod" ] } - ], - "description": "The type of payment method." + ] } }, "required": [ "billing_info", "created_at", "type" - ], - "type": "object" + ] }, "PaymentMethodCardChecks": { "description": "Card checks.", + "type": "object", "properties": { "address_line1_check": { "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", @@ -3002,23 +7312,23 @@ "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", "type": "string" } - }, - "type": "object" + } }, "PaymentMethodType": { "description": "An enum representing the possible values of an `PaymentMethod`'s `type` field.", + "type": "string", "enum": [ "card" - ], - "type": "string" + ] }, "PhoneNumber": { - "format": "phone", "title": "String", - "type": "string" + "type": "string", + "format": "phone" }, "Pong": { "description": "The response from the `/ping` endpoint.", + "type": "object", "properties": { "message": { "description": "The pong response.", @@ -3027,27 +7337,28 @@ }, "required": [ "message" - ], - "type": "object" + ] }, "Session": { "description": "An authentication session.\n\nFor our UIs, these are automatically created by Next.js.", + "type": "object", "properties": { "created_at": { "description": "The date and time the session was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "expires": { "description": "The date and time the session expires.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "id": { "description": "The unique identifier for the session.", "type": "string" }, "session_token": { + "description": "The session token.", "allOf": [ { "$ref": "#/components/schemas/Uuid", @@ -3056,13 +7367,12 @@ "#/components/schemas/Session" ] } - ], - "description": "The session token." + ] }, "updated_at": { "description": "The date and time the session was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "user_id": { "description": "The user ID of the user that the session belongs to.", @@ -3074,16 +7384,144 @@ "expires", "session_token", "updated_at" - ], - "type": "object" + ] }, "StatusCode": { - "format": "int32", "title": "int32", - "type": "integer" + "type": "integer", + "format": "int32" + }, + "UnitConversion": { + "description": "A unit conversion.", + "type": "object", + "properties": { + "completed_at": { + "nullable": true, + "description": "The time and date the unit conversion was completed.", + "type": "string", + "format": "partial-date-time" + }, + "created_at": { + "description": "The time and date the unit conversion was created.", + "type": "string", + "format": "partial-date-time" + }, + "error": { + "nullable": true, + "description": "The error the function returned, if any.", + "type": "string" + }, + "id": { + "description": "The unique identifier of the unit conversion.\n\nThis is the same as the API call ID.", + "allOf": [ + { + "$ref": "#/components/schemas/Uuid", + "x-scope": [ + "", + "#/components/schemas/UnitConversion" + ] + } + ] + }, + "input": { + "description": "The input value.", + "default": 0, + "type": "number", + "format": "float" + }, + "output": { + "nullable": true, + "description": "The resulting value.", + "type": "number", + "format": "double" + }, + "output_format": { + "description": "The output format of the unit conversion.", + "allOf": [ + { + "$ref": "#/components/schemas/UnitMetricFormat", + "x-scope": [ + "", + "#/components/schemas/UnitConversion" + ] + } + ] + }, + "src_format": { + "description": "The source format of the unit conversion.", + "allOf": [ + { + "$ref": "#/components/schemas/UnitMetricFormat", + "x-scope": [ + "", + "#/components/schemas/UnitConversion" + ] + } + ] + }, + "started_at": { + "nullable": true, + "description": "The time and date the unit conversion was started.", + "type": "string", + "format": "partial-date-time" + }, + "status": { + "description": "The status of the unit conversion.", + "allOf": [ + { + "$ref": "#/components/schemas/APICallStatus", + "x-scope": [ + "", + "#/components/schemas/UnitConversion" + ] + } + ] + }, + "updated_at": { + "description": "The time and date the unit conversion was last updated.", + "type": "string", + "format": "partial-date-time" + }, + "user_id": { + "description": "The user ID of the user who created the unit conversion.", + "type": "string" + } + }, + "required": [ + "created_at", + "id", + "output_format", + "src_format", + "status", + "updated_at" + ] + }, + "UnitMetricFormat": { + "description": "The valid types of metric unit formats.", + "type": "string", + "enum": [ + "atto", + "femto", + "pico", + "nano", + "micro", + "milli", + "centi", + "deci", + "metric_unit", + "deca", + "hecto", + "kilo", + "mega", + "giga", + "tera", + "peta", + "exa" + ] }, "UpdateUser": { "description": "The user-modifiable parts of a User.", + "type": "object", "properties": { "company": { "description": "The user's company.", @@ -3106,6 +7544,8 @@ "type": "string" }, "phone": { + "description": "The user's phone number.", + "default": "", "allOf": [ { "$ref": "#/components/schemas/PhoneNumber", @@ -3114,15 +7554,13 @@ "#/components/schemas/UpdateUser" ] } - ], - "default": "", - "description": "The user's phone number." + ] } - }, - "type": "object" + } }, "User": { "description": "A user.", + "type": "object", "properties": { "company": { "description": "The user's company.", @@ -3130,8 +7568,8 @@ }, "created_at": { "description": "The date and time the user was created.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" }, "discord": { "description": "The user's Discord handle.", @@ -3139,14 +7577,14 @@ }, "email": { "description": "The email address of the user.", - "format": "email", - "type": "string" + "type": "string", + "format": "email" }, "email_verified": { - "description": "The date and time the email address was verified.", - "format": "partial-date-time", "nullable": true, - "type": "string" + "description": "The date and time the email address was verified.", + "type": "string", + "format": "partial-date-time" }, "first_name": { "description": "The user's first name.", @@ -3173,6 +7611,8 @@ "type": "string" }, "phone": { + "description": "The user's phone number.", + "default": "", "allOf": [ { "$ref": "#/components/schemas/PhoneNumber", @@ -3181,4149 +7621,121 @@ "#/components/schemas/User" ] } - ], - "default": "", - "description": "The user's phone number." + ] }, "updated_at": { "description": "The date and time the user was last updated.", - "format": "partial-date-time", - "type": "string" + "type": "string", + "format": "partial-date-time" } }, "required": [ "created_at", "updated_at" - ], - "type": "object" + ] }, "UserResultsPage": { "description": "A single page of results", + "type": "object", "properties": { "items": { "description": "list of items on this page of results", + "type": "array", "items": { "$ref": "#/components/schemas/User", "x-scope": [ "", "#/components/schemas/UserResultsPage" ] - }, - "type": "array" + } }, "next_page": { - "description": "token used to fetch the next page of results (if any)", "nullable": true, + "description": "token used to fetch the next page of results (if any)", "type": "string" } }, "required": [ "items" - ], - "type": "object" + ] }, "Uuid": { "description": "A uuid.\n\nA Version 4 UUID is a universally unique identifier that is generated using random numbers.", - "format": "uuid", - "type": "string" - } - } - }, - "info": { - "contact": { - "email": "api@kittycad.io", - "url": "https://kittycad.io" - }, - "description": "API server for KittyCAD", - "title": "KittyCAD API", - "version": "0.1.0", - "x-go": { - "client": "// Create a client with your token.\nclient, err := kittycad.NewClient(\"$TOKEN\", \"your apps user agent\")\nif err != nil {\n panic(err)\n}\n\n// - OR -\n\n// Create a new client with your token parsed from the environment\n// variable: KITTYCAD_API_TOKEN.\nclient, err := kittycad.NewClientFromEnv(\"your apps user agent\")\nif err != nil {\n panic(err)\n}", - "install": "go get github.com/kittycad/kittycad.go" - }, - "x-python": { - "client": "# Create a client with your token.\nfrom kittycad 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 import ClientFromEnv\n\nclient = ClientFromEnv()", - "install": "pip install kittycad" - } - }, - "openapi": "3.0.3", - "paths": { - "/": { - "get": { - "operationId": "get_schema", - "responses": { - "200": { - "content": { - "application/json": { - "schema": {} - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get OpenAPI schema.", - "tags": [ - "meta" - ], - "x-go": { - "example": "// GetSchema: Get OpenAPI schema.\nresponseGetSchema, err := client.Meta.GetSchema()", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#MetaService.GetSchema" - }, - "x-python": { - "example": "from kittycad.models import dict\nfrom kittycad.api.meta import get_schema\nfrom kittycad.types import Response\n\nfc: dict = get_schema.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[dict] = get_schema.sync_detailed(client=client)\n\n# OR run async\nfc: dict = await get_schema.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[dict] = await get_schema.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.meta.get_schema.html" - } - } - }, - "/_meta/info": { - "get": { - "description": "This includes information on any of our other distributed systems it is connected to.\nYou must be a KittyCAD employee to perform this request.", - "operationId": "get_metadata", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Metadata", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get the metadata about our currently running server.", - "tags": [ - "meta", - "hidden" - ], - "x-go": { - "example": "// Getdata: Get the metadata about our currently running server.\n//\n// This includes information on any of our other distributed systems it is connected to.\n// You must be a KittyCAD employee to perform this request.\nmetadata, err := client.Meta.Getdata()", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#MetaService.Getdata" - }, - "x-python": { - "example": "from kittycad.models import Metadata\nfrom kittycad.api.meta import get_metadata\nfrom kittycad.types import Response\n\nfc: Metadata = get_metadata.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Metadata] = get_metadata.sync_detailed(client=client)\n\n# OR run async\nfc: Metadata = await get_metadata.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[Metadata] = await get_metadata.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.meta.get_metadata.html" - } - } - }, - "/api-call-metrics": { - "get": { - "description": "This endpoint requires authentication by a KittyCAD employee. The API calls are grouped by the parameter passed.", - "operationId": "get_api_call_metrics", - "parameters": [ - { - "description": "What field to group the metrics by.", - "in": "query", - "name": "group_by", - "required": true, - "schema": { - "$ref": "#/components/schemas/ApiCallQueryGroupBy", - "x-scope": [ - "" - ] - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ApiCallQueryGroup", - "x-scope": [ - "" - ] - }, - "title": "Array_of_ApiCallQueryGroup", - "type": "array" - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get API call metrics.", - "tags": [ - "api-calls", - "hidden" - ], - "x-go": { - "example": "// GetMetrics: Get API call metrics.\n//\n// This endpoint requires authentication by a KittyCAD employee. The API calls are grouped by the parameter passed.\n//\n// Parameters:\n//\t- `groupBy`: What field to group the metrics by.\nAPICallQueryGroup, err := client.APICall.GetMetrics(groupBy)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.GetMetrics" - }, - "x-python": { - "example": "from kittycad.models import [ApiCallQueryGroup]\nfrom kittycad.api.api-calls import get_api_call_metrics\nfrom kittycad.types import Response\n\nfc: [ApiCallQueryGroup] = get_api_call_metrics.sync(client=client, group_by=ApiCallQueryGroupBy)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[[ApiCallQueryGroup]] = get_api_call_metrics.sync_detailed(client=client, group_by=ApiCallQueryGroupBy)\n\n# OR run async\nfc: [ApiCallQueryGroup] = await get_api_call_metrics.asyncio(client=client, group_by=ApiCallQueryGroupBy)\n\n# OR run async with more info\nresponse: Response[[ApiCallQueryGroup]] = await get_api_call_metrics.asyncio_detailed(client=client, group_by=ApiCallQueryGroupBy)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.get_api_call_metrics.html" - } - } - }, - "/api-calls": { - "get": { - "description": "This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first.", - "operationId": "list_api_calls", - "parameters": [ - { - "description": "Maximum number of items returned by a single call", - "in": "query", - "name": "limit", - "schema": { - "format": "uint32", - "minimum": 1, - "nullable": true, - "type": "integer" - }, - "style": "form" - }, - { - "description": "Token returned by previous call to retrieve the subsequent page", - "in": "query", - "name": "page_token", - "schema": { - "nullable": true, - "type": "string" - }, - "style": "form" - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "$ref": "#/components/schemas/CreatedAtSortMode", - "x-scope": [ - "" - ] - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiCallWithPriceResultsPage", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "List API calls.", - "tags": [ - "api-calls", - "hidden" - ], - "x-dropshot-pagination": true, - "x-go": { - "example": "// List: List API calls.\n//\n// This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// To iterate over all pages, use the `ListAllPages` method, instead.\n//\n// Parameters:\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\naPICallWithPriceResultsPage, err := client.APICall.List(limit, pageToken, sortBy)\n\n// - OR -\n\n// ListAllPages: List API calls.\n//\n// This endpoint requires authentication by a KittyCAD employee. The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// This method is a wrapper around the `List` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `sortBy`\nAPICallWithPrice, err := client.APICall.ListAllPages(sortBy)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.List" - }, - "x-python": { - "example": "from kittycad.models import ApiCallWithPriceResultsPage\nfrom kittycad.api.api-calls import list_api_calls\nfrom kittycad.types import Response\n\nfc: ApiCallWithPriceResultsPage = list_api_calls.sync(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiCallWithPriceResultsPage] = list_api_calls.sync_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async\nfc: ApiCallWithPriceResultsPage = await list_api_calls.asyncio(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async with more info\nresponse: Response[ApiCallWithPriceResultsPage] = await list_api_calls.asyncio_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.list_api_calls.html" - } - } - }, - "/api-calls/{id}": { - "get": { - "description": "This endpoint requires authentication by any KittyCAD 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 KittyCAD employees can view API calls for other users.", - "operationId": "get_api_call", - "parameters": [ - { - "description": "The ID of the API call.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiCallWithPrice", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get details of an API call.", - "tags": [ - "api-calls", - "hidden" - ], - "x-go": { - "example": "// Get: Get details of an API call.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.\n// If the user is not authenticated to view the specified API call, then it is not returned.\n// Only KittyCAD employees can view API calls for other users.\n//\n// Parameters:\n//\t- `id`: The ID of the API call.\naPICallWithPrice, err := client.APICall.Get(id)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.Get" - }, - "x-python": { - "example": "from kittycad.models import ApiCallWithPrice\nfrom kittycad.api.api-calls import get_api_call\nfrom kittycad.types import Response\n\nfc: ApiCallWithPrice = get_api_call.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiCallWithPrice] = get_api_call.sync_detailed(client=client, id=)\n\n# OR run async\nfc: ApiCallWithPrice = await get_api_call.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[ApiCallWithPrice] = await get_api_call.asyncio_detailed(client=client, id=)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.get_api_call.html" - } - } - }, - "/async/operations": { - "get": { - "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 KittyCAD employee.", - "operationId": "list_async_operations", - "parameters": [ - { - "description": "Maximum number of items returned by a single call", - "in": "query", - "name": "limit", - "schema": { - "format": "uint32", - "minimum": 1, - "nullable": true, - "type": "integer" - }, - "style": "form" - }, - { - "description": "Token returned by previous call to retrieve the subsequent page", - "in": "query", - "name": "page_token", - "schema": { - "nullable": true, - "type": "string" - }, - "style": "form" - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "$ref": "#/components/schemas/CreatedAtSortMode", - "x-scope": [ - "" - ] - }, - "style": "form" - }, - { - "description": "The status to filter by.", - "in": "query", - "name": "status", - "schema": { - "$ref": "#/components/schemas/APICallStatus", - "x-scope": [ - "" - ] - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AsyncApiCallResultsPage", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "List async operations.", - "tags": [ - "api-calls", - "hidden" - ], - "x-dropshot-pagination": true, - "x-go": { - "example": "// ListAsyncOperations: List async operations.\n//\n// 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// This endpoint requires authentication by a KittyCAD employee.\n//\n// To iterate over all pages, use the `ListAsyncOperationsAllPages` method, instead.\n//\n// Parameters:\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\n//\t- `status`: The status to filter by.\nasyncAPICallResultsPage, err := client.APICall.ListAsyncOperations(limit, pageToken, sortBy, status)\n\n// - OR -\n\n// ListAsyncOperationsAllPages: List async operations.\n//\n// 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// This endpoint requires authentication by a KittyCAD employee.\n//\n// This method is a wrapper around the `ListAsyncOperations` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `sortBy`\n//\t- `status`: The status to filter by.\nAsyncAPICall, err := client.APICall.ListAsyncOperationsAllPages(sortBy, status)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.ListAsyncOperations" - }, - "x-python": { - "example": "from kittycad.models import AsyncApiCallResultsPage\nfrom kittycad.api.api-calls import list_async_operations\nfrom kittycad.types import Response\n\nfc: AsyncApiCallResultsPage = list_async_operations.sync(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode, status=APICallStatus)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[AsyncApiCallResultsPage] = list_async_operations.sync_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode, status=APICallStatus)\n\n# OR run async\nfc: AsyncApiCallResultsPage = await list_async_operations.asyncio(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode, status=APICallStatus)\n\n# OR run async with more info\nresponse: Response[AsyncApiCallResultsPage] = await list_async_operations.asyncio_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode, status=APICallStatus)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.list_async_operations.html" - } - } - }, - "/async/operations/{id}": { - "get": { - "description": "Get the status and output of an async operation.\nThis endpoint requires authentication by any KittyCAD 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 KittyCAD employees with the proper access can view async operations for other users.", - "operationId": "get_async_operation", - "parameters": [ - { - "description": "The ID of the async operation.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AsyncApiCallOutput", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get an async operation.", - "tags": [ - "api-calls" - ], - "x-go": { - "example": "// GetAsyncOperation: Get an async operation.\n//\n// Get the status and output of an async operation.\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested async operation for the user.\n// If the user is not authenticated to view the specified async operation, then it is not returned.\n// Only KittyCAD employees with the proper access can view async operations for other users.\n//\n// Parameters:\n//\t- `id`: The ID of the async operation.\nasyncAPICallOutput, err := client.APICall.GetAsyncOperation(id)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.GetAsyncOperation" - }, - "x-python": { - "example": "from kittycad.models import FileConversion\nfrom kittycad.api.api-calls import get_async_operation\nfrom kittycad.types import Response\n\nfc: FileConversion = get_async_operation.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileConversion] = get_async_operation.sync_detailed(client=client, id=)\n\n# OR run async\nfc: FileConversion = await get_async_operation.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[FileConversion] = await get_async_operation.asyncio_detailed(client=client, id=)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.get_async_operation.html" - } - } - }, - "/file/conversion/{src_format}/{output_format}": { - "post": { - "description": "Convert 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.", - "operationId": "create_file_conversion", - "parameters": [ - { - "description": "The format the file should be converted to.", - "in": "path", - "name": "output_format", - "required": true, - "schema": { - "$ref": "#/components/schemas/FileOutputFormat", - "x-scope": [ - "" - ] - }, - "style": "simple" - }, - { - "description": "The format of the file to convert.", - "in": "path", - "name": "src_format", - "required": true, - "schema": { - "$ref": "#/components/schemas/FileSourceFormat", - "x-scope": [ - "" - ] - }, - "style": "simple" - } - ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "format": "binary", - "type": "string" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileConversion", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful creation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Convert CAD file.", - "tags": [ - "file" - ], - "x-go": { - "example": "// CreateConversion: Convert CAD file.\n//\n// Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.\n// If the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string.\n// 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.\n//\n// Parameters:\n//\t- `outputFormat`: The format the file should be converted to.\n//\t- `srcFormat`: The format of the file to convert.\nfileConversion, err := client.File.CreateConversion(outputFormat, srcFormat, body)\n\n// - OR -\n\n// CreateConversionWithBase64Helper will automatically base64 encode and decode the contents\n// of the file body.\n//\n// This function is a wrapper around the CreateConversion function.\nfileConversion, err := client.File.CreateConversionWithBase64Helper(outputFormat, srcFormat, body)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateConversion" - }, - "x-python": { - "example": "from kittycad.models import FileConversion\nfrom kittycad.api.file import create_file_conversion_with_base64_helper\nfrom kittycad.types import Response\n\nfc: FileConversion = create_file_conversion_with_base64_helper.sync(client=client, output_format=FileOutputFormat, src_format=FileSourceFormat, body=bytes)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileConversion] = create_file_conversion_with_base64_helper.sync_detailed(client=client, output_format=FileOutputFormat, src_format=FileSourceFormat, body=bytes)\n\n# OR run async\nfc: FileConversion = await create_file_conversion_with_base64_helper.asyncio(client=client, output_format=FileOutputFormat, src_format=FileSourceFormat, body=bytes)\n\n# OR run async with more info\nresponse: Response[FileConversion] = await create_file_conversion_with_base64_helper.asyncio_detailed(client=client, output_format=FileOutputFormat, src_format=FileSourceFormat, body=bytes)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.create_file_conversion_with_base64_helper.html" - } - } - }, - "/file/conversions/{id}": { - "get": { - "description": "Get the status and output of an async file conversion.\nThis endpoint requires authentication by any KittyCAD user. It returns details of the requested file conversion for the user.\nIf the user is not authenticated to view the specified file conversion, then it is not returned.\nOnly KittyCAD employees with the proper access can view file conversions for other users.", - "operationId": "get_file_conversion", - "parameters": [ - { - "description": "The ID of the async operation.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AsyncApiCallOutput", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get a file conversion.", - "tags": [ - "file" - ], - "x-go": { - "example": "// GetConversion: Get a file conversion.\n//\n// Get the status and output of an async file conversion.\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested file conversion for the user.\n// If the user is not authenticated to view the specified file conversion, then it is not returned.\n// Only KittyCAD employees with the proper access can view file conversions for other users.\n//\n// Parameters:\n//\t- `id`: The ID of the async operation.\nasyncAPICallOutput, err := client.File.GetConversion(id)\n\n// - OR -\n\n// GetConversionWithBase64Helper will automatically base64 encode and decode the contents\n// of the file body.\n//\n// This function is a wrapper around the GetConversion function.\nasyncAPICallOutput, err := client.File.GetConversionWithBase64Helper(id)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.GetConversion" - }, - "x-python": { - "example": "from kittycad.models import FileConversion\nfrom kittycad.api.file import get_file_conversion_with_base64_helper\nfrom kittycad.types import Response\n\nfc: FileConversion = get_file_conversion_with_base64_helper.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileConversion] = get_file_conversion_with_base64_helper.sync_detailed(client=client, id=)\n\n# OR run async\nfc: FileConversion = await get_file_conversion_with_base64_helper.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[FileConversion] = await get_file_conversion_with_base64_helper.asyncio_detailed(client=client, id=)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.get_file_conversion_with_base64_helper.html" - } - } - }, - "/file/density": { - "post": { - "description": "Get 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.", - "operationId": "create_file_density", - "parameters": [ - { - "description": "The material mass.", - "in": "query", - "name": "material_mass", - "required": true, - "schema": { - "format": "float", - "type": "number" - }, - "style": "form" - }, - { - "description": "The format of the file.", - "in": "query", - "name": "src_format", - "required": true, - "schema": { - "$ref": "#/components/schemas/FileSourceFormat", - "x-scope": [ - "" - ] - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "format": "binary", - "type": "string" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileDensity", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful creation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get CAD file density.", - "tags": [ - "file", - "beta" - ], - "x-go": { - "example": "// CreateDensity: Get CAD file density.\n//\n// Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// 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.\n//\n// Parameters:\n//\t- `materialMass`: The material mass.\n//\t- `srcFormat`: The format of the file.\nfileDensity, err := client.File.CreateDensity(materialMass, srcFormat, body)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateDensity" - }, - "x-python": { - "example": "from kittycad.models import FileDensity\nfrom kittycad.api.file import create_file_density\nfrom kittycad.types import Response\n\nfc: FileDensity = create_file_density.sync(client=client, material_mass=\"\", src_format=FileSourceFormat, body=bytes)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileDensity] = create_file_density.sync_detailed(client=client, material_mass=\"\", src_format=FileSourceFormat, body=bytes)\n\n# OR run async\nfc: FileDensity = await create_file_density.asyncio(client=client, material_mass=\"\", src_format=FileSourceFormat, body=bytes)\n\n# OR run async with more info\nresponse: Response[FileDensity] = await create_file_density.asyncio_detailed(client=client, material_mass=\"\", src_format=FileSourceFormat, body=bytes)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.create_file_density.html" - } - } - }, - "/file/execute/{lang}": { - "post": { - "operationId": "create_file_execution", - "parameters": [ - { - "description": "The language of the code.", - "in": "path", - "name": "lang", - "required": true, - "schema": { - "$ref": "#/components/schemas/CodeLanguage", - "x-scope": [ - "" - ] - }, - "style": "simple" - }, - { - "description": "The output file we want to get the contents for (the paths are relative to where in litterbox it is being run). You can denote more than one file with a comma separated list of string paths.", - "in": "query", - "name": "output", - "schema": { - "nullable": true, - "type": "string" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "format": "binary", - "type": "string" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CodeOutput", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Execute a KittyCAD program in a specific language.", - "tags": [ - "file", - "hidden" - ], - "x-go": { - "example": "// CreateExecution: Execute a KittyCAD program in a specific language.\n//\n// Parameters:\n//\t- `lang`: The language of the code.\n//\t- `output`: The output file we want to get the contents for (the paths are relative to where in litterbox it is being run). You can denote more than one file with a comma separated list of string paths.\ncodeOutput, err := client.File.CreateExecution(lang, output, body)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateExecution" - }, - "x-python": { - "example": "from kittycad.models import CodeOutput\nfrom kittycad.api.file import create_file_execution\nfrom kittycad.types import Response\n\nfc: CodeOutput = create_file_execution.sync(client=client, lang=CodeLanguage, output=, body=bytes)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[CodeOutput] = create_file_execution.sync_detailed(client=client, lang=CodeLanguage, output=, body=bytes)\n\n# OR run async\nfc: CodeOutput = await create_file_execution.asyncio(client=client, lang=CodeLanguage, output=, body=bytes)\n\n# OR run async with more info\nresponse: Response[CodeOutput] = await create_file_execution.asyncio_detailed(client=client, lang=CodeLanguage, output=, body=bytes)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.create_file_execution.html" - } - } - }, - "/file/mass": { - "post": { - "description": "Get 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.", - "operationId": "create_file_mass", - "parameters": [ - { - "description": "The material density.", - "in": "query", - "name": "material_density", - "required": true, - "schema": { - "format": "float", - "type": "number" - }, - "style": "form" - }, - { - "description": "The format of the file.", - "in": "query", - "name": "src_format", - "required": true, - "schema": { - "$ref": "#/components/schemas/FileSourceFormat", - "x-scope": [ - "" - ] - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "format": "binary", - "type": "string" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileMass", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful creation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get CAD file mass.", - "tags": [ - "file", - "beta" - ], - "x-go": { - "example": "// CreateMass: Get CAD file mass.\n//\n// Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// 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.\n//\n// Parameters:\n//\t- `materialDensity`: The material density.\n//\t- `srcFormat`: The format of the file.\nfileMass, err := client.File.CreateMass(materialDensity, srcFormat, body)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateMass" - }, - "x-python": { - "example": "from kittycad.models import FileMass\nfrom kittycad.api.file import create_file_mass\nfrom kittycad.types import Response\n\nfc: FileMass = create_file_mass.sync(client=client, material_density=\"\", src_format=FileSourceFormat, body=bytes)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileMass] = create_file_mass.sync_detailed(client=client, material_density=\"\", src_format=FileSourceFormat, body=bytes)\n\n# OR run async\nfc: FileMass = await create_file_mass.asyncio(client=client, material_density=\"\", src_format=FileSourceFormat, body=bytes)\n\n# OR run async with more info\nresponse: Response[FileMass] = await create_file_mass.asyncio_detailed(client=client, material_density=\"\", src_format=FileSourceFormat, body=bytes)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.create_file_mass.html" - } - } - }, - "/file/volume": { - "post": { - "description": "Get 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.", - "operationId": "create_file_volume", - "parameters": [ - { - "description": "The format of the file.", - "in": "query", - "name": "src_format", - "required": true, - "schema": { - "$ref": "#/components/schemas/FileSourceFormat", - "x-scope": [ - "" - ] - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "format": "binary", - "type": "string" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileVolume", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful creation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get CAD file volume.", - "tags": [ - "file", - "beta" - ], - "x-go": { - "example": "// CreateVolume: Get CAD file volume.\n//\n// Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.\n// 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.\n//\n// Parameters:\n//\t- `srcFormat`: The format of the file.\nfileVolume, err := client.File.CreateVolume(srcFormat, body)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.CreateVolume" - }, - "x-python": { - "example": "from kittycad.models import FileVolume\nfrom kittycad.api.file import create_file_volume\nfrom kittycad.types import Response\n\nfc: FileVolume = create_file_volume.sync(client=client, src_format=FileSourceFormat, body=bytes)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileVolume] = create_file_volume.sync_detailed(client=client, src_format=FileSourceFormat, body=bytes)\n\n# OR run async\nfc: FileVolume = await create_file_volume.asyncio(client=client, src_format=FileSourceFormat, body=bytes)\n\n# OR run async with more info\nresponse: Response[FileVolume] = await create_file_volume.asyncio_detailed(client=client, src_format=FileSourceFormat, body=bytes)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.create_file_volume.html" - } - } - }, - "/login": { - "post": { - "operationId": "login", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LoginParams", - "x-scope": [ - "" - ] - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "resource updated", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Set-Cookie": { - "description": "Set-Cookie header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "This endpoint sets a session cookie for a user.", - "tags": [ - "hidden" - ], - "x-go": { - "example": "// Login: This endpoint sets a session cookie for a user.\nif err := client.Hidden.Login(body); err != nil {\n\tpanic(err)\n}", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#HiddenService.Login" - }, - "x-python": { - "example": "from kittycad.models import Error\nfrom kittycad.api.hidden import login\nfrom kittycad.types import Response\n\nfc: Error = login.sync(client=client, body=LoginParams)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Error] = login.sync_detailed(client=client, body=LoginParams)\n\n# OR run async\nfc: Error = await login.asyncio(client=client, body=LoginParams)\n\n# OR run async with more info\nresponse: Response[Error] = await login.asyncio_detailed(client=client, body=LoginParams)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.hidden.login.html" - } - } - }, - "/ping": { - "get": { - "operationId": "ping", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Pong", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Return pong.", - "tags": [ - "meta" - ], - "x-go": { - "example": "// Ping: Return pong.\npong, err := client.Meta.Ping()", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#MetaService.Ping" - }, - "x-python": { - "example": "from kittycad.models import Pong\nfrom kittycad.api.meta import ping\nfrom kittycad.types import Response\n\nfc: Pong = ping.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Pong] = ping.sync_detailed(client=client)\n\n# OR run async\nfc: Pong = await ping.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[Pong] = await ping.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.meta.ping.html" - } - } - }, - "/user": { - "get": { - "description": "Get the user information for the authenticated user.\nAlternatively, you can also use the `/users/me` endpoint.", - "operationId": "get_user_self", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/User", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get your user.", - "tags": [ - "users" - ], - "x-go": { - "example": "// GetSelf: Get your user.\n//\n// Get the user information for the authenticated user.\n// Alternatively, you can also use the `/users/me` endpoint.\nuser, err := client.User.GetSelf()", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.GetSelf" - }, - "x-python": { - "example": "from kittycad.models import User\nfrom kittycad.api.users import get_user_self\nfrom kittycad.types import Response\n\nfc: User = get_user_self.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[User] = get_user_self.sync_detailed(client=client)\n\n# OR run async\nfc: User = await get_user_self.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[User] = await get_user_self.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.get_user_self.html" - } - }, - "options": { - "description": "This is necessary for some preflight requests, specifically DELETE and PUT.", - "operationId": "options_user_self", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "enum": [ - null - ], - "title": "Null", - "type": "string" - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "OPTIONS endpoint for users.", - "tags": [ - "hidden" - ] - }, - "put": { - "description": "This endpoint requires authentication by any KittyCAD user. It updates information about the authenticated user.", - "operationId": "update_user_self", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateUser", - "x-scope": [ - "" - ] - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/User", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Update your user.", - "tags": [ - "users" - ], - "x-go": { - "example": "// UpdateSelf: Update your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It updates information about the authenticated user.\nuser, err := client.User.UpdateSelf(body)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.UpdateSelf" - }, - "x-python": { - "example": "from kittycad.models import User\nfrom kittycad.api.users import update_user_self\nfrom kittycad.types import Response\n\nfc: User = update_user_self.sync(client=client, body=UpdateUser)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[User] = update_user_self.sync_detailed(client=client, body=UpdateUser)\n\n# OR run async\nfc: User = await update_user_self.asyncio(client=client, body=UpdateUser)\n\n# OR run async with more info\nresponse: Response[User] = await update_user_self.asyncio_detailed(client=client, body=UpdateUser)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.update_user_self.html" - } - } - }, - "/user/api-calls": { - "get": { - "description": "This endpoint requires authentication by any KittyCAD 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.", - "operationId": "user_list_api_calls", - "parameters": [ - { - "description": "Maximum number of items returned by a single call", - "in": "query", - "name": "limit", - "schema": { - "format": "uint32", - "minimum": 1, - "nullable": true, - "type": "integer" - }, - "style": "form" - }, - { - "description": "Token returned by previous call to retrieve the subsequent page", - "in": "query", - "name": "page_token", - "schema": { - "nullable": true, - "type": "string" - }, - "style": "form" - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "$ref": "#/components/schemas/CreatedAtSortMode", - "x-scope": [ - "" - ] - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiCallWithPriceResultsPage", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "List API calls for your user.", - "tags": [ - "api-calls" - ], - "x-dropshot-pagination": true, - "x-go": { - "example": "// UserList: List API calls for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// To iterate over all pages, use the `UserListAllPages` method, instead.\n//\n// Parameters:\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\naPICallWithPriceResultsPage, err := client.APICall.UserList(limit, pageToken, sortBy)\n\n// - OR -\n\n// UserListAllPages: List API calls for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// This method is a wrapper around the `UserList` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `sortBy`\nAPICallWithPrice, err := client.APICall.UserListAllPages(sortBy)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.UserList" - }, - "x-python": { - "example": "from kittycad.models import ApiCallWithPriceResultsPage\nfrom kittycad.api.api-calls import user_list_api_calls\nfrom kittycad.types import Response\n\nfc: ApiCallWithPriceResultsPage = user_list_api_calls.sync(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiCallWithPriceResultsPage] = user_list_api_calls.sync_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async\nfc: ApiCallWithPriceResultsPage = await user_list_api_calls.asyncio(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async with more info\nresponse: Response[ApiCallWithPriceResultsPage] = await user_list_api_calls.asyncio_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.user_list_api_calls.html" - } - } - }, - "/user/api-calls/{id}": { - "get": { - "description": "This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.", - "operationId": "get_api_call_for_user", - "parameters": [ - { - "description": "The ID of the API call.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiCallWithPrice", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get an API call for a user.", - "tags": [ - "api-calls" - ], - "x-go": { - "example": "// GetForUser: Get an API call for a user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API call for the user.\n//\n// Parameters:\n//\t- `id`: The ID of the API call.\naPICallWithPrice, err := client.APICall.GetForUser(id)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.GetForUser" - }, - "x-python": { - "example": "from kittycad.models import ApiCallWithPrice\nfrom kittycad.api.api-calls import get_api_call_for_user\nfrom kittycad.types import Response\n\nfc: ApiCallWithPrice = get_api_call_for_user.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiCallWithPrice] = get_api_call_for_user.sync_detailed(client=client, id=)\n\n# OR run async\nfc: ApiCallWithPrice = await get_api_call_for_user.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[ApiCallWithPrice] = await get_api_call_for_user.asyncio_detailed(client=client, id=)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.get_api_call_for_user.html" - } - } - }, - "/user/api-tokens": { - "get": { - "description": "This endpoint requires authentication by any KittyCAD 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.", - "operationId": "list_api_tokens_for_user", - "parameters": [ - { - "description": "Maximum number of items returned by a single call", - "in": "query", - "name": "limit", - "schema": { - "format": "uint32", - "minimum": 1, - "nullable": true, - "type": "integer" - }, - "style": "form" - }, - { - "description": "Token returned by previous call to retrieve the subsequent page", - "in": "query", - "name": "page_token", - "schema": { - "nullable": true, - "type": "string" - }, - "style": "form" - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "$ref": "#/components/schemas/CreatedAtSortMode", - "x-scope": [ - "" - ] - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiTokenResultsPage", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "List API tokens for your user.", - "tags": [ - "api-tokens" - ], - "x-dropshot-pagination": true, - "x-go": { - "example": "// ListForUser: List API tokens for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns the API tokens for the authenticated user.\n// The API tokens are returned in order of creation, with the most recently created API tokens first.\n//\n// To iterate over all pages, use the `ListForUserAllPages` method, instead.\n//\n// Parameters:\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\naPITokenResultsPage, err := client.APIToken.ListForUser(limit, pageToken, sortBy)\n\n// - OR -\n\n// ListForUserAllPages: List API tokens for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns the API tokens for the authenticated user.\n// The API tokens are returned in order of creation, with the most recently created API tokens first.\n//\n// This method is a wrapper around the `ListForUser` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `sortBy`\nAPIToken, err := client.APIToken.ListForUserAllPages(sortBy)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APITokenService.ListForUser" - }, - "x-python": { - "example": "from kittycad.models import ApiTokenResultsPage\nfrom kittycad.api.api-tokens import list_api_tokens_for_user\nfrom kittycad.types import Response\n\nfc: ApiTokenResultsPage = list_api_tokens_for_user.sync(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiTokenResultsPage] = list_api_tokens_for_user.sync_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async\nfc: ApiTokenResultsPage = await list_api_tokens_for_user.asyncio(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async with more info\nresponse: Response[ApiTokenResultsPage] = await list_api_tokens_for_user.asyncio_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-tokens.list_api_tokens_for_user.html" - } - }, - "post": { - "description": "This endpoint requires authentication by any KittyCAD user. It creates a new API token for the authenticated user.", - "operationId": "create_api_token_for_user", - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful creation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Create a new API token for your user.", - "tags": [ - "api-tokens" - ], - "x-go": { - "example": "// CreateForUser: Create a new API token for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It creates a new API token for the authenticated user.\naPIToken, err := client.APIToken.CreateForUser()", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APITokenService.CreateForUser" - }, - "x-python": { - "example": "from kittycad.models import ApiToken\nfrom kittycad.api.api-tokens import create_api_token_for_user\nfrom kittycad.types import Response\n\nfc: ApiToken = create_api_token_for_user.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiToken] = create_api_token_for_user.sync_detailed(client=client)\n\n# OR run async\nfc: ApiToken = await create_api_token_for_user.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[ApiToken] = await create_api_token_for_user.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-tokens.create_api_token_for_user.html" - } - } - }, - "/user/api-tokens/{token}": { - "delete": { - "description": "This endpoint requires authentication by any KittyCAD 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.", - "operationId": "delete_api_token_for_user", - "parameters": [ - { - "description": "The API token.", - "in": "path", - "name": "token", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - }, - "style": "simple" - } - ], - "responses": { - "204": { - "description": "successful deletion", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Delete an API token for your user.", - "tags": [ - "api-tokens" - ], - "x-go": { - "example": "// DeleteForUser: Delete an API token for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It deletes the requested API token for the user.\n// 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.\n//\n// Parameters:\n//\t- `token`: The API token.\nif err := client.APIToken.DeleteForUser(token); err != nil {\n\tpanic(err)\n}", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APITokenService.DeleteForUser" - }, - "x-python": { - "example": "from kittycad.models import Error\nfrom kittycad.api.api-tokens import delete_api_token_for_user\nfrom kittycad.types import Response\n\nfc: Error = delete_api_token_for_user.sync(client=client, token=\"\")\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Error] = delete_api_token_for_user.sync_detailed(client=client, token=\"\")\n\n# OR run async\nfc: Error = await delete_api_token_for_user.asyncio(client=client, token=\"\")\n\n# OR run async with more info\nresponse: Response[Error] = await delete_api_token_for_user.asyncio_detailed(client=client, token=\"\")", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-tokens.delete_api_token_for_user.html" - } - }, - "get": { - "description": "This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.", - "operationId": "get_api_token_for_user", - "parameters": [ - { - "description": "The API token.", - "in": "path", - "name": "token", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - }, - "style": "simple" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiToken", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get an API token for your user.", - "tags": [ - "api-tokens" - ], - "x-go": { - "example": "// GetForUser: Get an API token for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.\n//\n// Parameters:\n//\t- `token`: The API token.\naPIToken, err := client.APIToken.GetForUser(token)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APITokenService.GetForUser" - }, - "x-python": { - "example": "from kittycad.models import ApiToken\nfrom kittycad.api.api-tokens import get_api_token_for_user\nfrom kittycad.types import Response\n\nfc: ApiToken = get_api_token_for_user.sync(client=client, token=\"\")\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiToken] = get_api_token_for_user.sync_detailed(client=client, token=\"\")\n\n# OR run async\nfc: ApiToken = await get_api_token_for_user.asyncio(client=client, token=\"\")\n\n# OR run async with more info\nresponse: Response[ApiToken] = await get_api_token_for_user.asyncio_detailed(client=client, token=\"\")", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-tokens.get_api_token_for_user.html" - } - }, - "options": { - "description": "This is necessary for some preflight requests, specifically DELETE.", - "operationId": "options_api_token_for_user", - "parameters": [ - { - "description": "The API token.", - "in": "path", - "name": "token", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - }, - "style": "simple" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "enum": [ - null - ], - "title": "Null", - "type": "string" - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "OPTIONS endpoint for API tokens.", - "tags": [ - "hidden" - ] - } - }, - "/user/extended": { - "get": { - "description": "Get the user information for the authenticated user.\nAlternatively, you can also use the `/users/me` endpoint.", - "operationId": "get_user_self_extended", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedUser", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get extended information about your user.", - "tags": [ - "users" - ], - "x-go": { - "example": "// GetSelfExtended: Get extended information about your user.\n//\n// Get the user information for the authenticated user.\n// Alternatively, you can also use the `/users/me` endpoint.\nextendedUser, err := client.User.GetSelfExtended()", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.GetSelfExtended" - }, - "x-python": { - "example": "from kittycad.models import ExtendedUser\nfrom kittycad.api.users import get_user_self_extended\nfrom kittycad.types import Response\n\nfc: ExtendedUser = get_user_self_extended.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ExtendedUser] = get_user_self_extended.sync_detailed(client=client)\n\n# OR run async\nfc: ExtendedUser = await get_user_self_extended.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[ExtendedUser] = await get_user_self_extended.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.get_user_self_extended.html" - } - } - }, - "/user/file/conversions/{id}": { - "get": { - "description": "Get the status and output of an async file conversion. If completed, the contents of the converted file (`output`) will be returned as a base64 encoded string.\nThis endpoint requires authentication by any KittyCAD user. It returns details of the requested file conversion for the user.", - "operationId": "get_file_conversion_for_user", - "parameters": [ - { - "description": "The ID of the async operation.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AsyncApiCallOutput", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get a file conversion for your user.", - "tags": [ - "file" - ], - "x-go": { - "example": "// GetConversionForUser: Get a file conversion for your user.\n//\n// Get the status and output of an async file conversion. If completed, the contents of the converted file (`output`) will be returned as a base64 encoded string.\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested file conversion for the user.\n//\n// Parameters:\n//\t- `id`: The ID of the async operation.\nasyncAPICallOutput, err := client.File.GetConversionForUser(id)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#FileService.GetConversionForUser" - }, - "x-python": { - "example": "from kittycad.models import FileConversion\nfrom kittycad.api.file import get_file_conversion_for_user\nfrom kittycad.types import Response\n\nfc: FileConversion = get_file_conversion_for_user.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[FileConversion] = get_file_conversion_for_user.sync_detailed(client=client, id=)\n\n# OR run async\nfc: FileConversion = await get_file_conversion_for_user.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[FileConversion] = await get_file_conversion_for_user.asyncio_detailed(client=client, id=)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.file.get_file_conversion_for_user.html" - } - } - }, - "/user/payment": { - "delete": { - "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by any KittyCAD user. It deletes the payment information for the authenticated user.", - "operationId": "delete_payment_information_for_user", - "responses": { - "204": { - "description": "successful deletion", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Delete payment info for your user.", - "tags": [ - "payments" - ], - "x-go": { - "example": "// DeleteInformationForUser: Delete payment info for your user.\n//\n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It deletes the payment information for the authenticated user.\nif err := client.Payment.DeleteInformationForUser(); err != nil {\n\tpanic(err)\n}", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.DeleteInformationForUser" - }, - "x-python": { - "example": "from kittycad.models import Error\nfrom kittycad.api.payments import delete_payment_information_for_user\nfrom kittycad.types import Response\n\nfc: Error = delete_payment_information_for_user.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Error] = delete_payment_information_for_user.sync_detailed(client=client)\n\n# OR run async\nfc: Error = await delete_payment_information_for_user.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[Error] = await delete_payment_information_for_user.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.delete_payment_information_for_user.html" - } - }, - "get": { - "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by any KittyCAD user. It gets the payment information for the authenticated user.", - "operationId": "get_payment_information_for_user", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Customer", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get payment info about your user.", - "tags": [ - "payments" - ], - "x-go": { - "example": "// GetInformationForUser: Get payment info about your user.\n//\n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It gets the payment information for the authenticated user.\ncustomer, err := client.Payment.GetInformationForUser()", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.GetInformationForUser" - }, - "x-python": { - "example": "from kittycad.models import Customer\nfrom kittycad.api.payments import get_payment_information_for_user\nfrom kittycad.types import Response\n\nfc: Customer = get_payment_information_for_user.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Customer] = get_payment_information_for_user.sync_detailed(client=client)\n\n# OR run async\nfc: Customer = await get_payment_information_for_user.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[Customer] = await get_payment_information_for_user.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.get_payment_information_for_user.html" - } - }, - "options": { - "description": "This is necessary for some preflight requests, specifically DELETE and PUT.", - "operationId": "options_payment_information_for_user", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "enum": [ - null - ], - "title": "Null", - "type": "string" - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "OPTIONS endpoint for user payment information.", - "tags": [ - "hidden" - ] - }, - "post": { - "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by any KittyCAD user. It creates the payment information for the authenticated user.", - "operationId": "create_payment_information_for_user", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BillingInfo", - "x-scope": [ - "" - ] - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Customer", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful creation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Create payment info for your user.", - "tags": [ - "payments" - ], - "x-go": { - "example": "// CreateInformationForUser: Create payment info for your user.\n//\n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It creates the payment information for the authenticated user.\ncustomer, err := client.Payment.CreateInformationForUser(body)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.CreateInformationForUser" - }, - "x-python": { - "example": "from kittycad.models import Customer\nfrom kittycad.api.payments import create_payment_information_for_user\nfrom kittycad.types import Response\n\nfc: Customer = create_payment_information_for_user.sync(client=client, body=BillingInfo)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Customer] = create_payment_information_for_user.sync_detailed(client=client, body=BillingInfo)\n\n# OR run async\nfc: Customer = await create_payment_information_for_user.asyncio(client=client, body=BillingInfo)\n\n# OR run async with more info\nresponse: Response[Customer] = await create_payment_information_for_user.asyncio_detailed(client=client, body=BillingInfo)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.create_payment_information_for_user.html" - } - }, - "put": { - "description": "This includes billing address, phone, and name.\nThis endpoint requires authentication by any KittyCAD user. It updates the payment information for the authenticated user.", - "operationId": "update_payment_information_for_user", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BillingInfo", - "x-scope": [ - "" - ] - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Customer", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Update payment info for your user.", - "tags": [ - "payments" - ], - "x-go": { - "example": "// UpdateInformationForUser: Update payment info for your user.\n//\n// This includes billing address, phone, and name.\n// This endpoint requires authentication by any KittyCAD user. It updates the payment information for the authenticated user.\ncustomer, err := client.Payment.UpdateInformationForUser(body)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.UpdateInformationForUser" - }, - "x-python": { - "example": "from kittycad.models import Customer\nfrom kittycad.api.payments import update_payment_information_for_user\nfrom kittycad.types import Response\n\nfc: Customer = update_payment_information_for_user.sync(client=client, body=BillingInfo)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Customer] = update_payment_information_for_user.sync_detailed(client=client, body=BillingInfo)\n\n# OR run async\nfc: Customer = await update_payment_information_for_user.asyncio(client=client, body=BillingInfo)\n\n# OR run async with more info\nresponse: Response[Customer] = await update_payment_information_for_user.asyncio_detailed(client=client, body=BillingInfo)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.update_payment_information_for_user.html" - } - } - }, - "/user/payment/intent": { - "post": { - "description": "This endpoint requires authentication by any KittyCAD user. It creates a new payment intent for the authenticated user.", - "operationId": "create_payment_intent_for_user", - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaymentIntent", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful creation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Create a payment intent for your user.", - "tags": [ - "payments", - "hidden" - ], - "x-go": { - "example": "// CreateIntentForUser: Create a payment intent for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It creates a new payment intent for the authenticated user.\npaymentIntent, err := client.Payment.CreateIntentForUser()", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.CreateIntentForUser" - }, - "x-python": { - "example": "from kittycad.models import PaymentIntent\nfrom kittycad.api.payments import create_payment_intent_for_user\nfrom kittycad.types import Response\n\nfc: PaymentIntent = create_payment_intent_for_user.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[PaymentIntent] = create_payment_intent_for_user.sync_detailed(client=client)\n\n# OR run async\nfc: PaymentIntent = await create_payment_intent_for_user.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[PaymentIntent] = await create_payment_intent_for_user.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.create_payment_intent_for_user.html" - } - } - }, - "/user/payment/invoices": { - "get": { - "description": "This endpoint requires authentication by any KittyCAD user. It lists invoices for the authenticated user.", - "operationId": "list_invoices_for_user", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/Invoice", - "x-scope": [ - "" - ] - }, - "title": "Array_of_Invoice", - "type": "array" - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "List invoices for your user.", - "tags": [ - "payments" - ], - "x-go": { - "example": "// ListInvoicesForUser: List invoices for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It lists invoices for the authenticated user.\nInvoice, err := client.Payment.ListInvoicesForUser()", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.ListInvoicesForUser" - }, - "x-python": { - "example": "from kittycad.models import [Invoice]\nfrom kittycad.api.payments import list_invoices_for_user\nfrom kittycad.types import Response\n\nfc: [Invoice] = list_invoices_for_user.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[[Invoice]] = list_invoices_for_user.sync_detailed(client=client)\n\n# OR run async\nfc: [Invoice] = await list_invoices_for_user.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[[Invoice]] = await list_invoices_for_user.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.list_invoices_for_user.html" - } - } - }, - "/user/payment/methods": { - "get": { - "description": "This endpoint requires authentication by any KittyCAD user. It lists payment methods for the authenticated user.", - "operationId": "list_payment_methods_for_user", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/PaymentMethod", - "x-scope": [ - "" - ] - }, - "title": "Array_of_PaymentMethod", - "type": "array" - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "List payment methods for your user.", - "tags": [ - "payments" - ], - "x-go": { - "example": "// ListMethodsForUser: List payment methods for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It lists payment methods for the authenticated user.\nPaymentMethod, err := client.Payment.ListMethodsForUser()", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.ListMethodsForUser" - }, - "x-python": { - "example": "from kittycad.models import [PaymentMethod]\nfrom kittycad.api.payments import list_payment_methods_for_user\nfrom kittycad.types import Response\n\nfc: [PaymentMethod] = list_payment_methods_for_user.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[[PaymentMethod]] = list_payment_methods_for_user.sync_detailed(client=client)\n\n# OR run async\nfc: [PaymentMethod] = await list_payment_methods_for_user.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[[PaymentMethod]] = await list_payment_methods_for_user.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.list_payment_methods_for_user.html" - } - } - }, - "/user/payment/methods/{id}": { - "delete": { - "description": "This endpoint requires authentication by any KittyCAD user. It deletes the specified payment method for the authenticated user.", - "operationId": "delete_payment_method_for_user", - "parameters": [ - { - "description": "The ID of the payment method.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ], - "responses": { - "204": { - "description": "successful deletion", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Delete a payment method for your user.", - "tags": [ - "payments", - "hidden" - ], - "x-go": { - "example": "// DeleteMethodForUser: Delete a payment method for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It deletes the specified payment method for the authenticated user.\n//\n// Parameters:\n//\t- `id`: The ID of the payment method.\nif err := client.Payment.DeleteMethodForUser(id); err != nil {\n\tpanic(err)\n}", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#PaymentService.DeleteMethodForUser" - }, - "x-python": { - "example": "from kittycad.models import Error\nfrom kittycad.api.payments import delete_payment_method_for_user\nfrom kittycad.types import Response\n\nfc: Error = delete_payment_method_for_user.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Error] = delete_payment_method_for_user.sync_detailed(client=client, id=)\n\n# OR run async\nfc: Error = await delete_payment_method_for_user.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[Error] = await delete_payment_method_for_user.asyncio_detailed(client=client, id=)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.delete_payment_method_for_user.html" - } - }, - "options": { - "description": "This is necessary for some preflight requests, specifically DELETE.", - "operationId": "options_payment_methods_for_user", - "parameters": [ - { - "description": "The ID of the payment method.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "enum": [ - null - ], - "title": "Null", - "type": "string" - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "OPTIONS endpoint for user payment methods.", - "tags": [ - "hidden" - ] - } - }, - "/user/session/{token}": { - "get": { - "description": "This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.", - "operationId": "get_session_for_user", - "parameters": [ - { - "description": "The API token.", - "in": "path", - "name": "token", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - }, - "style": "simple" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Session", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get a session for your user.", - "tags": [ - "sessions" - ], - "x-go": { - "example": "// GetForUser: Get a session for your user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns details of the requested API token for the user.\n//\n// Parameters:\n//\t- `token`: The API token.\nsession, err := client.Session.GetForUser(token)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#SessionService.GetForUser" - }, - "x-python": { - "example": "from kittycad.models import Session\nfrom kittycad.api.sessions import get_session_for_user\nfrom kittycad.types import Response\n\nfc: Session = get_session_for_user.sync(client=client, token=\"\")\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Session] = get_session_for_user.sync_detailed(client=client, token=\"\")\n\n# OR run async\nfc: Session = await get_session_for_user.asyncio(client=client, token=\"\")\n\n# OR run async with more info\nresponse: Response[Session] = await get_session_for_user.asyncio_detailed(client=client, token=\"\")", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.sessions.get_session_for_user.html" - } - } - }, - "/users": { - "get": { - "description": "This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.", - "operationId": "list_users", - "parameters": [ - { - "description": "Maximum number of items returned by a single call", - "in": "query", - "name": "limit", - "schema": { - "format": "uint32", - "minimum": 1, - "nullable": true, - "type": "integer" - }, - "style": "form" - }, - { - "description": "Token returned by previous call to retrieve the subsequent page", - "in": "query", - "name": "page_token", - "schema": { - "nullable": true, - "type": "string" - }, - "style": "form" - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "$ref": "#/components/schemas/CreatedAtSortMode", - "x-scope": [ - "" - ] - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserResultsPage", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "List users.", - "tags": [ - "users", - "hidden" - ], - "x-dropshot-pagination": true, - "x-go": { - "example": "// List: List users.\n//\n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n//\n// To iterate over all pages, use the `ListAllPages` method, instead.\n//\n// Parameters:\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\nuserResultsPage, err := client.User.List(limit, pageToken, sortBy)\n\n// - OR -\n\n// ListAllPages: List users.\n//\n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n//\n// This method is a wrapper around the `List` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `sortBy`\nUser, err := client.User.ListAllPages(sortBy)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.List" - }, - "x-python": { - "example": "from kittycad.models import UserResultsPage\nfrom kittycad.api.users import list_users\nfrom kittycad.types import Response\n\nfc: UserResultsPage = list_users.sync(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[UserResultsPage] = list_users.sync_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async\nfc: UserResultsPage = await list_users.asyncio(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async with more info\nresponse: Response[UserResultsPage] = await list_users.asyncio_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.list_users.html" - } - } - }, - "/users-extended": { - "get": { - "description": "This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.", - "operationId": "list_users_extended", - "parameters": [ - { - "description": "Maximum number of items returned by a single call", - "in": "query", - "name": "limit", - "schema": { - "format": "uint32", - "minimum": 1, - "nullable": true, - "type": "integer" - }, - "style": "form" - }, - { - "description": "Token returned by previous call to retrieve the subsequent page", - "in": "query", - "name": "page_token", - "schema": { - "nullable": true, - "type": "string" - }, - "style": "form" - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "$ref": "#/components/schemas/CreatedAtSortMode", - "x-scope": [ - "" - ] - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedUserResultsPage", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "List users with extended information.", - "tags": [ - "users", - "hidden" - ], - "x-dropshot-pagination": true, - "x-go": { - "example": "// ListExtended: List users with extended information.\n//\n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n//\n// To iterate over all pages, use the `ListExtendedAllPages` method, instead.\n//\n// Parameters:\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\nextendedUserResultsPage, err := client.User.ListExtended(limit, pageToken, sortBy)\n\n// - OR -\n\n// ListExtendedAllPages: List users with extended information.\n//\n// This endpoint required authentication by a KittyCAD employee. The users are returned in order of creation, with the most recently created users first.\n//\n// This method is a wrapper around the `ListExtended` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `sortBy`\nExtendedUser, err := client.User.ListExtendedAllPages(sortBy)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.ListExtended" - }, - "x-python": { - "example": "from kittycad.models import ExtendedUserResultsPage\nfrom kittycad.api.users import list_users_extended\nfrom kittycad.types import Response\n\nfc: ExtendedUserResultsPage = list_users_extended.sync(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ExtendedUserResultsPage] = list_users_extended.sync_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async\nfc: ExtendedUserResultsPage = await list_users_extended.asyncio(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async with more info\nresponse: Response[ExtendedUserResultsPage] = await list_users_extended.asyncio_detailed(client=client, limit=\"\", page_token=, sort_by=CreatedAtSortMode)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.list_users_extended.html" - } - } - }, - "/users-extended/{id}": { - "get": { - "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 KittyCAD user, you must be a KittyCAD employee.", - "operationId": "get_user_extended", - "parameters": [ - { - "description": "The user ID.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtendedUser", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get extended information about a user.", - "tags": [ - "users", - "hidden" - ], - "x-go": { - "example": "// GetExtended: Get extended information about a user.\n//\n// 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// Alternatively, to get information about the authenticated user, use `/user/extended` endpoint.\n// To get information about any KittyCAD user, you must be a KittyCAD employee.\n//\n// Parameters:\n//\t- `id`: The user ID.\nextendedUser, err := client.User.GetExtended(id)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.GetExtended" - }, - "x-python": { - "example": "from kittycad.models import ExtendedUser\nfrom kittycad.api.users import get_user_extended\nfrom kittycad.types import Response\n\nfc: ExtendedUser = get_user_extended.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ExtendedUser] = get_user_extended.sync_detailed(client=client, id=)\n\n# OR run async\nfc: ExtendedUser = await get_user_extended.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[ExtendedUser] = await get_user_extended.asyncio_detailed(client=client, id=)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.get_user_extended.html" - } - } - }, - "/users/{id}": { - "get": { - "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 KittyCAD user, you must be a KittyCAD employee.", - "operationId": "get_user", - "parameters": [ - { - "description": "The user ID.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/User", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "Get a user.", - "tags": [ - "users", - "hidden" - ], - "x-go": { - "example": "// Get: Get a user.\n//\n// 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// Alternatively, to get information about the authenticated user, use `/user` endpoint.\n// To get information about any KittyCAD user, you must be a KittyCAD employee.\n//\n// Parameters:\n//\t- `id`: The user ID.\nuser, err := client.User.Get(id)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#UserService.Get" - }, - "x-python": { - "example": "from kittycad.models import User\nfrom kittycad.api.users import get_user\nfrom kittycad.types import Response\n\nfc: User = get_user.sync(client=client, id=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[User] = get_user.sync_detailed(client=client, id=)\n\n# OR run async\nfc: User = await get_user.asyncio(client=client, id=)\n\n# OR run async with more info\nresponse: Response[User] = await get_user.asyncio_detailed(client=client, id=)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.get_user.html" - } - } - }, - "/users/{id}/api-calls": { - "get": { - "description": "This endpoint requires authentication by any KittyCAD 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 KittyCAD 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.", - "operationId": "list_api_calls_for_user", - "parameters": [ - { - "description": "The user ID.", - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - { - "description": "Maximum number of items returned by a single call", - "in": "query", - "name": "limit", - "schema": { - "format": "uint32", - "minimum": 1, - "nullable": true, - "type": "integer" - }, - "style": "form" - }, - { - "description": "Token returned by previous call to retrieve the subsequent page", - "in": "query", - "name": "page_token", - "schema": { - "nullable": true, - "type": "string" - }, - "style": "form" - }, - { - "in": "query", - "name": "sort_by", - "schema": { - "$ref": "#/components/schemas/CreatedAtSortMode", - "x-scope": [ - "" - ] - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiCallWithPriceResultsPage", - "x-scope": [ - "" - ] - } - } - }, - "description": "successful operation", - "headers": { - "Access-Control-Allow-Credentials": { - "description": "Access-Control-Allow-Credentials header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Headers": { - "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Methods": { - "description": "Access-Control-Allow-Methods header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "Access-Control-Allow-Origin": { - "description": "Access-Control-Allow-Origin header.", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - }, - "4XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - }, - "5XX": { - "$ref": "#/components/responses/Error", - "x-scope": [ - "" - ] - } - }, - "summary": "List API calls for a user.", - "tags": [ - "api-calls", - "hidden" - ], - "x-dropshot-pagination": true, - "x-go": { - "example": "// ListForUser: List API calls for a user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user if \"me\" is passed as the user id.\n// Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.\n// If the authenticated user is a KittyCAD employee, then the API calls are returned for the user specified by the user id.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// To iterate over all pages, use the `ListForUserAllPages` method, instead.\n//\n// Parameters:\n//\t- `id`: The user ID.\n//\t- `limit`: Maximum number of items returned by a single call\n//\t- `pageToken`: Token returned by previous call to retrieve the subsequent page\n//\t- `sortBy`\naPICallWithPriceResultsPage, err := client.APICall.ListForUser(id, limit, pageToken, sortBy)\n\n// - OR -\n\n// ListForUserAllPages: List API calls for a user.\n//\n// This endpoint requires authentication by any KittyCAD user. It returns the API calls for the authenticated user if \"me\" is passed as the user id.\n// Alternatively, you can use the `/user/api-calls` endpoint to get the API calls for your user.\n// If the authenticated user is a KittyCAD employee, then the API calls are returned for the user specified by the user id.\n// The API calls are returned in order of creation, with the most recently created API calls first.\n//\n// This method is a wrapper around the `ListForUser` method.\n// This method returns all the pages at once.\n//\n// Parameters:\n//\t- `id`: The user ID.\n//\t- `sortBy`\nAPICallWithPrice, err := client.APICall.ListForUserAllPages(id , sortBy)", - "libDocsLink": "https://pkg.go.dev/github.com/kittycad/kittycad.go/#APICallService.ListForUser" - }, - "x-python": { - "example": "from kittycad.models import ApiCallWithPriceResultsPage\nfrom kittycad.api.api-calls import list_api_calls_for_user\nfrom kittycad.types import Response\n\nfc: ApiCallWithPriceResultsPage = list_api_calls_for_user.sync(client=client, id=, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[ApiCallWithPriceResultsPage] = list_api_calls_for_user.sync_detailed(client=client, id=, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async\nfc: ApiCallWithPriceResultsPage = await list_api_calls_for_user.asyncio(client=client, id=, limit=\"\", page_token=, sort_by=CreatedAtSortMode)\n\n# OR run async with more info\nresponse: Response[ApiCallWithPriceResultsPage] = await list_api_calls_for_user.asyncio_detailed(client=client, id=, limit=\"\", page_token=, sort_by=CreatedAtSortMode)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.api-calls.list_api_calls_for_user.html" - } + "type": "string", + "format": "uuid" } } }, "tags": [ { + "name": "api-calls", "description": "API calls that have been performed by users can be queried by the API. This is helpful for debugging as well as billing.", "externalDocs": { "url": "https://docs.kittycad.io/api/api-calls" - }, - "name": "api-calls" + } }, { + "name": "api-tokens", "description": "API tokens allow users to call the API outside of their session token that is used as a cookie in the user interface. Users can create, delete, and list their API tokens. But, of course, you need an API token to do this, so first be sure to generate one in the account UI.", "externalDocs": { "url": "https://docs.kittycad.io/api/api-tokens" - }, - "name": "api-tokens" + } }, { + "name": "beta", "description": "Beta API endpoints. We will not charge for these endpoints while they are in beta.", "externalDocs": { "url": "https://docs.kittycad.io/api/beta" - }, - "name": "beta" + } }, { + "name": "file", "description": "CAD file operations. Create, get, and list CAD file conversions. More endpoints will be added here in the future as we build out transforms, etc on CAD models.", "externalDocs": { "url": "https://docs.kittycad.io/api/file" - }, - "name": "file" + } }, { + "name": "hidden", "description": "Hidden API endpoints that should not show up in the docs.", "externalDocs": { "url": "https://docs.kittycad.io/api/hidden" - }, - "name": "hidden" + } }, { + "name": "meta", "description": "Meta information about the API.", "externalDocs": { "url": "https://docs.kittycad.io/api/meta" - }, - "name": "meta" + } }, { + "name": "payments", "description": "Operations around payments and billing.", "externalDocs": { "url": "https://docs.kittycad.io/api/payments" - }, - "name": "payments" + } }, { + "name": "sessions", "description": "Sessions allow users to call the API from their session cookie in the browser.", "externalDocs": { "url": "https://docs.kittycad.io/api/sessions" - }, - "name": "sessions" + } }, { + "name": "unit", + "description": "Unit conversion operations.", + "externalDocs": { + "url": "https://docs.kittycad.io/api/file" + } + }, + { + "name": "users", "description": "A user is someone who uses the KittyCAD API. Here, we can create, delete, and list users. We can also get information about a user. Operations will only be authorized if the user is requesting information about themselves.", "externalDocs": { "url": "https://docs.kittycad.io/api/users" - }, - "name": "users" + } } ] } \ No newline at end of file