Update api spec (#346)

* YOYO NEW API SPEC!

* Generated new lib

* 2.0.46

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: zoo-github-actions-auth[bot]

__tests__/gen/ml-list_conversations_for_user.test.ts

@@ -0,0 +1,18 @@
+import { ml } from '../../src/index.js';
+
+async function example() {
+  const response = await ml.list_conversations_for_user({
+    limit: 7,
+    page_token: 'string',
+    sort_by: 'created_at_ascending',
+  });
+  if ('error_code' in response) throw response;
+
+  return response;
+}
+
+describe('Testing ml.list_conversations_for_user', () => {
+  it('should be truthy or throw', async () => {
+    expect(await example()).toBeTruthy();
+  });
+});

__tests__/gen/ml-list_text_to_cad_models_for_user.test.ts

@@ -5,6 +5,7 @@ async function example() {
     limit: 7,
     page_token: 'string',
     sort_by: 'created_at_ascending',
+    conversation_id: '00000000-0000-0000-0000-000000000000',
     no_models: true,
   });
   if ('error_code' in response) throw response;

kittycad.ts.patch.json

@@ -115,7 +115,7 @@
     "op": "add",
     "path": "/paths/~1user~1text-to-cad/get/x-typescript",
     "value": {
-      "example": "import { ml } from '@kittycad/lib'\n\nasync function example() {\n    const response = await ml.list_text_to_cad_models_for_user({\n        limit: 7,\n        page_token: 'string',\n        sort_by: 'created_at_ascending',\n        no_models: true,\n    })\n    if ('error_code' in response) throw response\n    console.log(JSON.stringify(response, null, 2))\n}\n",
+      "example": "import { ml } from '@kittycad/lib'\n\nasync function example() {\n    const response = await ml.list_text_to_cad_models_for_user({\n        limit: 7,\n        page_token: 'string',\n        sort_by: 'created_at_ascending',\n        conversation_id: '00000000-0000-0000-0000-000000000000',\n        no_models: true,\n    })\n    if ('error_code' in response) throw response\n    console.log(JSON.stringify(response, null, 2))\n}\n",
       "libDocsLink": ""
     }
   },
@@ -935,6 +935,14 @@
       "libDocsLink": ""
     }
   },
+  {
+    "op": "add",
+    "path": "/paths/~1ml~1conversations/get/x-typescript",
+    "value": {
+      "example": "import { ml } from '@kittycad/lib'\n\nasync function example() {\n    const response = await ml.list_conversations_for_user({\n        limit: 7,\n        page_token: 'string',\n        sort_by: 'created_at_ascending',\n    })\n    if ('error_code' in response) throw response\n    console.log(JSON.stringify(response, null, 2))\n}\n",
+      "libDocsLink": ""
+    }
+  },
   {
     "op": "add",
     "path": "/paths/~1ml-prompts~1{id}/get/x-typescript",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kittycad/lib",
-  "version": "2.0.45",
+  "version": "2.0.46",
   "description": "Javascript library for KittyCAD API",
   "type": "module",
   "keywords": [

spec.json

@@ -4230,6 +4230,116 @@
         }
       }
     },
