@air/api-rest 0.1.1

package/dist/index.d.cts

@@ -0,0 +1,400 @@
+import { CursorPageParams, AirBase, PagePromise, AirBaseOptions } from '@air/api-core';
+export { APIError, AirBase, AirBaseOptions, AuthenticationError, BadRequestError, ConnectionError, CursorPage, CursorPageParams, CursorPageResponse, InternalServerError, NotFoundError, PagePromise, PermissionError, RateLimitError, RequestOptions, TimeoutError, VERSION } from '@air/api-core';
+
+interface Tag {
+    id: string;
+    name: string;
+}
+interface TagListParams extends CursorPageParams {
+    name?: string;
+}
+interface TagCreateParams {
+    name: string;
+}
+interface TagUpdateParams {
+    name?: string;
+}
+
+interface SmartTag {
+    name: string;
+}
+interface AssetCustomFieldValue {
+    id: string;
+    name: string;
+    type: string;
+    value: string | null;
+    values: {
+        id: string;
+        name: string;
+    }[] | null;
+}
+interface AssetVersionUrls {
+    thumbnail: string | null;
+    preview: string | null;
+}
+interface AssetVersion {
+    id: string;
+    fileName: string;
+    ext: string;
+    title: string;
+    description: string | null;
+    summary: string | null;
+    type: string;
+    createdAt: string;
+    updatedAt: string;
+    fileCreatedAt: string | null;
+    width: number | null;
+    height: number | null;
+    duration: number | undefined;
+    size: number;
+    smartTags: SmartTag[];
+    tags: Tag[] | undefined;
+    urls: AssetVersionUrls;
+}
+interface Asset {
+    id: string;
+    customFields: AssetCustomFieldValue[] | undefined;
+    coverVersion: AssetVersion;
+}
+interface AssetListParams extends CursorPageParams {
+    parentBoardId?: string;
+    includeNestedAssets?: boolean;
+    tag?: string | string[];
+    customField?: string | string[];
+    search?: string;
+    "createdAt[gte]"?: string;
+    "createdAt[lte]"?: string;
+}
+interface AssetVersionUpdateParams {
+    title?: string;
+    description?: string;
+}
+interface SetCustomFieldParams {
+    value?: string | null;
+    values?: {
+        id: string;
+    }[] | null;
+}
+interface AddVersionTagParams {
+    id: string;
+}
+interface AssetVersionDownloadUrl {
+    url: string;
+}
+interface AssetBoardListParams extends CursorPageParams {
+    includeCustomFields?: boolean;
+}
+interface AssetVersionListResponse {
+    data: AssetVersion[];
+    total: number;
+}
+
+interface Board {
+    id: string;
+    parentBoardId: string | null;
+    title: string;
+    description: string | null;
+    createdAt: string;
+    updatedAt: string;
+    customFields: AssetCustomFieldValue[] | undefined;
+}
+interface BoardListParams extends CursorPageParams {
+    name?: string;
+    parentBoardId?: string;
+    customField?: string | string[];
+}
+interface BoardCreateParams {
+    title: string;
+    description?: string;
+    parentBoardId?: string;
+}
+interface BoardUpdateParams {
+    title?: string;
+    description?: string;
+    parentBoardId?: string | null;
+}
+interface AddBoardAssetsParams {
+    assetIds: string[];
+}
+interface SetBoardCustomFieldParams {
+    value?: string | null;
+    values?: {
+        id: string;
+    }[] | null;
+}
+interface Guest {
+    id: string;
+    email: string;
+    roleId: string;
+    boardId: string;
+}
+interface AddGuestParams {
+    email: string;
+    roleId: string;
+}
+interface UpdateGuestParams {
+    roleId: string;
+}
+interface GuestListParams {
+    email?: string;
+}
+interface GuestListResponse {
+    data: Guest[];
+}
+
+declare class Assets {
+    private client;
+    constructor(client: AirBase);
+    list(params?: AssetListParams): PagePromise<Asset>;
+    get(assetId: string): Promise<Asset>;
+    delete(assetId: string): Promise<void>;
+    setCustomField(assetId: string, customFieldId: string, params: SetCustomFieldParams): Promise<void>;
+    listVersions(assetId: string): Promise<AssetVersionListResponse>;
+    getVersion(assetId: string, versionId: string): Promise<AssetVersion>;
+    updateVersion(assetId: string, versionId: string, params: AssetVersionUpdateParams): Promise<void>;
+    getVersionDownloadUrl(assetId: string, versionId: string): Promise<AssetVersionDownloadUrl>;
+    addVersionTag(assetId: string, versionId: string, params: AddVersionTagParams): Promise<AssetVersion>;
+    removeVersionTag(assetId: string, versionId: string, tagId: string): Promise<void>;
+    listBoards(assetId: string, params?: AssetBoardListParams): PagePromise<Board>;
+}
+
+declare class Boards {
+    private client;
+    constructor(client: AirBase);
+    list(params?: BoardListParams): PagePromise<Board>;
+    get(boardId: string): Promise<Board>;
+    create(params: BoardCreateParams): Promise<Board>;
+    update(boardId: string, params: BoardUpdateParams): Promise<void>;
+    delete(boardId: string): Promise<void>;
+    addAssets(boardId: string, params: AddBoardAssetsParams): Promise<void>;
+    removeAsset(boardId: string, assetId: string): Promise<void>;
+    setCustomField(boardId: string, customFieldId: string, params: SetBoardCustomFieldParams): Promise<void>;
+    addGuest(boardId: string, params: AddGuestParams): Promise<Guest>;
+    listGuests(boardId: string, params?: GuestListParams): Promise<Guest[]>;
+    updateGuest(boardId: string, guestId: string, params: UpdateGuestParams): Promise<void>;
+    removeGuest(boardId: string, guestId: string): Promise<void>;
+}
+
+type CustomFieldType = "single-select" | "multi-select" | "plain-text" | "date";
+interface CustomFieldValue {
+    id: string;
+    name: string;
+}
+interface CustomField {
+    id: string;
+    name: string;
+    description: string | null;
+    type: CustomFieldType;
+    values: CustomFieldValue[] | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CustomFieldListParams extends CursorPageParams {
+}
+interface CustomFieldCreateParams {
+    name: string;
+    description?: string;
+    type: CustomFieldType;
+    values?: {
+        name: string;
+    }[];
+}
+interface CustomFieldUpdateParams {
+    name?: string;
+    description?: string;
+}
+interface CustomFieldValueCreateParams {
+    name: string;
+}
+interface CustomFieldValueUpdateParams {
+    name?: string;
+}
+
+declare class CustomFields {
+    private client;
+    constructor(client: AirBase);
+    list(params?: CustomFieldListParams): PagePromise<CustomField>;
+    get(customFieldId: string): Promise<CustomField>;
+    create(params: CustomFieldCreateParams): Promise<CustomField>;
+    update(customFieldId: string, params: CustomFieldUpdateParams): Promise<void>;
+    delete(customFieldId: string): Promise<void>;
+    createValue(customFieldId: string, params: CustomFieldValueCreateParams): Promise<CustomFieldValue>;
+    updateValue(customFieldId: string, valueId: string, params: CustomFieldValueUpdateParams): Promise<void>;
+    deleteValue(customFieldId: string, valueId: string): Promise<void>;
+}
+
+interface ImportCreateParams {
+    sourceUrl: string;
+    fileName?: string;
+    ext?: string;
+    recordedAt?: string;
+    parentBoardId?: string;
+    assetId?: string;
+    description?: string;
+    title?: string;
+    customFields?: {
+        id: string;
+        value?: string | null;
+        values?: {
+            id: string;
+        }[] | null;
+    }[] | null;
+    tags?: {
+        id: string;
+    }[] | null;
+}
+interface ImportCreateResponse {
+    id: string;
+    assetId: string;
+    versionId: string;
+}
+type ImportStatus = "pending" | "inProgress" | "succeeded" | "failed";
+interface ImportStatusResponse {
+    status: ImportStatus;
+    error?: {
+        type: string;
+        message: string;
+    };
+}
+
+declare class Imports {
+    private client;
+    constructor(client: AirBase);
+    create(params: ImportCreateParams): Promise<ImportCreateResponse>;
+    getStatus(importId: string): Promise<ImportStatusResponse>;
+}
+
+interface Role {
+    id: string;
+    name: string;
+    description: string;
+    billable: boolean;
+    type: string;
+}
+interface RoleListParams {
+    type: "guest";
+}
+interface RoleListResponse {
+    data: Role[];
+}
+
+declare class Roles {
+    private client;
+    constructor(client: AirBase);
+    list(params?: RoleListParams): Promise<Role[]>;
+}
+
+declare class Tags {
+    private client;
+    constructor(client: AirBase);
+    list(params?: TagListParams): PagePromise<Tag>;
+    get(tagId: string): Promise<Tag>;
+    create(params: TagCreateParams): Promise<Tag>;
+    update(tagId: string, params: TagUpdateParams): Promise<void>;
+    delete(tagId: string): Promise<void>;
+}
+
+interface UploadCreateParams {
+    fileName: string;
+    ext: string;
+    size: number;
+    mime: string;
+    recordedAt?: string;
+    parentBoardId?: string;
+    assetId?: string;
+    customFields?: {
+        id: string;
+        value?: string | null;
+        values?: {
+            id: string;
+        }[] | null;
+    }[] | null;
+    tags?: {
+        id: string;
+    }[] | null;
+}
+interface SmallUploadResponse {
+    assetId: string;
+    versionId: string;
+    uploadUrl: string;
+}
+interface LargeUploadResponse {
+    assetId: string;
+    versionId: string;
+    multiPartUploadId: string;
+    key: string;
+}
+type UploadCreateResponse = SmallUploadResponse | LargeUploadResponse;
+interface GetPartUploadUrlParams {
+    multiPartUploadId: string;
+    key: string;
+    partNumber: number;
+}
+interface GetPartUploadUrlResponse {
+    url: string;
+}
+interface CompleteMultipartParams {
+    multiPartUploadId: string;
+    key: string;
+    parts: {
+        etag: string;
+        partNumber: number;
+    }[];
+}
+interface UploadFileParams {
+    filePath?: string;
+    buffer?: Buffer | ArrayBuffer;
+    file?: File;
+    fileName?: string;
+    ext?: string;
+    mime?: string;
+}
+interface UploadFileOptions {
+    parentBoardId?: string;
+    assetId?: string;
+    customFields?: {
+        id: string;
+        value?: string | null;
+        values?: {
+            id: string;
+        }[] | null;
+    }[] | null;
+    tags?: {
+        id: string;
+    }[] | null;
+    onProgress?: (progress: {
+        percentage: number;
+        uploadedBytes: number;
+        totalBytes: number;
+    }) => void;
+}
+interface UploadFileResponse {
+    assetId: string;
+    versionId: string;
+}
+
+declare class Uploads {
+    private client;
+    constructor(client: AirBase);
+    create(params: UploadCreateParams): Promise<UploadCreateResponse>;
+    getPartUploadUrl(params: GetPartUploadUrlParams): Promise<GetPartUploadUrlResponse>;
+    completeMultipart(params: CompleteMultipartParams): Promise<void>;
+    uploadFile(params: UploadFileParams, options?: UploadFileOptions): Promise<UploadFileResponse>;
+    private _uploadSmallFile;
+    private _uploadLargeFile;
+}
+
+interface AirApiOptions extends AirBaseOptions {
+}
+declare class AirApi extends AirBase {
+    readonly assets: Assets;
+    readonly boards: Boards;
+    readonly tags: Tags;
+    readonly customFields: CustomFields;
+    readonly roles: Roles;
+    readonly imports: Imports;
+    readonly uploads: Uploads;
+    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 GetPartUploadUrlParams, type GetPartUploadUrlResponse, type Guest, type GuestListParams, type GuestListResponse, type ImportCreateParams, type ImportCreateResponse, type ImportStatus, type ImportStatusResponse, Imports, type LargeUploadResponse, 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 };