@37signals/basecamp 0.24.0 → 0.26.0

package/src/generated/schema.d.ts

@@ -86,7 +86,14 @@ export interface paths {
         };
         /** @description Get a single boost */
         get: operations["GetBoost"];
-        put?: never;
+        /**
+         * @description Replace the content of a boost. Only the boost's creator may update it: an
+         *     admin updating someone else's boost gets 403 Forbidden, as does any caller
+         *     when comments are closed on the boosted recording. A boost on a deleted
+         *     recording, or in another account, answers 404. A missing or invalid
+         *     `content` answers a bodiless 422. There is no bucket-scoped route.
+         */
+        put: operations["UpdateBoost"];
         post?: never;
         /** @description Delete a boost */
         delete: operations["DeleteBoost"];
@@ -138,10 +145,14 @@ export interface paths {
             cookie?: never;
         };
         get?: never;
-        /** @description Update a wormhole's destination column */
+        /** @description Point a card table's wormhole, its shortcut for sending cards to another card table, at a different destination column */
         put: operations["UpdateWormhole"];
         post?: never;
-        /** @description Delete a wormhole */
+        /**
+         * @description Permanently delete a card table's wormhole, the shortcut that sends cards to another card table.
+         *
+         *     It does not go to the trash and cannot be restored.
+         */
         delete: operations["DeleteWormhole"];
         options?: never;
         head?: never;
@@ -158,10 +169,12 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * @description Create a wormhole linking this card table to a column on another card table.
+         * @description Add a wormhole to a card table: a standing shortcut that sends cards to a column on another card table, usually in another project.
          *
          *     A wormhole is the only mechanism for moving a card to a different project: its
-         *     id is a valid `column_id` for MoveCard, teleporting the card across projects.
+         *     id is a valid `column_id` for MoveCard, teleporting the card there. It is not
+         *     needed for a one-off move within a project; MoveCard goes to any column there
+         *     directly. A card table holds at most four wormholes.
          *     `destinationRecordingId` is the id of a column on another accessible card table.
          */
         post: operations["CreateWormhole"];
@@ -533,7 +546,18 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Move a card to a different column */
+        /**
+         * @description Move a card to any column in its project, including on another card table there, or through a linked wormhole to another project (queued: the card gets a new id, and position, if sent, must still be positive but doesn't set placement).
+         *
+         *     `column_id` may be any column in the card's project, including a column on
+         *     another card table in the same project; the card moves there directly, with
+         *     no wormhole needed. To send the card to another project, pass the id of a
+         *     linked wormhole (`linked: true`) the card table already has, listed in
+         *     GetCardTable's `wormholes`; an unlinked or unreachable one returns not found.
+         *     A move through a wormhole is queued: the card arrives under a new id and its
+         *     old id then returns not found. `position` does not control where it lands,
+         *     but if supplied it must still be a positive integer.
+         */
         post: operations["MoveCard"];
         delete?: never;
         options?: never;
@@ -712,7 +736,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Move a column within a card table */
+        /** @description Move a column to a slot within its card table. target_id is the card table's own id (the same as cardTableId), not a column; position is the 1-based slot among the columns, not counting Triage, Not Now or Done. */
         post: operations["MoveCardColumn"];
         delete?: never;
         options?: never;
