@bit-ui-libs/common/src/lib/users/services/documents.service.interfaces.ts

This library was generated with [Nx](https://nx.dev).

import { FilteredRequest } from '../../common';
import { DocumentStatusEnum } from '../enums';
import { DocumentsService } from './documents.service';

export interface WithDocumentsService {
  documents: DocumentsService;
}

export type ListDocumentsRequest = FilteredRequest<{
  docId?: string;
  userId?: string;
  typeId?: string;
  status?: DocumentStatusEnum;
}>;

// Documents API has a simpler model for Attachments,
// as opposed to the the other AttachmentData from common
export interface BitDocumentAttachmentData {
  name: string;
  data?: string;
  url?: string;
}

export interface AddDocumentRequest {
  docId?: string;
  profileId: string;
  userId?: string;
  typeId?: number;
  // Despite being defined as optional in the API,
  // the backend still requires this, for some reason
  number: string;
  attachments?: BitDocumentAttachmentData[];
}

export interface EditDocumentRequest {
  docId: string;
  profileId: string;
  typeId: number;
  number: string;
  attachments: BitDocumentAttachmentData[];
}