+    "/ml/conversations": {
+      "get": {
+        "tags": [
+          "ml"
+        ],
+        "summary": "List conversations",
+        "description": "This endpoint requires authentication by any Zoo user. It returns the conversations for the authenticated user.\n\nThe conversations are returned in order of creation, with the most recently created conversations first.",
+        "operationId": "list_conversations_for_user",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "limit",
+            "description": "Maximum number of items returned by a single call",
+            "schema": {
+              "nullable": true,
+              "type": "integer",
+              "format": "uint32",
+              "minimum": 1
+            }
+          },
+          {
+            "in": "query",
+            "name": "page_token",
+            "description": "Token returned by previous call to retrieve the subsequent page",
+            "schema": {
+              "nullable": true,
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "sort_by",
+            "schema": {
+              "$ref": "#/components/schemas/CreatedAtSortMode"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "headers": {
+              "Access-Control-Allow-Credentials": {
+                "description": "Access-Control-Allow-Credentials header.",
+                "style": "simple",
+                "schema": {
+                  "nullable": true,
+                  "type": "string"
+                }
+              },
+              "Access-Control-Allow-Headers": {
+                "description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.",
+                "style": "simple",
+                "schema": {
+                  "nullable": true,
+                  "type": "string"
+                }
+              },
+              "Access-Control-Allow-Methods": {
+                "description": "Access-Control-Allow-Methods header.",
+                "style": "simple",
+                "schema": {
+                  "nullable": true,
+                  "type": "string"
+                }
+              },
+              "Access-Control-Allow-Origin": {
+                "description": "Access-Control-Allow-Origin header.",
+                "style": "simple",
+                "schema": {
+                  "nullable": true,
+                  "type": "string"
+                }
+              },
+              "Set-Cookie": {
+                "description": "Set-Cookie header.",
+                "style": "simple",
+                "schema": {
+                  "nullable": true,
+                  "type": "string"
+                }
+              },
+              "X-Api-Call-Id": {
+                "description": "ID for this request. We return it so that users can report this to us and help us debug their problems.",
+                "style": "simple",
+                "required": true,
+                "schema": {
+                  "type": "string"
+                }
+              }
+            },
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ConversationResultsPage"
+                }
+              }
+            }
+          },
+          "4XX": {
+            "$ref": "#/components/responses/Error"
+          },
+          "5XX": {
+            "$ref": "#/components/responses/Error"
+          }
+        },
+        "x-dropshot-pagination": {
+          "required": []
+        }
+      }
+    },
     "/ml/convert/proprietary-to-kcl": {
       "post": {
         "tags": [
@@ -15847,6 +15957,14 @@
               "$ref": "#/components/schemas/CreatedAtSortMode"
             }
           },
+          {
+            "in": "query",
+            "name": "conversation_id",
+            "description": "If specified, only return the prompts for the conversation id given.",
+            "schema": {
+              "$ref": "#/components/schemas/Uuid"
+            }
+          },
           {
             "in": "query",
             "name": "no_models",
@@ -15913,7 +16031,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/TextToCadResultsPage"
+                  "$ref": "#/components/schemas/TextToCadResponseResultsPage"
                 }
               }
             }
@@ -16006,7 +16124,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/TextToCad"
+                  "$ref": "#/components/schemas/TextToCadResponse"
                 }
               }
             }
@@ -20365,6 +20483,72 @@
           }
         }
       },
+      "Conversation": {
+        "description": "A conversation composed of many ML prompts.",
+        "type": "object",
+        "properties": {
+          "created_at": {
+            "title": "DateTime",
+            "description": "The date and time the conversation was created.",
+            "type": "string",
+            "format": "date-time"
+          },
+          "first_prompt": {
+            "description": "The prompt that started this conversation.",
+            "type": "string"
+          },
+          "id": {
+            "description": "The unique identifier for the conversation.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/Uuid"
+              }
+            ]
+          },
+          "updated_at": {
+            "title": "DateTime",
+            "description": "The date and time the conversation was last updated.",
+            "type": "string",
+            "format": "date-time"
+          },
+          "user_id": {
+            "description": "The user ID of the user who created the conversation.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/Uuid"
+              }
+            ]
+          }
+        },
+        "required": [
+          "created_at",
+          "first_prompt",
+          "id",
+          "updated_at",
+          "user_id"
+        ]
+      },
+      "ConversationResultsPage": {
+        "description": "A single page of results",
+        "type": "object",
+        "properties": {
+          "items": {
+            "description": "list of items on this page of results",
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Conversation"
+            }
+          },
+          "next_page": {
+            "nullable": true,
+            "description": "token used to fetch the next page of results (if any)",
+            "type": "string"
+          }
+        },
+        "required": [
+          "items"
+        ]
+      },
       "ConversionParams": {
         "description": "Describes the file to convert (src) and what it should be converted into (output).",
         "type": "object",
@@ -35008,15 +35192,44 @@
           }
         }
       },