@@ -960,6 +984,44 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/circles.json": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description Get Pings: the caller's active Pings that have a line in them, most
+         *     recently updated first, in one unpaginated response. Archived Pings, and
+         *     Pings no one has posted in yet, are not listed; GetPing reads either by id.
+         *
+         *     Answers `403 Forbidden` (`{"error": "Pings have been disabled"}`) when the
+         *     caller cannot ping.
+         */
+        get: operations["ListPings"];
+        put?: never;
+        /**
+         * @description Create a Ping with people, or return the one that already holds exactly
+         *     them.
+         *
+         *     The caller is always included. Without `new_group`, an existing active
+         *     Ping with exactly these people (the oldest, if several) is returned rather
+         *     than a second one created; with `new_group: true` and more than one other
+         *     person, a new group is created every time. Either way the answer is
+         *     `201 Created` with the Ping.
+         *
+         *     Answers `403 Forbidden` (`{"error": "Pings have been disabled"}`) when the
+         *     caller cannot ping, and a bodiless `422` when nobody in the Ping would be a
+         *     person who can ping.
+         */
+        post: operations["CreatePing"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/circles/people.json": {
         parameters: {
             query?: never;
@@ -982,6 +1044,29 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/circles/{pingId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * @description Get a Ping by its id, which is its bucket's id.
+         *
+         *     Answers `403 Forbidden` (`{"error": "Pings have been disabled"}`) when the
+         *     caller cannot ping, and `404 Not Found` for a bucket that is not a Ping the
+         *     caller is in.
+         */
+        get: operations["GetPing"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/client/approvals/{approvalId}": {
         parameters: {
             query?: never;
@@ -1464,7 +1549,7 @@ export interface paths {
         /** @description List all lineup markers for the account */
         get: operations["ListLineupMarkers"];
         put?: never;
-        /** @description Create a new lineup marker */
+        /** @description Create a new lineup marker. Returns the created marker. */
         post: operations["CreateLineupMarker"];
         delete?: never;
         options?: never;
@@ -1480,7 +1565,7 @@ export interface paths {
             cookie?: never;
         };
         get?: never;
-        /** @description Update an existing lineup marker */
+        /** @description Update an existing lineup marker. Returns the updated marker. */
         put: operations["UpdateLineupMarker"];
         post?: never;
         /** @description Delete a lineup marker */
@@ -1846,7 +1931,7 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * @description Get the current user's notification inbox (the "Hey!" menu).
+         * @description Get the current user's notifications (the "Hey!" menu in Basecamp 4).
          *     Notifications are grouped into unreads, reads, bubble-ups, and
          *     scheduled bubble-ups (`memories` remains as an always-empty
          *     placeholder on BC5). Reads are paginated (50 per page). Unreads are
@@ -2372,7 +2457,7 @@ export interface paths {
         };
         /** @description Get a single question by id */
         get: operations["GetQuestion"];
-        /** @description Update an existing question */
+        /** @description Update an existing question's title, schedule or both. A schedule replaces the whole schedule, so send every part of it: one without frequency or time_of_day is refused, and one without start_date re-anchors the recurrence on today. Pausing and resuming are PauseQuestion and ResumeQuestion. */
         put: operations["UpdateQuestion"];
         post?: never;
         delete?: never;
@@ -2649,10 +2734,10 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** @description List boosts on a specific event within a recording */
+        /** @description List boosts on a specific event within a recording. Only boostable events carry boosts: those whose action is completed, adopted, column_changed or moved_in (their JSON includes boosts_count and boosts_url). Any other event answers 403 Forbidden; an event on a recording the person cannot see answers 404. */
         get: operations["ListEventBoosts"];
         put?: never;
-        /** @description Create a boost on a specific event within a recording */
+        /** @description Create a boost on a specific event within a recording. Only boostable events accept one: those whose action is completed, adopted, column_changed or moved_in (their JSON includes boosts_count and boosts_url). Any other event answers 403 Forbidden, as does an event on a recording whose comments are closed; an event on a recording the person cannot see answers 404. */
         post: operations["CreateEventBoost"];
         delete?: never;
         options?: never;
@@ -4260,6 +4345,13 @@ export interface components {
             creator: components["schemas"]["Person"];
             subscribers?: components["schemas"]["Person"][];
             lists?: components["schemas"]["CardColumn"][];
+            /**
+             * @description The card table's wormholes: shortcuts for sending cards to other card
+             *     tables, usually in other projects. Only wormholes whose destination the
+             *     requester can reach are listed; the rest are omitted, not shown unlinked.
+             *     Not needed to move a card within its project; MoveCard reaches any column
+             *     there directly.
+             */
             wormholes?: components["schemas"]["Wormhole"][];
         };
         Chatbot: {
@@ -4633,6 +4725,7 @@ export interface components {
             name: string;
             date: string;
         };
+        CreateLineupMarkerResponseContent: components["schemas"]["LineupMarker"];
         CreateMessageRequestContent: {
             subject: string;
             content?: string;
@@ -4659,6 +4752,16 @@ export interface components {
             /** Format: password */
             company_name?: string;
         };
+        CreatePingRequestContent: {
+            /**
+             * @description Person ids of the people to ping. People the caller cannot reach are
+             *     dropped.
+             */
+            user_ids: number[];
+            /** @description Create a new group even when a Ping with exactly these people exists. */
+            new_group?: boolean;
+        };
+        CreatePingResponseContent: components["schemas"]["Ping"];
         CreateProjectFromTemplateRequestContent: {
             project: components["schemas"]["ProjectConstructionAttributes"];
         };
@@ -5038,8 +5141,14 @@ export interface components {
             created_at: string;
             creator: components["schemas"]["Person"];
             performed_by?: components["schemas"]["Person"];
-            /** Format: int32 */
+            /**
+             * Format: int32
+             * @description Present only on boostable events (action completed, adopted,
+             *     column_changed or moved_in); the event boost operations refuse any
+             *     other event with 403.
+             */
             boosts_count?: number;
+            /** @description Present only on boostable events; see boosts_count. */
             boosts_url?: string;
         };
         EventDetails: {
@@ -5578,6 +5687,7 @@ export interface components {
             events: components["schemas"]["TimelineEvent"][];
         };
         GetPersonResponseContent: components["schemas"]["Person"];
+        GetPingResponseContent: components["schemas"]["Ping"];
         GetProgressReportResponseContent: components["schemas"]["TimelineEvent"][];
         GetProjectConstructionResponseContent: components["schemas"]["ProjectConstruction"];
         GetProjectResponseContent: components["schemas"]["Project"];
@@ -5772,6 +5882,7 @@ export interface components {
         ListMyDraftsResponseContent: components["schemas"]["Draft"][];
         ListPeopleResponseContent: components["schemas"]["Person"][];
         ListPingablePeopleResponseContent: components["schemas"]["Person"][];
+        ListPingsResponseContent: components["schemas"]["Ping"][];
         ListProjectPeopleResponseContent: components["schemas"]["Person"][];
         ListProjectsResponseContent: components["schemas"]["Project"][];
         ListQuestionAnswerersResponseContent: components["schemas"]["Person"][];
@@ -5855,15 +5966,31 @@ export interface components {
             updated_at: string;
         };
         MoveCardColumnRequestContent: {
-            /** Format: int64 */
+            /**
+             * Format: int64
+             * @description The column to move.
+             */
             source_id: number;
-            /** Format: int64 */
+            /**
+             * Format: int64
+             * @description The card table the column moves within: the same id as `cardTableId`.
+             *     Basecamp refuses any other destination, a column included, with 422.
+             */
             target_id: number;
-            /** Format: int32 */
+            /**
+             * Format: int32
+             * @description 1-based slot among the card table's columns, not counting Triage,
+             *     Not Now or Done. 1 puts the column first; a slot past the last puts it
+             *     last. Default: 1.
+             */
             position?: number;
         };
         MoveCardRequestContent: {
-            /** Format: int64 */
+            /**
+             * Format: int64
+             * @description Any column in the card's project, on this or another card table, or a
+             *     wormhole id to send the card to another project.
+             */
             column_id: number;
             /**
              * Format: int32
@@ -6103,6 +6230,59 @@ export interface components {
             /** Format: password */
             name: string;
         };
+        /**
+         * @description A Ping: a private conversation between people, held in its own bucket with
+         *     one Campfire. The Campfire's lines are read and written through the
+         *     Campfires service; `room_url` and `links.lines` name it.
+         */
+        Ping: {
+            /**
+             * Format: int64
+             * @description The Ping's id, which is also its bucket's id.
+             */
+            id: number;
+            created_at: string;
+            updated_at: string;
+            /**
+             * @description The Ping's name for the caller: its given name when `named`, else the
+             *     names of the other people in it.
+             */
+            title: string;
+            /** @description Whether someone gave the Ping a name. */
+            named: boolean;
+            /** @description The Ping's own image, present only when one was uploaded. */
+            image_url?: string;
+            /** Format: password */
+            avatar_url: string;
+            url: string;
+            app_url: string;
+            bookmark_url: string;
+            /** @description The Ping's Campfire (`/buckets/{bucketId}/chats/{campfireId}.json`). */
+            room_url: string;
+            /**
+             * @description Present only when the Ping can be renamed: one with more than one other
+             *     person in it.
+             */
+            edit_title_url?: string;
+            links: components["schemas"]["PingLinks"];
+            /**
+             * @description The people in the Ping other than the caller; the caller alone when
+             *     nobody else is in it.
+             */
+            people: components["schemas"]["Person"][];
+        };
+        /**
+         * @description The Ping's Campfire endpoints, so a client need not derive them from
+         *     `room_url`. The wire object also repeats `url`, `app_url`, `bookmark_url`
+         *     and `edit_title_url` as `self`, `app`, `bookmark` and `edit_title`; those
+         *     are read from the Ping's own fields.
+         */
+        PingLinks: {
+            /** @description The Campfire's lines (`/buckets/{bucketId}/chats/{campfireId}/lines.json`). */
+            lines: string;
+            /** @description The Campfire's uploads. */
+            files: string;
+        };
         /**
          * @description The poll envelope. Every 200 carries `events` and `position`; `next` only
          *     while the walk continues.
@@ -6194,6 +6374,11 @@ export interface components {
             start_date?: string;
             end_date?: string;
             clients_enabled?: boolean;
+            /**
+             * @description True when the project's timesheet is turned on. The project timesheet
+             *     report (GET /projects/{projectId}/timesheet.json) answers 404 until it is.
+             */
+            timesheet_enabled?: boolean;
             bookmark_url?: string;
             /** @description Bucket stars collection for this project (`/buckets/{id}/stars.json`). */
             star_url?: string;
@@ -7862,6 +8047,10 @@ export interface components {
             name: string;
         };
         UpdateAccountNameResponseContent: components["schemas"]["Account"];
+        UpdateBoostRequestContent: {
+            content: string;
+        };
+        UpdateBoostResponseContent: components["schemas"]["Boost"];
         UpdateCalendarRequestContent: {
             calendar: components["schemas"]["CalendarAttributes"];
         };
@@ -7947,6 +8136,7 @@ export interface components {
             name?: string;
             date?: string;
         };
+        UpdateLineupMarkerResponseContent: components["schemas"]["LineupMarker"];
         UpdateMessageRequestContent: {
             subject?: string;
             content?: string;
@@ -8021,9 +8211,9 @@ export interface components {
             subscribed?: boolean;
         };
         UpdateQuestionRequestContent: {
+            /** @description The question text. An update carries a title, a schedule or both. */
             title?: string;
             schedule?: components["schemas"]["QuestionScheduleInput"];
-            paused?: boolean;
         };
         UpdateQuestionResponseContent: components["schemas"]["Question"];
         UpdateScheduleSettingsRequestContent: {
@@ -8279,8 +8469,9 @@ export interface components {
             message?: string;
         };
         /**
-         * @description A wormhole links this card table to a column on another card table, enabling
-         *     cards to move across projects. It carries the full recording representation
+         * @description A wormhole is a standing shortcut from this card table to a column on another
+         *     card table, usually in another project, and the only way to move a card across
+         *     projects. It carries the full recording representation
          *     plus the destination-linkage fields. The wormhole's own `url`/`app_url`/`parent`
          *     point at the *source* board; `destination_url` is the only field identifying
          *     the destination column.
@@ -8716,6 +8907,75 @@ export interface operations {
             };
         };
     };
+    UpdateBoost: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                boostId: number;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateBoostRequestContent"];
+            };
+        };
+        responses: {
+            /** @description UpdateBoost 200 response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UpdateBoostResponseContent"];
+                };
+            };
+            /** @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 NotFoundError 404 response */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["NotFoundErrorResponseContent"];
+                };
+            };
+            /** @description BareValidationError 422 response */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description InternalServerError 500 response */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InternalServerErrorResponseContent"];
+                };
+            };
+        };
+    };
     DeleteBoost: {
         parameters: {
             query?: never;
@@ -12980,6 +13240,129 @@ export interface operations {
             };
         };
     };
+    ListPings: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ListPings 200 response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ListPingsResponseContent"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    CreatePing: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreatePingRequestContent"];
+            };
+        };
+        responses: {
+            /** @description CreatePing 201 response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CreatePingResponseContent"];
+                };
+            };
+            /** @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 BareValidationError 422 response */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @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;
@@ -13036,6 +13419,78 @@ export interface operations {
             };
         };
     };
+    GetPing: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /**
+                 * @description A Ping's id is the id of the bucket that holds it (the bucket type is
+                 *     "Circle", which is also the wire path), so the `bucket.id` a Ping's
+                 *     recordings carry is the id GetPing takes.
+                 */
+                pingId: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description GetPing 200 response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetPingResponseContent"];
+                };
+            };
+            /** @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 NotFoundError 404 response */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["NotFoundErrorResponseContent"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     GetClientApproval: {
         parameters: {
             query?: never;
@@ -14884,7 +15339,9 @@ export interface operations {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["CreateLineupMarkerResponseContent"];
+                };
             };
             /** @description UnauthorizedError 401 response */
             401: {
@@ -14953,7 +15410,9 @@ export interface operations {
                 headers: {
                     [name: string]: unknown;
                 };
-                content?: never;
+                content: {
+                    "application/json": components["schemas"]["UpdateLineupMarkerResponseContent"];
+                };
             };
             /** @description UnauthorizedError 401 response */
             401: {