@air/api-rest 0.3.0 → 0.5.0

package/README.md

@@ -21,6 +21,7 @@ npm install @air/api-rest
 ## What's included
 
 - Resource classes: `BoardsResource`, `AssetsResource`, `TagsResource`, `CustomFieldsResource`, `UploadsResource`, `ImportsResource`, `RolesResource`
+- Asset CDN link helpers: `listCdnLinks`, `createCdnLink`, and `updateCdnLink`
 - Full TypeScript types for all API request/response shapes
 - `AirApi` client class that composes all resources
 

package/dist/index.cjs

@@ -77,6 +77,9 @@ var Assets = class {
     if (params.includeNestedAssets !== void 0) {
       query.includeNestedAssets = params.includeNestedAssets;
     }
+    if (params.semantic !== void 0) {
+      query.semantic = params.semantic;
+    }
     if (params.tag) {
       query.tag = params.tag;
     }
@@ -103,6 +106,26 @@ var Assets = class {
       path: `/assets/${assetId}`
     });
   }
+  async listCdnLinks(assetId) {
+    return this.client.request({
+      method: "GET",
+      path: `/assets/${assetId}/cdnLinks`
+    });
+  }
+  async createCdnLink(assetId, params) {
+    return this.client.request({
+      method: "POST",
+      path: `/assets/${assetId}/cdnLinks`,
+      body: params
+    });
+  }
+  async updateCdnLink(assetId, cdnLinkId, params) {
+    return this.client.request({
+      method: "PATCH",
+      path: `/assets/${assetId}/cdnLinks/${cdnLinkId}`,
+      body: params
+    });
+  }
   async setCustomField(assetId, customFieldId, params) {
     return this.client.request({
       method: "PUT",

package/dist/index.d.cts

@@ -62,6 +62,13 @@ interface AssetListParams extends CursorPageParams {
     tag?: string | string[];
     customField?: string | string[];
     search?: string;
+    /**
+     * When true, `search` is used for semantic search via AI embeddings.
+     * Requires a non-blank `search` value and Semantic Search enabled on the workspace.
+     * Returns a single page of results ordered by relevance. Combining with `tag`,
+     * `customField`, `createdAt`, or `cursor` is rejected by the API with 400.
+     */
+    semantic?: boolean;
     "createdAt[gte]"?: string;
     "createdAt[lte]"?: string;
 }
@@ -81,6 +88,34 @@ interface AddVersionTagParams {
 interface AssetVersionDownloadUrl {
     url: string;
 }
+interface CdnLinkBase {
+    id: string;
+    url: string;
+    assetId: string;
+    active: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+type CdnLink = (CdnLinkBase & {
+    followsDefaultVersion: true;
+    versionId?: never;
+}) | (CdnLinkBase & {
+    followsDefaultVersion: false;
+    versionId: string;
+});
+type AssetCdnLinkCreateParams = {
+    followsDefaultVersion: true;
+    versionId?: never;
+} | {
+    versionId: string;
+    followsDefaultVersion?: never;
+};
+interface AssetCdnLinkUpdateParams {
+    active: boolean;
+}
+interface AssetCdnLinkListResponse {
+    data: CdnLink[];
+}
 interface AssetBoardListParams extends CursorPageParams {
     includeCustomFields?: boolean;
 }
@@ -159,6 +194,9 @@ declare class Assets {
     list(params?: AssetListParams): PagePromise<Asset>;
     get(assetId: string): Promise<Asset>;
     delete(assetId: string): Promise<void>;
+    listCdnLinks(assetId: string): Promise<AssetCdnLinkListResponse>;
+    createCdnLink(assetId: string, params: AssetCdnLinkCreateParams): Promise<CdnLink>;
+    updateCdnLink(assetId: string, cdnLinkId: string, params: AssetCdnLinkUpdateParams): Promise<void>;
     setCustomField(assetId: string, customFieldId: string, params: SetCustomFieldParams): Promise<void>;
     listVersions(assetId: string): Promise<AssetVersionListResponse>;
     getVersion(assetId: string, versionId: string): Promise<AssetVersion>;
@@ -476,4 +514,4 @@ declare class AirApi extends AirBase {
     constructor(options?: AirApiOptions);
 }
 
-export { type AddBoardAssetsParams, type AddGuestParams, type AddVersionTagParams, AirApi, type AirApiOptions, type Asset, type AssetBoardListParams, type AssetCustomFieldValue, type AssetListParams, type AssetVersion, type AssetVersionDownloadUrl, type AssetVersionListResponse, type AssetVersionUpdateParams, type AssetVersionUrls, Assets, type Board, type BoardCreateParams, type BoardListParams, type BoardUpdateParams, Boards, type CompleteMultipartParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, type CustomFieldUpdateParams, type CustomFieldValue, type CustomFieldValueCreateParams, type CustomFieldValueUpdateParams, CustomFields, type FileMeta, type FileSource, type GetPartUploadUrlParams, type GetPartUploadUrlResponse, type Guest, type GuestListParams, type GuestListResponse, type ImportCreateParams, type ImportCreateResponse, type ImportStatus, type ImportStatusResponse, Imports, type LargeUploadResponse, Libraries, type Library, type LibraryCreateParams, type LibraryListParams, type LibraryUpdateParams, type Role, type RoleListParams, type RoleListResponse, Roles, type SetBoardCustomFieldParams, type SetCustomFieldParams, type SmallUploadResponse, type SmartTag, type Tag, type TagCreateParams, type TagListParams, type TagUpdateParams, Tags, type UpdateGuestParams, type UploadCreateParams, type UploadCreateResponse, type UploadFileOptions, type UploadFileParams, type UploadFileResponse, Uploads, type Workspace, type WorkspaceListResponse, Workspaces };
+export { type AddBoardAssetsParams, type AddGuestParams, type AddVersionTagParams, AirApi, type AirApiOptions, type Asset, type AssetBoardListParams, type AssetCdnLinkCreateParams, type AssetCdnLinkListResponse, type AssetCdnLinkUpdateParams, type AssetCustomFieldValue, type AssetListParams, type AssetVersion, type AssetVersionDownloadUrl, type AssetVersionListResponse, type AssetVersionUpdateParams, type AssetVersionUrls, Assets, type Board, type BoardCreateParams, type BoardListParams, type BoardUpdateParams, Boards, type CdnLink, type CompleteMultipartParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, type CustomFieldUpdateParams, type CustomFieldValue, type CustomFieldValueCreateParams, type CustomFieldValueUpdateParams, CustomFields, type FileMeta, type FileSource, type GetPartUploadUrlParams, type GetPartUploadUrlResponse, type Guest, type GuestListParams, type GuestListResponse, type ImportCreateParams, type ImportCreateResponse, type ImportStatus, type ImportStatusResponse, Imports, type LargeUploadResponse, Libraries, type Library, type LibraryCreateParams, type LibraryListParams, type LibraryUpdateParams, type Role, type RoleListParams, type RoleListResponse, Roles, type SetBoardCustomFieldParams, type SetCustomFieldParams, type SmallUploadResponse, type SmartTag, type Tag, type TagCreateParams, type TagListParams, type TagUpdateParams, Tags, type UpdateGuestParams, type UploadCreateParams, type UploadCreateResponse, type UploadFileOptions, type UploadFileParams, type UploadFileResponse, Uploads, type Workspace, type WorkspaceListResponse, Workspaces };

package/dist/index.d.ts

@@ -62,6 +62,13 @@ interface AssetListParams extends CursorPageParams {
     tag?: string | string[];
     customField?: string | string[];
     search?: string;
+    /**
+     * When true, `search` is used for semantic search via AI embeddings.
+     * Requires a non-blank `search` value and Semantic Search enabled on the workspace.
+     * Returns a single page of results ordered by relevance. Combining with `tag`,
+     * `customField`, `createdAt`, or `cursor` is rejected by the API with 400.
+     */
+    semantic?: boolean;
     "createdAt[gte]"?: string;
     "createdAt[lte]"?: string;
 }
@@ -81,6 +88,34 @@ interface AddVersionTagParams {
 interface AssetVersionDownloadUrl {
     url: string;
 }
+interface CdnLinkBase {
+    id: string;
+    url: string;
+    assetId: string;
+    active: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+type CdnLink = (CdnLinkBase & {
+    followsDefaultVersion: true;
+    versionId?: never;
+}) | (CdnLinkBase & {
+    followsDefaultVersion: false;
+    versionId: string;
+});
+type AssetCdnLinkCreateParams = {
+    followsDefaultVersion: true;
+    versionId?: never;
+} | {
+    versionId: string;
+    followsDefaultVersion?: never;
+};
+interface AssetCdnLinkUpdateParams {
+    active: boolean;
+}
+interface AssetCdnLinkListResponse {
+    data: CdnLink[];
+}
 interface AssetBoardListParams extends CursorPageParams {
     includeCustomFields?: boolean;
 }
@@ -159,6 +194,9 @@ declare class Assets {
     list(params?: AssetListParams): PagePromise<Asset>;
     get(assetId: string): Promise<Asset>;
     delete(assetId: string): Promise<void>;
+    listCdnLinks(assetId: string): Promise<AssetCdnLinkListResponse>;
+    createCdnLink(assetId: string, params: AssetCdnLinkCreateParams): Promise<CdnLink>;
+    updateCdnLink(assetId: string, cdnLinkId: string, params: AssetCdnLinkUpdateParams): Promise<void>;
     setCustomField(assetId: string, customFieldId: string, params: SetCustomFieldParams): Promise<void>;
     listVersions(assetId: string): Promise<AssetVersionListResponse>;
     getVersion(assetId: string, versionId: string): Promise<AssetVersion>;
@@ -476,4 +514,4 @@ declare class AirApi extends AirBase {
     constructor(options?: AirApiOptions);
 }
 
-export { type AddBoardAssetsParams, type AddGuestParams, type AddVersionTagParams, AirApi, type AirApiOptions, type Asset, type AssetBoardListParams, type AssetCustomFieldValue, type AssetListParams, type AssetVersion, type AssetVersionDownloadUrl, type AssetVersionListResponse, type AssetVersionUpdateParams, type AssetVersionUrls, Assets, type Board, type BoardCreateParams, type BoardListParams, type BoardUpdateParams, Boards, type CompleteMultipartParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, type CustomFieldUpdateParams, type CustomFieldValue, type CustomFieldValueCreateParams, type CustomFieldValueUpdateParams, CustomFields, type FileMeta, type FileSource, type GetPartUploadUrlParams, type GetPartUploadUrlResponse, type Guest, type GuestListParams, type GuestListResponse, type ImportCreateParams, type ImportCreateResponse, type ImportStatus, type ImportStatusResponse, Imports, type LargeUploadResponse, Libraries, type Library, type LibraryCreateParams, type LibraryListParams, type LibraryUpdateParams, type Role, type RoleListParams, type RoleListResponse, Roles, type SetBoardCustomFieldParams, type SetCustomFieldParams, type SmallUploadResponse, type SmartTag, type Tag, type TagCreateParams, type TagListParams, type TagUpdateParams, Tags, type UpdateGuestParams, type UploadCreateParams, type UploadCreateResponse, type UploadFileOptions, type UploadFileParams, type UploadFileResponse, Uploads, type Workspace, type WorkspaceListResponse, Workspaces };
+export { type AddBoardAssetsParams, type AddGuestParams, type AddVersionTagParams, AirApi, type AirApiOptions, type Asset, type AssetBoardListParams, type AssetCdnLinkCreateParams, type AssetCdnLinkListResponse, type AssetCdnLinkUpdateParams, type AssetCustomFieldValue, type AssetListParams, type AssetVersion, type AssetVersionDownloadUrl, type AssetVersionListResponse, type AssetVersionUpdateParams, type AssetVersionUrls, Assets, type Board, type BoardCreateParams, type BoardListParams, type BoardUpdateParams, Boards, type CdnLink, type CompleteMultipartParams, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldType, type CustomFieldUpdateParams, type CustomFieldValue, type CustomFieldValueCreateParams, type CustomFieldValueUpdateParams, CustomFields, type FileMeta, type FileSource, type GetPartUploadUrlParams, type GetPartUploadUrlResponse, type Guest, type GuestListParams, type GuestListResponse, type ImportCreateParams, type ImportCreateResponse, type ImportStatus, type ImportStatusResponse, Imports, type LargeUploadResponse, Libraries, type Library, type LibraryCreateParams, type LibraryListParams, type LibraryUpdateParams, type Role, type RoleListParams, type RoleListResponse, Roles, type SetBoardCustomFieldParams, type SetCustomFieldParams, type SmallUploadResponse, type SmartTag, type Tag, type TagCreateParams, type TagListParams, type TagUpdateParams, Tags, type UpdateGuestParams, type UploadCreateParams, type UploadCreateResponse, type UploadFileOptions, type UploadFileParams, type UploadFileResponse, Uploads, type Workspace, type WorkspaceListResponse, Workspaces };

package/dist/index.js

@@ -16,6 +16,9 @@ var Assets = class {
     if (params.includeNestedAssets !== void 0) {
       query.includeNestedAssets = params.includeNestedAssets;
     }
+    if (params.semantic !== void 0) {
+      query.semantic = params.semantic;
+    }
     if (params.tag) {
       query.tag = params.tag;
     }
@@ -42,6 +45,26 @@ var Assets = class {
       path: `/assets/${assetId}`
     });
   }
+  async listCdnLinks(assetId) {
+    return this.client.request({
+      method: "GET",
+      path: `/assets/${assetId}/cdnLinks`
+    });
+  }
+  async createCdnLink(assetId, params) {
+    return this.client.request({
+      method: "POST",
+      path: `/assets/${assetId}/cdnLinks`,
+      body: params
+    });
+  }
+  async updateCdnLink(assetId, cdnLinkId, params) {
+    return this.client.request({
+      method: "PATCH",
+      path: `/assets/${assetId}/cdnLinks/${cdnLinkId}`,
+      body: params
+    });
+  }
   async setCustomField(assetId, customFieldId, params) {
     return this.client.request({
       method: "PUT",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@air/api-rest",
-  "version": "0.3.0",
+  "version": "0.5.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.3.0"
+    "@air/api-core": "0.5.0"
   },
   "engines": {
     "node": ">=18"