@37signals/basecamp 0.2.2 → 0.3.0

package/src/generated/openapi-stripped.json

@@ -3627,6 +3627,201 @@
         }
       }
     },
+    "/chats/{campfireId}/uploads.json": {
+      "get": {
+        "description": "List uploaded files in a campfire\n\n**Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL\nto fetch additional pages. X-Total-Count header provides total count.",
+        "operationId": "ListCampfireUploads",
+        "parameters": [
+          {
+            "name": "campfireId",
+            "in": "path",
+            "schema": {
+              "type": "integer",
+              "format": "int64"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "ListCampfireUploads 200 response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ListCampfireUploadsResponseContent"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "UnauthorizedError 401 response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UnauthorizedErrorResponseContent"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "ForbiddenError 403 response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ForbiddenErrorResponseContent"
+                }
+              }
+            }
+          },
+          "429": {
+            "description": "RateLimitError 429 response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RateLimitErrorResponseContent"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "InternalServerError 500 response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/InternalServerErrorResponseContent"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Campfire"
+        ],
+        "x-basecamp-pagination": {
+          "style": "link",
+          "totalCountHeader": "X-Total-Count",
+          "maxPageSize": 50
+        },
+        "x-basecamp-retry": {
+          "maxAttempts": 3,
+          "baseDelayMs": 1000,
+          "backoff": "exponential",
+          "retryOn": [
+            429,
+            503
+          ]
+        }
+      },
+      "post": {
+        "description": "Upload a file to a campfire",
+        "operationId": "CreateCampfireUpload",
+        "requestBody": {
+          "content": {
+            "application/octet-stream": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateCampfireUploadInputPayload"
+              }
+            }
+          },
+          "required": true
+        },
+        "parameters": [
+          {
+            "name": "campfireId",
+            "in": "path",
+            "schema": {
+              "type": "integer",
+              "format": "int64"
+            },
+            "required": true
+          },
+          {
+            "name": "name",
+            "in": "query",
+            "description": "Filename for the uploaded file (e.g. \"report.pdf\").",
+            "schema": {
+              "type": "string",
+              "description": "Filename for the uploaded file (e.g. \"report.pdf\")."
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "201": {
+            "description": "CreateCampfireUpload 201 response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CreateCampfireUploadResponseContent"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "UnauthorizedError 401 response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UnauthorizedErrorResponseContent"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "ForbiddenError 403 response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ForbiddenErrorResponseContent"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "ValidationError 422 response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ValidationErrorResponseContent"
+                }
+              }
+            }
+          },
+          "429": {
+            "description": "RateLimitError 429 response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RateLimitErrorResponseContent"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "InternalServerError 500 response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/InternalServerErrorResponseContent"
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Campfire"
+        ],
+        "x-basecamp-retry": {
+          "maxAttempts": 3,
+          "baseDelayMs": 2000,
+          "backoff": "exponential",
+          "retryOn": [
+            429,
+            503
+          ]
+        }
+      }
+    },
     "/circles/people.json": {
       "get": {
         "description": "List all account users who can be pinged\n\n**Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL\nto fetch additional pages. X-Total-Count header provides total count.",
@@ -12100,7 +12295,7 @@
         "operationId": "Search",
         "parameters": [
           {
-            "name": "query",
+            "name": "q",
             "in": "query",
             "schema": {
               "type": "string"
@@ -12115,14 +12310,6 @@
               "type": "string",
               "description": "created_at|updated_at"
             }
-          },
-          {
-            "name": "page",
-            "in": "query",
-            "schema": {
-              "type": "integer",
-              "format": "int32"
-            }
           }
         ],
         "responses": {
@@ -16025,6 +16212,9 @@
           },
           "lines_url": {
             "type": "string"
+          },
+          "files_url": {
+            "type": "string"
           }
         },
         "required": [
@@ -16082,6 +16272,12 @@
           "content": {
             "type": "string"
           },
+          "attachments": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CampfireLineAttachment"
+            }
+          },
           "parent": {
             "$ref": "#/components/schemas/RecordingParent"
           },
@@ -16102,7 +16298,6 @@
         "required": [
           "app_url",
           "bucket",
-          "content",
           "created_at",
           "creator",
           "id",
@@ -16116,6 +16311,30 @@
           "visible_to_clients"
         ]
       },
