@37signals/basecamp 0.21.0 → 0.23.0

package/src/generated/openapi-stripped.json

@@ -17308,6 +17308,106 @@
         }
       }
     },
+    "/recordings/{recordingId}/filing.json": {
+      "post": {
+        "description": "Move a document, upload or vault into another vault in its project, or reorder it in its own vault.\n\nPassing the vault it is already in changes only its position. The\nrecording moves in place: its id, comments, bookmarks and history stay with\nit, and a vault takes everything inside it along. A destination in another\nproject is 404; moves to another project are not this operation. 404, 403 and\nsome 422s carry no body.\n\n403 when the caller may not move the recording (an account can restrict moves\nto admins and creators). 422 when position is not a positive whole number, the\ndestination is not a vault or is not active, the recording is not active, or a\nvault would move into one of its own vaults; only the position and vault-cycle\nrefusals carry an `error` message.",
+        "operationId": "MoveRecordingToVault",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/MoveRecordingToVaultRequestContent"
+              }
+            }
+          },
+          "required": true
+        },
+        "parameters": [
+          {
+            "name": "recordingId",
+            "in": "path",
+            "schema": {
+              "type": "integer",
+              "format": "int64"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "MoveRecordingToVault 204 response"
+          },
+          "400": {
+            "description": "BadRequestError 400 response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BadRequestErrorResponseContent"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "UnauthorizedError 401 response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UnauthorizedErrorResponseContent"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "BareForbiddenError 403 response"
+          },
+          "404": {
+            "description": "BareNotFoundError 404 response"
+          },
+          "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": [
+          "Recordings"
+        ],
+        "x-basecamp-retry": {
+          "maxAttempts": 2,
+          "baseDelayMs": 1000,
+          "backoff": "exponential",
+          "retryOn": [
+            429,
+            503
+          ]
+        }
+      }
+    },
     "/recordings/{recordingId}/spotlight.json": {
       "delete": {
         "description": "Remove a recording from the spotlight area.\nIdempotent: removing an absent spotlight also returns 204.",
@@ -28807,7 +28907,7 @@
             "type": "string"
           },
           "schedule": {
-            "$ref": "#/components/schemas/QuestionSchedule"
+            "$ref": "#/components/schemas/QuestionScheduleInput"
           },
           "visible_to_clients": {
             "type": "boolean"
@@ -32045,6 +32145,24 @@
           "column_id"
         ]
       },
+      "MoveRecordingToVaultRequestContent": {
+        "type": "object",
+        "properties": {
+          "parent_id": {
+            "type": "integer",
+            "description": "The destination vault. The recording's current vault keeps it where it is\nand changes only its position.",
+            "format": "int64"
+          },
+          "position": {
+            "type": "integer",
+            "description": "1-indexed position within the destination vault. Defaults to 1 (first); a\nposition past the end places it last.",
+            "format": "int32"
+          }
+        },
+        "required": [
+          "parent_id"
+        ]
+      },
       "MyAssignment": {
         "type": "object",
         "properties": {
@@ -33215,7 +33333,8 @@
             "items": {
               "type": "integer",
               "format": "int32"
-            }
+            },
+            "x-go-type-skip-optional-pointer": true
           },
           "hour": {
             "type": "integer",
@@ -33245,6 +33364,32 @@
           }
         }
       },
