Struct DocumentsClient 

pub struct DocumentsClient {
    pub http_client: HttpClient,
}

Fields

http_client: HttpClient

Implementations

impl DocumentsClient

pub fn new(config: ClientConfig) -> Result<Self, ApiError>

pub async fn list_documents( &self, request: &ListDocumentsQueryRequest, options: Option<RequestOptions>, ) -> Result<PaginatedResponseDocumentResponse, ApiError>

Retrieve all documents linked to a client.

Arguments

• order_by - Field to order the results by, e.g., ‘created_at:desc,updated_at:asc’
• q - Query string for filtering. Format: “field:operator:value;…”. Supported fields: id, client_id, loan_id, installment_id, waterfall_id, category, file_name, document_date, folder_path. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
• options - Additional request options such as headers, timeout, etc.

Returns

JSON response from the API

pub async fn upload_document( &self, request: &UploadDocumentRequest, options: Option<RequestOptions>, ) -> Result<DocumentResponse, ApiError>

Upload a new document related to a client or loan, such as financial statements or KYC files.

Arguments

• options - Additional request options such as headers, timeout, etc.

Returns

JSON response from the API

pub async fn get_available_document_categories( &self, options: Option<RequestOptions>, ) -> Result<AvailableDocumentCategoriesResponse, ApiError>

Retrieve all available document categories.

Arguments

• options - Additional request options such as headers, timeout, etc.

Returns

JSON response from the API

pub async fn get_document_by_id( &self, document_id: &str, options: Option<RequestOptions>, ) -> Result<DocumentResponse, ApiError>

Retrieve details for a specific document using its document ID.

Arguments

• options - Additional request options such as headers, timeout, etc.

Returns

JSON response from the API

pub async fn delete_document( &self, document_id: &str, options: Option<RequestOptions>, ) -> Result<(), ApiError>

Delete a specific document by using its document ID.

Arguments

• options - Additional request options such as headers, timeout, etc.

Returns

Empty response