diff --git a/.github/workflows/update-spec-for-docs.yml b/.github/workflows/update-spec-for-docs.yml index 54b635459..db994473a 100644 --- a/.github/workflows/update-spec-for-docs.yml +++ b/.github/workflows/update-spec-for-docs.yml @@ -40,8 +40,8 @@ jobs: - name: move spec to docs shell: bash run: | - rm docs/spec.json || true - cp spec.json docs/spec.json + rm docs/kittycad.py.patch.json || true + cp kittycad.py.patch.json docs/kittycad.py.patch.json - name: commit the changes in the docs repo shell: bash run: | @@ -53,7 +53,7 @@ jobs: git commit -am "YOYO NEW SPEC DOCS ${VERSION}!" || exit 0 git fetch origin git rebase origin/main || exit 0 - export NEW_BRANCH="update-spec-${VERSION}" + export NEW_BRANCH="update-spec-python" git checkout -b "$NEW_BRANCH" git push -f origin "$NEW_BRANCH" gh pr create --title "Update lang spec docs for ${VERSION}" \ diff --git a/generate/generate.py b/generate/generate.py index cff6a6cb7..dd579ceaa 100755 --- a/generate/generate.py +++ b/generate/generate.py @@ -1,5 +1,6 @@ #!/usr/bin/env python3 from prance import BaseParser +import jsonpatch import json import os @@ -10,9 +11,9 @@ package_name = 'kittycad' def main(): cwd = os.getcwd() - path = os.path.join(cwd, 'spec.json') - print("opening spec file: ", path) - parser = BaseParser(path) + spec_path = os.path.join(cwd, 'spec.json') + print("opening spec file: ", spec_path) + parser = BaseParser(spec_path) # Generate the types. generateTypes(cwd, parser.specification) @@ -30,16 +31,23 @@ client = Client(token="$TOKEN") # - OR - # Create a new client with your token parsed from the environment variable: -# KITTYCAD_API_TOKEN. +# `KITTYCAD_API_TOKEN`. from kittycad import ClientFromEnv client = ClientFromEnv()""", 'install': 'pip install kittycad', } + # Read the original spec file as a dict. + spec = open(spec_path, 'r') + original = json.load(spec) + # Create the json patch document. + patch = jsonpatch.make_patch(original, data) + # Rewrite the spec back out. - f = open(path, 'w') - f.write(json.dumps(data, indent=4)) + patch_file = os.path.join(cwd, 'kittycad.py.patch.json') + f = open(patch_file, 'w') + f.write(patch.to_string()) f.close() diff --git a/kittycad.py.patch.json b/kittycad.py.patch.json new file mode 100644 index 000000000..f5f275ca0 --- /dev/null +++ b/kittycad.py.patch.json @@ -0,0 +1 @@ +[{"op": "replace", "path": "/info/x-python/client", "value": "# 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()"}] \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 881ca825e..c62eac515 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,6 +33,7 @@ openapi-parser = "^0.2.6" autopep8 = "^1.6.0" prance = "^0.21.8" openapi-spec-validator = "^0.4.0" +jsonpatch = "^1.32" [build-system] requires = ["poetry>=1.0"] diff --git a/spec.json b/spec.json index 65e6d618d..2eb3a102b 100644 --- a/spec.json +++ b/spec.json @@ -1,9281 +1,8150 @@ { - "components": { + "components": { + "responses": { + "Error": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + }, + "description": "Error" + } + }, + "schemas": { + "AccountProvider": { + "description": "An account provider.", + "enum": [ + "google", + "github" + ], + "type": "string" + }, + "Address": { + "description": "An address.", + "properties": { + "city": { + "description": "The city component.", + "type": "string" + }, + "country": { + "description": "The country component.", + "type": "string" + }, + "created_at": { + "description": "The time and date the address was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "description": "The unique identifier of the address." + }, + "state": { + "description": "The state component.", + "type": "string" + }, + "street1": { + "description": "The first street component.", + "type": "string" + }, + "street2": { + "description": "The second street component.", + "type": "string" + }, + "updated_at": { + "description": "The time and date the address was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "user_id": { + "description": "The user ID that this address belongs to.", + "type": "string" + }, + "zip": { + "description": "The zip component.", + "type": "string" + } + }, + "required": [ + "created_at", + "id", + "updated_at" + ], + "type": "object" + }, + "ApiCallQueryGroup": { + "description": "A response for a query on the API call table that is grouped by something.", + "properties": { + "count": { + "format": "int64", + "type": "integer" + }, + "query": { + "type": "string" + } + }, + "required": [ + "count", + "query" + ], + "type": "object" + }, + "ApiCallQueryGroupBy": { + "description": "The field of an API call to group by.", + "enum": [ + "email", + "method", + "endpoint", + "user_id", + "origin", + "ip_address" + ], + "type": "string" + }, + "ApiCallStatus": { + "description": "The status of an async API call.", + "enum": [ + "Queued", + "Uploaded", + "In Progress", + "Completed", + "Failed" + ], + "type": "string" + }, + "ApiCallWithPrice": { + "description": "An API call with the price.\n\nThis is a join of the `ApiCall` and `ApiCallPrice` tables.", + "properties": { + "completed_at": { + "description": "The date and time the API call completed billing.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "created_at": { + "description": "The date and time the API call was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "duration": { + "description": "The duration of the API call.", + "format": "duration", + "nullable": true, + "title": "int64", + "type": "integer" + }, + "email": { + "description": "The user's email address.", + "format": "email", + "type": "string" + }, + "endpoint": { + "description": "The endpoint requested by the API call.", + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "description": "The unique identifier for the API call." + }, + "ip_address": { + "default": "", + "description": "The ip address of the origin.", + "format": "ip", + "title": "String", + "type": "string" + }, + "method": { + "allOf": [ + { + "$ref": "#/components/schemas/Method" + } + ], + "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" + }, + "origin": { + "description": "The origin of the API call.", + "type": "string" + }, + "price": { + "description": "The price of the API call.", + "format": "money-usd", + "nullable": true, + "title": "Number", + "type": "number" + }, + "request_body": { + "description": "The request body sent by the API call.", + "nullable": true, + "type": "string" + }, + "request_query_params": { + "description": "The request query params sent by the API call.", + "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, + "type": "string" + }, + "started_at": { + "description": "The date and time the API call started billing.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "status_code": { + "description": "The status code returned by the API call.", + "format": "int32", + "nullable": true, + "title": "int32", + "type": "integer" + }, + "stripe_invoice_item_id": { + "description": "The Stripe invoice item ID of the API call if it is billable.", + "type": "string" + }, + "token": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "description": "The API token that made the API call." + }, + "updated_at": { + "description": "The date and time the API call was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "user_agent": { + "description": "The user agent of the request.", + "type": "string" + }, + "user_id": { + "description": "The ID of the user that made the API call.", + "type": "string" + } + }, + "required": [ + "created_at", + "id", + "method", + "token", + "updated_at", + "user_agent" + ], + "type": "object" + }, + "ApiCallWithPriceResultsPage": { + "description": "A single page of results", + "properties": { + "items": { + "description": "list of items on this page of results", + "items": { + "$ref": "#/components/schemas/ApiCallWithPrice" + }, + "type": "array" + }, + "next_page": { + "description": "token used to fetch the next page of results (if any)", + "nullable": true, + "type": "string" + } + }, + "required": [ + "items" + ], + "type": "object" + }, + "ApiToken": { + "description": "An API token.\n\nThese are used to authenticate users with Bearer authentication.", + "properties": { + "created_at": { + "description": "The date and time the API token was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "id": { + "description": "The unique identifier for the API token.", + "type": "string" + }, + "is_valid": { + "description": "If the token is valid. We never delete API tokens, but we can mark them as invalid. We save them for ever to preserve the history of the API token.", + "type": "boolean" + }, + "token": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "description": "The API token itself." + }, + "updated_at": { + "description": "The date and time the API token was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "user_id": { + "description": "The ID of the user that owns the API token.", + "type": "string" + } + }, + "required": [ + "created_at", + "is_valid", + "token", + "updated_at" + ], + "type": "object" + }, + "ApiTokenResultsPage": { + "description": "A single page of results", + "properties": { + "items": { + "description": "list of items on this page of results", + "items": { + "$ref": "#/components/schemas/ApiToken" + }, + "type": "array" + }, + "next_page": { + "description": "token used to fetch the next page of results (if any)", + "nullable": true, + "type": "string" + } + }, + "required": [ + "items" + ], + "type": "object" + }, + "AppClientInfo": { + "description": "Information about a third party app client.", + "properties": { + "url": { + "description": "The URL for consent.", + "type": "string" + } + }, + "type": "object" + }, + "AsyncApiCall": { + "description": "An async API call.", + "properties": { + "completed_at": { + "description": "The time and date the async API call was completed.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "created_at": { + "description": "The time and date the async API call was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "error": { + "description": "The error the function returned, if any.", + "nullable": true, + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "description": "The unique identifier of the async API call.\n\nThis is the same as the API call ID." + }, + "input": { + "default": null, + "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 + }, + "started_at": { + "description": "The time and date the async API call was started.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/ApiCallStatus" + } + ], + "description": "The status of the async API call." + }, + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/AsyncApiCallType" + } + ], + "description": "The type of async API call." + }, + "updated_at": { + "description": "The time and date the async API call was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "user_id": { + "description": "The user ID of the user who created the async API call.", + "type": "string" + }, + "worker": { + "description": "The worker node that is performing or performed the async API call.", + "type": "string" + } + }, + "required": [ + "created_at", + "id", + "status", + "type", + "updated_at" + ], + "type": "object" + }, + "AsyncApiCallOutput": { + "description": "The output from the async API call.", + "oneOf": [ + { + "description": "A file conversion.", + "properties": { + "completed_at": { + "description": "The time and date the file conversion was completed.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "created_at": { + "description": "The time and date the file conversion was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "error": { + "description": "The error the function returned, if any.", + "nullable": true, + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "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.", + "format": "byte", + "nullable": true, + "title": "String", + "type": "string" + }, + "output_format": { + "allOf": [ + { + "$ref": "#/components/schemas/FileOutputFormat" + } + ], + "description": "The output format of the file conversion." + }, + "src_format": { + "allOf": [ + { + "$ref": "#/components/schemas/FileSourceFormat" + } + ], + "description": "The source format of the file conversion." + }, + "started_at": { + "description": "The time and date the file conversion was started.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/ApiCallStatus" + } + ], + "description": "The status of the file conversion." + }, + "type": { + "enum": [ + "FileConversion" + ], + "type": "string" + }, + "updated_at": { + "description": "The time and date the file conversion was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "user_id": { + "description": "The user ID of the user who created the file conversion.", + "type": "string" + } + }, + "required": [ + "created_at", + "id", + "output_format", + "src_format", + "status", + "type", + "updated_at" + ], + "type": "object" + }, + { + "description": "A file mass.", + "properties": { + "completed_at": { + "description": "The time and date the mass was completed.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "created_at": { + "description": "The time and date the mass was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "error": { + "description": "The error the function returned, if any.", + "nullable": true, + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "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" + }, + "material_density": { + "default": 0.0, + "description": "The material density as denoted by the user.", + "format": "float", + "type": "number" + }, + "src_format": { + "allOf": [ + { + "$ref": "#/components/schemas/FileSourceFormat" + } + ], + "description": "The source format of the file." + }, + "started_at": { + "description": "The time and date the mass was started.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/ApiCallStatus" + } + ], + "description": "The status of the mass." + }, + "type": { + "enum": [ + "FileMass" + ], + "type": "string" + }, + "updated_at": { + "description": "The time and date the mass was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "user_id": { + "description": "The user ID of the user who created the mass.", + "type": "string" + } + }, + "required": [ + "created_at", + "id", + "src_format", + "status", + "type", + "updated_at" + ], + "type": "object" + }, + { + "description": "A file volume.", + "properties": { + "completed_at": { + "description": "The time and date the volume was completed.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "created_at": { + "description": "The time and date the volume was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "error": { + "description": "The error the function returned, if any.", + "nullable": true, + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "description": "The unique identifier of the volume request.\n\nThis is the same as the API call ID." + }, + "src_format": { + "allOf": [ + { + "$ref": "#/components/schemas/FileSourceFormat" + } + ], + "description": "The source format of the file." + }, + "started_at": { + "description": "The time and date the volume was started.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/ApiCallStatus" + } + ], + "description": "The status of the volume." + }, + "type": { + "enum": [ + "FileVolume" + ], + "type": "string" + }, + "updated_at": { + "description": "The time and date the volume was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "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" + } + }, + "required": [ + "created_at", + "id", + "src_format", + "status", + "type", + "updated_at" + ], + "type": "object" + }, + { + "description": "A file density.", + "properties": { + "completed_at": { + "description": "The time and date the density was completed.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "created_at": { + "description": "The time and date the density was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "density": { + "description": "The resulting density.", + "format": "double", + "nullable": true, + "type": "number" + }, + "error": { + "description": "The error the function returned, if any.", + "nullable": true, + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "description": "The unique identifier of the density request.\n\nThis is the same as the API call ID." + }, + "material_mass": { + "default": 0.0, + "description": "The material mass as denoted by the user.", + "format": "float", + "type": "number" + }, + "src_format": { + "allOf": [ + { + "$ref": "#/components/schemas/FileSourceFormat" + } + ], + "description": "The source format of the file." + }, + "started_at": { + "description": "The time and date the density was started.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/ApiCallStatus" + } + ], + "description": "The status of the density." + }, + "type": { + "enum": [ + "FileDensity" + ], + "type": "string" + }, + "updated_at": { + "description": "The time and date the density was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "user_id": { + "description": "The user ID of the user who created the density.", + "type": "string" + } + }, + "required": [ + "created_at", + "id", + "src_format", + "status", + "type", + "updated_at" + ], + "type": "object" + } + ] + }, + "AsyncApiCallResultsPage": { + "description": "A single page of results", + "properties": { + "items": { + "description": "list of items on this page of results", + "items": { + "$ref": "#/components/schemas/AsyncApiCall" + }, + "type": "array" + }, + "next_page": { + "description": "token used to fetch the next page of results (if any)", + "nullable": true, + "type": "string" + } + }, + "required": [ + "items" + ], + "type": "object" + }, + "AsyncApiCallType": { + "description": "The type of async API call.", + "enum": [ + "FileConversion", + "FileVolume", + "FileMass", + "FileDensity" + ], + "type": "string" + }, + "BillingInfo": { + "description": "The billing information for payments.", + "properties": { + "address": { + "allOf": [ + { + "$ref": "#/components/schemas/Address" + } + ], + "description": "The address of the customer.", + "nullable": true + }, + "name": { + "description": "The name of the customer.", + "type": "string" + }, + "phone": { + "default": "", + "description": "The phone for the customer.", + "format": "phone", + "title": "String", + "type": "string" + } + }, + "type": "object" + }, + "CacheMetadata": { + "description": "Metadata about our cache.\n\nThis is mostly used for internal purposes and debugging.", + "properties": { + "ok": { + "description": "If the cache returned an ok response from ping.", + "type": "boolean" + } + }, + "required": [ + "ok" + ], + "type": "object" + }, + "CardDetails": { + "description": "The card details of a payment method.", + "properties": { + "brand": { + "description": "Card brand.\n\nCan be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", + "type": "string" + }, + "checks": { + "allOf": [ + { + "$ref": "#/components/schemas/PaymentMethodCardChecks" + } + ], + "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" + }, + "exp_year": { + "default": 0, + "description": "Four-digit number representing the card's expiration year.", + "format": "int64", + "type": "integer" + }, + "fingerprint": { + "description": "Uniquely identifies this particular card number.", + "type": "string" + }, + "funding": { + "description": "Card funding type.\n\nCan be `credit`, `debit`, `prepaid`, or `unknown`.", + "type": "string" + }, + "last4": { + "description": "The last four digits of the card.", + "type": "string" + } + }, + "type": "object" + }, + "Cluster": { + "description": "Cluster information.", + "properties": { + "addr": { + "description": "The IP address of the cluster.", + "format": "ip", + "nullable": true, + "type": "string" + }, + "auth_timeout": { + "default": 0, + "description": "The auth timeout of the cluster.", + "format": "int64", + "type": "integer" + }, + "cluster_port": { + "default": 0, + "description": "The port of the cluster.", + "format": "int64", + "type": "integer" + }, + "name": { + "default": "", + "description": "The name of the cluster.", + "type": "string" + }, + "tls_timeout": { + "default": 0, + "description": "The TLS timeout for the cluster.", + "format": "int64", + "type": "integer" + }, + "urls": { + "description": "The urls of the cluster.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CodeLanguage": { + "description": "The language code is written in.", + "enum": [ + "go", + "python", + "node" + ], + "type": "string" + }, + "CodeOutput": { + "description": "Output of the code being executed.", + "properties": { + "output_files": { + "description": "The contents of the files requested if they were passed.", + "items": { + "$ref": "#/components/schemas/OutputFile" + }, + "type": "array" + }, + "stderr": { + "default": "", + "description": "The stderr of the code.", + "type": "string" + }, + "stdout": { + "default": "", + "description": "The stdout of the code.", + "type": "string" + } + }, + "type": "object" + }, + "Commit": { + "description": "Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as `containerd`, or `runC`.", + "properties": { + "expected": { + "description": "Commit ID of external tool expected by dockerd as set at build time.", + "nullable": true, + "type": "string" + }, + "id": { + "description": "Actual commit ID of external tool.", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "Connection": { + "description": "Metadata about a pub-sub connection.\n\nThis is mostly used for internal purposes and debugging.", + "properties": { + "auth_timeout": { + "default": 0, + "description": "The auth timeout of the server.", + "format": "int64", + "type": "integer" + }, + "cluster": { + "allOf": [ + { + "$ref": "#/components/schemas/Cluster" + } + ], + "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" + }, + "connections": { + "default": 0, + "description": "The number of connections to the server.", + "format": "int64", + "type": "integer" + }, + "cores": { + "default": 0, + "description": "The CPU core usage of the server.", + "format": "int64", + "type": "integer" + }, + "cpu": { + "format": "double", + "nullable": true, + "type": "number" + }, + "gateway": { + "allOf": [ + { + "$ref": "#/components/schemas/Gateway" + } + ], + "default": { + "auth_timeout": 0, + "host": "", + "name": "", + "port": 0, + "tls_timeout": 0 + }, + "description": "Information about the gateway." + }, + "git_commit": { + "default": "", + "description": "The git commit.", + "type": "string" + }, + "go": { + "default": "", + "description": "The go version.", + "type": "string" + }, + "gomaxprocs": { + "default": 0, + "description": "`GOMAXPROCS` of the server.", + "format": "int64", + "type": "integer" + }, + "host": { + "description": "The host of the server.", + "format": "ip", + "type": "string" + }, + "http_base_path": { + "default": "", + "description": "The http base path of the server.", + "type": "string" + }, + "http_host": { + "default": "", + "description": "The http host of the server.", + "type": "string" + }, + "http_port": { + "default": 0, + "description": "The http port of the server.", + "format": "int64", + "type": "integer" + }, + "http_req_stats": { + "additionalProperties": { + "format": "int64", + "type": "integer" + }, + "type": "object" + }, + "https_port": { + "default": 0, + "description": "The https port of the server.", + "format": "int64", + "type": "integer" + }, + "in_bytes": { + "default": 0, + "description": "The count of inbound bytes for the server.", + "format": "int64", + "type": "integer" + }, + "in_msgs": { + "default": 0, + "description": "The number of inbound messages for the server.", + "format": "int64", + "type": "integer" + }, + "jetstream": { + "allOf": [ + { + "$ref": "#/components/schemas/Jetstream" + } + ], + "default": { + "config": { + "domain": "", + "max_memory": 0, + "max_storage": 0, + "store_dir": "" + }, + "meta": { + "cluster_size": 0, + "leader": "", + "name": "" + }, + "stats": { + "accounts": 0, + "api": { + "errors": 0, + "inflight": 0, + "total": 0 + }, + "ha_assets": 0, + "memory": 0, + "reserved_memory": 0, + "reserved_store": 0, + "store": 0 + } + }, + "description": "Jetstream information." + }, + "leaf": { + "allOf": [ + { + "$ref": "#/components/schemas/LeafNode" + } + ], + "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" + }, + "max_connections": { + "default": 0, + "description": "The max connections of the server.", + "format": "int64", + "type": "integer" + }, + "max_control_line": { + "default": 0, + "description": "The max control line of the server.", + "format": "int64", + "type": "integer" + }, + "max_payload": { + "default": 0, + "description": "The max payload of the server.", + "format": "int64", + "type": "integer" + }, + "max_pending": { + "default": 0, + "description": "The max pending of the server.", + "format": "int64", + "type": "integer" + }, + "mem": { + "default": 0, + "description": "The memory usage of the server.", + "format": "int64", + "type": "integer" + }, + "now": { + "description": "The time now.", + "format": "date-time", + "type": "string" + }, + "out_bytes": { + "default": 0, + "description": "The count of outbound bytes for the server.", + "format": "int64", + "type": "integer" + }, + "out_msgs": { + "default": 0, + "description": "The number of outbound messages for the server.", + "format": "int64", + "type": "integer" + }, + "ping_interval": { + "default": 0, + "description": "The ping interval of the server.", + "format": "int64", + "type": "integer" + }, + "ping_max": { + "default": 0, + "description": "The ping max of the server.", + "format": "int64", + "type": "integer" + }, + "port": { + "default": 0, + "description": "The port of the server.", + "format": "int64", + "type": "integer" + }, + "proto": { + "default": 0, + "description": "The protocol version.", + "format": "int64", + "type": "integer" + }, + "remotes": { + "default": 0, + "description": "The number of remotes for the server.", + "format": "int64", + "type": "integer" + }, + "routes": { + "default": 0, + "description": "The number of routes for the server.", + "format": "int64", + "type": "integer" + }, + "server_id": { + "default": "", + "description": "The server ID.", + "type": "string" + }, + "server_name": { + "default": "", + "description": "The server name.", + "type": "string" + }, + "slow_consumers": { + "default": 0, + "description": "The number of slow consumers for the server.", + "format": "int64", + "type": "integer" + }, + "start": { + "description": "When the server was started.", + "format": "date-time", + "type": "string" + }, + "subscriptions": { + "default": 0, + "description": "The number of subscriptions for the server.", + "format": "int64", + "type": "integer" + }, + "system_account": { + "default": "", + "description": "The system account.", + "type": "string" + }, + "tls_timeout": { + "default": 0, + "description": "The TLS timeout of the server.", + "format": "int64", + "type": "integer" + }, + "total_connections": { + "default": 0, + "description": "The total number of connections to the server.", + "format": "int64", + "type": "integer" + }, + "uptime": { + "default": "", + "description": "The uptime of the server.", + "type": "string" + }, + "version": { + "default": "", + "description": "The version of the service.", + "type": "string" + }, + "write_deadline": { + "default": 0, + "description": "The write deadline of the server.", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "config_load_time", + "host", + "http_req_stats", + "now", + "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.", + "enum": [ + "created-at-ascending", + "created-at-descending" + ], + "type": "string" + }, + "Currency": { + "description": "Currency is the list of supported currencies.\n\nFor more details see .", + "enum": [ + "aed", + "afn", + "all", + "amd", + "ang", + "aoa", + "ars", + "aud", + "awg", + "azn", + "bam", + "bbd", + "bdt", + "bgn", + "bif", + "bmd", + "bnd", + "bob", + "brl", + "bsd", + "bwp", + "bzd", + "cad", + "cdf", + "chf", + "clp", + "cny", + "cop", + "crc", + "cve", + "czk", + "djf", + "dkk", + "dop", + "dzd", + "eek", + "egp", + "etb", + "eur", + "fjd", + "fkp", + "gbp", + "gel", + "gip", + "gmd", + "gnf", + "gtq", + "gyd", + "hkd", + "hnl", + "hrk", + "htg", + "huf", + "idr", + "ils", + "inr", + "isk", + "jmd", + "jpy", + "kes", + "kgs", + "khr", + "kmf", + "krw", + "kyd", + "kzt", + "lak", + "lbp", + "lkr", + "lrd", + "lsl", + "ltl", + "lvl", + "mad", + "mdl", + "mga", + "mkd", + "mnt", + "mop", + "mro", + "mur", + "mvr", + "mwk", + "mxn", + "myr", + "mzn", + "nad", + "ngn", + "nio", + "nok", + "npr", + "nzd", + "pab", + "pen", + "pgk", + "php", + "pkr", + "pln", + "pyg", + "qar", + "ron", + "rsd", + "rub", + "rwf", + "sar", + "sbd", + "scr", + "sek", + "sgd", + "shp", + "sll", + "sos", + "srd", + "std", + "svc", + "szl", + "thb", + "tjs", + "top", + "try", + "ttd", + "twd", + "tzs", + "uah", + "ugx", + "usd", + "uyu", + "uzs", + "vef", + "vnd", + "vuv", + "wst", + "xaf", + "xcd", + "xof", + "xpf", + "yer", + "zar", + "zmw" + ], + "type": "string" + }, + "Customer": { + "description": "The resource representing a payment \"Customer\".", + "properties": { + "address": { + "allOf": [ + { + "$ref": "#/components/schemas/Address" + } + ], + "description": "The customer's address.", + "nullable": true + }, + "balance": { + "default": 0.0, + "description": "Current balance, if any, being stored on the customer in the payments service.\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": "money-usd", + "title": "Number", + "type": "number" + }, + "created_at": { + "description": "Time at which the object was created.", + "format": "date-time", + "type": "string" + }, + "currency": { + "allOf": [ + { + "$ref": "#/components/schemas/Currency" + } + ], + "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`.", + "type": "boolean" + }, + "email": { + "description": "The customer's email address.", + "format": "email", + "type": "string" + }, + "id": { + "description": "Unique identifier for the object.", + "type": "string" + }, + "metadata": { + "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": { + "default": "", + "description": "The customer's phone number.", + "format": "phone", + "title": "String", + "type": "string" + } + }, + "required": [ + "created_at", + "currency" + ], + "type": "object" + }, + "CustomerBalance": { + "description": "A balance for a user.\n\nThis holds information about the financial balance for the user.", + "properties": { + "created_at": { + "description": "The date and time the balance was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "description": "The unique identifier for the balance." + }, + "monthly_credits_remaining": { + "description": "The monthy credits remaining in the balance. This gets re-upped every month, but if the credits are not used for a month they do not carry over to the next month. It is a stable amount granted to the user per month.", + "format": "money-usd", + "title": "Number", + "type": "number" + }, + "pre_pay_cash_remaining": { + "description": "The amount of pre-pay cash remaining in the balance. This number goes down as the user uses their pre-paid credits. The reason we track this amount is if a user ever wants to withdraw their pre-pay cash, we can use this amount to determine how much to give them. Say a user has $100 in pre-paid cash, their bill is worth, $50 after subtracting any other credits (like monthly etc.) Their bill is $50, their pre-pay cash remaining will be subtracted by 50 to pay the bill and their `pre_pay_credits_remaining` will be subtracted by 50 to pay the bill. This way if they want to withdraw money after, they can only withdraw $50 since that is the amount of cash they have remaining.", + "format": "money-usd", + "title": "Number", + "type": "number" + }, + "pre_pay_credits_remaining": { + "description": "The amount of credits remaining in the balance. This is typically the amount of cash * some multiplier they get for pre-paying their account. This number lowers every time a bill is paid with the balance. This number increases every time a user adds funds to their balance. This may be through a subscription or a one off payment.", + "format": "money-usd", + "title": "Number", + "type": "number" + }, + "total_due": { + "description": "This includes any outstanding, draft, or open invoices and any pending invoice items. This does not include any credits the user has on their account.", + "format": "money-usd", + "title": "Number", + "type": "number" + }, + "updated_at": { + "description": "The date and time the balance was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "user_id": { + "description": "The user ID the balance belongs to.", + "type": "string" + } + }, + "required": [ + "created_at", + "id", + "monthly_credits_remaining", + "pre_pay_cash_remaining", + "pre_pay_credits_remaining", + "total_due", + "updated_at" + ], + "type": "object" + }, + "DeviceAccessTokenRequestForm": { + "description": "The form for a device access token request.", + "properties": { + "client_id": { + "description": "The client ID.", + "format": "uuid", + "type": "string" + }, + "device_code": { + "description": "The device code.", + "format": "uuid", + "type": "string" + }, + "grant_type": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuth2GrantType" + } + ], + "description": "The grant type." + } + }, + "required": [ + "client_id", + "device_code", + "grant_type" + ], + "type": "object" + }, + "DeviceAuthRequestForm": { + "description": "The request parameters for the OAuth 2.0 Device Authorization Grant flow.", + "properties": { + "client_id": { + "description": "The client ID.", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "client_id" + ], + "type": "object" + }, + "DeviceAuthVerifyParams": { + "description": "The request parameters to verify the `user_code` for the OAuth 2.0 Device Authorization Grant.", + "properties": { + "user_code": { + "description": "The user code.", + "type": "string" + } + }, + "required": [ + "user_code" + ], + "type": "object" + }, + "DockerSystemInfo": { + "description": "Docker system info.", + "properties": { + "architecture": { + "description": "Hardware architecture of the host, as returned by the Go runtime (`GOARCH`). A full list of possible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment).", + "nullable": true, + "type": "string" + }, + "bridge_nf_ip6tables": { + "description": "Indicates if `bridge-nf-call-ip6tables` is available on the host.", + "nullable": true, + "type": "boolean" + }, + "bridge_nf_iptables": { + "description": "Indicates if `bridge-nf-call-iptables` is available on the host.", + "nullable": true, + "type": "boolean" + }, + "cgroup_driver": { + "allOf": [ + { + "$ref": "#/components/schemas/SystemInfoCgroupDriverEnum" + } + ], + "description": "The driver to use for managing cgroups.", + "nullable": true + }, + "cgroup_version": { + "allOf": [ + { + "$ref": "#/components/schemas/SystemInfoCgroupVersionEnum" + } + ], + "description": "The version of the cgroup.", + "nullable": true + }, + "cluster_advertise": { + "description": "The network endpoint that the Engine advertises for the purpose of node discovery. ClusterAdvertise is a `host:port` combination on which the daemon is reachable by other hosts.\n\n**Deprecated**: This field is only propagated when using standalone Swarm mode, and overlay networking using an external k/v store. Overlay networks with Swarm mode enabled use the built-in raft store, and this field will be empty.", + "nullable": true, + "type": "string" + }, + "cluster_store": { + "description": "URL of the distributed storage backend. The storage backend is used for multihost networking (to store network and endpoint information) and by the node discovery mechanism.\n\n**Deprecated**: This field is only propagated when using standalone Swarm mode, and overlay networking using an external k/v store. Overlay networks with Swarm mode enabled use the built-in raft store, and this field will be empty.", + "nullable": true, + "type": "string" + }, + "containerd_commit": { + "allOf": [ + { + "$ref": "#/components/schemas/Commit" + } + ], + "nullable": true + }, + "containers": { + "description": "Total number of containers on the host.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "containers_paused": { + "description": "Number of containers with status `\\\"paused\\\"`.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "containers_running": { + "description": "Number of containers with status `\\\"running\\\"`.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "containers_stopped": { + "description": "Number of containers with status `\\\"stopped\\\"`.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "cpu_cfs_period": { + "description": "Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host.", + "nullable": true, + "type": "boolean" + }, + "cpu_cfs_quota": { + "description": "Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host.", + "nullable": true, + "type": "boolean" + }, + "cpu_set": { + "description": "Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt)", + "nullable": true, + "type": "boolean" + }, + "cpu_shares": { + "description": "Indicates if CPU Shares limiting is supported by the host.", + "nullable": true, + "type": "boolean" + }, + "debug": { + "description": "Indicates if the daemon is running in debug-mode / with debug-level logging enabled.", + "nullable": true, + "type": "boolean" + }, + "default_address_pools": { + "description": "List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \\\"10.10.0.0/16\\\" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools.", + "items": { + "$ref": "#/components/schemas/SystemInfoDefaultAddressPools" + }, + "type": "array" + }, + "default_runtime": { + "description": "Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time.", + "nullable": true, + "type": "string" + }, + "docker_root_dir": { + "description": "Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\\\\ProgramData\\\\docker` on Windows.", + "nullable": true, + "type": "string" + }, + "driver": { + "description": "Name of the storage driver in use.", + "nullable": true, + "type": "string" + }, + "driver_status": { + "description": "Information specific to the storage driver, provided as \\\"label\\\" / \\\"value\\\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of `docker info` on the command line.\n\n**Note**: The information returned in this field, including the formatting of values and labels, should not be considered stable, and may change without notice.", + "items": { + "items": { + "type": "string" + }, + "type": "array" + }, + "type": "array" + }, + "experimental_build": { + "description": "Indicates if experimental features are enabled on the daemon.", + "nullable": true, + "type": "boolean" + }, + "http_proxy": { + "description": "HTTP-proxy configured for the daemon. This value is obtained from the [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration.", + "nullable": true, + "type": "string" + }, + "https_proxy": { + "description": "HTTPS-proxy configured for the daemon. This value is obtained from the [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration.", + "nullable": true, + "type": "string" + }, + "id": { + "description": "Unique identifier of the daemon.\n\n**Note**: The format of the ID itself is not part of the API, and should not be considered stable.", + "nullable": true, + "type": "string" + }, + "images": { + "description": "Total number of images on the host. Both _tagged_ and _untagged_ (dangling) images are counted.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "index_server_address": { + "description": "Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud.", + "nullable": true, + "type": "string" + }, + "init_binary": { + "description": "Name and, optional, path of the `docker-init` binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result.", + "nullable": true, + "type": "string" + }, + "init_commit": { + "allOf": [ + { + "$ref": "#/components/schemas/Commit" + } + ], + "nullable": true + }, + "ipv4_forwarding": { + "description": "Indicates IPv4 forwarding is enabled.", + "nullable": true, + "type": "boolean" + }, + "isolation": { + "allOf": [ + { + "$ref": "#/components/schemas/SystemInfoIsolationEnum" + } + ], + "description": "Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms.", + "nullable": true + }, + "kernel_memory": { + "description": "Indicates if the host has kernel memory limit support enabled.\n\n**Deprecated**: This field is deprecated as the kernel 5.4 deprecated `kmem.limit_in_bytes`.", + "nullable": true, + "type": "boolean" + }, + "kernel_memory_tcp": { + "description": "Indicates if the host has kernel memory TCP limit support enabled. Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup.", + "nullable": true, + "type": "boolean" + }, + "kernel_version": { + "description": "Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the HKEY_LOCAL_MACHINE\\\\\\\\SOFTWARE\\\\\\\\Microsoft\\\\\\\\Windows NT\\\\\\\\CurrentVersion\\\\\\\\ registry value, for example _\\\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\\\"_.", + "nullable": true, + "type": "string" + }, + "labels": { + "description": "User-defined labels (key/value metadata) as set on the daemon.\n\n**Note**: When part of a Swarm, nodes can both have _daemon_ labels, set through the daemon configuration, and _node_ labels, set from a manager node in the Swarm. Node labels are not included in this field. Node labels can be retrieved using the `/nodes/(id)` endpoint on a manager node in the Swarm.", + "items": { + "type": "string" + }, + "type": "array" + }, + "live_restore_enabled": { + "description": "Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected.", + "nullable": true, + "type": "boolean" + }, + "logging_driver": { + "description": "The logging driver to use as a default for new containers.", + "nullable": true, + "type": "string" + }, + "mem_total": { + "description": "Total amount of physical memory available on the host, in bytes.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "memory_limit": { + "description": "Indicates if the host has memory limit support enabled.", + "nullable": true, + "type": "boolean" + }, + "n_events_listener": { + "description": "Number of event listeners subscribed.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "n_fd": { + "description": "The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "name": { + "description": "Hostname of the host.", + "nullable": true, + "type": "string" + }, + "ncpu": { + "description": "The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "no_proxy": { + "description": "Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Containers do not automatically inherit this configuration.", + "nullable": true, + "type": "string" + }, + "oom_kill_disable": { + "description": "Indicates if OOM killer disable is supported on the host.", + "nullable": true, + "type": "boolean" + }, + "operating_system": { + "description": "Name of the host's operating system, for example: \\\"Ubuntu 16.04.2 LTS\\\" or \\\"Windows Server 2016 Datacenter\\\"", + "nullable": true, + "type": "string" + }, + "os_type": { + "description": "Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are \\\"linux\\\" and \\\"windows\\\". A full list of possible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment).", + "nullable": true, + "type": "string" + }, + "os_version": { + "description": "Version of the host's operating system\n\n**Note**: The information returned in this field, including its very existence, and the formatting of values, should not be considered stable, and may change without notice.", + "nullable": true, + "type": "string" + }, + "pids_limit": { + "description": "Indicates if the host kernel has PID limit support enabled.", + "nullable": true, + "type": "boolean" + }, + "plugins": { + "allOf": [ + { + "$ref": "#/components/schemas/PluginsInfo" + } + ], + "nullable": true + }, + "product_license": { + "description": "Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included.", + "nullable": true, + "type": "string" + }, + "registry_config": { + "allOf": [ + { + "$ref": "#/components/schemas/RegistryServiceConfig" + } + ], + "nullable": true + }, + "runc_commit": { + "allOf": [ + { + "$ref": "#/components/schemas/Commit" + } + ], + "nullable": true + }, + "runtimes": { + "additionalProperties": { + "$ref": "#/components/schemas/Runtime" + }, + "type": "object" + }, + "security_options": { + "description": "List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), and rootless. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs.", + "items": { + "type": "string" + }, + "type": "array" + }, + "server_version": { + "description": "Version string of the daemon. **Note**: the [standalone Swarm API](https://docs.docker.com/swarm/swarm-api/) returns the Swarm version instead of the daemon version, for example `swarm/1.2.8`.", + "nullable": true, + "type": "string" + }, + "swap_limit": { + "description": "Indicates if the host has memory swap limit support enabled.", + "nullable": true, + "type": "boolean" + }, + "system_time": { + "description": "The number of goroutines that currently exist. This information is only returned if debug-mode is enabled.", + "nullable": true, + "type": "string" + }, + "warnings": { + "description": "List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "EmailAuthenticationForm": { + "description": "The body of the form for email authentication.", + "properties": { + "callback_url": { + "description": "The URL to redirect back to after we have authenticated.", + "format": "uri", + "nullable": true, + "type": "string" + }, + "email": { + "description": "The user's email.", + "format": "email", + "type": "string" + } + }, + "required": [ + "email" + ], + "type": "object" + }, + "EngineMetadata": { + "description": "Metadata about our currently running server.\n\nThis is mostly used for internal purposes and debugging.", + "properties": { + "async_jobs_running": { + "description": "If any async job is currently running.", + "type": "boolean" + }, + "cache": { + "allOf": [ + { + "$ref": "#/components/schemas/CacheMetadata" + } + ], + "description": "Metadata about our cache." + }, + "environment": { + "allOf": [ + { + "$ref": "#/components/schemas/Environment" + } + ], + "description": "The environment we are running in." + }, + "fs": { + "allOf": [ + { + "$ref": "#/components/schemas/FileSystemMetadata" + } + ], + "description": "Metadata about our file system." + }, + "git_hash": { + "description": "The git hash of the server.", + "type": "string" + }, + "pubsub": { + "allOf": [ + { + "$ref": "#/components/schemas/Connection" + } + ], + "description": "Metadata about our pub-sub connection." + } + }, + "required": [ + "async_jobs_running", + "cache", + "environment", + "fs", + "git_hash", + "pubsub" + ], + "type": "object" + }, + "Environment": { + "description": "The environment the server is running in.", + "enum": [ + "DEVELOPMENT", + "PREVIEW", + "PRODUCTION" + ], + "type": "string" + }, + "Error": { + "description": "Error information from a response.", + "properties": { + "error_code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "request_id": { + "type": "string" + } + }, + "required": [ + "message", + "request_id" + ], + "type": "object" + }, + "ExecutorMetadata": { + "description": "Metadata about our currently running server.\n\nThis is mostly used for internal purposes and debugging.", + "properties": { + "docker_info": { + "allOf": [ + { + "$ref": "#/components/schemas/DockerSystemInfo" + } + ], + "description": "Information about the docker daemon." + }, + "environment": { + "allOf": [ + { + "$ref": "#/components/schemas/Environment" + } + ], + "description": "The environment we are running in." + }, + "git_hash": { + "description": "The git hash of the server.", + "type": "string" + } + }, + "required": [ + "docker_info", + "environment", + "git_hash" + ], + "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.", + "properties": { + "company": { + "description": "The user's company.", + "type": "string" + }, + "created_at": { + "description": "The date and time the user was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "discord": { + "description": "The user's Discord handle.", + "type": "string" + }, + "email": { + "description": "The email address of the user.", + "format": "email", + "type": "string" + }, + "email_verified": { + "description": "The date and time the email address was verified.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "first_name": { + "description": "The user's first name.", + "type": "string" + }, + "github": { + "description": "The user's GitHub handle.", + "type": "string" + }, + "id": { + "description": "The unique identifier for the user.", + "type": "string" + }, + "image": { + "description": "The image avatar for the user. This is a URL.", + "format": "uri", + "title": "String", + "type": "string" + }, + "last_name": { + "description": "The user's last name.", + "type": "string" + }, + "mailchimp_id": { + "description": "The user's MailChimp ID. This is mostly used for internal mapping.", + "nullable": true, + "type": "string" + }, + "name": { + "description": "The name of the user. This is auto populated at first from the authentication provider (if there was a name). It can be updated by the user by updating their `first_name` and `last_name` fields.", + "type": "string" + }, + "phone": { + "default": "", + "description": "The user's phone number.", + "format": "phone", + "title": "String", + "type": "string" + }, + "stripe_id": { + "description": "The user's Stripe ID. This is mostly used for internal mapping.", + "nullable": true, + "type": "string" + }, + "updated_at": { + "description": "The date and time the user was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "zendesk_id": { + "description": "The user's Zendesk ID. This is mostly used for internal mapping.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "created_at", + "image", + "updated_at" + ], + "type": "object" + }, + "ExtendedUserResultsPage": { + "description": "A single page of results", + "properties": { + "items": { + "description": "list of items on this page of results", + "items": { + "$ref": "#/components/schemas/ExtendedUser" + }, + "type": "array" + }, + "next_page": { + "description": "token used to fetch the next page of results (if any)", + "nullable": true, + "type": "string" + } + }, + "required": [ + "items" + ], + "type": "object" + }, + "FileConversion": { + "description": "A file conversion.", + "properties": { + "completed_at": { + "description": "The time and date the file conversion was completed.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "created_at": { + "description": "The time and date the file conversion was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "error": { + "description": "The error the function returned, if any.", + "nullable": true, + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "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.", + "format": "byte", + "nullable": true, + "title": "String", + "type": "string" + }, + "output_format": { + "allOf": [ + { + "$ref": "#/components/schemas/FileOutputFormat" + } + ], + "description": "The output format of the file conversion." + }, + "src_format": { + "allOf": [ + { + "$ref": "#/components/schemas/FileSourceFormat" + } + ], + "description": "The source format of the file conversion." + }, + "started_at": { + "description": "The time and date the file conversion was started.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/ApiCallStatus" + } + ], + "description": "The status of the file conversion." + }, + "updated_at": { + "description": "The time and date the file conversion was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "user_id": { + "description": "The user ID of the user who created the file conversion.", + "type": "string" + } + }, + "required": [ + "created_at", + "id", + "output_format", + "src_format", + "status", + "updated_at" + ], + "type": "object" + }, + "FileDensity": { + "description": "A file density result.", + "properties": { + "completed_at": { + "description": "The time and date the density was completed.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "created_at": { + "description": "The time and date the density was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "density": { + "description": "The resulting density.", + "format": "double", + "nullable": true, + "type": "number" + }, + "error": { + "description": "The error the function returned, if any.", + "nullable": true, + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "description": "The unique identifier of the density request.\n\nThis is the same as the API call ID." + }, + "material_mass": { + "default": 0.0, + "description": "The material mass as denoted by the user.", + "format": "float", + "type": "number" + }, + "src_format": { + "allOf": [ + { + "$ref": "#/components/schemas/FileSourceFormat" + } + ], + "description": "The source format of the file." + }, + "started_at": { + "description": "The time and date the density was started.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/ApiCallStatus" + } + ], + "description": "The status of the density." + }, + "updated_at": { + "description": "The time and date the density was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "user_id": { + "description": "The user ID of the user who created the density.", + "type": "string" + } + }, + "required": [ + "created_at", + "id", + "src_format", + "status", + "updated_at" + ], + "type": "object" + }, + "FileMass": { + "description": "A file mass result.", + "properties": { + "completed_at": { + "description": "The time and date the mass was completed.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "created_at": { + "description": "The time and date the mass was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "error": { + "description": "The error the function returned, if any.", + "nullable": true, + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "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" + }, + "material_density": { + "default": 0.0, + "description": "The material density as denoted by the user.", + "format": "float", + "type": "number" + }, + "src_format": { + "allOf": [ + { + "$ref": "#/components/schemas/FileSourceFormat" + } + ], + "description": "The source format of the file." + }, + "started_at": { + "description": "The time and date the mass was started.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/ApiCallStatus" + } + ], + "description": "The status of the mass." + }, + "updated_at": { + "description": "The time and date the mass was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "user_id": { + "description": "The user ID of the user who created the mass.", + "type": "string" + } + }, + "required": [ + "created_at", + "id", + "src_format", + "status", + "updated_at" + ], + "type": "object" + }, + "FileOutputFormat": { + "description": "The valid types of output file formats.", + "enum": [ + "stl", + "obj", + "dae", + "step", + "fbx", + "fbxb" + ], + "type": "string" + }, + "FileSourceFormat": { + "description": "The valid types of source file formats.", + "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.", + "properties": { + "ok": { + "description": "If the file system passed a sanity check.", + "type": "boolean" + } + }, + "required": [ + "ok" + ], + "type": "object" + }, + "FileVolume": { + "description": "A file volume result.", + "properties": { + "completed_at": { + "description": "The time and date the volume was completed.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "created_at": { + "description": "The time and date the volume was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "error": { + "description": "The error the function returned, if any.", + "nullable": true, + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "description": "The unique identifier of the volume request.\n\nThis is the same as the API call ID." + }, + "src_format": { + "allOf": [ + { + "$ref": "#/components/schemas/FileSourceFormat" + } + ], + "description": "The source format of the file." + }, + "started_at": { + "description": "The time and date the volume was started.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/ApiCallStatus" + } + ], + "description": "The status of the volume." + }, + "updated_at": { + "description": "The time and date the volume was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "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" + } + }, + "required": [ + "created_at", + "id", + "src_format", + "status", + "updated_at" + ], + "type": "object" + }, + "Gateway": { + "description": "Gateway information.", + "properties": { + "auth_timeout": { + "default": 0, + "description": "The auth timeout of the gateway.", + "format": "int64", + "type": "integer" + }, + "host": { + "default": "", + "description": "The host of the gateway.", + "type": "string" + }, + "name": { + "default": "", + "description": "The name of the gateway.", + "type": "string" + }, + "port": { + "default": 0, + "description": "The port of the gateway.", + "format": "int64", + "type": "integer" + }, + "tls_timeout": { + "default": 0, + "description": "The TLS timeout for the gateway.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "IndexInfo": { + "description": "IndexInfo contains information about a registry.", + "properties": { + "mirrors": { + "description": "List of mirrors, expressed as URIs.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name of the registry, such as \\\"docker.io\\\".", + "nullable": true, + "type": "string" + }, + "official": { + "description": "Indicates whether this is an official registry (i.e., Docker Hub / docker.io)", + "nullable": true, + "type": "boolean" + }, + "secure": { + "description": "Indicates if the registry is part of the list of insecure registries. If `false`, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication.\n\n**Warning**: Insecure registries can be useful when running a local registry. However, because its use creates security vulnerabilities it should ONLY be enabled for testing purposes. For increased security, users should add their CA to their system's list of trusted CAs instead of enabling this option.", + "nullable": true, + "type": "boolean" + } + }, + "type": "object" + }, + "Invoice": { + "description": "An invoice.", + "properties": { + "amount_due": { + "default": 0.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": "money-usd", + "title": "Number", + "type": "number" + }, + "amount_paid": { + "default": 0.0, + "description": "The amount, in USD, that was paid.", + "format": "money-usd", + "title": "Number", + "type": "number" + }, + "amount_remaining": { + "default": 0.0, + "description": "The amount remaining, in USD, that is due.", + "format": "money-usd", + "title": "Number", + "type": "number" + }, + "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.", + "format": "uint64", + "minimum": 0, + "type": "integer" + }, + "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.", + "type": "boolean" + }, + "created_at": { + "description": "Time at which the object was created.", + "format": "date-time", + "type": "string" + }, + "currency": { + "allOf": [ + { + "$ref": "#/components/schemas/Currency" + } + ], + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase." + }, + "customer_email": { + "description": "The email address for the customer. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.", + "format": "email", + "type": "string" + }, + "customer_id": { + "description": "Customer ID. The unique identifier for the customer this invoice belongs to. This is the customer ID in the payments service, not our database customer ID.", + "type": "string" + }, + "default_payment_method": { + "description": "Default payment method.", + "type": "string" + }, + "description": { + "description": "Description of the invoice.", + "type": "string" + }, + "id": { + "description": "Unique identifier for the object.", + "type": "string" + }, + "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.", + "items": { + "$ref": "#/components/schemas/InvoiceLineItem" + }, + "type": "array" + }, + "metadata": { + "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.", + "type": "boolean" + }, + "pdf": { + "description": "The link to download the PDF for the invoice.", + "format": "uri", + "nullable": true, + "type": "string" + }, + "receipt_number": { + "description": "This is the transaction number that appears on email receipts sent for this invoice.", + "type": "string" + }, + "statement_descriptor": { + "description": "Extra information about an invoice for the customer's credit card statement.", + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/InvoiceStatus" + } + ], + "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.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": "money-usd", + "title": "Number", + "type": "number" + }, + "tax": { + "default": 0.0, + "description": "The amount of tax on this invoice.\n\nThis is the sum of all the tax amounts on this invoice.", + "format": "money-usd", + "title": "Number", + "type": "number" + }, + "total": { + "default": 0.0, + "description": "Total after discounts and taxes.", + "format": "money-usd", + "title": "Number", + "type": "number" + }, + "url": { + "description": "The URL for the hosted invoice page, which allows customers to view and pay an invoice.", + "format": "uri", + "nullable": true, + "type": "string" + } + }, + "required": [ + "created_at", + "currency" + ], + "type": "object" + }, + "InvoiceLineItem": { + "description": "An invoice line item.", + "properties": { + "amount": { + "default": 0.0, + "description": "The amount, in USD.", + "format": "money-usd", + "title": "Number", + "type": "number" + }, + "currency": { + "allOf": [ + { + "$ref": "#/components/schemas/Currency" + } + ], + "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase." + }, + "description": { + "description": "The description.", + "type": "string" + }, + "id": { + "description": "Unique identifier for the object.", + "type": "string" + }, + "invoice_item": { + "description": "The ID of the invoice item associated with this line item if any.", + "type": "string" + }, + "metadata": { + "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.", + "enum": [ + "deleted", + "draft", + "open", + "paid", + "uncollectible", + "void" + ], + "type": "string" + }, + "Jetstream": { + "description": "Jetstream information.", + "properties": { + "config": { + "allOf": [ + { + "$ref": "#/components/schemas/JetstreamConfig" + } + ], + "default": { + "domain": "", + "max_memory": 0, + "max_storage": 0, + "store_dir": "" + }, + "description": "The Jetstream config." + }, + "meta": { + "allOf": [ + { + "$ref": "#/components/schemas/MetaClusterInfo" + } + ], + "default": { + "cluster_size": 0, + "leader": "", + "name": "" + }, + "description": "Meta information about the cluster." + }, + "stats": { + "allOf": [ + { + "$ref": "#/components/schemas/JetstreamStats" + } + ], + "default": { + "accounts": 0, + "api": { + "errors": 0, + "inflight": 0, + "total": 0 + }, + "ha_assets": 0, + "memory": 0, + "reserved_memory": 0, + "reserved_store": 0, + "store": 0 + }, + "description": "Jetstream statistics." + } + }, + "type": "object" + }, + "JetstreamApiStats": { + "description": "Jetstream API statistics.", + "properties": { + "errors": { + "default": 0, + "description": "The number of errors.", + "format": "int64", + "type": "integer" + }, + "inflight": { + "default": 0, + "description": "The number of inflight requests.", + "format": "int64", + "type": "integer" + }, + "total": { + "default": 0, + "description": "The number of requests.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "JetstreamConfig": { + "description": "Jetstream configuration.", + "properties": { + "domain": { + "default": "", + "description": "The domain.", + "type": "string" + }, + "max_memory": { + "default": 0, + "description": "The max memory.", + "format": "int64", + "type": "integer" + }, + "max_storage": { + "default": 0, + "description": "The max storage.", + "format": "int64", + "type": "integer" + }, + "store_dir": { + "default": "", + "description": "The store directory.", + "type": "string" + } + }, + "type": "object" + }, + "JetstreamStats": { + "description": "Jetstream statistics.", + "properties": { + "accounts": { + "default": 0, + "description": "The number of accounts.", + "format": "int64", + "type": "integer" + }, + "api": { + "allOf": [ + { + "$ref": "#/components/schemas/JetstreamApiStats" + } + ], + "default": { + "errors": 0, + "inflight": 0, + "total": 0 + }, + "description": "API stats." + }, + "ha_assets": { + "default": 0, + "description": "The number of HA assets.", + "format": "int64", + "type": "integer" + }, + "memory": { + "default": 0, + "description": "The memory used by the Jetstream server.", + "format": "int64", + "type": "integer" + }, + "reserved_memory": { + "default": 0, + "description": "The reserved memory for the Jetstream server.", + "format": "int64", + "type": "integer" + }, + "reserved_store": { + "default": 0, + "description": "The reserved storage for the Jetstream server.", + "format": "int64", + "type": "integer" + }, + "store": { + "default": 0, + "description": "The storage used by the Jetstream server.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "LeafNode": { + "description": "Leaf node information.", + "properties": { + "auth_timeout": { + "default": 0, + "description": "The auth timeout of the leaf node.", + "format": "int64", + "type": "integer" + }, + "host": { + "default": "", + "description": "The host of the leaf node.", + "type": "string" + }, + "port": { + "default": 0, + "description": "The port of the leaf node.", + "format": "int64", + "type": "integer" + }, + "tls_timeout": { + "default": 0, + "description": "The TLS timeout for the leaf node.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "MetaClusterInfo": { + "description": "Jetstream statistics.", + "properties": { + "cluster_size": { + "default": 0, + "description": "The size of the cluster.", + "format": "int64", + "type": "integer" + }, + "leader": { + "default": "", + "description": "The leader of the cluster.", + "type": "string" + }, + "name": { + "default": "", + "description": "The name of the cluster.", + "type": "string" + } + }, + "type": "object" + }, + "Metadata": { + "description": "Metadata about our currently running server.\n\nThis is mostly used for internal purposes and debugging.", + "properties": { + "cache": { + "allOf": [ + { + "$ref": "#/components/schemas/CacheMetadata" + } + ], + "description": "Metadata about our cache." + }, + "engine": { + "allOf": [ + { + "$ref": "#/components/schemas/EngineMetadata" + } + ], + "description": "Metadata about our engine API connection." + }, + "environment": { + "allOf": [ + { + "$ref": "#/components/schemas/Environment" + } + ], + "description": "The environment we are running in." + }, + "executor": { + "allOf": [ + { + "$ref": "#/components/schemas/ExecutorMetadata" + } + ], + "description": "Metadata about our executor API connection." + }, + "fs": { + "allOf": [ + { + "$ref": "#/components/schemas/FileSystemMetadata" + } + ], + "description": "Metadata about our file system." + }, + "git_hash": { + "description": "The git hash of the server.", + "type": "string" + }, + "pubsub": { + "allOf": [ + { + "$ref": "#/components/schemas/Connection" + } + ], + "description": "Metadata about our pub-sub connection." + } + }, + "required": [ + "cache", + "engine", + "environment", + "executor", + "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.", + "enum": [ + "OPTIONS", + "GET", + "POST", + "PUT", + "DELETE", + "HEAD", + "TRACE", + "CONNECT", + "PATCH", + "EXTENSION" + ], + "type": "string" + }, + "OAuth2ClientInfo": { + "description": "Information about an OAuth 2.0 client.", + "properties": { + "csrf_token": { + "description": "Value used for [CSRF](https://tools.ietf.org/html/rfc6749#section-10.12) protection via the `state` parameter.", + "type": "string" + }, + "pkce_code_verifier": { + "description": "Code Verifier used for [PKCE]((https://tools.ietf.org/html/rfc7636)) protection via the `code_verifier` parameter. The value must have a minimum length of 43 characters and a maximum length of 128 characters. Each character must be ASCII alphanumeric or one of the characters \"-\" / \".\" / \"_\" / \"~\".", + "nullable": true, + "type": "string" + }, + "url": { + "description": "The URL for consent.", + "type": "string" + } + }, + "type": "object" + }, + "OAuth2GrantType": { + "description": "An OAuth 2.0 Grant Type. These are documented here: .", + "enum": [ + "urn:ietf:params:oauth:grant-type:device_code" + ], + "type": "string" + }, + "OutputFile": { + "description": "Output file contents.", + "properties": { + "contents": { + "description": "The contents of the file. This is base64 encoded so we can ensure it is UTF-8 for JSON.", + "nullable": true, + "type": "string" + }, + "name": { + "default": "", + "description": "The name of the file.", + "type": "string" + } + }, + "type": "object" + }, + "PaymentIntent": { + "description": "A payment intent response.", + "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.", + "type": "string" + } + }, + "required": [ + "client_secret" + ], + "type": "object" + }, + "PaymentMethod": { + "description": "A payment method.", + "properties": { + "billing_info": { + "allOf": [ + { + "$ref": "#/components/schemas/BillingInfo" + } + ], + "description": "The billing info for the payment method." + }, + "card": { + "allOf": [ + { + "$ref": "#/components/schemas/CardDetails" + } + ], + "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" + }, + "id": { + "description": "Unique identifier for the object.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "default": {}, + "description": "Set of key-value pairs.", + "type": "object" + }, + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/PaymentMethodType" + } + ], + "description": "The type of payment method." + } + }, + "required": [ + "billing_info", + "created_at", + "type" + ], + "type": "object" + }, + "PaymentMethodCardChecks": { + "description": "Card checks.", + "properties": { + "address_line1_check": { + "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", + "type": "string" + }, + "address_postal_code_check": { + "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", + "type": "string" + }, + "cvc_check": { + "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.", + "enum": [ + "card" + ], + "type": "string" + }, + "PluginsInfo": { + "description": "Available plugins per type.\n\n**Note**: Only unmanaged (V1) plugins are included in this list. V1 plugins are \\\"lazily\\\" loaded, and are not returned in this list if there is no resource using the plugin.", + "properties": { + "authorization": { + "description": "Names of available authorization plugins.", + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "description": "Names of available logging-drivers, and logging-driver plugins.", + "items": { + "type": "string" + }, + "type": "array" + }, + "network": { + "description": "Names of available network-drivers, and network-driver plugins.", + "items": { + "type": "string" + }, + "type": "array" + }, + "volume": { + "description": "Names of available volume-drivers, and network-driver plugins.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Pong": { + "description": "The response from the `/ping` endpoint.", + "properties": { + "message": { + "description": "The pong response.", + "type": "string" + } + }, + "required": [ + "message" + ], + "type": "object" + }, + "RegistryServiceConfig": { + "description": "RegistryServiceConfig stores daemon registry services configuration.", + "properties": { + "allow_nondistributable_artifacts_cid_rs": { + "description": "List of IP ranges to which nondistributable artifacts can be pushed, using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632). Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior, and enables the daemon to push nondistributable artifacts to all registries whose resolved IP address is within the subnet described by the CIDR syntax. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server.\n\n**Warning**: Nondistributable artifacts typically have restrictions on how and where they can be distributed and shared. Only use this feature to push artifacts to private registries and ensure that you are in compliance with any terms that cover redistributing nondistributable artifacts.", + "items": { + "type": "string" + }, + "type": "array" + }, + "allow_nondistributable_artifacts_hostnames": { + "description": "List of registry hostnames to which nondistributable artifacts can be pushed, using the format `[:]` or `[:]`. Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior for the specified registries. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server.\n\n**Warning**: Nondistributable artifacts typically have restrictions on how and where they can be distributed and shared. Only use this feature to push artifacts to private registries and ensure that you are in compliance with any terms that cover redistributing nondistributable artifacts.", + "items": { + "type": "string" + }, + "type": "array" + }, + "index_configs": { + "additionalProperties": { + "$ref": "#/components/schemas/IndexInfo" + }, + "type": "object" + }, + "insecure_registry_cid_rs": { + "description": "List of IP ranges of insecure registries, using the CIDR syntax ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (`127.0.0.0/8`) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under `IndexConfigs` and have their `Secure` field set to `false`.\n\n**Warning**: Using this option can be useful when running a local registry, but introduces security vulnerabilities. This option should therefore ONLY be used for testing purposes. For increased security, users should add their CA to their system's list of trusted CAs instead of enabling this option.", + "items": { + "type": "string" + }, + "type": "array" + }, + "mirrors": { + "description": "List of registry URLs that act as a mirror for the official (`docker.io`) registry.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Runtime": { + "description": "Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec) runtime. The runtime is invoked by the daemon via the `containerd` daemon. OCI runtimes act as an interface to the Linux kernel namespaces, cgroups, and SELinux.", + "properties": { + "path": { + "description": "Name and, optional, path, of the OCI executable binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result.", + "nullable": true, + "type": "string" + }, + "runtime_args": { + "description": "List of command-line arguments to pass to the runtime when invoked.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Session": { + "description": "An authentication session.\n\nFor our UIs, these are automatically created by Next.js.", + "properties": { + "created_at": { + "description": "The date and time the session was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "expires": { + "description": "The date and time the session expires.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "id": { + "description": "The unique identifier for the session.", + "type": "string" + }, + "session_token": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "description": "The session token." + }, + "updated_at": { + "description": "The date and time the session was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "user_id": { + "description": "The user ID of the user that the session belongs to.", + "type": "string" + } + }, + "required": [ + "created_at", + "expires", + "session_token", + "updated_at" + ], + "type": "object" + }, + "SystemInfoCgroupDriverEnum": { + "enum": [ + "", + "cgroupfs", + "systemd", + "none" + ], + "type": "string" + }, + "SystemInfoCgroupVersionEnum": { + "enum": [ + "", + "1", + "2" + ], + "type": "string" + }, + "SystemInfoDefaultAddressPools": { + "properties": { + "base": { + "description": "The network address in CIDR format", + "nullable": true, + "type": "string" + }, + "size": { + "description": "The network pool size", + "format": "int64", + "nullable": true, + "type": "integer" + } + }, + "type": "object" + }, + "SystemInfoIsolationEnum": { + "enum": [ + "", + "default", + "hyperv", + "process" + ], + "type": "string" + }, + "UnitConversion": { + "description": "A unit conversion.", + "properties": { + "completed_at": { + "description": "The time and date the unit conversion was completed.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "created_at": { + "description": "The time and date the unit conversion was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "error": { + "description": "The error the function returned, if any.", + "nullable": true, + "type": "string" + }, + "id": { + "allOf": [ + { + "$ref": "#/components/schemas/Uuid" + } + ], + "description": "The unique identifier of the unit conversion.\n\nThis is the same as the API call ID." + }, + "input": { + "default": 0.0, + "description": "The input value.", + "format": "float", + "type": "number" + }, + "output": { + "description": "The resulting value.", + "format": "double", + "nullable": true, + "type": "number" + }, + "output_format": { + "allOf": [ + { + "$ref": "#/components/schemas/UnitMetricFormat" + } + ], + "description": "The output format of the unit conversion." + }, + "src_format": { + "allOf": [ + { + "$ref": "#/components/schemas/UnitMetricFormat" + } + ], + "description": "The source format of the unit conversion." + }, + "started_at": { + "description": "The time and date the unit conversion was started.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/ApiCallStatus" + } + ], + "description": "The status of the unit conversion." + }, + "updated_at": { + "description": "The time and date the unit conversion was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "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" + ], + "type": "object" + }, + "UnitMetricFormat": { + "description": "The valid types of metric unit formats.", + "enum": [ + "atto", + "femto", + "pico", + "nano", + "micro", + "milli", + "centi", + "deci", + "metric_unit", + "deca", + "hecto", + "kilo", + "mega", + "giga", + "tera", + "peta", + "exa" + ], + "type": "string" + }, + "UpdateUser": { + "description": "The user-modifiable parts of a User.", + "properties": { + "company": { + "description": "The user's company.", + "type": "string" + }, + "discord": { + "description": "The user's Discord handle.", + "type": "string" + }, + "first_name": { + "description": "The user's first name.", + "type": "string" + }, + "github": { + "description": "The user's GitHub handle.", + "type": "string" + }, + "last_name": { + "description": "The user's last name.", + "type": "string" + }, + "phone": { + "default": "", + "description": "The user's phone number.", + "format": "phone", + "title": "String", + "type": "string" + } + }, + "type": "object" + }, + "User": { + "description": "A user.", + "properties": { + "company": { + "description": "The user's company.", + "type": "string" + }, + "created_at": { + "description": "The date and time the user was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "discord": { + "description": "The user's Discord handle.", + "type": "string" + }, + "email": { + "description": "The email address of the user.", + "format": "email", + "type": "string" + }, + "email_verified": { + "description": "The date and time the email address was verified.", + "format": "date-time", + "nullable": true, + "title": "DateTime", + "type": "string" + }, + "first_name": { + "description": "The user's first name.", + "type": "string" + }, + "github": { + "description": "The user's GitHub handle.", + "type": "string" + }, + "id": { + "description": "The unique identifier for the user.", + "type": "string" + }, + "image": { + "description": "The image avatar for the user. This is a URL.", + "format": "uri", + "title": "String", + "type": "string" + }, + "last_name": { + "description": "The user's last name.", + "type": "string" + }, + "name": { + "description": "The name of the user. This is auto populated at first from the authentication provider (if there was a name). It can be updated by the user by updating their `first_name` and `last_name` fields.", + "type": "string" + }, + "phone": { + "default": "", + "description": "The user's phone number.", + "format": "phone", + "title": "String", + "type": "string" + }, + "updated_at": { + "description": "The date and time the user was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + } + }, + "required": [ + "created_at", + "image", + "updated_at" + ], + "type": "object" + }, + "UserResultsPage": { + "description": "A single page of results", + "properties": { + "items": { + "description": "list of items on this page of results", + "items": { + "$ref": "#/components/schemas/User" + }, + "type": "array" + }, + "next_page": { + "description": "token used to fetch the next page of results (if any)", + "nullable": true, + "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" + }, + "VerificationToken": { + "description": "A verification token for a user.\n\nThis is typically used to verify a user's email address.", + "properties": { + "created_at": { + "description": "The date and time the verification token was created.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "expires": { + "description": "The date and time the verification token expires.", + "format": "date-time", + "title": "DateTime", + "type": "string" + }, + "id": { + "description": "The token used for verification. This is used as the id for the table since it is unique per record.", + "type": "string" + }, + "identifier": { + "description": "The identifier for the user. This is typically the user's email address since that is what we are verifying.", + "type": "string" + }, + "updated_at": { + "description": "The date and time the verification token was last updated.", + "format": "date-time", + "title": "DateTime", + "type": "string" + } + }, + "required": [ + "created_at", + "expires", + "updated_at" + ], + "type": "object" + } + } + }, + "info": { + "contact": { + "email": "api@kittycad.io", + "url": "https://kittycad.io" + }, + "description": "API server for KittyCAD", + "title": "KittyCAD API", + "version": "0.1.0" + }, + "openapi": "3.0.3", + "paths": { + "/": { + "get": { + "operationId": "get_schema", "responses": { - "Error": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error", - "x-scope": [ - "", - "#/components/responses/Error" - ] - } - } + "200": { + "content": { + "application/json": { + "schema": {} + } + }, + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "required": true, + "schema": { + "type": "string" }, - "description": "Error" + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } }, - "schemas": { - "AccountProvider": { - "description": "An account provider.", - "enum": [ - "google", - "github" - ], - "type": "string" - }, - "Address": { - "description": "An address.", - "properties": { - "city": { - "description": "The city component.", - "type": "string" - }, - "country": { - "description": "The country component.", - "type": "string" - }, - "created_at": { - "description": "The time and date the address was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/components/schemas/Customer", - "#/components/schemas/Address" - ] - } - ], - "description": "The unique identifier of the address." - }, - "state": { - "description": "The state component.", - "type": "string" - }, - "street1": { - "description": "The first street component.", - "type": "string" - }, - "street2": { - "description": "The second street component.", - "type": "string" - }, - "updated_at": { - "description": "The time and date the address was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "user_id": { - "description": "The user ID that this address belongs to.", - "type": "string" - }, - "zip": { - "description": "The zip component.", - "type": "string" - } - }, - "required": [ - "created_at", - "id", - "updated_at" - ], - "type": "object" - }, - "ApiCallQueryGroup": { - "description": "A response for a query on the API call table that is grouped by something.", - "properties": { - "count": { - "format": "int64", - "type": "integer" - }, - "query": { - "type": "string" - } - }, - "required": [ - "count", - "query" - ], - "type": "object" - }, - "ApiCallQueryGroupBy": { - "description": "The field of an API call to group by.", - "enum": [ - "email", - "method", - "endpoint", - "user_id", - "origin", - "ip_address" - ], - "type": "string" - }, - "ApiCallStatus": { - "description": "The status of an async API call.", - "enum": [ - "Queued", - "Uploaded", - "In Progress", - "Completed", - "Failed" - ], - "type": "string" - }, - "ApiCallWithPrice": { - "description": "An API call with the price.\n\nThis is a join of the `ApiCall` and `ApiCallPrice` tables.", - "properties": { - "completed_at": { - "description": "The date and time the API call completed billing.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "created_at": { - "description": "The date and time the API call was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "duration": { - "description": "The duration of the API call.", - "format": "duration", - "nullable": true, - "title": "int64", - "type": "integer" - }, - "email": { - "description": "The user's email address.", - "format": "email", - "type": "string" - }, - "endpoint": { - "description": "The endpoint requested by the API call.", - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/components/schemas/ApiCallWithPriceResultsPage", - "#/components/schemas/ApiCallWithPrice" - ] - } - ], - "description": "The unique identifier for the API call." - }, - "ip_address": { - "default": "", - "description": "The ip address of the origin.", - "format": "ip", - "title": "String", - "type": "string" - }, - "method": { - "allOf": [ - { - "$ref": "#/components/schemas/Method", - "x-scope": [ - "", - "#/components/schemas/ApiCallWithPriceResultsPage", - "#/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" - }, - "origin": { - "description": "The origin of the API call.", - "type": "string" - }, - "price": { - "description": "The price of the API call.", - "format": "money-usd", - "nullable": true, - "title": "Number", - "type": "number" - }, - "request_body": { - "description": "The request body sent by the API call.", - "nullable": true, - "type": "string" - }, - "request_query_params": { - "description": "The request query params sent by the API call.", - "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, - "type": "string" - }, - "started_at": { - "description": "The date and time the API call started billing.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "status_code": { - "description": "The status code returned by the API call.", - "format": "int32", - "nullable": true, - "title": "int32", - "type": "integer" - }, - "stripe_invoice_item_id": { - "description": "The Stripe invoice item ID of the API call if it is billable.", - "type": "string" - }, - "token": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/components/schemas/ApiCallWithPriceResultsPage", - "#/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": "date-time", - "title": "DateTime", - "type": "string" - }, - "user_agent": { - "description": "The user agent of the request.", - "type": "string" - }, - "user_id": { - "description": "The ID of the user that made the API call.", - "type": "string" - } - }, - "required": [ - "created_at", - "id", - "method", - "token", - "updated_at", - "user_agent" - ], - "type": "object" - }, - "ApiCallWithPriceResultsPage": { - "description": "A single page of results", - "properties": { - "items": { - "description": "list of items on this page of results", - "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, - "type": "string" - } - }, - "required": [ - "items" - ], - "type": "object" - }, - "ApiToken": { - "description": "An API token.\n\nThese are used to authenticate users with Bearer authentication.", - "properties": { - "created_at": { - "description": "The date and time the API token was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "id": { - "description": "The unique identifier for the API token.", - "type": "string" - }, - "is_valid": { - "description": "If the token is valid. We never delete API tokens, but we can mark them as invalid. We save them for ever to preserve the history of the API token.", - "type": "boolean" - }, - "token": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/components/schemas/ApiTokenResultsPage", - "#/components/schemas/ApiToken" - ] - } - ], - "description": "The API token itself." - }, - "updated_at": { - "description": "The date and time the API token was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "user_id": { - "description": "The ID of the user that owns the API token.", - "type": "string" - } - }, - "required": [ - "created_at", - "is_valid", - "token", - "updated_at" - ], - "type": "object" - }, - "ApiTokenResultsPage": { - "description": "A single page of results", - "properties": { - "items": { - "description": "list of items on this page of results", - "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, - "type": "string" - } - }, - "required": [ - "items" - ], - "type": "object" - }, - "AppClientInfo": { - "description": "Information about a third party app client.", - "properties": { - "url": { - "description": "The URL for consent.", - "type": "string" - } - }, - "type": "object" - }, - "AsyncApiCall": { - "description": "An async API call.", - "properties": { - "completed_at": { - "description": "The time and date the async API call was completed.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "created_at": { - "description": "The time and date the async API call was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "error": { - "description": "The error the function returned, if any.", - "nullable": true, - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/components/schemas/AsyncApiCallResultsPage", - "#/components/schemas/AsyncApiCall" - ] - } - ], - "description": "The unique identifier of the async API call.\n\nThis is the same as the API call ID." - }, - "input": { - "default": null, - "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 - }, - "started_at": { - "description": "The time and date the async API call was started.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ApiCallStatus", - "x-scope": [ - "", - "#/components/schemas/AsyncApiCallResultsPage", - "#/components/schemas/AsyncApiCall" - ] - } - ], - "description": "The status of the async API call." - }, - "type": { - "allOf": [ - { - "$ref": "#/components/schemas/AsyncApiCallType", - "x-scope": [ - "", - "#/components/schemas/AsyncApiCallResultsPage", - "#/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": "date-time", - "title": "DateTime", - "type": "string" - }, - "user_id": { - "description": "The user ID of the user who created the async API call.", - "type": "string" - }, - "worker": { - "description": "The worker node that is performing or performed the async API call.", - "type": "string" - } - }, - "required": [ - "created_at", - "id", - "status", - "type", - "updated_at" - ], - "type": "object" - }, - "AsyncApiCallOutput": { - "description": "The output from the async API call.", - "oneOf": [ - { - "description": "A file conversion.", - "properties": { - "completed_at": { - "description": "The time and date the file conversion was completed.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "created_at": { - "description": "The time and date the file conversion was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "error": { - "description": "The error the function returned, if any.", - "nullable": true, - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/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.", - "format": "byte", - "nullable": true, - "title": "String", - "type": "string" - }, - "output_format": { - "allOf": [ - { - "$ref": "#/components/schemas/FileOutputFormat", - "x-scope": [ - "", - "#/components/schemas/AsyncApiCallOutput" - ] - } - ], - "description": "The output format of the file conversion." - }, - "src_format": { - "allOf": [ - { - "$ref": "#/components/schemas/FileSourceFormat", - "x-scope": [ - "", - "#/components/schemas/AsyncApiCallOutput" - ] - } - ], - "description": "The source format of the file conversion." - }, - "started_at": { - "description": "The time and date the file conversion was started.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ApiCallStatus", - "x-scope": [ - "", - "#/components/schemas/AsyncApiCallOutput" - ] - } - ], - "description": "The status of the file conversion." - }, - "type": { - "enum": [ - "FileConversion" - ], - "type": "string" - }, - "updated_at": { - "description": "The time and date the file conversion was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "user_id": { - "description": "The user ID of the user who created the file conversion.", - "type": "string" - } - }, - "required": [ - "created_at", - "id", - "output_format", - "src_format", - "status", - "type", - "updated_at" - ], - "type": "object" - }, - { - "description": "A file mass.", - "properties": { - "completed_at": { - "description": "The time and date the mass was completed.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "created_at": { - "description": "The time and date the mass was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "error": { - "description": "The error the function returned, if any.", - "nullable": true, - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/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" - }, - "material_density": { - "default": 0.0, - "description": "The material density as denoted by the user.", - "format": "float", - "type": "number" - }, - "src_format": { - "allOf": [ - { - "$ref": "#/components/schemas/FileSourceFormat", - "x-scope": [ - "", - "#/components/schemas/AsyncApiCallOutput" - ] - } - ], - "description": "The source format of the file." - }, - "started_at": { - "description": "The time and date the mass was started.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ApiCallStatus", - "x-scope": [ - "", - "#/components/schemas/AsyncApiCallOutput" - ] - } - ], - "description": "The status of the mass." - }, - "type": { - "enum": [ - "FileMass" - ], - "type": "string" - }, - "updated_at": { - "description": "The time and date the mass was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "user_id": { - "description": "The user ID of the user who created the mass.", - "type": "string" - } - }, - "required": [ - "created_at", - "id", - "src_format", - "status", - "type", - "updated_at" - ], - "type": "object" - }, - { - "description": "A file volume.", - "properties": { - "completed_at": { - "description": "The time and date the volume was completed.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "created_at": { - "description": "The time and date the volume was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "error": { - "description": "The error the function returned, if any.", - "nullable": true, - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/components/schemas/AsyncApiCallOutput" - ] - } - ], - "description": "The unique identifier of the volume request.\n\nThis is the same as the API call ID." - }, - "src_format": { - "allOf": [ - { - "$ref": "#/components/schemas/FileSourceFormat", - "x-scope": [ - "", - "#/components/schemas/AsyncApiCallOutput" - ] - } - ], - "description": "The source format of the file." - }, - "started_at": { - "description": "The time and date the volume was started.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ApiCallStatus", - "x-scope": [ - "", - "#/components/schemas/AsyncApiCallOutput" - ] - } - ], - "description": "The status of the volume." - }, - "type": { - "enum": [ - "FileVolume" - ], - "type": "string" - }, - "updated_at": { - "description": "The time and date the volume was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "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" - } - }, - "required": [ - "created_at", - "id", - "src_format", - "status", - "type", - "updated_at" - ], - "type": "object" - }, - { - "description": "A file density.", - "properties": { - "completed_at": { - "description": "The time and date the density was completed.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "created_at": { - "description": "The time and date the density was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "density": { - "description": "The resulting density.", - "format": "double", - "nullable": true, - "type": "number" - }, - "error": { - "description": "The error the function returned, if any.", - "nullable": true, - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/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.0, - "description": "The material mass as denoted by the user.", - "format": "float", - "type": "number" - }, - "src_format": { - "allOf": [ - { - "$ref": "#/components/schemas/FileSourceFormat", - "x-scope": [ - "", - "#/components/schemas/AsyncApiCallOutput" - ] - } - ], - "description": "The source format of the file." - }, - "started_at": { - "description": "The time and date the density was started.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ApiCallStatus", - "x-scope": [ - "", - "#/components/schemas/AsyncApiCallOutput" - ] - } - ], - "description": "The status of the density." - }, - "type": { - "enum": [ - "FileDensity" - ], - "type": "string" - }, - "updated_at": { - "description": "The time and date the density was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "user_id": { - "description": "The user ID of the user who created the density.", - "type": "string" - } - }, - "required": [ - "created_at", - "id", - "src_format", - "status", - "type", - "updated_at" - ], - "type": "object" - } - ] - }, - "AsyncApiCallResultsPage": { - "description": "A single page of results", - "properties": { - "items": { - "description": "list of items on this page of results", - "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, - "type": "string" - } - }, - "required": [ - "items" - ], - "type": "object" - }, - "AsyncApiCallType": { - "description": "The type of async API call.", - "enum": [ - "FileConversion", - "FileVolume", - "FileMass", - "FileDensity" - ], - "type": "string" - }, - "BillingInfo": { - "description": "The billing information for payments.", - "properties": { - "address": { - "allOf": [ - { - "$ref": "#/components/schemas/Address", - "x-scope": [ - "", - "#/components/schemas/BillingInfo" - ] - } - ], - "description": "The address of the customer.", - "nullable": true - }, - "name": { - "description": "The name of the customer.", - "type": "string" - }, - "phone": { - "default": "", - "description": "The phone for the customer.", - "format": "phone", - "title": "String", - "type": "string" - } - }, - "type": "object" - }, - "CacheMetadata": { - "description": "Metadata about our cache.\n\nThis is mostly used for internal purposes and debugging.", - "properties": { - "ok": { - "description": "If the cache returned an ok response from ping.", - "type": "boolean" - } - }, - "required": [ - "ok" - ], - "type": "object" - }, - "CardDetails": { - "description": "The card details of a payment method.", - "properties": { - "brand": { - "description": "Card brand.\n\nCan be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", - "type": "string" - }, - "checks": { - "allOf": [ - { - "$ref": "#/components/schemas/PaymentMethodCardChecks", - "x-scope": [ - "", - "#/components/schemas/PaymentMethod", - "#/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" - }, - "exp_year": { - "default": 0, - "description": "Four-digit number representing the card's expiration year.", - "format": "int64", - "type": "integer" - }, - "fingerprint": { - "description": "Uniquely identifies this particular card number.", - "type": "string" - }, - "funding": { - "description": "Card funding type.\n\nCan be `credit`, `debit`, `prepaid`, or `unknown`.", - "type": "string" - }, - "last4": { - "description": "The last four digits of the card.", - "type": "string" - } - }, - "type": "object" - }, - "Cluster": { - "description": "Cluster information.", - "properties": { - "addr": { - "description": "The IP address of the cluster.", - "format": "ip", - "nullable": true, - "type": "string" - }, - "auth_timeout": { - "default": 0, - "description": "The auth timeout of the cluster.", - "format": "int64", - "type": "integer" - }, - "cluster_port": { - "default": 0, - "description": "The port of the cluster.", - "format": "int64", - "type": "integer" - }, - "name": { - "default": "", - "description": "The name of the cluster.", - "type": "string" - }, - "tls_timeout": { - "default": 0, - "description": "The TLS timeout for the cluster.", - "format": "int64", - "type": "integer" - }, - "urls": { - "description": "The urls of the cluster.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "CodeLanguage": { - "description": "The language code is written in.", - "enum": [ - "go", - "python", - "node" - ], - "type": "string" - }, - "CodeOutput": { - "description": "Output of the code being executed.", - "properties": { - "output_files": { - "description": "The contents of the files requested if they were passed.", - "items": { - "$ref": "#/components/schemas/OutputFile", - "x-scope": [ - "", - "#/components/schemas/CodeOutput" - ] - }, - "type": "array" - }, - "stderr": { - "default": "", - "description": "The stderr of the code.", - "type": "string" - }, - "stdout": { - "default": "", - "description": "The stdout of the code.", - "type": "string" - } - }, - "type": "object" - }, - "Commit": { - "description": "Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as `containerd`, or `runC`.", - "properties": { - "expected": { - "description": "Commit ID of external tool expected by dockerd as set at build time.", - "nullable": true, - "type": "string" - }, - "id": { - "description": "Actual commit ID of external tool.", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "Connection": { - "description": "Metadata about a pub-sub connection.\n\nThis is mostly used for internal purposes and debugging.", - "properties": { - "auth_timeout": { - "default": 0, - "description": "The auth timeout of the server.", - "format": "int64", - "type": "integer" - }, - "cluster": { - "allOf": [ - { - "$ref": "#/components/schemas/Cluster", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/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" - }, - "connections": { - "default": 0, - "description": "The number of connections to the server.", - "format": "int64", - "type": "integer" - }, - "cores": { - "default": 0, - "description": "The CPU core usage of the server.", - "format": "int64", - "type": "integer" - }, - "cpu": { - "format": "double", - "nullable": true, - "type": "number" - }, - "gateway": { - "allOf": [ - { - "$ref": "#/components/schemas/Gateway", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/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.", - "type": "string" - }, - "go": { - "default": "", - "description": "The go version.", - "type": "string" - }, - "gomaxprocs": { - "default": 0, - "description": "`GOMAXPROCS` of the server.", - "format": "int64", - "type": "integer" - }, - "host": { - "description": "The host of the server.", - "format": "ip", - "type": "string" - }, - "http_base_path": { - "default": "", - "description": "The http base path of the server.", - "type": "string" - }, - "http_host": { - "default": "", - "description": "The http host of the server.", - "type": "string" - }, - "http_port": { - "default": 0, - "description": "The http port of the server.", - "format": "int64", - "type": "integer" - }, - "http_req_stats": { - "additionalProperties": { - "format": "int64", - "type": "integer" - }, - "type": "object" - }, - "https_port": { - "default": 0, - "description": "The https port of the server.", - "format": "int64", - "type": "integer" - }, - "in_bytes": { - "default": 0, - "description": "The count of inbound bytes for the server.", - "format": "int64", - "type": "integer" - }, - "in_msgs": { - "default": 0, - "description": "The number of inbound messages for the server.", - "format": "int64", - "type": "integer" - }, - "jetstream": { - "allOf": [ - { - "$ref": "#/components/schemas/Jetstream", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/Connection" - ] - } - ], - "default": { - "config": { - "domain": "", - "max_memory": 0, - "max_storage": 0, - "store_dir": "" - }, - "meta": { - "cluster_size": 0, - "leader": "", - "name": "" - }, - "stats": { - "accounts": 0, - "api": { - "errors": 0, - "inflight": 0, - "total": 0 - }, - "ha_assets": 0, - "memory": 0, - "reserved_memory": 0, - "reserved_store": 0, - "store": 0 - } - }, - "description": "Jetstream information." - }, - "leaf": { - "allOf": [ - { - "$ref": "#/components/schemas/LeafNode", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/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" - }, - "max_connections": { - "default": 0, - "description": "The max connections of the server.", - "format": "int64", - "type": "integer" - }, - "max_control_line": { - "default": 0, - "description": "The max control line of the server.", - "format": "int64", - "type": "integer" - }, - "max_payload": { - "default": 0, - "description": "The max payload of the server.", - "format": "int64", - "type": "integer" - }, - "max_pending": { - "default": 0, - "description": "The max pending of the server.", - "format": "int64", - "type": "integer" - }, - "mem": { - "default": 0, - "description": "The memory usage of the server.", - "format": "int64", - "type": "integer" - }, - "now": { - "description": "The time now.", - "format": "date-time", - "type": "string" - }, - "out_bytes": { - "default": 0, - "description": "The count of outbound bytes for the server.", - "format": "int64", - "type": "integer" - }, - "out_msgs": { - "default": 0, - "description": "The number of outbound messages for the server.", - "format": "int64", - "type": "integer" - }, - "ping_interval": { - "default": 0, - "description": "The ping interval of the server.", - "format": "int64", - "type": "integer" - }, - "ping_max": { - "default": 0, - "description": "The ping max of the server.", - "format": "int64", - "type": "integer" - }, - "port": { - "default": 0, - "description": "The port of the server.", - "format": "int64", - "type": "integer" - }, - "proto": { - "default": 0, - "description": "The protocol version.", - "format": "int64", - "type": "integer" - }, - "remotes": { - "default": 0, - "description": "The number of remotes for the server.", - "format": "int64", - "type": "integer" - }, - "routes": { - "default": 0, - "description": "The number of routes for the server.", - "format": "int64", - "type": "integer" - }, - "server_id": { - "default": "", - "description": "The server ID.", - "type": "string" - }, - "server_name": { - "default": "", - "description": "The server name.", - "type": "string" - }, - "slow_consumers": { - "default": 0, - "description": "The number of slow consumers for the server.", - "format": "int64", - "type": "integer" - }, - "start": { - "description": "When the server was started.", - "format": "date-time", - "type": "string" - }, - "subscriptions": { - "default": 0, - "description": "The number of subscriptions for the server.", - "format": "int64", - "type": "integer" - }, - "system_account": { - "default": "", - "description": "The system account.", - "type": "string" - }, - "tls_timeout": { - "default": 0, - "description": "The TLS timeout of the server.", - "format": "int64", - "type": "integer" - }, - "total_connections": { - "default": 0, - "description": "The total number of connections to the server.", - "format": "int64", - "type": "integer" - }, - "uptime": { - "default": "", - "description": "The uptime of the server.", - "type": "string" - }, - "version": { - "default": "", - "description": "The version of the service.", - "type": "string" - }, - "write_deadline": { - "default": 0, - "description": "The write deadline of the server.", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "config_load_time", - "host", - "http_req_stats", - "now", - "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.", - "enum": [ - "created-at-ascending", - "created-at-descending" - ], - "type": "string" - }, - "Currency": { - "description": "Currency is the list of supported currencies.\n\nFor more details see .", - "enum": [ - "aed", - "afn", - "all", - "amd", - "ang", - "aoa", - "ars", - "aud", - "awg", - "azn", - "bam", - "bbd", - "bdt", - "bgn", - "bif", - "bmd", - "bnd", - "bob", - "brl", - "bsd", - "bwp", - "bzd", - "cad", - "cdf", - "chf", - "clp", - "cny", - "cop", - "crc", - "cve", - "czk", - "djf", - "dkk", - "dop", - "dzd", - "eek", - "egp", - "etb", - "eur", - "fjd", - "fkp", - "gbp", - "gel", - "gip", - "gmd", - "gnf", - "gtq", - "gyd", - "hkd", - "hnl", - "hrk", - "htg", - "huf", - "idr", - "ils", - "inr", - "isk", - "jmd", - "jpy", - "kes", - "kgs", - "khr", - "kmf", - "krw", - "kyd", - "kzt", - "lak", - "lbp", - "lkr", - "lrd", - "lsl", - "ltl", - "lvl", - "mad", - "mdl", - "mga", - "mkd", - "mnt", - "mop", - "mro", - "mur", - "mvr", - "mwk", - "mxn", - "myr", - "mzn", - "nad", - "ngn", - "nio", - "nok", - "npr", - "nzd", - "pab", - "pen", - "pgk", - "php", - "pkr", - "pln", - "pyg", - "qar", - "ron", - "rsd", - "rub", - "rwf", - "sar", - "sbd", - "scr", - "sek", - "sgd", - "shp", - "sll", - "sos", - "srd", - "std", - "svc", - "szl", - "thb", - "tjs", - "top", - "try", - "ttd", - "twd", - "tzs", - "uah", - "ugx", - "usd", - "uyu", - "uzs", - "vef", - "vnd", - "vuv", - "wst", - "xaf", - "xcd", - "xof", - "xpf", - "yer", - "zar", - "zmw" - ], - "type": "string" - }, - "Customer": { - "description": "The resource representing a payment \"Customer\".", - "properties": { - "address": { - "allOf": [ - { - "$ref": "#/components/schemas/Address", - "x-scope": [ - "", - "#/components/schemas/Customer" - ] - } - ], - "description": "The customer's address.", - "nullable": true - }, - "balance": { - "default": 0.0, - "description": "Current balance, if any, being stored on the customer in the payments service.\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": "money-usd", - "title": "Number", - "type": "number" - }, - "created_at": { - "description": "Time at which the object was created.", - "format": "date-time", - "type": "string" - }, - "currency": { - "allOf": [ - { - "$ref": "#/components/schemas/Currency", - "x-scope": [ - "", - "#/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`.", - "type": "boolean" - }, - "email": { - "description": "The customer's email address.", - "format": "email", - "type": "string" - }, - "id": { - "description": "Unique identifier for the object.", - "type": "string" - }, - "metadata": { - "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": { - "default": "", - "description": "The customer's phone number.", - "format": "phone", - "title": "String", - "type": "string" - } - }, - "required": [ - "created_at", - "currency" - ], - "type": "object" - }, - "CustomerBalance": { - "description": "A balance for a user.\n\nThis holds information about the financial balance for the user.", - "properties": { - "created_at": { - "description": "The date and time the balance was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/components/schemas/CustomerBalance" - ] - } - ], - "description": "The unique identifier for the balance." - }, - "monthly_credits_remaining": { - "description": "The monthy credits remaining in the balance. This gets re-upped every month, but if the credits are not used for a month they do not carry over to the next month. It is a stable amount granted to the user per month.", - "format": "money-usd", - "title": "Number", - "type": "number" - }, - "pre_pay_cash_remaining": { - "description": "The amount of pre-pay cash remaining in the balance. This number goes down as the user uses their pre-paid credits. The reason we track this amount is if a user ever wants to withdraw their pre-pay cash, we can use this amount to determine how much to give them. Say a user has $100 in pre-paid cash, their bill is worth, $50 after subtracting any other credits (like monthly etc.) Their bill is $50, their pre-pay cash remaining will be subtracted by 50 to pay the bill and their `pre_pay_credits_remaining` will be subtracted by 50 to pay the bill. This way if they want to withdraw money after, they can only withdraw $50 since that is the amount of cash they have remaining.", - "format": "money-usd", - "title": "Number", - "type": "number" - }, - "pre_pay_credits_remaining": { - "description": "The amount of credits remaining in the balance. This is typically the amount of cash * some multiplier they get for pre-paying their account. This number lowers every time a bill is paid with the balance. This number increases every time a user adds funds to their balance. This may be through a subscription or a one off payment.", - "format": "money-usd", - "title": "Number", - "type": "number" - }, - "total_due": { - "description": "This includes any outstanding, draft, or open invoices and any pending invoice items. This does not include any credits the user has on their account.", - "format": "money-usd", - "title": "Number", - "type": "number" - }, - "updated_at": { - "description": "The date and time the balance was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "user_id": { - "description": "The user ID the balance belongs to.", - "type": "string" - } - }, - "required": [ - "created_at", - "id", - "monthly_credits_remaining", - "pre_pay_cash_remaining", - "pre_pay_credits_remaining", - "total_due", - "updated_at" - ], - "type": "object" - }, - "DeviceAccessTokenRequestForm": { - "description": "The form for a device access token request.", - "properties": { - "client_id": { - "description": "The client ID.", - "format": "uuid", - "type": "string" - }, - "device_code": { - "description": "The device code.", - "format": "uuid", - "type": "string" - }, - "grant_type": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuth2GrantType", - "x-scope": [ - "", - "#/components/schemas/DeviceAccessTokenRequestForm" - ] - } - ], - "description": "The grant type." - } - }, - "required": [ - "client_id", - "device_code", - "grant_type" - ], - "type": "object" - }, - "DeviceAuthRequestForm": { - "description": "The request parameters for the OAuth 2.0 Device Authorization Grant flow.", - "properties": { - "client_id": { - "description": "The client ID.", - "format": "uuid", - "type": "string" - } - }, - "required": [ - "client_id" - ], - "type": "object" - }, - "DeviceAuthVerifyParams": { - "description": "The request parameters to verify the `user_code` for the OAuth 2.0 Device Authorization Grant.", - "properties": { - "user_code": { - "description": "The user code.", - "type": "string" - } - }, - "required": [ - "user_code" - ], - "type": "object" - }, - "DockerSystemInfo": { - "description": "Docker system info.", - "properties": { - "architecture": { - "description": "Hardware architecture of the host, as returned by the Go runtime (`GOARCH`). A full list of possible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment).", - "nullable": true, - "type": "string" - }, - "bridge_nf_ip6tables": { - "description": "Indicates if `bridge-nf-call-ip6tables` is available on the host.", - "nullable": true, - "type": "boolean" - }, - "bridge_nf_iptables": { - "description": "Indicates if `bridge-nf-call-iptables` is available on the host.", - "nullable": true, - "type": "boolean" - }, - "cgroup_driver": { - "allOf": [ - { - "$ref": "#/components/schemas/SystemInfoCgroupDriverEnum", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/ExecutorMetadata", - "#/components/schemas/DockerSystemInfo" - ] - } - ], - "description": "The driver to use for managing cgroups.", - "nullable": true - }, - "cgroup_version": { - "allOf": [ - { - "$ref": "#/components/schemas/SystemInfoCgroupVersionEnum", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/ExecutorMetadata", - "#/components/schemas/DockerSystemInfo" - ] - } - ], - "description": "The version of the cgroup.", - "nullable": true - }, - "cluster_advertise": { - "description": "The network endpoint that the Engine advertises for the purpose of node discovery. ClusterAdvertise is a `host:port` combination on which the daemon is reachable by other hosts.\n\n**Deprecated**: This field is only propagated when using standalone Swarm mode, and overlay networking using an external k/v store. Overlay networks with Swarm mode enabled use the built-in raft store, and this field will be empty.", - "nullable": true, - "type": "string" - }, - "cluster_store": { - "description": "URL of the distributed storage backend. The storage backend is used for multihost networking (to store network and endpoint information) and by the node discovery mechanism.\n\n**Deprecated**: This field is only propagated when using standalone Swarm mode, and overlay networking using an external k/v store. Overlay networks with Swarm mode enabled use the built-in raft store, and this field will be empty.", - "nullable": true, - "type": "string" - }, - "containerd_commit": { - "allOf": [ - { - "$ref": "#/components/schemas/Commit", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/ExecutorMetadata", - "#/components/schemas/DockerSystemInfo" - ] - } - ], - "nullable": true - }, - "containers": { - "description": "Total number of containers on the host.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "containers_paused": { - "description": "Number of containers with status `\\\"paused\\\"`.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "containers_running": { - "description": "Number of containers with status `\\\"running\\\"`.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "containers_stopped": { - "description": "Number of containers with status `\\\"stopped\\\"`.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "cpu_cfs_period": { - "description": "Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host.", - "nullable": true, - "type": "boolean" - }, - "cpu_cfs_quota": { - "description": "Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host.", - "nullable": true, - "type": "boolean" - }, - "cpu_set": { - "description": "Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See [cpuset(7)](https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt)", - "nullable": true, - "type": "boolean" - }, - "cpu_shares": { - "description": "Indicates if CPU Shares limiting is supported by the host.", - "nullable": true, - "type": "boolean" - }, - "debug": { - "description": "Indicates if the daemon is running in debug-mode / with debug-level logging enabled.", - "nullable": true, - "type": "boolean" - }, - "default_address_pools": { - "description": "List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base \\\"10.10.0.0/16\\\" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools.", - "items": { - "$ref": "#/components/schemas/SystemInfoDefaultAddressPools", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/ExecutorMetadata", - "#/components/schemas/DockerSystemInfo" - ] - }, - "type": "array" - }, - "default_runtime": { - "description": "Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time.", - "nullable": true, - "type": "string" - }, - "docker_root_dir": { - "description": "Root directory of persistent Docker state. Defaults to `/var/lib/docker` on Linux, and `C:\\\\ProgramData\\\\docker` on Windows.", - "nullable": true, - "type": "string" - }, - "driver": { - "description": "Name of the storage driver in use.", - "nullable": true, - "type": "string" - }, - "driver_status": { - "description": "Information specific to the storage driver, provided as \\\"label\\\" / \\\"value\\\" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of `docker info` on the command line.\n\n**Note**: The information returned in this field, including the formatting of values and labels, should not be considered stable, and may change without notice.", - "items": { - "items": { - "type": "string" - }, - "type": "array" - }, - "type": "array" - }, - "experimental_build": { - "description": "Indicates if experimental features are enabled on the daemon.", - "nullable": true, - "type": "boolean" - }, - "http_proxy": { - "description": "HTTP-proxy configured for the daemon. This value is obtained from the [`HTTP_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration.", - "nullable": true, - "type": "string" - }, - "https_proxy": { - "description": "HTTPS-proxy configured for the daemon. This value is obtained from the [`HTTPS_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Credentials ([user info component](https://tools.ietf.org/html/rfc3986#section-3.2.1)) in the proxy URL are masked in the API response. Containers do not automatically inherit this configuration.", - "nullable": true, - "type": "string" - }, - "id": { - "description": "Unique identifier of the daemon.\n\n**Note**: The format of the ID itself is not part of the API, and should not be considered stable.", - "nullable": true, - "type": "string" - }, - "images": { - "description": "Total number of images on the host. Both _tagged_ and _untagged_ (dangling) images are counted.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "index_server_address": { - "description": "Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud.", - "nullable": true, - "type": "string" - }, - "init_binary": { - "description": "Name and, optional, path of the `docker-init` binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result.", - "nullable": true, - "type": "string" - }, - "init_commit": { - "allOf": [ - { - "$ref": "#/components/schemas/Commit", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/ExecutorMetadata", - "#/components/schemas/DockerSystemInfo" - ] - } - ], - "nullable": true - }, - "ipv4_forwarding": { - "description": "Indicates IPv4 forwarding is enabled.", - "nullable": true, - "type": "boolean" - }, - "isolation": { - "allOf": [ - { - "$ref": "#/components/schemas/SystemInfoIsolationEnum", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/ExecutorMetadata", - "#/components/schemas/DockerSystemInfo" - ] - } - ], - "description": "Represents the isolation technology to use as a default for containers. The supported values are platform-specific. If no isolation value is specified on daemon start, on Windows client, the default is `hyperv`, and on Windows server, the default is `process`. This option is currently not used on other platforms.", - "nullable": true - }, - "kernel_memory": { - "description": "Indicates if the host has kernel memory limit support enabled.\n\n**Deprecated**: This field is deprecated as the kernel 5.4 deprecated `kmem.limit_in_bytes`.", - "nullable": true, - "type": "boolean" - }, - "kernel_memory_tcp": { - "description": "Indicates if the host has kernel memory TCP limit support enabled. Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding `memory.kmem.tcp.limit_in_bytes` cgroup.", - "nullable": true, - "type": "boolean" - }, - "kernel_version": { - "description": "Kernel version of the host. On Linux, this information obtained from `uname`. On Windows this information is queried from the HKEY_LOCAL_MACHINE\\\\\\\\SOFTWARE\\\\\\\\Microsoft\\\\\\\\Windows NT\\\\\\\\CurrentVersion\\\\\\\\ registry value, for example _\\\"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)\\\"_.", - "nullable": true, - "type": "string" - }, - "labels": { - "description": "User-defined labels (key/value metadata) as set on the daemon.\n\n**Note**: When part of a Swarm, nodes can both have _daemon_ labels, set through the daemon configuration, and _node_ labels, set from a manager node in the Swarm. Node labels are not included in this field. Node labels can be retrieved using the `/nodes/(id)` endpoint on a manager node in the Swarm.", - "items": { - "type": "string" - }, - "type": "array" - }, - "live_restore_enabled": { - "description": "Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected.", - "nullable": true, - "type": "boolean" - }, - "logging_driver": { - "description": "The logging driver to use as a default for new containers.", - "nullable": true, - "type": "string" - }, - "mem_total": { - "description": "Total amount of physical memory available on the host, in bytes.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "memory_limit": { - "description": "Indicates if the host has memory limit support enabled.", - "nullable": true, - "type": "boolean" - }, - "n_events_listener": { - "description": "Number of event listeners subscribed.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "n_fd": { - "description": "The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "name": { - "description": "Hostname of the host.", - "nullable": true, - "type": "string" - }, - "ncpu": { - "description": "The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "no_proxy": { - "description": "Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the [`NO_PROXY`](https://www.gnu.org/software/wget/manual/html_node/Proxies.html) environment variable. Containers do not automatically inherit this configuration.", - "nullable": true, - "type": "string" - }, - "oom_kill_disable": { - "description": "Indicates if OOM killer disable is supported on the host.", - "nullable": true, - "type": "boolean" - }, - "operating_system": { - "description": "Name of the host's operating system, for example: \\\"Ubuntu 16.04.2 LTS\\\" or \\\"Windows Server 2016 Datacenter\\\"", - "nullable": true, - "type": "string" - }, - "os_type": { - "description": "Generic type of the operating system of the host, as returned by the Go runtime (`GOOS`). Currently returned values are \\\"linux\\\" and \\\"windows\\\". A full list of possible values can be found in the [Go documentation](https://golang.org/doc/install/source#environment).", - "nullable": true, - "type": "string" - }, - "os_version": { - "description": "Version of the host's operating system\n\n**Note**: The information returned in this field, including its very existence, and the formatting of values, should not be considered stable, and may change without notice.", - "nullable": true, - "type": "string" - }, - "pids_limit": { - "description": "Indicates if the host kernel has PID limit support enabled.", - "nullable": true, - "type": "boolean" - }, - "plugins": { - "allOf": [ - { - "$ref": "#/components/schemas/PluginsInfo", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/ExecutorMetadata", - "#/components/schemas/DockerSystemInfo" - ] - } - ], - "nullable": true - }, - "product_license": { - "description": "Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included.", - "nullable": true, - "type": "string" - }, - "registry_config": { - "allOf": [ - { - "$ref": "#/components/schemas/RegistryServiceConfig", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/ExecutorMetadata", - "#/components/schemas/DockerSystemInfo" - ] - } - ], - "nullable": true - }, - "runc_commit": { - "allOf": [ - { - "$ref": "#/components/schemas/Commit", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/ExecutorMetadata", - "#/components/schemas/DockerSystemInfo" - ] - } - ], - "nullable": true - }, - "runtimes": { - "additionalProperties": { - "$ref": "#/components/schemas/Runtime", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/ExecutorMetadata", - "#/components/schemas/DockerSystemInfo" - ] - }, - "type": "object" - }, - "security_options": { - "description": "List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), and rootless. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs.", - "items": { - "type": "string" - }, - "type": "array" - }, - "server_version": { - "description": "Version string of the daemon. **Note**: the [standalone Swarm API](https://docs.docker.com/swarm/swarm-api/) returns the Swarm version instead of the daemon version, for example `swarm/1.2.8`.", - "nullable": true, - "type": "string" - }, - "swap_limit": { - "description": "Indicates if the host has memory swap limit support enabled.", - "nullable": true, - "type": "boolean" - }, - "system_time": { - "description": "The number of goroutines that currently exist. This information is only returned if debug-mode is enabled.", - "nullable": true, - "type": "string" - }, - "warnings": { - "description": "List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "EmailAuthenticationForm": { - "description": "The body of the form for email authentication.", - "properties": { - "callback_url": { - "description": "The URL to redirect back to after we have authenticated.", - "format": "uri", - "nullable": true, - "type": "string" - }, - "email": { - "description": "The user's email.", - "format": "email", - "type": "string" - } - }, - "required": [ - "email" - ], - "type": "object" - }, - "EngineMetadata": { - "description": "Metadata about our currently running server.\n\nThis is mostly used for internal purposes and debugging.", - "properties": { - "async_jobs_running": { - "description": "If any async job is currently running.", - "type": "boolean" - }, - "cache": { - "allOf": [ - { - "$ref": "#/components/schemas/CacheMetadata", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/EngineMetadata" - ] - } - ], - "description": "Metadata about our cache." - }, - "environment": { - "allOf": [ - { - "$ref": "#/components/schemas/Environment", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/EngineMetadata" - ] - } - ], - "description": "The environment we are running in." - }, - "fs": { - "allOf": [ - { - "$ref": "#/components/schemas/FileSystemMetadata", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/EngineMetadata" - ] - } - ], - "description": "Metadata about our file system." - }, - "git_hash": { - "description": "The git hash of the server.", - "type": "string" - }, - "pubsub": { - "allOf": [ - { - "$ref": "#/components/schemas/Connection", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/EngineMetadata" - ] - } - ], - "description": "Metadata about our pub-sub connection." - } - }, - "required": [ - "async_jobs_running", - "cache", - "environment", - "fs", - "git_hash", - "pubsub" - ], - "type": "object" - }, - "Environment": { - "description": "The environment the server is running in.", - "enum": [ - "DEVELOPMENT", - "PREVIEW", - "PRODUCTION" - ], - "type": "string" - }, - "Error": { - "description": "Error information from a response.", - "properties": { - "error_code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "request_id": { - "type": "string" - } - }, - "required": [ - "message", - "request_id" - ], - "type": "object" - }, - "ExecutorMetadata": { - "description": "Metadata about our currently running server.\n\nThis is mostly used for internal purposes and debugging.", - "properties": { - "docker_info": { - "allOf": [ - { - "$ref": "#/components/schemas/DockerSystemInfo", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/ExecutorMetadata" - ] - } - ], - "description": "Information about the docker daemon." - }, - "environment": { - "allOf": [ - { - "$ref": "#/components/schemas/Environment", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/ExecutorMetadata" - ] - } - ], - "description": "The environment we are running in." - }, - "git_hash": { - "description": "The git hash of the server.", - "type": "string" - } - }, - "required": [ - "docker_info", - "environment", - "git_hash" - ], - "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.", - "properties": { - "company": { - "description": "The user's company.", - "type": "string" - }, - "created_at": { - "description": "The date and time the user was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "discord": { - "description": "The user's Discord handle.", - "type": "string" - }, - "email": { - "description": "The email address of the user.", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "The date and time the email address was verified.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "first_name": { - "description": "The user's first name.", - "type": "string" - }, - "github": { - "description": "The user's GitHub handle.", - "type": "string" - }, - "id": { - "description": "The unique identifier for the user.", - "type": "string" - }, - "image": { - "description": "The image avatar for the user. This is a URL.", - "format": "uri", - "title": "String", - "type": "string" - }, - "last_name": { - "description": "The user's last name.", - "type": "string" - }, - "mailchimp_id": { - "description": "The user's MailChimp ID. This is mostly used for internal mapping.", - "nullable": true, - "type": "string" - }, - "name": { - "description": "The name of the user. This is auto populated at first from the authentication provider (if there was a name). It can be updated by the user by updating their `first_name` and `last_name` fields.", - "type": "string" - }, - "phone": { - "default": "", - "description": "The user's phone number.", - "format": "phone", - "title": "String", - "type": "string" - }, - "stripe_id": { - "description": "The user's Stripe ID. This is mostly used for internal mapping.", - "nullable": true, - "type": "string" - }, - "updated_at": { - "description": "The date and time the user was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "zendesk_id": { - "description": "The user's Zendesk ID. This is mostly used for internal mapping.", - "nullable": true, - "type": "string" - } - }, - "required": [ - "created_at", - "image", - "updated_at" - ], - "type": "object" - }, - "ExtendedUserResultsPage": { - "description": "A single page of results", - "properties": { - "items": { - "description": "list of items on this page of results", - "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, - "type": "string" - } - }, - "required": [ - "items" - ], - "type": "object" - }, - "FileConversion": { - "description": "A file conversion.", - "properties": { - "completed_at": { - "description": "The time and date the file conversion was completed.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "created_at": { - "description": "The time and date the file conversion was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "error": { - "description": "The error the function returned, if any.", - "nullable": true, - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/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.", - "format": "byte", - "nullable": true, - "title": "String", - "type": "string" - }, - "output_format": { - "allOf": [ - { - "$ref": "#/components/schemas/FileOutputFormat", - "x-scope": [ - "", - "#/components/schemas/FileConversion" - ] - } - ], - "description": "The output format of the file conversion." - }, - "src_format": { - "allOf": [ - { - "$ref": "#/components/schemas/FileSourceFormat", - "x-scope": [ - "", - "#/components/schemas/FileConversion" - ] - } - ], - "description": "The source format of the file conversion." - }, - "started_at": { - "description": "The time and date the file conversion was started.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ApiCallStatus", - "x-scope": [ - "", - "#/components/schemas/FileConversion" - ] - } - ], - "description": "The status of the file conversion." - }, - "updated_at": { - "description": "The time and date the file conversion was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "user_id": { - "description": "The user ID of the user who created the file conversion.", - "type": "string" - } - }, - "required": [ - "created_at", - "id", - "output_format", - "src_format", - "status", - "updated_at" - ], - "type": "object" - }, - "FileDensity": { - "description": "A file density result.", - "properties": { - "completed_at": { - "description": "The time and date the density was completed.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "created_at": { - "description": "The time and date the density was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "density": { - "description": "The resulting density.", - "format": "double", - "nullable": true, - "type": "number" - }, - "error": { - "description": "The error the function returned, if any.", - "nullable": true, - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/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.0, - "description": "The material mass as denoted by the user.", - "format": "float", - "type": "number" - }, - "src_format": { - "allOf": [ - { - "$ref": "#/components/schemas/FileSourceFormat", - "x-scope": [ - "", - "#/components/schemas/FileDensity" - ] - } - ], - "description": "The source format of the file." - }, - "started_at": { - "description": "The time and date the density was started.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ApiCallStatus", - "x-scope": [ - "", - "#/components/schemas/FileDensity" - ] - } - ], - "description": "The status of the density." - }, - "updated_at": { - "description": "The time and date the density was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "user_id": { - "description": "The user ID of the user who created the density.", - "type": "string" - } - }, - "required": [ - "created_at", - "id", - "src_format", - "status", - "updated_at" - ], - "type": "object" - }, - "FileMass": { - "description": "A file mass result.", - "properties": { - "completed_at": { - "description": "The time and date the mass was completed.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "created_at": { - "description": "The time and date the mass was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "error": { - "description": "The error the function returned, if any.", - "nullable": true, - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/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" - }, - "material_density": { - "default": 0.0, - "description": "The material density as denoted by the user.", - "format": "float", - "type": "number" - }, - "src_format": { - "allOf": [ - { - "$ref": "#/components/schemas/FileSourceFormat", - "x-scope": [ - "", - "#/components/schemas/FileMass" - ] - } - ], - "description": "The source format of the file." - }, - "started_at": { - "description": "The time and date the mass was started.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ApiCallStatus", - "x-scope": [ - "", - "#/components/schemas/FileMass" - ] - } - ], - "description": "The status of the mass." - }, - "updated_at": { - "description": "The time and date the mass was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "user_id": { - "description": "The user ID of the user who created the mass.", - "type": "string" - } - }, - "required": [ - "created_at", - "id", - "src_format", - "status", - "updated_at" - ], - "type": "object" - }, - "FileOutputFormat": { - "description": "The valid types of output file formats.", - "enum": [ - "stl", - "obj", - "dae", - "step", - "fbx", - "fbxb" - ], - "type": "string" - }, - "FileSourceFormat": { - "description": "The valid types of source file formats.", - "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.", - "properties": { - "ok": { - "description": "If the file system passed a sanity check.", - "type": "boolean" - } - }, - "required": [ - "ok" - ], - "type": "object" - }, - "FileVolume": { - "description": "A file volume result.", - "properties": { - "completed_at": { - "description": "The time and date the volume was completed.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "created_at": { - "description": "The time and date the volume was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "error": { - "description": "The error the function returned, if any.", - "nullable": true, - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/components/schemas/FileVolume" - ] - } - ], - "description": "The unique identifier of the volume request.\n\nThis is the same as the API call ID." - }, - "src_format": { - "allOf": [ - { - "$ref": "#/components/schemas/FileSourceFormat", - "x-scope": [ - "", - "#/components/schemas/FileVolume" - ] - } - ], - "description": "The source format of the file." - }, - "started_at": { - "description": "The time and date the volume was started.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ApiCallStatus", - "x-scope": [ - "", - "#/components/schemas/FileVolume" - ] - } - ], - "description": "The status of the volume." - }, - "updated_at": { - "description": "The time and date the volume was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "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" - } - }, - "required": [ - "created_at", - "id", - "src_format", - "status", - "updated_at" - ], - "type": "object" - }, - "Gateway": { - "description": "Gateway information.", - "properties": { - "auth_timeout": { - "default": 0, - "description": "The auth timeout of the gateway.", - "format": "int64", - "type": "integer" - }, - "host": { - "default": "", - "description": "The host of the gateway.", - "type": "string" - }, - "name": { - "default": "", - "description": "The name of the gateway.", - "type": "string" - }, - "port": { - "default": 0, - "description": "The port of the gateway.", - "format": "int64", - "type": "integer" - }, - "tls_timeout": { - "default": 0, - "description": "The TLS timeout for the gateway.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "IndexInfo": { - "description": "IndexInfo contains information about a registry.", - "properties": { - "mirrors": { - "description": "List of mirrors, expressed as URIs.", - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name of the registry, such as \\\"docker.io\\\".", - "nullable": true, - "type": "string" - }, - "official": { - "description": "Indicates whether this is an official registry (i.e., Docker Hub / docker.io)", - "nullable": true, - "type": "boolean" - }, - "secure": { - "description": "Indicates if the registry is part of the list of insecure registries. If `false`, the registry is insecure. Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication.\n\n**Warning**: Insecure registries can be useful when running a local registry. However, because its use creates security vulnerabilities it should ONLY be enabled for testing purposes. For increased security, users should add their CA to their system's list of trusted CAs instead of enabling this option.", - "nullable": true, - "type": "boolean" - } - }, - "type": "object" - }, - "Invoice": { - "description": "An invoice.", - "properties": { - "amount_due": { - "default": 0.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": "money-usd", - "title": "Number", - "type": "number" - }, - "amount_paid": { - "default": 0.0, - "description": "The amount, in USD, that was paid.", - "format": "money-usd", - "title": "Number", - "type": "number" - }, - "amount_remaining": { - "default": 0.0, - "description": "The amount remaining, in USD, that is due.", - "format": "money-usd", - "title": "Number", - "type": "number" - }, - "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.", - "format": "uint64", - "minimum": 0, - "type": "integer" - }, - "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.", - "type": "boolean" - }, - "created_at": { - "description": "Time at which the object was created.", - "format": "date-time", - "type": "string" - }, - "currency": { - "allOf": [ - { - "$ref": "#/components/schemas/Currency", - "x-scope": [ - "", - "#/components/schemas/Invoice" - ] - } - ], - "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase." - }, - "customer_email": { - "description": "The email address for the customer. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.", - "format": "email", - "type": "string" - }, - "customer_id": { - "description": "Customer ID. The unique identifier for the customer this invoice belongs to. This is the customer ID in the payments service, not our database customer ID.", - "type": "string" - }, - "default_payment_method": { - "description": "Default payment method.", - "type": "string" - }, - "description": { - "description": "Description of the invoice.", - "type": "string" - }, - "id": { - "description": "Unique identifier for the object.", - "type": "string" - }, - "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.", - "items": { - "$ref": "#/components/schemas/InvoiceLineItem", - "x-scope": [ - "", - "#/components/schemas/Invoice" - ] - }, - "type": "array" - }, - "metadata": { - "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.", - "type": "boolean" - }, - "pdf": { - "description": "The link to download the PDF for the invoice.", - "format": "uri", - "nullable": true, - "type": "string" - }, - "receipt_number": { - "description": "This is the transaction number that appears on email receipts sent for this invoice.", - "type": "string" - }, - "statement_descriptor": { - "description": "Extra information about an invoice for the customer's credit card statement.", - "type": "string" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/InvoiceStatus", - "x-scope": [ - "", - "#/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.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": "money-usd", - "title": "Number", - "type": "number" - }, - "tax": { - "default": 0.0, - "description": "The amount of tax on this invoice.\n\nThis is the sum of all the tax amounts on this invoice.", - "format": "money-usd", - "title": "Number", - "type": "number" - }, - "total": { - "default": 0.0, - "description": "Total after discounts and taxes.", - "format": "money-usd", - "title": "Number", - "type": "number" - }, - "url": { - "description": "The URL for the hosted invoice page, which allows customers to view and pay an invoice.", - "format": "uri", - "nullable": true, - "type": "string" - } - }, - "required": [ - "created_at", - "currency" - ], - "type": "object" - }, - "InvoiceLineItem": { - "description": "An invoice line item.", - "properties": { - "amount": { - "default": 0.0, - "description": "The amount, in USD.", - "format": "money-usd", - "title": "Number", - "type": "number" - }, - "currency": { - "allOf": [ - { - "$ref": "#/components/schemas/Currency", - "x-scope": [ - "", - "#/components/schemas/Invoice", - "#/components/schemas/InvoiceLineItem" - ] - } - ], - "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase." - }, - "description": { - "description": "The description.", - "type": "string" - }, - "id": { - "description": "Unique identifier for the object.", - "type": "string" - }, - "invoice_item": { - "description": "The ID of the invoice item associated with this line item if any.", - "type": "string" - }, - "metadata": { - "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.", - "enum": [ - "deleted", - "draft", - "open", - "paid", - "uncollectible", - "void" - ], - "type": "string" - }, - "Jetstream": { - "description": "Jetstream information.", - "properties": { - "config": { - "allOf": [ - { - "$ref": "#/components/schemas/JetstreamConfig", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/Connection", - "#/components/schemas/Jetstream" - ] - } - ], - "default": { - "domain": "", - "max_memory": 0, - "max_storage": 0, - "store_dir": "" - }, - "description": "The Jetstream config." - }, - "meta": { - "allOf": [ - { - "$ref": "#/components/schemas/MetaClusterInfo", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/Connection", - "#/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" - ] - } - ], - "default": { - "accounts": 0, - "api": { - "errors": 0, - "inflight": 0, - "total": 0 - }, - "ha_assets": 0, - "memory": 0, - "reserved_memory": 0, - "reserved_store": 0, - "store": 0 - }, - "description": "Jetstream statistics." - } - }, - "type": "object" - }, - "JetstreamApiStats": { - "description": "Jetstream API statistics.", - "properties": { - "errors": { - "default": 0, - "description": "The number of errors.", - "format": "int64", - "type": "integer" - }, - "inflight": { - "default": 0, - "description": "The number of inflight requests.", - "format": "int64", - "type": "integer" - }, - "total": { - "default": 0, - "description": "The number of requests.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "JetstreamConfig": { - "description": "Jetstream configuration.", - "properties": { - "domain": { - "default": "", - "description": "The domain.", - "type": "string" - }, - "max_memory": { - "default": 0, - "description": "The max memory.", - "format": "int64", - "type": "integer" - }, - "max_storage": { - "default": 0, - "description": "The max storage.", - "format": "int64", - "type": "integer" - }, - "store_dir": { - "default": "", - "description": "The store directory.", - "type": "string" - } - }, - "type": "object" - }, - "JetstreamStats": { - "description": "Jetstream statistics.", - "properties": { - "accounts": { - "default": 0, - "description": "The number of accounts.", - "format": "int64", - "type": "integer" - }, - "api": { - "allOf": [ - { - "$ref": "#/components/schemas/JetstreamApiStats", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/Connection", - "#/components/schemas/Jetstream", - "#/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" - }, - "memory": { - "default": 0, - "description": "The memory used by the Jetstream server.", - "format": "int64", - "type": "integer" - }, - "reserved_memory": { - "default": 0, - "description": "The reserved memory for the Jetstream server.", - "format": "int64", - "type": "integer" - }, - "reserved_store": { - "default": 0, - "description": "The reserved storage for the Jetstream server.", - "format": "int64", - "type": "integer" - }, - "store": { - "default": 0, - "description": "The storage used by the Jetstream server.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "LeafNode": { - "description": "Leaf node information.", - "properties": { - "auth_timeout": { - "default": 0, - "description": "The auth timeout of the leaf node.", - "format": "int64", - "type": "integer" - }, - "host": { - "default": "", - "description": "The host of the leaf node.", - "type": "string" - }, - "port": { - "default": 0, - "description": "The port of the leaf node.", - "format": "int64", - "type": "integer" - }, - "tls_timeout": { - "default": 0, - "description": "The TLS timeout for the leaf node.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "MetaClusterInfo": { - "description": "Jetstream statistics.", - "properties": { - "cluster_size": { - "default": 0, - "description": "The size of the cluster.", - "format": "int64", - "type": "integer" - }, - "leader": { - "default": "", - "description": "The leader of the cluster.", - "type": "string" - }, - "name": { - "default": "", - "description": "The name of the cluster.", - "type": "string" - } - }, - "type": "object" - }, - "Metadata": { - "description": "Metadata about our currently running server.\n\nThis is mostly used for internal purposes and debugging.", - "properties": { - "cache": { - "allOf": [ - { - "$ref": "#/components/schemas/CacheMetadata", - "x-scope": [ - "", - "#/components/schemas/Metadata" - ] - } - ], - "description": "Metadata about our cache." - }, - "engine": { - "allOf": [ - { - "$ref": "#/components/schemas/EngineMetadata", - "x-scope": [ - "", - "#/components/schemas/Metadata" - ] - } - ], - "description": "Metadata about our engine API connection." - }, - "environment": { - "allOf": [ - { - "$ref": "#/components/schemas/Environment", - "x-scope": [ - "", - "#/components/schemas/Metadata" - ] - } - ], - "description": "The environment we are running in." - }, - "executor": { - "allOf": [ - { - "$ref": "#/components/schemas/ExecutorMetadata", - "x-scope": [ - "", - "#/components/schemas/Metadata" - ] - } - ], - "description": "Metadata about our executor API connection." - }, - "fs": { - "allOf": [ - { - "$ref": "#/components/schemas/FileSystemMetadata", - "x-scope": [ - "", - "#/components/schemas/Metadata" - ] - } - ], - "description": "Metadata about our file system." - }, - "git_hash": { - "description": "The git hash of the server.", - "type": "string" - }, - "pubsub": { - "allOf": [ - { - "$ref": "#/components/schemas/Connection", - "x-scope": [ - "", - "#/components/schemas/Metadata" - ] - } - ], - "description": "Metadata about our pub-sub connection." - } - }, - "required": [ - "cache", - "engine", - "environment", - "executor", - "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.", - "enum": [ - "OPTIONS", - "GET", - "POST", - "PUT", - "DELETE", - "HEAD", - "TRACE", - "CONNECT", - "PATCH", - "EXTENSION" - ], - "type": "string" - }, - "OAuth2ClientInfo": { - "description": "Information about an OAuth 2.0 client.", - "properties": { - "csrf_token": { - "description": "Value used for [CSRF](https://tools.ietf.org/html/rfc6749#section-10.12) protection via the `state` parameter.", - "type": "string" - }, - "pkce_code_verifier": { - "description": "Code Verifier used for [PKCE]((https://tools.ietf.org/html/rfc7636)) protection via the `code_verifier` parameter. The value must have a minimum length of 43 characters and a maximum length of 128 characters. Each character must be ASCII alphanumeric or one of the characters \"-\" / \".\" / \"_\" / \"~\".", - "nullable": true, - "type": "string" - }, - "url": { - "description": "The URL for consent.", - "type": "string" - } - }, - "type": "object" - }, - "OAuth2GrantType": { - "description": "An OAuth 2.0 Grant Type. These are documented here: .", - "enum": [ - "urn:ietf:params:oauth:grant-type:device_code" - ], - "type": "string" - }, - "OutputFile": { - "description": "Output file contents.", - "properties": { - "contents": { - "description": "The contents of the file. This is base64 encoded so we can ensure it is UTF-8 for JSON.", - "nullable": true, - "type": "string" - }, - "name": { - "default": "", - "description": "The name of the file.", - "type": "string" - } - }, - "type": "object" - }, - "PaymentIntent": { - "description": "A payment intent response.", - "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.", - "type": "string" - } - }, - "required": [ - "client_secret" - ], - "type": "object" - }, - "PaymentMethod": { - "description": "A payment method.", - "properties": { - "billing_info": { - "allOf": [ - { - "$ref": "#/components/schemas/BillingInfo", - "x-scope": [ - "", - "#/components/schemas/PaymentMethod" - ] - } - ], - "description": "The billing info for the payment method." - }, - "card": { - "allOf": [ - { - "$ref": "#/components/schemas/CardDetails", - "x-scope": [ - "", - "#/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" - }, - "id": { - "description": "Unique identifier for the object.", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "default": {}, - "description": "Set of key-value pairs.", - "type": "object" - }, - "type": { - "allOf": [ - { - "$ref": "#/components/schemas/PaymentMethodType", - "x-scope": [ - "", - "#/components/schemas/PaymentMethod" - ] - } - ], - "description": "The type of payment method." - } - }, - "required": [ - "billing_info", - "created_at", - "type" - ], - "type": "object" - }, - "PaymentMethodCardChecks": { - "description": "Card checks.", - "properties": { - "address_line1_check": { - "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", - "type": "string" - }, - "address_postal_code_check": { - "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", - "type": "string" - }, - "cvc_check": { - "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.", - "enum": [ - "card" - ], - "type": "string" - }, - "PluginsInfo": { - "description": "Available plugins per type.\n\n**Note**: Only unmanaged (V1) plugins are included in this list. V1 plugins are \\\"lazily\\\" loaded, and are not returned in this list if there is no resource using the plugin.", - "properties": { - "authorization": { - "description": "Names of available authorization plugins.", - "items": { - "type": "string" - }, - "type": "array" - }, - "log": { - "description": "Names of available logging-drivers, and logging-driver plugins.", - "items": { - "type": "string" - }, - "type": "array" - }, - "network": { - "description": "Names of available network-drivers, and network-driver plugins.", - "items": { - "type": "string" - }, - "type": "array" - }, - "volume": { - "description": "Names of available volume-drivers, and network-driver plugins.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Pong": { - "description": "The response from the `/ping` endpoint.", - "properties": { - "message": { - "description": "The pong response.", - "type": "string" - } - }, - "required": [ - "message" - ], - "type": "object" - }, - "RegistryServiceConfig": { - "description": "RegistryServiceConfig stores daemon registry services configuration.", - "properties": { - "allow_nondistributable_artifacts_cid_rs": { - "description": "List of IP ranges to which nondistributable artifacts can be pushed, using the CIDR syntax [RFC 4632](https://tools.ietf.org/html/4632). Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior, and enables the daemon to push nondistributable artifacts to all registries whose resolved IP address is within the subnet described by the CIDR syntax. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server.\n\n**Warning**: Nondistributable artifacts typically have restrictions on how and where they can be distributed and shared. Only use this feature to push artifacts to private registries and ensure that you are in compliance with any terms that cover redistributing nondistributable artifacts.", - "items": { - "type": "string" - }, - "type": "array" - }, - "allow_nondistributable_artifacts_hostnames": { - "description": "List of registry hostnames to which nondistributable artifacts can be pushed, using the format `[:]` or `[:]`. Some images (for example, Windows base images) contain artifacts whose distribution is restricted by license. When these images are pushed to a registry, restricted artifacts are not included. This configuration override this behavior for the specified registries. This option is useful when pushing images containing nondistributable artifacts to a registry on an air-gapped network so hosts on that network can pull the images without connecting to another server.\n\n**Warning**: Nondistributable artifacts typically have restrictions on how and where they can be distributed and shared. Only use this feature to push artifacts to private registries and ensure that you are in compliance with any terms that cover redistributing nondistributable artifacts.", - "items": { - "type": "string" - }, - "type": "array" - }, - "index_configs": { - "additionalProperties": { - "$ref": "#/components/schemas/IndexInfo", - "x-scope": [ - "", - "#/components/schemas/Metadata", - "#/components/schemas/ExecutorMetadata", - "#/components/schemas/DockerSystemInfo", - "#/components/schemas/RegistryServiceConfig" - ] - }, - "type": "object" - }, - "insecure_registry_cid_rs": { - "description": "List of IP ranges of insecure registries, using the CIDR syntax ([RFC 4632](https://tools.ietf.org/html/4632)). Insecure registries accept un-encrypted (HTTP) and/or untrusted (HTTPS with certificates from unknown CAs) communication. By default, local registries (`127.0.0.0/8`) are configured as insecure. All other registries are secure. Communicating with an insecure registry is not possible if the daemon assumes that registry is secure. This configuration override this behavior, insecure communication with registries whose resolved IP address is within the subnet described by the CIDR syntax. Registries can also be marked insecure by hostname. Those registries are listed under `IndexConfigs` and have their `Secure` field set to `false`.\n\n**Warning**: Using this option can be useful when running a local registry, but introduces security vulnerabilities. This option should therefore ONLY be used for testing purposes. For increased security, users should add their CA to their system's list of trusted CAs instead of enabling this option.", - "items": { - "type": "string" - }, - "type": "array" - }, - "mirrors": { - "description": "List of registry URLs that act as a mirror for the official (`docker.io`) registry.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Runtime": { - "description": "Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec) runtime. The runtime is invoked by the daemon via the `containerd` daemon. OCI runtimes act as an interface to the Linux kernel namespaces, cgroups, and SELinux.", - "properties": { - "path": { - "description": "Name and, optional, path, of the OCI executable binary. If the path is omitted, the daemon searches the host's `$PATH` for the binary and uses the first result.", - "nullable": true, - "type": "string" - }, - "runtime_args": { - "description": "List of command-line arguments to pass to the runtime when invoked.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Session": { - "description": "An authentication session.\n\nFor our UIs, these are automatically created by Next.js.", - "properties": { - "created_at": { - "description": "The date and time the session was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "expires": { - "description": "The date and time the session expires.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "id": { - "description": "The unique identifier for the session.", - "type": "string" - }, - "session_token": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/components/schemas/Session" - ] - } - ], - "description": "The session token." - }, - "updated_at": { - "description": "The date and time the session was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "user_id": { - "description": "The user ID of the user that the session belongs to.", - "type": "string" - } - }, - "required": [ - "created_at", - "expires", - "session_token", - "updated_at" - ], - "type": "object" - }, - "SystemInfoCgroupDriverEnum": { - "enum": [ - "", - "cgroupfs", - "systemd", - "none" - ], - "type": "string" - }, - "SystemInfoCgroupVersionEnum": { - "enum": [ - "", - "1", - "2" - ], - "type": "string" - }, - "SystemInfoDefaultAddressPools": { - "properties": { - "base": { - "description": "The network address in CIDR format", - "nullable": true, - "type": "string" - }, - "size": { - "description": "The network pool size", - "format": "int64", - "nullable": true, - "type": "integer" - } - }, - "type": "object" - }, - "SystemInfoIsolationEnum": { - "enum": [ - "", - "default", - "hyperv", - "process" - ], - "type": "string" - }, - "UnitConversion": { - "description": "A unit conversion.", - "properties": { - "completed_at": { - "description": "The time and date the unit conversion was completed.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "created_at": { - "description": "The time and date the unit conversion was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "error": { - "description": "The error the function returned, if any.", - "nullable": true, - "type": "string" - }, - "id": { - "allOf": [ - { - "$ref": "#/components/schemas/Uuid", - "x-scope": [ - "", - "#/components/schemas/UnitConversion" - ] - } - ], - "description": "The unique identifier of the unit conversion.\n\nThis is the same as the API call ID." - }, - "input": { - "default": 0.0, - "description": "The input value.", - "format": "float", - "type": "number" - }, - "output": { - "description": "The resulting value.", - "format": "double", - "nullable": true, - "type": "number" - }, - "output_format": { - "allOf": [ - { - "$ref": "#/components/schemas/UnitMetricFormat", - "x-scope": [ - "", - "#/components/schemas/UnitConversion" - ] - } - ], - "description": "The output format of the unit conversion." - }, - "src_format": { - "allOf": [ - { - "$ref": "#/components/schemas/UnitMetricFormat", - "x-scope": [ - "", - "#/components/schemas/UnitConversion" - ] - } - ], - "description": "The source format of the unit conversion." - }, - "started_at": { - "description": "The time and date the unit conversion was started.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ApiCallStatus", - "x-scope": [ - "", - "#/components/schemas/UnitConversion" - ] - } - ], - "description": "The status of the unit conversion." - }, - "updated_at": { - "description": "The time and date the unit conversion was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "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" - ], - "type": "object" - }, - "UnitMetricFormat": { - "description": "The valid types of metric unit formats.", - "enum": [ - "atto", - "femto", - "pico", - "nano", - "micro", - "milli", - "centi", - "deci", - "metric_unit", - "deca", - "hecto", - "kilo", - "mega", - "giga", - "tera", - "peta", - "exa" - ], - "type": "string" - }, - "UpdateUser": { - "description": "The user-modifiable parts of a User.", - "properties": { - "company": { - "description": "The user's company.", - "type": "string" - }, - "discord": { - "description": "The user's Discord handle.", - "type": "string" - }, - "first_name": { - "description": "The user's first name.", - "type": "string" - }, - "github": { - "description": "The user's GitHub handle.", - "type": "string" - }, - "last_name": { - "description": "The user's last name.", - "type": "string" - }, - "phone": { - "default": "", - "description": "The user's phone number.", - "format": "phone", - "title": "String", - "type": "string" - } - }, - "type": "object" - }, - "User": { - "description": "A user.", - "properties": { - "company": { - "description": "The user's company.", - "type": "string" - }, - "created_at": { - "description": "The date and time the user was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "discord": { - "description": "The user's Discord handle.", - "type": "string" - }, - "email": { - "description": "The email address of the user.", - "format": "email", - "type": "string" - }, - "email_verified": { - "description": "The date and time the email address was verified.", - "format": "date-time", - "nullable": true, - "title": "DateTime", - "type": "string" - }, - "first_name": { - "description": "The user's first name.", - "type": "string" - }, - "github": { - "description": "The user's GitHub handle.", - "type": "string" - }, - "id": { - "description": "The unique identifier for the user.", - "type": "string" - }, - "image": { - "description": "The image avatar for the user. This is a URL.", - "format": "uri", - "title": "String", - "type": "string" - }, - "last_name": { - "description": "The user's last name.", - "type": "string" - }, - "name": { - "description": "The name of the user. This is auto populated at first from the authentication provider (if there was a name). It can be updated by the user by updating their `first_name` and `last_name` fields.", - "type": "string" - }, - "phone": { - "default": "", - "description": "The user's phone number.", - "format": "phone", - "title": "String", - "type": "string" - }, - "updated_at": { - "description": "The date and time the user was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - } - }, - "required": [ - "created_at", - "image", - "updated_at" - ], - "type": "object" - }, - "UserResultsPage": { - "description": "A single page of results", - "properties": { - "items": { - "description": "list of items on this page of results", - "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, - "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" - }, - "VerificationToken": { - "description": "A verification token for a user.\n\nThis is typically used to verify a user's email address.", - "properties": { - "created_at": { - "description": "The date and time the verification token was created.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "expires": { - "description": "The date and time the verification token expires.", - "format": "date-time", - "title": "DateTime", - "type": "string" - }, - "id": { - "description": "The token used for verification. This is used as the id for the table since it is unique per record.", - "type": "string" - }, - "identifier": { - "description": "The identifier for the user. This is typically the user's email address since that is what we are verifying.", - "type": "string" - }, - "updated_at": { - "description": "The date and time the verification token was last updated.", - "format": "date-time", - "title": "DateTime", - "type": "string" - } - }, - "required": [ - "created_at", - "expires", - "updated_at" - ], - "type": "object" - } - } + "summary": "Get OpenAPI schema.", + "tags": [ + "meta" + ] + } }, - "info": { - "contact": { - "email": "api@kittycad.io", - "url": "https://kittycad.io" + "/_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" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } }, - "description": "API server for KittyCAD", - "title": "KittyCAD API", - "version": "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" - } + "summary": "Get the metadata about our currently running server.", + "tags": [ + "meta", + "hidden" + ] + } }, - "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-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-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-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-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-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" - } - } - }, - "/apps/github/callback": { - "get": { - "description": "This is different than OAuth 2.0 authentication for users. This endpoint grants access for KittyCAD to access user's repos.\nThe user doesn't need KittyCAD OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.", - "operationId": "apps_github_callback", - "requestBody": { - "content": { - "application/json": { - "schema": {} - } - }, - "required": true - }, - "responses": { - "204": { - "description": "successful operation, no content", - "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": "Listen for callbacks to GitHub app authentication.", - "tags": [ - "apps", - "hidden" - ], - "x-python": { - "example": "from kittycad.models import Error\nfrom kittycad.api.apps import apps_github_callback\nfrom kittycad.types import Response\n\nfc: Error = apps_github_callback.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Error] = apps_github_callback.sync_detailed(client=client)\n\n# OR run async\nfc: Error = await apps_github_callback.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[Error] = await apps_github_callback.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.apps.apps_github_callback.html" - } - } - }, - "/apps/github/consent": { - "get": { - "description": "This is different than OAuth 2.0 authentication for users. This endpoint grants access for KittyCAD to access user's repos.\nThe user doesn't need KittyCAD OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.", - "operationId": "apps_github_consent", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppClientInfo", - "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 consent URL for GitHub app authentication.", - "tags": [ - "apps", - "hidden" - ], - "x-python": { - "example": "from kittycad.models import AppClientInfo\nfrom kittycad.api.apps import apps_github_consent\nfrom kittycad.types import Response\n\nfc: AppClientInfo = apps_github_consent.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[AppClientInfo] = apps_github_consent.sync_detailed(client=client)\n\n# OR run async\nfc: AppClientInfo = await apps_github_consent.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[AppClientInfo] = await apps_github_consent.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.apps.apps_github_consent.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-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-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" - } - } - }, - "/auth/email": { - "options": { - "description": "This is necessary for some preflight requests, specifically POST, PUT, and DELETE.", - "operationId": "options_auth_email", - "responses": { - "204": { - "description": "successful operation, no content", - "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 endoint.", - "tags": [ - "hidden" - ] + "/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" }, - "post": { - "operationId": "auth_email", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EmailAuthenticationForm", - "x-scope": [ - "" - ] - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VerificationToken", - "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 an email verification request for a user.", - "tags": [ - "hidden" - ], - "x-python": { - "example": "from kittycad.models import VerificationToken\nfrom kittycad.api.hidden import auth_email\nfrom kittycad.types import Response\n\nfc: VerificationToken = auth_email.sync(client=client, body=EmailAuthenticationForm)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[VerificationToken] = auth_email.sync_detailed(client=client, body=EmailAuthenticationForm)\n\n# OR run async\nfc: VerificationToken = await auth_email.asyncio(client=client, body=EmailAuthenticationForm)\n\n# OR run async with more info\nresponse: Response[VerificationToken] = await auth_email.asyncio_detailed(client=client, body=EmailAuthenticationForm)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.hidden.auth_email.html" + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ApiCallQueryGroup" + }, + "title": "Array_of_ApiCallQueryGroup", + "type": "array" } - } - }, - "/auth/email/callback": { - "get": { - "operationId": "auth_email_callback", - "parameters": [ - { - "description": "The URL to redirect back to after we have authenticated.", - "in": "query", - "name": "callback_url", - "schema": { - "format": "uri", - "nullable": true, - "type": "string" - }, - "style": "form" - }, - { - "description": "The user's email.", - "in": "query", - "name": "email", - "required": true, - "schema": { - "format": "email", - "type": "string" - }, - "style": "form" - }, - { - "description": "The verification token.", - "in": "query", - "name": "token", - "required": true, - "schema": { - "type": "string" - }, - "style": "form" - } - ], - "responses": { - "302": { - "description": "Temporary Redirect", - "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": "Listen for callbacks for email verification for users.", - "tags": [ - "hidden" - ], - "x-python": { - "example": "from kittycad.models import Error\nfrom kittycad.api.hidden import auth_email_callback\nfrom kittycad.types import Response\n\nfc: Error = auth_email_callback.sync(client=client, callback_url=\"\", email=\"\", token=)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Error] = auth_email_callback.sync_detailed(client=client, callback_url=\"\", email=\"\", token=)\n\n# OR run async\nfc: Error = await auth_email_callback.asyncio(client=client, callback_url=\"\", email=\"\", token=)\n\n# OR run async with more info\nresponse: Response[Error] = await auth_email_callback.asyncio_detailed(client=client, callback_url=\"\", email=\"\", token=)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.hidden.auth_email_callback.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-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-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-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-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-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-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" - } - } - }, - "/logout": { - "post": { - "description": "This is used in logout scenarios.", - "operationId": "logout", - "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 removes the session cookie for a user.", - "tags": [ - "hidden" - ], - "x-python": { - "example": "from kittycad.models import Error\nfrom kittycad.api.hidden import logout\nfrom kittycad.types import Response\n\nfc: Error = logout.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Error] = logout.sync_detailed(client=client)\n\n# OR run async\nfc: Error = await logout.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[Error] = await logout.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.hidden.logout.html" - } - } - }, - "/oauth2/device/auth": { - "post": { - "description": "This endpoint is designed to be accessed from an *unauthenticated* API client. It generates and records a `device_code` and `user_code` which must be verified and confirmed prior to a token being granted.", - "operationId": "device_auth_request", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/DeviceAuthRequestForm", - "x-scope": [ - "" - ] - } - } - }, - "required": true - }, - "responses": { - "default": { - "content": { - "*/*": { - "schema": {} - } - }, - "description": "" - } - }, - "summary": "Start an OAuth 2.0 Device Authorization Grant.", - "tags": [ - "oauth2", - "hidden" - ] - } - }, - "/oauth2/device/confirm": { - "options": { - "description": "This is necessary for some preflight requests, specifically POST, PUT, and DELETE.", - "operationId": "options_device_auth_confirm", - "responses": { - "204": { - "description": "successful operation, no content", - "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 endoint.", - "tags": [ - "hidden" - ] + } }, - "post": { - "description": "This endpoint is designed to be accessed by the user agent (browser), not the client requesting the token. So we do not actually return the token here; it will be returned in response to the poll on `/oauth2/device/token`.", - "operationId": "device_auth_confirm", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeviceAuthVerifyParams", - "x-scope": [ - "" - ] - } - } - }, - "required": true + "description": "successful operation", + "headers": { + "Access-Control-Allow-Credentials": { + "description": "Access-Control-Allow-Credentials header.", + "required": true, + "schema": { + "type": "string" }, - "responses": { - "204": { - "description": "successful operation, no content", - "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": [ - "" - ] - } + "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" }, - "summary": "Confirm an OAuth 2.0 Device Authorization Grant.", - "tags": [ - "oauth2", - "hidden" - ] + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } }, - "/oauth2/device/token": { - "post": { - "description": "This endpoint should be polled by the client until the user code is verified and the grant is confirmed.", - "operationId": "device_access_token", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/DeviceAccessTokenRequestForm", - "x-scope": [ - "" - ] - } - } - }, - "required": true - }, - "responses": { - "default": { - "content": { - "*/*": { - "schema": {} - } - }, - "description": "" - } - }, - "summary": "Request a device access token.", - "tags": [ - "oauth2", - "hidden" - ] - } - }, - "/oauth2/device/verify": { - "get": { - "description": "This endpoint should be accessed in a full user agent (e.g., a browser). If the user is not logged in, we redirect them to the login page and use the `callback_url` parameter to get them to the UI verification form upon logging in. If they are logged in, we redirect them to the UI verification form on the website.", - "operationId": "device_auth_verify", - "parameters": [ - { - "description": "The user code.", - "in": "query", - "name": "user_code", - "required": true, - "schema": { - "type": "string" - }, - "style": "form" - } - ], - "responses": { - "302": { - "description": "Temporary Redirect", - "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": "Verify an OAuth 2.0 Device Authorization Grant.", - "tags": [ - "oauth2", - "hidden" - ] - } - }, - "/oauth2/provider/{provider}/callback": { - "get": { - "operationId": "oauth2_provider_callback", - "parameters": [ - { - "description": "The provider.", - "in": "path", - "name": "provider", - "required": true, - "schema": { - "$ref": "#/components/schemas/AccountProvider", - "x-scope": [ - "" - ] - }, - "style": "simple" - }, - { - "description": "The authorization code.", - "in": "query", - "name": "code", - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "The state that we had passed in through the user consent URL.", - "in": "query", - "name": "state", - "schema": { - "type": "string" - }, - "style": "form" - } - ], - "responses": { - "302": { - "description": "Temporary Redirect", - "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": "Listen for callbacks for the OAuth 2.0 provider.", - "tags": [ - "oauth2", - "hidden" - ] - } - }, - "/oauth2/provider/{provider}/consent": { - "get": { - "operationId": "oauth2_provider_consent", - "parameters": [ - { - "description": "The provider.", - "in": "path", - "name": "provider", - "required": true, - "schema": { - "$ref": "#/components/schemas/AccountProvider", - "x-scope": [ - "" - ] - }, - "style": "simple" - }, - { - "description": "The URL to redirect back to after we have authenticated.", - "in": "query", - "name": "callback_url", - "schema": { - "nullable": true, - "type": "string" - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OAuth2ClientInfo", - "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 consent URL and other information for the OAuth 2.0 provider.", - "tags": [ - "oauth2", - "hidden" - ] - } - }, - "/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-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": { - "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": [ - { - "description": "The output format of the unit.", - "in": "path", - "name": "output_format", - "required": true, - "schema": { - "$ref": "#/components/schemas/UnitMetricFormat", - "x-scope": [ - "" - ] - }, - "style": "simple" - }, - { - "description": "The source format of the unit.", - "in": "path", - "name": "src_format", - "required": true, - "schema": { - "$ref": "#/components/schemas/UnitMetricFormat", - "x-scope": [ - "" - ] - }, - "style": "simple" - }, - { - "description": "The initial value.", - "in": "query", - "name": "value", - "required": true, - "schema": { - "format": "float", - "type": "number" - }, - "style": "form" - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UnitConversion", - "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 units.", - "tags": [ - "unit", - "beta" - ], - "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": { - "delete": { - "description": "This endpoint requires authentication by any KittyCAD user. It deletes the authenticated user from KittyCAD's database.\nThis call will only succeed if all invoices associated with the user have been paid in full and there is no outstanding balance.", - "operationId": "delete_user_self", - "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 your user.", - "tags": [ - "users" - ], - "x-python": { - "example": "from kittycad.models import Error\nfrom kittycad.api.users import delete_user_self\nfrom kittycad.types import Response\n\nfc: Error = delete_user_self.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[Error] = delete_user_self.sync_detailed(client=client)\n\n# OR run async\nfc: Error = await delete_user_self.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[Error] = await delete_user_self.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.users.delete_user_self.html" - } - }, - "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-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 POST, PUT, and DELETE.", - "operationId": "options_user_self", - "responses": { - "204": { - "description": "successful operation, no content", - "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 endoint.", - "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-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-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-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-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-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-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-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 POST, PUT, and 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": { - "204": { - "description": "successful operation, no content", - "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 endoint.", - "tags": [ - "hidden" - ] - } - }, - "/user/extended": { - "get": { - "description": "Get the user information for the authenticated user.\nAlternatively, you can also use the `/users-extended/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-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-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-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-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 POST, PUT, and DELETE.", - "operationId": "options_payment_information_for_user", - "responses": { - "204": { - "description": "successful operation, no content", - "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 endoint.", - "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-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-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/balance": { - "get": { - "description": "This endpoint requires authentication by any KittyCAD user. It gets the balance information for the authenticated user.", - "operationId": "get_payment_balance_for_user", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerBalance", - "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 balance for your user.", - "tags": [ - "payments" - ], - "x-python": { - "example": "from kittycad.models import CustomerBalance\nfrom kittycad.api.payments import get_payment_balance_for_user\nfrom kittycad.types import Response\n\nfc: CustomerBalance = get_payment_balance_for_user.sync(client=client)\n\n# OR if you need more info (e.g. status_code)\nresponse: Response[CustomerBalance] = get_payment_balance_for_user.sync_detailed(client=client)\n\n# OR run async\nfc: CustomerBalance = await get_payment_balance_for_user.asyncio(client=client)\n\n# OR run async with more info\nresponse: Response[CustomerBalance] = await get_payment_balance_for_user.asyncio_detailed(client=client)", - "libDocsLink": "https://python.api.docs.kittycad.io/modules/kittycad.api.payments.get_payment_balance_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-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-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-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-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 POST, PUT, and 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": { - "204": { - "description": "successful operation, no content", - "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 endoint.", - "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-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-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-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-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-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-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" - } - } - } + "summary": "Get API call metrics.", + "tags": [ + "api-calls", + "hidden" + ] + } }, - "tags": [ - { - "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" + "/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" }, - "name": "api-calls" + "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" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCallWithPriceResultsPage" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } }, - { - "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" + "summary": "List API calls.", + "tags": [ + "api-calls", + "hidden" + ], + "x-dropshot-pagination": true + } + }, + "/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" }, - "name": "api-tokens" + "style": "simple" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCallWithPrice" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } }, - { - "description": "Endpoints for third party app grant flows.", - "externalDocs": { - "url": "https://docs.kittycad.io/api/apps" - }, - "name": "apps" + "summary": "Get details of an API call.", + "tags": [ + "api-calls", + "hidden" + ] + } + }, + "/apps/github/callback": { + "get": { + "description": "This is different than OAuth 2.0 authentication for users. This endpoint grants access for KittyCAD to access user's repos.\nThe user doesn't need KittyCAD OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.", + "operationId": "apps_github_callback", + "requestBody": { + "content": { + "application/json": { + "schema": {} + } + }, + "required": true }, - { - "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" + "responses": { + "204": { + "description": "successful operation, no content", + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } }, - { - "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" + "summary": "Listen for callbacks to GitHub app authentication.", + "tags": [ + "apps", + "hidden" + ] + } + }, + "/apps/github/consent": { + "get": { + "description": "This is different than OAuth 2.0 authentication for users. This endpoint grants access for KittyCAD to access user's repos.\nThe user doesn't need KittyCAD OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.", + "operationId": "apps_github_consent", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppClientInfo" + } + } }, - "name": "file" + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } }, - { - "description": "Hidden API endpoints that should not show up in the docs.", - "externalDocs": { - "url": "https://docs.kittycad.io/api/hidden" + "summary": "Get the consent URL for GitHub app authentication.", + "tags": [ + "apps", + "hidden" + ] + } + }, + "/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" }, - "name": "hidden" + "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" + }, + "style": "form" + }, + { + "description": "The status to filter by.", + "in": "query", + "name": "status", + "schema": { + "$ref": "#/components/schemas/ApiCallStatus" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncApiCallResultsPage" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } }, - { - "description": "Meta information about the API.", - "externalDocs": { - "url": "https://docs.kittycad.io/api/meta" + "summary": "List async operations.", + "tags": [ + "api-calls", + "hidden" + ], + "x-dropshot-pagination": true + } + }, + "/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" }, - "name": "meta" + "style": "simple" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncApiCallOutput" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } }, - { - "description": "Endpoints that implement OAuth 2.0 grant flows.", - "externalDocs": { - "url": "https://docs.kittycad.io/api/oauth2" - }, - "name": "oauth2" + "summary": "Get an async operation.", + "tags": [ + "api-calls" + ] + } + }, + "/auth/email": { + "options": { + "description": "This is necessary for some preflight requests, specifically POST, PUT, and DELETE.", + "operationId": "options_auth_email", + "responses": { + "204": { + "description": "successful operation, no content", + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } }, - { - "description": "Operations around payments and billing.", - "externalDocs": { - "url": "https://docs.kittycad.io/api/payments" - }, - "name": "payments" + "summary": "OPTIONS endoint.", + "tags": [ + "hidden" + ] + }, + "post": { + "operationId": "auth_email", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EmailAuthenticationForm" + } + } + }, + "required": true }, - { - "description": "Sessions allow users to call the API from their session cookie in the browser.", - "externalDocs": { - "url": "https://docs.kittycad.io/api/sessions" + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VerificationToken" + } + } }, - "name": "sessions" + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } }, - { - "description": "Unit conversion operations.", - "externalDocs": { - "url": "https://docs.kittycad.io/api/file" + "summary": "Create an email verification request for a user.", + "tags": [ + "hidden" + ] + } + }, + "/auth/email/callback": { + "get": { + "operationId": "auth_email_callback", + "parameters": [ + { + "description": "The URL to redirect back to after we have authenticated.", + "in": "query", + "name": "callback_url", + "schema": { + "format": "uri", + "nullable": true, + "type": "string" }, - "name": "unit" + "style": "form" + }, + { + "description": "The user's email.", + "in": "query", + "name": "email", + "required": true, + "schema": { + "format": "email", + "type": "string" + }, + "style": "form" + }, + { + "description": "The verification token.", + "in": "query", + "name": "token", + "required": true, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "302": { + "description": "Temporary Redirect", + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } }, - { - "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" + "summary": "Listen for callbacks for email verification for users.", + "tags": [ + "hidden" + ] + } + }, + "/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" }, - "name": "users" - } - ] + "style": "simple" + }, + { + "description": "The format of the file to convert.", + "in": "path", + "name": "src_format", + "required": true, + "schema": { + "$ref": "#/components/schemas/FileSourceFormat" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "format": "binary", + "type": "string" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileConversion" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Convert CAD file.", + "tags": [ + "file" + ] + } + }, + "/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" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get a file conversion.", + "tags": [ + "file" + ] + } + }, + "/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" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "format": "binary", + "type": "string" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileDensity" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get CAD file density.", + "tags": [ + "file", + "beta" + ] + } + }, + "/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" + }, + "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" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Execute a KittyCAD program in a specific language.", + "tags": [ + "file", + "hidden" + ] + } + }, + "/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" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "format": "binary", + "type": "string" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileMass" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get CAD file mass.", + "tags": [ + "file", + "beta" + ] + } + }, + "/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" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "format": "binary", + "type": "string" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileVolume" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get CAD file volume.", + "tags": [ + "file", + "beta" + ] + } + }, + "/logout": { + "post": { + "description": "This is used in logout scenarios.", + "operationId": "logout", + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "This endpoint removes the session cookie for a user.", + "tags": [ + "hidden" + ] + } + }, + "/oauth2/device/auth": { + "post": { + "description": "This endpoint is designed to be accessed from an *unauthenticated* API client. It generates and records a `device_code` and `user_code` which must be verified and confirmed prior to a token being granted.", + "operationId": "device_auth_request", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/DeviceAuthRequestForm" + } + } + }, + "required": true + }, + "responses": { + "default": { + "content": { + "*/*": { + "schema": {} + } + }, + "description": "" + } + }, + "summary": "Start an OAuth 2.0 Device Authorization Grant.", + "tags": [ + "oauth2", + "hidden" + ] + } + }, + "/oauth2/device/confirm": { + "options": { + "description": "This is necessary for some preflight requests, specifically POST, PUT, and DELETE.", + "operationId": "options_device_auth_confirm", + "responses": { + "204": { + "description": "successful operation, no content", + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "OPTIONS endoint.", + "tags": [ + "hidden" + ] + }, + "post": { + "description": "This endpoint is designed to be accessed by the user agent (browser), not the client requesting the token. So we do not actually return the token here; it will be returned in response to the poll on `/oauth2/device/token`.", + "operationId": "device_auth_confirm", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeviceAuthVerifyParams" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "successful operation, no content", + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Confirm an OAuth 2.0 Device Authorization Grant.", + "tags": [ + "oauth2", + "hidden" + ] + } + }, + "/oauth2/device/token": { + "post": { + "description": "This endpoint should be polled by the client until the user code is verified and the grant is confirmed.", + "operationId": "device_access_token", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/DeviceAccessTokenRequestForm" + } + } + }, + "required": true + }, + "responses": { + "default": { + "content": { + "*/*": { + "schema": {} + } + }, + "description": "" + } + }, + "summary": "Request a device access token.", + "tags": [ + "oauth2", + "hidden" + ] + } + }, + "/oauth2/device/verify": { + "get": { + "description": "This endpoint should be accessed in a full user agent (e.g., a browser). If the user is not logged in, we redirect them to the login page and use the `callback_url` parameter to get them to the UI verification form upon logging in. If they are logged in, we redirect them to the UI verification form on the website.", + "operationId": "device_auth_verify", + "parameters": [ + { + "description": "The user code.", + "in": "query", + "name": "user_code", + "required": true, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "302": { + "description": "Temporary Redirect", + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Verify an OAuth 2.0 Device Authorization Grant.", + "tags": [ + "oauth2", + "hidden" + ] + } + }, + "/oauth2/provider/{provider}/callback": { + "get": { + "operationId": "oauth2_provider_callback", + "parameters": [ + { + "description": "The provider.", + "in": "path", + "name": "provider", + "required": true, + "schema": { + "$ref": "#/components/schemas/AccountProvider" + }, + "style": "simple" + }, + { + "description": "The authorization code.", + "in": "query", + "name": "code", + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The state that we had passed in through the user consent URL.", + "in": "query", + "name": "state", + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "302": { + "description": "Temporary Redirect", + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Listen for callbacks for the OAuth 2.0 provider.", + "tags": [ + "oauth2", + "hidden" + ] + } + }, + "/oauth2/provider/{provider}/consent": { + "get": { + "operationId": "oauth2_provider_consent", + "parameters": [ + { + "description": "The provider.", + "in": "path", + "name": "provider", + "required": true, + "schema": { + "$ref": "#/components/schemas/AccountProvider" + }, + "style": "simple" + }, + { + "description": "The URL to redirect back to after we have authenticated.", + "in": "query", + "name": "callback_url", + "schema": { + "nullable": true, + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OAuth2ClientInfo" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get the consent URL and other information for the OAuth 2.0 provider.", + "tags": [ + "oauth2", + "hidden" + ] + } + }, + "/ping": { + "get": { + "operationId": "ping", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pong" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Return pong.", + "tags": [ + "meta" + ] + } + }, + "/unit/conversion/{src_format}/{output_format}": { + "post": { + "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": [ + { + "description": "The output format of the unit.", + "in": "path", + "name": "output_format", + "required": true, + "schema": { + "$ref": "#/components/schemas/UnitMetricFormat" + }, + "style": "simple" + }, + { + "description": "The source format of the unit.", + "in": "path", + "name": "src_format", + "required": true, + "schema": { + "$ref": "#/components/schemas/UnitMetricFormat" + }, + "style": "simple" + }, + { + "description": "The initial value.", + "in": "query", + "name": "value", + "required": true, + "schema": { + "format": "float", + "type": "number" + }, + "style": "form" + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UnitConversion" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Convert units.", + "tags": [ + "unit", + "beta" + ] + } + }, + "/user": { + "delete": { + "description": "This endpoint requires authentication by any KittyCAD user. It deletes the authenticated user from KittyCAD's database.\nThis call will only succeed if all invoices associated with the user have been paid in full and there is no outstanding balance.", + "operationId": "delete_user_self", + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Delete your user.", + "tags": [ + "users" + ] + }, + "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" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get your user.", + "tags": [ + "users" + ] + }, + "options": { + "description": "This is necessary for some preflight requests, specifically POST, PUT, and DELETE.", + "operationId": "options_user_self", + "responses": { + "204": { + "description": "successful operation, no content", + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "OPTIONS endoint.", + "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" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Update your user.", + "tags": [ + "users" + ] + } + }, + "/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" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCallWithPriceResultsPage" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "List API calls for your user.", + "tags": [ + "api-calls" + ], + "x-dropshot-pagination": true + } + }, + "/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" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get an API call for a user.", + "tags": [ + "api-calls" + ] + } + }, + "/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" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiTokenResultsPage" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "List API tokens for your user.", + "tags": [ + "api-tokens" + ], + "x-dropshot-pagination": true + }, + "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" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Create a new API token for your user.", + "tags": [ + "api-tokens" + ] + } + }, + "/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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Delete an API token for your user.", + "tags": [ + "api-tokens" + ] + }, + "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" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get an API token for your user.", + "tags": [ + "api-tokens" + ] + }, + "options": { + "description": "This is necessary for some preflight requests, specifically POST, PUT, and 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": { + "204": { + "description": "successful operation, no content", + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "OPTIONS endoint.", + "tags": [ + "hidden" + ] + } + }, + "/user/extended": { + "get": { + "description": "Get the user information for the authenticated user.\nAlternatively, you can also use the `/users-extended/me` endpoint.", + "operationId": "get_user_self_extended", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedUser" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get extended information about your user.", + "tags": [ + "users" + ] + } + }, + "/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" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get a file conversion for your user.", + "tags": [ + "file" + ] + } + }, + "/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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Delete payment info for your user.", + "tags": [ + "payments" + ] + }, + "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" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get payment info about your user.", + "tags": [ + "payments" + ] + }, + "options": { + "description": "This is necessary for some preflight requests, specifically POST, PUT, and DELETE.", + "operationId": "options_payment_information_for_user", + "responses": { + "204": { + "description": "successful operation, no content", + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "OPTIONS endoint.", + "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" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Customer" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Create payment info for your user.", + "tags": [ + "payments" + ] + }, + "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" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Customer" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Update payment info for your user.", + "tags": [ + "payments" + ] + } + }, + "/user/payment/balance": { + "get": { + "description": "This endpoint requires authentication by any KittyCAD user. It gets the balance information for the authenticated user.", + "operationId": "get_payment_balance_for_user", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerBalance" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get balance for your user.", + "tags": [ + "payments" + ] + } + }, + "/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" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Create a payment intent for your user.", + "tags": [ + "payments", + "hidden" + ] + } + }, + "/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" + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "List invoices for your user.", + "tags": [ + "payments" + ] + } + }, + "/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" + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "List payment methods for your user.", + "tags": [ + "payments" + ] + } + }, + "/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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Delete a payment method for your user.", + "tags": [ + "payments", + "hidden" + ] + }, + "options": { + "description": "This is necessary for some preflight requests, specifically POST, PUT, and 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": { + "204": { + "description": "successful operation, no content", + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "OPTIONS endoint.", + "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" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get a session for your user.", + "tags": [ + "sessions" + ] + } + }, + "/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" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserResultsPage" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "List users.", + "tags": [ + "users", + "hidden" + ], + "x-dropshot-pagination": true + } + }, + "/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" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtendedUserResultsPage" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "List users with extended information.", + "tags": [ + "users", + "hidden" + ], + "x-dropshot-pagination": true + } + }, + "/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" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get extended information about a user.", + "tags": [ + "users", + "hidden" + ] + } + }, + "/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" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "Get a user.", + "tags": [ + "users", + "hidden" + ] + } + }, + "/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" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCallWithPriceResultsPage" + } + } + }, + "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" + }, + "5XX": { + "$ref": "#/components/responses/Error" + } + }, + "summary": "List API calls for a user.", + "tags": [ + "api-calls", + "hidden" + ], + "x-dropshot-pagination": true + } + } + }, + "tags": [ + { + "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" + }, + { + "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" + }, + { + "description": "Endpoints for third party app grant flows.", + "externalDocs": { + "url": "https://docs.kittycad.io/api/apps" + }, + "name": "apps" + }, + { + "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" + }, + { + "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" + }, + { + "description": "Hidden API endpoints that should not show up in the docs.", + "externalDocs": { + "url": "https://docs.kittycad.io/api/hidden" + }, + "name": "hidden" + }, + { + "description": "Meta information about the API.", + "externalDocs": { + "url": "https://docs.kittycad.io/api/meta" + }, + "name": "meta" + }, + { + "description": "Endpoints that implement OAuth 2.0 grant flows.", + "externalDocs": { + "url": "https://docs.kittycad.io/api/oauth2" + }, + "name": "oauth2" + }, + { + "description": "Operations around payments and billing.", + "externalDocs": { + "url": "https://docs.kittycad.io/api/payments" + }, + "name": "payments" + }, + { + "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" + }, + { + "description": "Unit conversion operations.", + "externalDocs": { + "url": "https://docs.kittycad.io/api/file" + }, + "name": "unit" + }, + { + "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