+      "QuestionScheduleInput": {
+        "type": "object",
+        "description": "The schedule a question is created or updated with. BC3 reads the time of\nday as a string (\"5:00pm\"); hour and minute appear only in responses.",
+        "properties": {
+          "frequency": {
+            "type": "string"
+          },
+          "days": {
+            "type": "array",
+            "items": {
+              "type": "integer",
+              "format": "int32"
+            }
+          },
+          "time_of_day": {
+            "type": "string"
+          },
+          "week_instance": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "start_date": {
+            "type": "string"
+          }
+        }
+      },
       "Questionnaire": {
         "type": "object",
         "properties": {
@@ -36552,13 +36697,13 @@
       "UpdateQuestionNotificationSettingsRequestContent": {
         "type": "object",
         "properties": {
-          "notify_on_answer": {
+          "responding": {
             "type": "boolean",
-            "description": "Notify when someone answers"
+            "description": "Whether the authenticated user is asked this question. Omit to leave it unchanged.\nTurning it on also subscribes the user unless `subscribed: false` is sent with it."
           },
-          "digest_include_unanswered": {
+          "subscribed": {
             "type": "boolean",
-            "description": "Include unanswered in digest"
+            "description": "Whether the authenticated user is notified when someone answers. Omit to leave it unchanged."
           }
         }
       },
@@ -36580,7 +36725,7 @@
             "type": "string"
           },
           "schedule": {
-            "$ref": "#/components/schemas/QuestionSchedule"
+            "$ref": "#/components/schemas/QuestionScheduleInput"
           },
           "paused": {
             "type": "boolean"

package/src/generated/path-mapping.ts

@@ -137,6 +137,7 @@ export const PATH_TO_OPERATION: Record<string, string> = {
   "PUT:/{accountId}/recordings/{recordingId}/client_visibility.json": "SetClientVisibility",
   "GET:/{accountId}/recordings/{recordingId}/comments.json": "ListComments",
   "POST:/{accountId}/recordings/{recordingId}/comments.json": "CreateComment",
+  "POST:/{accountId}/recordings/{recordingId}/filing.json": "MoveRecordingToVault",
   "DELETE:/{accountId}/recordings/{recordingId}/spotlight.json": "UnspotlightRecording",
   "POST:/{accountId}/recordings/{recordingId}/spotlight.json": "SpotlightRecording",
   "PUT:/{accountId}/recordings/{recordingId}/status/active.json": "UnarchiveRecording",

package/src/generated/schema.d.ts

@@ -2660,6 +2660,37 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/recordings/{recordingId}/filing.json": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * @description Move a document, upload or vault into another vault in its project, or reorder it in its own vault.
+         *
+         *     Passing the vault it is already in changes only its position. The
+         *     recording moves in place: its id, comments, bookmarks and history stay with
+         *     it, and a vault takes everything inside it along. A destination in another
+         *     project is 404; moves to another project are not this operation. 404, 403 and
+         *     some 422s carry no body.
+         *
+         *     403 when the caller may not move the recording (an account can restrict moves
+         *     to admins and creators). 422 when position is not a positive whole number, the
+         *     destination is not a vault or is not active, the recording is not active, or a
+         *     vault would move into one of its own vaults; only the position and vault-cycle
+         *     refusals carry an `error` message.
+         */
+        post: operations["MoveRecordingToVault"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/recordings/{recordingId}/spotlight.json": {
         parameters: {
             query?: never;
@@ -4639,7 +4670,7 @@ export interface components {
         CreateProjectResponseContent: components["schemas"]["Project"];
         CreateQuestionRequestContent: {
             title: string;
-            schedule: components["schemas"]["QuestionSchedule"];
+            schedule: components["schemas"]["QuestionScheduleInput"];
             visible_to_clients?: boolean;
         };
         CreateQuestionResponseContent: components["schemas"]["Question"];
@@ -5840,6 +5871,20 @@ export interface components {
              */
             position?: number;
         };
+        MoveRecordingToVaultRequestContent: {
+            /**
+             * Format: int64
+             * @description The destination vault. The recording's current vault keeps it where it is
+             *     and changes only its position.
+             */
+            parent_id: number;
+            /**
+             * Format: int32
+             * @description 1-indexed position within the destination vault. Defaults to 1 (first); a
+             *     position past the end places it last.
+             */
+            position?: number;
+        };
         MyAssignment: {
             /** Format: int64 */
             id: number;
@@ -6282,6 +6327,18 @@ export interface components {
             start_date?: string;
             end_date?: string;
         };
+        /**
+         * @description The schedule a question is created or updated with. BC3 reads the time of
+         *     day as a string ("5:00pm"); hour and minute appear only in responses.
+         */
+        QuestionScheduleInput: {
+            frequency?: string;
+            days?: number[];
+            time_of_day?: string;
+            /** Format: int32 */
+            week_instance?: number;
+            start_date?: string;
+        };
         Questionnaire: {
             /** Format: int64 */
             id: number;
@@ -7951,10 +8008,13 @@ export interface components {
         };
         UpdateProjectResponseContent: components["schemas"]["Project"];
         UpdateQuestionNotificationSettingsRequestContent: {
-            /** @description Notify when someone answers */
-            notify_on_answer?: boolean;
-            /** @description Include unanswered in digest */
-            digest_include_unanswered?: boolean;
+            /**
+             * @description Whether the authenticated user is asked this question. Omit to leave it unchanged.
+             *     Turning it on also subscribes the user unless `subscribed: false` is sent with it.
+             */
+            responding?: boolean;
+            /** @description Whether the authenticated user is notified when someone answers. Omit to leave it unchanged. */
+            subscribed?: boolean;
         };
         UpdateQuestionNotificationSettingsResponseContent: {
             responding?: boolean;
@@ -7962,7 +8022,7 @@ export interface components {
         };
         UpdateQuestionRequestContent: {
             title?: string;
-            schedule?: components["schemas"]["QuestionSchedule"];
+            schedule?: components["schemas"]["QuestionScheduleInput"];
             paused?: boolean;
         };
         UpdateQuestionResponseContent: components["schemas"]["Question"];
@@ -20001,6 +20061,89 @@ export interface operations {
             };
         };
     };
+    MoveRecordingToVault: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                recordingId: number;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["MoveRecordingToVaultRequestContent"];
+            };
+        };
+        responses: {
+            /** @description MoveRecordingToVault 204 response */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description BadRequestError 400 response */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BadRequestErrorResponseContent"];
+                };
+            };
+            /** @description UnauthorizedError 401 response */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UnauthorizedErrorResponseContent"];
+                };
+            };
+            /** @description BareForbiddenError 403 response */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description BareNotFoundError 404 response */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     SpotlightRecording: {
         parameters: {
             query?: never;

package/src/generated/services/checkins.ts

@@ -56,7 +56,7 @@ export interface CreateQuestionCheckinRequest {
   /** Title */
   title: string;
   /** Schedule */
-  schedule: components["schemas"]["QuestionSchedule"];
+  schedule: components["schemas"]["QuestionScheduleInput"];
   /** Visible to clients */
   visibleToClients?: boolean;
 }
@@ -68,7 +68,7 @@ export interface UpdateQuestionCheckinRequest {
   /** Title */
   title?: string;
   /** Schedule */
-  schedule?: components["schemas"]["QuestionSchedule"];
+  schedule?: components["schemas"]["QuestionScheduleInput"];
   /** Paused */
   paused?: boolean;
 }
@@ -109,10 +109,11 @@ export interface ByPersonCheckinOptions extends PaginationOptions {
  * Request parameters for updateNotificationSettings.
  */
 export interface UpdateNotificationSettingsCheckinRequest {
-  /** Notify when someone answers */
-  notifyOnAnswer?: boolean;
-  /** Include unanswered in digest */
-  digestIncludeUnanswered?: boolean;
+  /** Whether the authenticated user is asked this question. Omit to leave it unchanged.
+Turning it on also subscribes the user unless `subscribed: false` is sent with it. */
+  responding?: boolean;
+  /** Whether the authenticated user is notified when someone answers. Omit to leave it unchanged. */
+  subscribed?: boolean;
 }
 
 
@@ -559,8 +560,8 @@ export class CheckinsService extends BaseService {
             path: { questionId },
           },
           body: {
-            notify_on_answer: req.notifyOnAnswer,
-            digest_include_unanswered: req.digestIncludeUnanswered,
+            responding: req.responding,
+            subscribed: req.subscribed,
           },
         })
     );

package/src/generated/services/recordings.ts

@@ -32,6 +32,18 @@ export interface ListRecordingOptions extends PaginationOptions {
   page?: number;
 }
 
+/**
+ * Request parameters for moveToVault.
+ */
+export interface MoveToVaultRecordingRequest {
+  /** The destination vault. The recording's current vault keeps it where it is
+and changes only its position. */
+  parentId: number;
+  /** 1-indexed position within the destination vault. Defaults to 1 (first); a
+position past the end places it last. */
+  position?: number;
+}
+
 
 // =============================================================================
 // Service
@@ -74,6 +86,40 @@ export class RecordingsService extends BaseService {
     );
   }
 
+  /**
+   * Move a document, upload or vault into another vault in its project, or reorder it in its own vault.
+   * @param recordingId - The recording ID
+   * @param req - Recording request parameters
+   * @returns void
+   * @throws {BasecampError} If the request fails
+   *
+   * @example
+   * ```ts
+   * await client.recordings.moveToVault(123, { parentId: 1 });
+   * ```
+   */
+  async moveToVault(recordingId: number, req: MoveToVaultRecordingRequest): Promise<void> {
+    await this.request(
+      {
+        service: "Recordings",
+        operation: "MoveRecordingToVault",
+        resourceType: "recording",
+        isMutation: true,
+        resourceId: recordingId,
+      },
+      () =>
+        this.client.POST("/recordings/{recordingId}/filing.json", {
+          params: {
+            path: { recordingId },
+          },
+          body: {
+            parent_id: req.parentId,
+            position: req.position,
+          },
+        })
+    );
+  }
+
   /**
    * Put a recording's card in the spotlight area on its project or template home page.
    * @param recordingId - The recording ID