-      "TextToCadResultsPage": {
+      "TextToCadResponse": {
+        "description": "Type that encompasses all Text-to-CAD response types, including iteration and multi-file iteration.",
+        "anyOf": [
+          {
+            "description": "A response from a text to CAD prompt.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextToCad"
+              }
+            ]
+          },
+          {
+            "description": "A response from a text to CAD iteration.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextToCadIteration"
+              }
+            ]
+          },
+          {
+            "description": "A response from a text to CAD multi-file iteration.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextToCadMultiFileIteration"
+              }
+            ]
+          }
+        ]
+      },
+      "TextToCadResponseResultsPage": {
         "description": "A single page of results",
         "type": "object",
         "properties": {
           "items": {
             "description": "list of items on this page of results",
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/TextToCad"
+              "$ref": "#/components/schemas/TextToCadResponse"
             }
           },
           "next_page": {

src/api/ml/get_text_to_cad_model_for_user.ts

@@ -1,12 +1,14 @@
-import { TextToCad_type, Error_type } from '../../models.js';
+import { TextToCadResponse_type, Error_type } from '../../models.js';
 import { Client } from '../../client.js';
 
 interface Get_text_to_cad_model_for_user_params {
   client?: Client;
   id: string;
 }
 
-type Get_text_to_cad_model_for_user_return = TextToCad_type | Error_type;
+type Get_text_to_cad_model_for_user_return =
+  | TextToCadResponse_type
+  | Error_type;
 
 export default async function get_text_to_cad_model_for_user({
   client,

src/api/ml/list_conversations_for_user.ts

@@ -0,0 +1,53 @@
+import {
+  ConversationResultsPage_type,
+  Error_type,
+  CreatedAtSortMode_type,
+} from '../../models.js';
+import { Client } from '../../client.js';
+
+interface List_conversations_for_user_params {
+  client?: Client;
+  limit: number;
+  page_token: string;
+  sort_by: CreatedAtSortMode_type;
+}
+
+type List_conversations_for_user_return =
+  | ConversationResultsPage_type
+  | Error_type;
+
+export default async function list_conversations_for_user({
+  client,
+  limit,
+  page_token,
+  sort_by,
+}: List_conversations_for_user_params): Promise<List_conversations_for_user_return> {
+  const url = `/ml/conversations?limit=${limit}&page_token=${page_token}&sort_by=${sort_by}`;
+  // Backwards compatible for the BASE_URL env variable
+  // That used to exist in only this lib, ZOO_HOST exists in the all the other
+  // sdks and the CLI.
+  const urlBase =
+    process?.env?.ZOO_HOST || process?.env?.BASE_URL || 'https://api.zoo.dev';
+  const fullUrl = urlBase + url;
+  // The other sdks use to use KITTYCAD_API_TOKEN, now they still do for
+  // backwards compatibility, but the new standard is ZOO_API_TOKEN.
+  // For some reason only this lib supported KITTYCAD_TOKEN, so we need to
+  // check for that as well.
+  const kittycadToken = client
+    ? client.token || process.env.ZOO_API_TOKEN || ''
+    : process.env.KITTYCAD_TOKEN ||
+      process.env.KITTYCAD_API_TOKEN ||
+      process.env.ZOO_API_TOKEN ||
+      '';
+  const headers = {
+    Authorization: `Bearer ${kittycadToken}`,
+    'Content-Type': 'text/plain',
+  };
+  const fetchOptions = {
+    method: 'GET',
+    headers,
+  };
+  const response = await fetch(fullUrl, fetchOptions);
+  const result = (await response.json()) as List_conversations_for_user_return;
+  return result;
+}