+      "CampfireLineAttachment": {
+        "type": "object",
+        "properties": {
+          "title": {
+            "type": "string"
+          },
+          "url": {
+            "type": "string"
+          },
+          "filename": {
+            "type": "string"
+          },
+          "content_type": {
+            "type": "string"
+          },
+          "byte_size": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "download_url": {
+            "type": "string"
+          }
+        }
+      },
       "Card": {
         "type": "object",
         "properties": {
@@ -16969,6 +17188,14 @@
       "CreateCampfireLineResponseContent": {
         "$ref": "#/components/schemas/CampfireLine"
       },
+      "CreateCampfireUploadInputPayload": {
+        "type": "string",
+        "description": "Raw binary content of the file. Set the Content-Type header to match\nthe file's media type (e.g. \"image/png\", \"application/pdf\").",
+        "contentEncoding": "byte"
+      },
+      "CreateCampfireUploadResponseContent": {
+        "$ref": "#/components/schemas/CampfireLine"
+      },
       "CreateCardColumnRequestContent": {
         "type": "object",
         "properties": {
@@ -18211,6 +18438,12 @@
           "$ref": "#/components/schemas/CampfireLine"
         }
       },
+      "ListCampfireUploadsResponseContent": {
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/CampfireLine"
+        }
+      },
       "ListCampfiresResponseContent": {
         "type": "array",
         "items": {

package/src/generated/path-mapping.ts

@@ -49,6 +49,8 @@ export const PATH_TO_OPERATION: Record<string, string> = {
   "POST:/{accountId}/chats/{campfireId}/lines.json": "CreateCampfireLine",
   "DELETE:/{accountId}/chats/{campfireId}/lines/{lineId}": "DeleteCampfireLine",
   "GET:/{accountId}/chats/{campfireId}/lines/{lineId}": "GetCampfireLine",
+  "GET:/{accountId}/chats/{campfireId}/uploads.json": "ListCampfireUploads",
+  "POST:/{accountId}/chats/{campfireId}/uploads.json": "CreateCampfireUpload",
   "GET:/{accountId}/client/approvals.json": "ListClientApprovals",
   "GET:/{accountId}/client/approvals/{approvalId}": "GetClientApproval",
   "GET:/{accountId}/client/correspondences.json": "ListClientCorrespondences",

package/src/generated/schema.d.ts

@@ -474,6 +474,29 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/chats/{campfireId}/uploads.json": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description List uploaded files in a campfire
+         *
+         *     **Pagination**: Uses Link header (RFC5988). Follow the `next` rel URL
+         *     to fetch additional pages. X-Total-Count header provides total count.
+         */
+        get: operations["ListCampfireUploads"];
+        put?: never;
+        /** @description Upload a file to a campfire */
+        post: operations["CreateCampfireUpload"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/circles/people.json": {
         parameters: {
             query?: never;
@@ -2229,6 +2252,7 @@ export interface components {
             creator: components["schemas"]["Person"];
             topic?: string;
             lines_url?: string;
+            files_url?: string;
         };
         CampfireLine: {
             /** Format: int64 */
@@ -2243,7 +2267,8 @@ export interface components {
             url: string;
             app_url: string;
             bookmark_url?: string;
-            content: string;
+            content?: string;
+            attachments?: components["schemas"]["CampfireLineAttachment"][];
             parent: components["schemas"]["RecordingParent"];
             bucket: components["schemas"]["TodoBucket"];
             creator: components["schemas"]["Person"];
@@ -2251,6 +2276,15 @@ export interface components {
             boosts_count?: number;
             boosts_url?: string;
         };
+        CampfireLineAttachment: {
+            title?: string;
+            url?: string;
+            filename?: string;
+            content_type?: string;
+            /** Format: int64 */
+            byte_size?: number;
+            download_url?: string;
+        };
         Card: {
             /** Format: int64 */
             id: number;
@@ -2504,6 +2538,12 @@ export interface components {
             content_type?: string;
         };
         CreateCampfireLineResponseContent: components["schemas"]["CampfireLine"];
+        /**
+         * @description Raw binary content of the file. Set the Content-Type header to match
+         *     the file's media type (e.g. "image/png", "application/pdf").
+         */
+        CreateCampfireUploadInputPayload: string;
+        CreateCampfireUploadResponseContent: components["schemas"]["CampfireLine"];
         CreateCardColumnRequestContent: {
             title: string;
             description?: string;
@@ -2857,6 +2897,7 @@ export interface components {
         ListAnswersResponseContent: components["schemas"]["QuestionAnswer"][];
         ListAssignablePeopleResponseContent: components["schemas"]["Person"][];
         ListCampfireLinesResponseContent: components["schemas"]["CampfireLine"][];
+        ListCampfireUploadsResponseContent: components["schemas"]["CampfireLine"][];
         ListCampfiresResponseContent: components["schemas"]["Campfire"][];
         ListCardsResponseContent: components["schemas"]["Card"][];
         ListChatbotsResponseContent: components["schemas"]["Chatbot"][];
@@ -6375,6 +6416,138 @@ export interface operations {
             };
         };
     };
+    ListCampfireUploads: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                campfireId: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ListCampfireUploads 200 response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ListCampfireUploadsResponseContent"];
+                };
+            };
+            /** @description UnauthorizedError 401 response */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UnauthorizedErrorResponseContent"];
+                };
+            };
+            /** @description ForbiddenError 403 response */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ForbiddenErrorResponseContent"];
+                };
+            };
+            /** @description RateLimitError 429 response */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RateLimitErrorResponseContent"];
+                };
+            };
+            /** @description InternalServerError 500 response */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InternalServerErrorResponseContent"];
+                };
+            };
+        };
+    };
+    CreateCampfireUpload: {
+        parameters: {
+            query: {
+                /** @description Filename for the uploaded file (e.g. "report.pdf"). */
+                name: string;
+            };
+            header?: never;
+            path: {
+                campfireId: number;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/octet-stream": components["schemas"]["CreateCampfireUploadInputPayload"];
+            };
+        };
+        responses: {
+            /** @description CreateCampfireUpload 201 response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CreateCampfireUploadResponseContent"];
+                };
+            };
+            /** @description UnauthorizedError 401 response */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UnauthorizedErrorResponseContent"];
+                };
+            };
+            /** @description ForbiddenError 403 response */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ForbiddenErrorResponseContent"];
+                };
+            };
+            /** @description ValidationError 422 response */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ValidationErrorResponseContent"];
+                };
+            };
+            /** @description RateLimitError 429 response */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["RateLimitErrorResponseContent"];
+                };
+            };
+            /** @description InternalServerError 500 response */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InternalServerErrorResponseContent"];
+                };
+            };
+        };
+    };
     ListPingablePeople: {
         parameters: {
             query?: never;
@@ -12276,10 +12449,9 @@ export interface operations {
     Search: {
         parameters: {
             query: {
-                query: string;
+                q: string;
                 /** @description created_at|updated_at */
                 sort?: string;
-                page?: number;
             };
             header?: never;
             path?: never;

package/src/generated/services/campfires.ts

@@ -69,6 +69,12 @@ export interface CreateLineCampfireRequest {
   contentType?: string;
 }
 
+/**
+ * Options for listUploads.
+ */
+export interface ListUploadsCampfireOptions extends PaginationOptions {
+}
+
 
 // =============================================================================
 // Service
@@ -430,4 +436,73 @@ export class CampfiresService extends BaseService {
         })
     );
   }
+
+  /**
+   * List uploaded files in a campfire
+   * @param campfireId - The campfire ID
+   * @param options - Optional query parameters
+   * @returns All CampfireLine across all pages, with .meta.totalCount
+   *
+   * @example
+   * ```ts
+   * const result = await client.campfires.listUploads(123);
+   * ```
+   */
+  async listUploads(campfireId: number, options?: ListUploadsCampfireOptions): Promise<ListResult<CampfireLine>> {
+    return this.requestPaginated(
+      {
+        service: "Campfires",
+        operation: "ListCampfireUploads",
+        resourceType: "campfire_upload",
+        isMutation: false,
+        resourceId: campfireId,
+      },
+      () =>
+        this.client.GET("/chats/{campfireId}/uploads.json", {
+          params: {
+            path: { campfireId },
+          },
+        })
+      , options
+    );
+  }
+
+  /**
+   * Upload a file to a campfire
+   * @param campfireId - The campfire ID
+   * @param data - Binary file data to upload
+   * @param contentType - MIME type of the file (e.g., "image/png", "application/pdf")
+   * @param name - Filename for the uploaded file (e.g. "report.pdf").
+   * @returns The CampfireLine
+   * @throws {BasecampError} If required fields are missing or invalid
+   *
+   * @example
+   * ```ts
+   * const result = await client.campfires.createUpload(123, fileData, "image/png", "name");
+   * ```
+   */
+  async createUpload(campfireId: number, data: ArrayBuffer | Uint8Array | string, contentType: string, name: string): Promise<CampfireLine> {
+    const response = await this.request(
+      {
+        service: "Campfires",
+        operation: "CreateCampfireUpload",
+        resourceType: "campfire_upload",
+        isMutation: true,
+        resourceId: campfireId,
+      },
+      () =>
+        this.client.POST("/chats/{campfireId}/uploads.json", {
+          params: {
+            path: { campfireId },
+            query: { name: name },
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            header: { "Content-Type": contentType } as any,
+          },
+          body: data as unknown as string,
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          bodySerializer: (body: unknown) => body as any,
+        })
+    );
+    return response;
+  }
 }

package/src/generated/services/search.ts

@@ -20,8 +20,6 @@ import type { PaginationOptions } from "../../pagination.js";
 export interface SearchSearchOptions extends PaginationOptions {
   /** Filter by sort */
   sort?: "created_at" | "updated_at";
-  /** Page */
-  page?: number;
 }
 
 
@@ -36,16 +34,16 @@ export class SearchService extends BaseService {
 
   /**
    * Search for content across the account
-   * @param query - query
+   * @param q - q
    * @param options - Optional query parameters
    * @returns All results across all pages, with .meta.totalCount
    *
    * @example
    * ```ts
-   * const result = await client.search.search("query");
+   * const result = await client.search.search("q");
    * ```
    */
-  async search(query: string, options?: SearchSearchOptions): Promise<components["schemas"]["SearchResponseContent"]> {
+  async search(q: string, options?: SearchSearchOptions): Promise<components["schemas"]["SearchResponseContent"]> {
     return this.requestPaginated(
       {
         service: "Search",
@@ -56,7 +54,7 @@ export class SearchService extends BaseService {
       () =>
         this.client.GET("/search.json", {
           params: {
-            query: { query: query, sort: options?.sort, page: options?.page },
+            query: { q: q, sort: options?.sort },
           },
         })
       , options