@air/api-rest 0.8.0 → 0.9.0

package/dist/index.d.cts

@@ -238,9 +238,15 @@ interface GuestListResponse {
     data: Guest[];
 }
 
-/** Visitor comment access on a share link. */
+/**
+ * Visitor comment access on a share link.
+ * `allowed` lets anyone with the link post comments.
+ */
 type ShareLinkCommentsAccess = "hidden" | "read_only" | "allowed";
-/** Visitor custom field access on a share link. */
+/**
+ * Visitor custom field access on a share link.
+ * `editable` lets anyone with the link change custom field values.
+ */
 type ShareLinkCustomFieldsAccess = "hidden" | "read_only" | "editable";
 /**
  * Public share link fields shared by assets and boards.
@@ -292,10 +298,31 @@ interface BoardShareLinkListResponse extends CursorPageResponse<BoardShareLink>
  * Settings accepted on share-link create and update.
  * Omitted fields follow the workspace Share Link Defaults on create,
  * and stay unchanged on update.
+ *
+ * `password` is write only; reads return `hasPassword`. `null` clears
+ * `password` and `expiresAt`. An empty password is rejected. `expiresAt`
+ * must be an ISO 8601 date-time in the future.
+ *
+ * Turning `password`, `expiresAt`, `requireAccount`, `comments`, or
+ * `customFields` on needs the workspace `shareLinks` add-on. Otherwise the
+ * API returns 422 `ADDON_DISABLED` and applies nothing in the request.
+ * Raising `comments` from `read_only` to `allowed`, or `customFields` from
+ * `read_only` to `editable`, counts as turning it on, so a link that already
+ * shows comments or custom fields can still get that 422.
+ * `extra.settings` names the rejected settings, and uses `expiration` for
+ * `expiresAt`. Re-sending a value the link already has, changing an existing
+ * password or expiration, and turning a setting off are accepted.
  */
 interface ShareLinkWriteSettings {
     active?: boolean;
     allowDownload?: boolean;
+    /** Write only. `null` removes the password. */
+    password?: string | null;
+    /** ISO 8601 date-time in the future. `null` removes the expiration. */
+    expiresAt?: string | null;
+    requireAccount?: boolean;
+    comments?: ShareLinkCommentsAccess;
+    customFields?: ShareLinkCustomFieldsAccess;
 }
 /** Asset links also accept `showAllVersions`. */
 interface AssetShareLinkWriteSettings extends ShareLinkWriteSettings {

package/dist/index.d.ts

@@ -238,9 +238,15 @@ interface GuestListResponse {
     data: Guest[];
 }
 
-/** Visitor comment access on a share link. */
+/**
+ * Visitor comment access on a share link.
+ * `allowed` lets anyone with the link post comments.
+ */
 type ShareLinkCommentsAccess = "hidden" | "read_only" | "allowed";
-/** Visitor custom field access on a share link. */
+/**
+ * Visitor custom field access on a share link.
+ * `editable` lets anyone with the link change custom field values.
+ */
 type ShareLinkCustomFieldsAccess = "hidden" | "read_only" | "editable";
 /**
  * Public share link fields shared by assets and boards.
@@ -292,10 +298,31 @@ interface BoardShareLinkListResponse extends CursorPageResponse<BoardShareLink>
  * Settings accepted on share-link create and update.
  * Omitted fields follow the workspace Share Link Defaults on create,
  * and stay unchanged on update.
+ *
+ * `password` is write only; reads return `hasPassword`. `null` clears
+ * `password` and `expiresAt`. An empty password is rejected. `expiresAt`
+ * must be an ISO 8601 date-time in the future.
+ *
+ * Turning `password`, `expiresAt`, `requireAccount`, `comments`, or
+ * `customFields` on needs the workspace `shareLinks` add-on. Otherwise the
+ * API returns 422 `ADDON_DISABLED` and applies nothing in the request.
+ * Raising `comments` from `read_only` to `allowed`, or `customFields` from
+ * `read_only` to `editable`, counts as turning it on, so a link that already
+ * shows comments or custom fields can still get that 422.
+ * `extra.settings` names the rejected settings, and uses `expiration` for
+ * `expiresAt`. Re-sending a value the link already has, changing an existing
+ * password or expiration, and turning a setting off are accepted.
  */
 interface ShareLinkWriteSettings {
     active?: boolean;
     allowDownload?: boolean;
+    /** Write only. `null` removes the password. */
+    password?: string | null;
+    /** ISO 8601 date-time in the future. `null` removes the expiration. */
+    expiresAt?: string | null;
+    requireAccount?: boolean;
+    comments?: ShareLinkCommentsAccess;
+    customFields?: ShareLinkCustomFieldsAccess;
 }
 /** Asset links also accept `showAllVersions`. */
 interface AssetShareLinkWriteSettings extends ShareLinkWriteSettings {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@air/api-rest",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "type": "module",
   "description": "Typed REST client for Air API",
   "main": "./dist/index.cjs",
@@ -29,7 +29,7 @@
     "clean": "rm -rf dist .tsc-out tsconfig.tsbuildinfo"
   },
   "dependencies": {
-    "@air/api-core": "0.8.0"
+    "@air/api-core": "0.9.0"
   },
   "engines": {
     "node": ">=18"