# Documents

## List all documents

`documents.list(DocumentListParams**kwargs)  -> SyncCursorPagination[Document]`

**get** `/documents`

Retrieve a paginated list of documents using cursor-based pagination

### Parameters

- `after: Optional[str]`

  Cursor for forward pagination. Returns items after this cursor.

- `before: Optional[str]`

  Cursor for backward pagination. Returns items before this cursor.

- `household_id: Optional[str]`

  Filter documents by household ID

- `limit: Optional[int]`

  Maximum number of items to return

- `type: Optional[DocumentType]`

  Filter by document type

  - `"GRAT_DESIGN_SUMMARY"`

  - `"GENERATED_PRESENTATION"`

  - `"ASSET_VALUATION"`

  - `"SIGNED_TRUST_DOCUMENT"`

  - `"TRUST_AMENDMENT"`

  - `"TRANSFER_CONFIRMATION"`

  - `"EXISTING_REMAINDER_TRUST_DOCUMENT"`

  - `"BALANCE_SHEET"`

  - `"WILL"`

  - `"WILL_CODICIL"`

  - `"POWER_OF_ATTORNEY"`

  - `"ASSIGNMENT_OF_INTEREST"`

  - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"`

  - `"LOAN_NOTE_AGREEMENT"`

  - `"ARTICLES_OF_INCORPORATION"`

  - `"OPERATING_AGREEMENT"`

  - `"PARTNERSHIP_AGREEMENT"`

  - `"ACCOUNT_DOCUMENTATION_STATEMENT"`

  - `"TAX_ID_CONFIRMATION"`

  - `"GIFT_TAX_RETURN"`

  - `"INCOME_TAX_RETURN"`

  - `"TAX_RECEIPT"`

  - `"TAX_FILING"`

  - `"CORPORATE_BYLAWS"`

  - `"LLC_AGREEMENT"`

  - `"LLC_AGREEMENT_AMENDMENT"`

  - `"OPERATING_AGREEMENT_AMENDMENT"`

  - `"PARTNERSHIP_AGREEMENT_AMENDMENT"`

  - `"SHAREHOLDERS_AGREEMENT"`

  - `"STATE_BUSINESS_FILING"`

  - `"LOGGED_CONTRIBUTION"`

  - `"LOGGED_DISTRIBUTION"`

  - `"INSURANCE_POLICY"`

  - `"CRUMMEY_LETTER"`

  - `"INSURANCE_PREMIUM_PAYMENT"`

  - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"`

  - `"FINCEN_FILING"`

  - `"HEALTHCARE_PROXY"`

  - `"LIVING_WILL"`

  - `"DRIVERS_LICENSE"`

  - `"PASSPORT"`

  - `"DEED"`

  - `"OTHER"`

### Returns

- `class Document: …`

  - `id: str`

    Unique identifier with document_ prefix

  - `created_at: datetime`

    Timestamp when the document was created

  - `household_id: str`

    Household ID this document belongs to

  - `name: str`

    Display name of the document

  - `type: DocumentType`

    Type of document

    - `"GRAT_DESIGN_SUMMARY"`

    - `"GENERATED_PRESENTATION"`

    - `"ASSET_VALUATION"`

    - `"SIGNED_TRUST_DOCUMENT"`

    - `"TRUST_AMENDMENT"`

    - `"TRANSFER_CONFIRMATION"`

    - `"EXISTING_REMAINDER_TRUST_DOCUMENT"`

    - `"BALANCE_SHEET"`

    - `"WILL"`

    - `"WILL_CODICIL"`

    - `"POWER_OF_ATTORNEY"`

    - `"ASSIGNMENT_OF_INTEREST"`

    - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"`

    - `"LOAN_NOTE_AGREEMENT"`

    - `"ARTICLES_OF_INCORPORATION"`

    - `"OPERATING_AGREEMENT"`

    - `"PARTNERSHIP_AGREEMENT"`

    - `"ACCOUNT_DOCUMENTATION_STATEMENT"`

    - `"TAX_ID_CONFIRMATION"`

    - `"GIFT_TAX_RETURN"`

    - `"INCOME_TAX_RETURN"`

    - `"TAX_RECEIPT"`

    - `"TAX_FILING"`

    - `"CORPORATE_BYLAWS"`

    - `"LLC_AGREEMENT"`

    - `"LLC_AGREEMENT_AMENDMENT"`

    - `"OPERATING_AGREEMENT_AMENDMENT"`

    - `"PARTNERSHIP_AGREEMENT_AMENDMENT"`

    - `"SHAREHOLDERS_AGREEMENT"`

    - `"STATE_BUSINESS_FILING"`

    - `"LOGGED_CONTRIBUTION"`

    - `"LOGGED_DISTRIBUTION"`

    - `"INSURANCE_POLICY"`

    - `"CRUMMEY_LETTER"`

    - `"INSURANCE_PREMIUM_PAYMENT"`

    - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"`

    - `"FINCEN_FILING"`

    - `"HEALTHCARE_PROXY"`

    - `"LIVING_WILL"`

    - `"DRIVERS_LICENSE"`

    - `"PASSPORT"`

    - `"DEED"`

    - `"OTHER"`

  - `updated_at: datetime`

    Timestamp when the document was last updated

  - `enable_ai_suggestions: Optional[bool]`

    Whether this document should be used for AI suggestions

  - `entity_id: Optional[str]`

    Entity ID if this document is owned by an entity

  - `individual_id: Optional[str]`

    Individual ID if this document is associated with an individual

### Example

```python
from withluminary import Luminary

client = Luminary()
page = client.documents.list()
page = page.data[0]
print(page.id)
```

#### Response

```json
{
  "data": [
    {
      "id": "document_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2024-01-15T09:30:00Z",
      "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "name": "Trust Agreement.pdf",
      "type": "GRAT_DESIGN_SUMMARY",
      "updated_at": "2024-01-20T14:45:00Z",
      "enable_ai_suggestions": true,
      "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "individual_id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_previous_page": false,
    "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9",
    "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9"
  },
  "total_count": 100
}
```

## Upload a new document

`documents.create(DocumentCreateParams**kwargs)  -> Document`

**post** `/documents`

Create a new document with file content

### Parameters

- `file: FileTypes`

  The document file to upload

- `household_id: str`

  Household ID this document belongs to

- `name: str`

  Display name of the document

- `type: DocumentType`

  Type of document

  - `"GRAT_DESIGN_SUMMARY"`

  - `"GENERATED_PRESENTATION"`

  - `"ASSET_VALUATION"`

  - `"SIGNED_TRUST_DOCUMENT"`

  - `"TRUST_AMENDMENT"`

  - `"TRANSFER_CONFIRMATION"`

  - `"EXISTING_REMAINDER_TRUST_DOCUMENT"`

  - `"BALANCE_SHEET"`

  - `"WILL"`

  - `"WILL_CODICIL"`

  - `"POWER_OF_ATTORNEY"`

  - `"ASSIGNMENT_OF_INTEREST"`

  - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"`

  - `"LOAN_NOTE_AGREEMENT"`

  - `"ARTICLES_OF_INCORPORATION"`

  - `"OPERATING_AGREEMENT"`

  - `"PARTNERSHIP_AGREEMENT"`

  - `"ACCOUNT_DOCUMENTATION_STATEMENT"`

  - `"TAX_ID_CONFIRMATION"`

  - `"GIFT_TAX_RETURN"`

  - `"INCOME_TAX_RETURN"`

  - `"TAX_RECEIPT"`

  - `"TAX_FILING"`

  - `"CORPORATE_BYLAWS"`

  - `"LLC_AGREEMENT"`

  - `"LLC_AGREEMENT_AMENDMENT"`

  - `"OPERATING_AGREEMENT_AMENDMENT"`

  - `"PARTNERSHIP_AGREEMENT_AMENDMENT"`

  - `"SHAREHOLDERS_AGREEMENT"`

  - `"STATE_BUSINESS_FILING"`

  - `"LOGGED_CONTRIBUTION"`

  - `"LOGGED_DISTRIBUTION"`

  - `"INSURANCE_POLICY"`

  - `"CRUMMEY_LETTER"`

  - `"INSURANCE_PREMIUM_PAYMENT"`

  - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"`

  - `"FINCEN_FILING"`

  - `"HEALTHCARE_PROXY"`

  - `"LIVING_WILL"`

  - `"DRIVERS_LICENSE"`

  - `"PASSPORT"`

  - `"DEED"`

  - `"OTHER"`

- `enable_ai_suggestions: Optional[bool]`

  Whether this document should be used for AI suggestions

- `entity_id: Optional[str]`

  Entity ID if this document is owned by an entity

- `individual_id: Optional[str]`

  Individual ID if associated with an individual

### Returns

- `class Document: …`

  - `id: str`

    Unique identifier with document_ prefix

  - `created_at: datetime`

    Timestamp when the document was created

  - `household_id: str`

    Household ID this document belongs to

  - `name: str`

    Display name of the document

  - `type: DocumentType`

    Type of document

    - `"GRAT_DESIGN_SUMMARY"`

    - `"GENERATED_PRESENTATION"`

    - `"ASSET_VALUATION"`

    - `"SIGNED_TRUST_DOCUMENT"`

    - `"TRUST_AMENDMENT"`

    - `"TRANSFER_CONFIRMATION"`

    - `"EXISTING_REMAINDER_TRUST_DOCUMENT"`

    - `"BALANCE_SHEET"`

    - `"WILL"`

    - `"WILL_CODICIL"`

    - `"POWER_OF_ATTORNEY"`

    - `"ASSIGNMENT_OF_INTEREST"`

    - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"`

    - `"LOAN_NOTE_AGREEMENT"`

    - `"ARTICLES_OF_INCORPORATION"`

    - `"OPERATING_AGREEMENT"`

    - `"PARTNERSHIP_AGREEMENT"`

    - `"ACCOUNT_DOCUMENTATION_STATEMENT"`

    - `"TAX_ID_CONFIRMATION"`

    - `"GIFT_TAX_RETURN"`

    - `"INCOME_TAX_RETURN"`

    - `"TAX_RECEIPT"`

    - `"TAX_FILING"`

    - `"CORPORATE_BYLAWS"`

    - `"LLC_AGREEMENT"`

    - `"LLC_AGREEMENT_AMENDMENT"`

    - `"OPERATING_AGREEMENT_AMENDMENT"`

    - `"PARTNERSHIP_AGREEMENT_AMENDMENT"`

    - `"SHAREHOLDERS_AGREEMENT"`

    - `"STATE_BUSINESS_FILING"`

    - `"LOGGED_CONTRIBUTION"`

    - `"LOGGED_DISTRIBUTION"`

    - `"INSURANCE_POLICY"`

    - `"CRUMMEY_LETTER"`

    - `"INSURANCE_PREMIUM_PAYMENT"`

    - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"`

    - `"FINCEN_FILING"`

    - `"HEALTHCARE_PROXY"`

    - `"LIVING_WILL"`

    - `"DRIVERS_LICENSE"`

    - `"PASSPORT"`

    - `"DEED"`

    - `"OTHER"`

  - `updated_at: datetime`

    Timestamp when the document was last updated

  - `enable_ai_suggestions: Optional[bool]`

    Whether this document should be used for AI suggestions

  - `entity_id: Optional[str]`

    Entity ID if this document is owned by an entity

  - `individual_id: Optional[str]`

    Individual ID if this document is associated with an individual

### Example

```python
from withluminary import Luminary

client = Luminary()
document = client.documents.create(
    file=b"Example data",
    household_id="household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
    name="Trust Agreement.pdf",
    type="GRAT_DESIGN_SUMMARY",
)
print(document.id)
```

#### Response

```json
{
  "id": "document_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "created_at": "2024-01-15T09:30:00Z",
  "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "name": "Trust Agreement.pdf",
  "type": "GRAT_DESIGN_SUMMARY",
  "updated_at": "2024-01-20T14:45:00Z",
  "enable_ai_suggestions": true,
  "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "individual_id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV"
}
```

## Delete a document

`documents.delete(strid)`

**delete** `/documents/{id}`

Soft delete a document (marks as deleted but preserves data)

### Parameters

- `id: str`

### Example

```python
from withluminary import Luminary

client = Luminary()
client.documents.delete(
    "id",
)
```

## Get a document by ID

`documents.retrieve(strid)  -> Document`

**get** `/documents/{id}`

Retrieve document metadata

### Parameters

- `id: str`

### Returns

- `class Document: …`

  - `id: str`

    Unique identifier with document_ prefix

  - `created_at: datetime`

    Timestamp when the document was created

  - `household_id: str`

    Household ID this document belongs to

  - `name: str`

    Display name of the document

  - `type: DocumentType`

    Type of document

    - `"GRAT_DESIGN_SUMMARY"`

    - `"GENERATED_PRESENTATION"`

    - `"ASSET_VALUATION"`

    - `"SIGNED_TRUST_DOCUMENT"`

    - `"TRUST_AMENDMENT"`

    - `"TRANSFER_CONFIRMATION"`

    - `"EXISTING_REMAINDER_TRUST_DOCUMENT"`

    - `"BALANCE_SHEET"`

    - `"WILL"`

    - `"WILL_CODICIL"`

    - `"POWER_OF_ATTORNEY"`

    - `"ASSIGNMENT_OF_INTEREST"`

    - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"`

    - `"LOAN_NOTE_AGREEMENT"`

    - `"ARTICLES_OF_INCORPORATION"`

    - `"OPERATING_AGREEMENT"`

    - `"PARTNERSHIP_AGREEMENT"`

    - `"ACCOUNT_DOCUMENTATION_STATEMENT"`

    - `"TAX_ID_CONFIRMATION"`

    - `"GIFT_TAX_RETURN"`

    - `"INCOME_TAX_RETURN"`

    - `"TAX_RECEIPT"`

    - `"TAX_FILING"`

    - `"CORPORATE_BYLAWS"`

    - `"LLC_AGREEMENT"`

    - `"LLC_AGREEMENT_AMENDMENT"`

    - `"OPERATING_AGREEMENT_AMENDMENT"`

    - `"PARTNERSHIP_AGREEMENT_AMENDMENT"`

    - `"SHAREHOLDERS_AGREEMENT"`

    - `"STATE_BUSINESS_FILING"`

    - `"LOGGED_CONTRIBUTION"`

    - `"LOGGED_DISTRIBUTION"`

    - `"INSURANCE_POLICY"`

    - `"CRUMMEY_LETTER"`

    - `"INSURANCE_PREMIUM_PAYMENT"`

    - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"`

    - `"FINCEN_FILING"`

    - `"HEALTHCARE_PROXY"`

    - `"LIVING_WILL"`

    - `"DRIVERS_LICENSE"`

    - `"PASSPORT"`

    - `"DEED"`

    - `"OTHER"`

  - `updated_at: datetime`

    Timestamp when the document was last updated

  - `enable_ai_suggestions: Optional[bool]`

    Whether this document should be used for AI suggestions

  - `entity_id: Optional[str]`

    Entity ID if this document is owned by an entity

  - `individual_id: Optional[str]`

    Individual ID if this document is associated with an individual

### Example

```python
from withluminary import Luminary

client = Luminary()
document = client.documents.retrieve(
    "id",
)
print(document.id)
```

#### Response

```json
{
  "id": "document_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "created_at": "2024-01-15T09:30:00Z",
  "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "name": "Trust Agreement.pdf",
  "type": "GRAT_DESIGN_SUMMARY",
  "updated_at": "2024-01-20T14:45:00Z",
  "enable_ai_suggestions": true,
  "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "individual_id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV"
}
```

## Update a document

`documents.update(strid, DocumentUpdateParams**kwargs)  -> Document`

**put** `/documents/{id}`

Update document metadata only

### Parameters

- `id: str`

- `enable_ai_suggestions: Optional[bool]`

  Whether this document should be used for AI suggestions

- `entity_id: Optional[str]`

  Entity ID if this document is owned by an entity

- `individual_id: Optional[str]`

  Individual ID if associated with an individual

- `name: Optional[str]`

  Display name of the document

- `type: Optional[DocumentType]`

  Type of document

  - `"GRAT_DESIGN_SUMMARY"`

  - `"GENERATED_PRESENTATION"`

  - `"ASSET_VALUATION"`

  - `"SIGNED_TRUST_DOCUMENT"`

  - `"TRUST_AMENDMENT"`

  - `"TRANSFER_CONFIRMATION"`

  - `"EXISTING_REMAINDER_TRUST_DOCUMENT"`

  - `"BALANCE_SHEET"`

  - `"WILL"`

  - `"WILL_CODICIL"`

  - `"POWER_OF_ATTORNEY"`

  - `"ASSIGNMENT_OF_INTEREST"`

  - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"`

  - `"LOAN_NOTE_AGREEMENT"`

  - `"ARTICLES_OF_INCORPORATION"`

  - `"OPERATING_AGREEMENT"`

  - `"PARTNERSHIP_AGREEMENT"`

  - `"ACCOUNT_DOCUMENTATION_STATEMENT"`

  - `"TAX_ID_CONFIRMATION"`

  - `"GIFT_TAX_RETURN"`

  - `"INCOME_TAX_RETURN"`

  - `"TAX_RECEIPT"`

  - `"TAX_FILING"`

  - `"CORPORATE_BYLAWS"`

  - `"LLC_AGREEMENT"`

  - `"LLC_AGREEMENT_AMENDMENT"`

  - `"OPERATING_AGREEMENT_AMENDMENT"`

  - `"PARTNERSHIP_AGREEMENT_AMENDMENT"`

  - `"SHAREHOLDERS_AGREEMENT"`

  - `"STATE_BUSINESS_FILING"`

  - `"LOGGED_CONTRIBUTION"`

  - `"LOGGED_DISTRIBUTION"`

  - `"INSURANCE_POLICY"`

  - `"CRUMMEY_LETTER"`

  - `"INSURANCE_PREMIUM_PAYMENT"`

  - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"`

  - `"FINCEN_FILING"`

  - `"HEALTHCARE_PROXY"`

  - `"LIVING_WILL"`

  - `"DRIVERS_LICENSE"`

  - `"PASSPORT"`

  - `"DEED"`

  - `"OTHER"`

### Returns

- `class Document: …`

  - `id: str`

    Unique identifier with document_ prefix

  - `created_at: datetime`

    Timestamp when the document was created

  - `household_id: str`

    Household ID this document belongs to

  - `name: str`

    Display name of the document

  - `type: DocumentType`

    Type of document

    - `"GRAT_DESIGN_SUMMARY"`

    - `"GENERATED_PRESENTATION"`

    - `"ASSET_VALUATION"`

    - `"SIGNED_TRUST_DOCUMENT"`

    - `"TRUST_AMENDMENT"`

    - `"TRANSFER_CONFIRMATION"`

    - `"EXISTING_REMAINDER_TRUST_DOCUMENT"`

    - `"BALANCE_SHEET"`

    - `"WILL"`

    - `"WILL_CODICIL"`

    - `"POWER_OF_ATTORNEY"`

    - `"ASSIGNMENT_OF_INTEREST"`

    - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"`

    - `"LOAN_NOTE_AGREEMENT"`

    - `"ARTICLES_OF_INCORPORATION"`

    - `"OPERATING_AGREEMENT"`

    - `"PARTNERSHIP_AGREEMENT"`

    - `"ACCOUNT_DOCUMENTATION_STATEMENT"`

    - `"TAX_ID_CONFIRMATION"`

    - `"GIFT_TAX_RETURN"`

    - `"INCOME_TAX_RETURN"`

    - `"TAX_RECEIPT"`

    - `"TAX_FILING"`

    - `"CORPORATE_BYLAWS"`

    - `"LLC_AGREEMENT"`

    - `"LLC_AGREEMENT_AMENDMENT"`

    - `"OPERATING_AGREEMENT_AMENDMENT"`

    - `"PARTNERSHIP_AGREEMENT_AMENDMENT"`

    - `"SHAREHOLDERS_AGREEMENT"`

    - `"STATE_BUSINESS_FILING"`

    - `"LOGGED_CONTRIBUTION"`

    - `"LOGGED_DISTRIBUTION"`

    - `"INSURANCE_POLICY"`

    - `"CRUMMEY_LETTER"`

    - `"INSURANCE_PREMIUM_PAYMENT"`

    - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"`

    - `"FINCEN_FILING"`

    - `"HEALTHCARE_PROXY"`

    - `"LIVING_WILL"`

    - `"DRIVERS_LICENSE"`

    - `"PASSPORT"`

    - `"DEED"`

    - `"OTHER"`

  - `updated_at: datetime`

    Timestamp when the document was last updated

  - `enable_ai_suggestions: Optional[bool]`

    Whether this document should be used for AI suggestions

  - `entity_id: Optional[str]`

    Entity ID if this document is owned by an entity

  - `individual_id: Optional[str]`

    Individual ID if this document is associated with an individual

### Example

```python
from withluminary import Luminary

client = Luminary()
document = client.documents.update(
    id="id",
)
print(document.id)
```

#### Response

```json
{
  "id": "document_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "created_at": "2024-01-15T09:30:00Z",
  "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "name": "Trust Agreement.pdf",
  "type": "GRAT_DESIGN_SUMMARY",
  "updated_at": "2024-01-20T14:45:00Z",
  "enable_ai_suggestions": true,
  "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "individual_id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV"
}
```

## Get summaries for a document

`documents.get_summaries(strid)  -> DocumentGetSummariesResponse`

**get** `/documents/{id}/document-summaries`

Retrieve all summaries associated with a specific document

### Parameters

- `id: str`

### Returns

- `class DocumentGetSummariesResponse: …`

  - `data: List[DocumentSummary]`

    - `id: str`

      Unique identifier for the document summary

    - `created_at: datetime`

      Timestamp when the summary was created

    - `display_name: str`

      Display name for the summary

    - `document_id: str`

      ID of the document this summary belongs to

    - `household_id: str`

      ID of the household this summary belongs to

    - `summary: str`

      The summary text content

    - `updated_at: datetime`

      Timestamp when the summary was last updated

    - `entry_mode: Optional[DocumentSummaryEntryMode]`

      Indicates if the summary was AI-generated or user-entered

      - `"AI_AUTO"`

      - `"USER"`

    - `summary_format: Optional[DocumentSummaryFormat]`

      Format of the summary content

      - `"MARKDOWN"`

      - `"PLAIN_TEXT"`

### Example

```python
from withluminary import Luminary

client = Luminary()
response = client.documents.get_summaries(
    "id",
)
print(response.data)
```

#### Response

```json
{
  "data": [
    {
      "id": "document_summary_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2019-12-27T18:11:19.117Z",
      "display_name": "Default summary",
      "document_id": "document_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "summary": "summary",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "entry_mode": "AI_AUTO",
      "summary_format": "MARKDOWN"
    }
  ]
}
```

## Download document file content

`documents.download(strid)  -> BinaryResponseContent`

**get** `/documents/{id}/download`

Download the binary content of the document file

### Parameters

- `id: str`

### Returns

- `BinaryResponseContent`

### Example

```python
from withluminary import Luminary

client = Luminary()
response = client.documents.download(
    "id",
)
print(response)
content = response.read()
print(content)
```

## Domain Types

### Document

- `class Document: …`

  - `id: str`

    Unique identifier with document_ prefix

  - `created_at: datetime`

    Timestamp when the document was created

  - `household_id: str`

    Household ID this document belongs to

  - `name: str`

    Display name of the document

  - `type: DocumentType`

    Type of document

    - `"GRAT_DESIGN_SUMMARY"`

    - `"GENERATED_PRESENTATION"`

    - `"ASSET_VALUATION"`

    - `"SIGNED_TRUST_DOCUMENT"`

    - `"TRUST_AMENDMENT"`

    - `"TRANSFER_CONFIRMATION"`

    - `"EXISTING_REMAINDER_TRUST_DOCUMENT"`

    - `"BALANCE_SHEET"`

    - `"WILL"`

    - `"WILL_CODICIL"`

    - `"POWER_OF_ATTORNEY"`

    - `"ASSIGNMENT_OF_INTEREST"`

    - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"`

    - `"LOAN_NOTE_AGREEMENT"`

    - `"ARTICLES_OF_INCORPORATION"`

    - `"OPERATING_AGREEMENT"`

    - `"PARTNERSHIP_AGREEMENT"`

    - `"ACCOUNT_DOCUMENTATION_STATEMENT"`

    - `"TAX_ID_CONFIRMATION"`

    - `"GIFT_TAX_RETURN"`

    - `"INCOME_TAX_RETURN"`

    - `"TAX_RECEIPT"`

    - `"TAX_FILING"`

    - `"CORPORATE_BYLAWS"`

    - `"LLC_AGREEMENT"`

    - `"LLC_AGREEMENT_AMENDMENT"`

    - `"OPERATING_AGREEMENT_AMENDMENT"`

    - `"PARTNERSHIP_AGREEMENT_AMENDMENT"`

    - `"SHAREHOLDERS_AGREEMENT"`

    - `"STATE_BUSINESS_FILING"`

    - `"LOGGED_CONTRIBUTION"`

    - `"LOGGED_DISTRIBUTION"`

    - `"INSURANCE_POLICY"`

    - `"CRUMMEY_LETTER"`

    - `"INSURANCE_PREMIUM_PAYMENT"`

    - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"`

    - `"FINCEN_FILING"`

    - `"HEALTHCARE_PROXY"`

    - `"LIVING_WILL"`

    - `"DRIVERS_LICENSE"`

    - `"PASSPORT"`

    - `"DEED"`

    - `"OTHER"`

  - `updated_at: datetime`

    Timestamp when the document was last updated

  - `enable_ai_suggestions: Optional[bool]`

    Whether this document should be used for AI suggestions

  - `entity_id: Optional[str]`

    Entity ID if this document is owned by an entity

  - `individual_id: Optional[str]`

    Individual ID if this document is associated with an individual

### Document List

- `class DocumentList: …`

  - `data: List[Document]`

    - `id: str`

      Unique identifier with document_ prefix

    - `created_at: datetime`

      Timestamp when the document was created

    - `household_id: str`

      Household ID this document belongs to

    - `name: str`

      Display name of the document

    - `type: DocumentType`

      Type of document

      - `"GRAT_DESIGN_SUMMARY"`

      - `"GENERATED_PRESENTATION"`

      - `"ASSET_VALUATION"`

      - `"SIGNED_TRUST_DOCUMENT"`

      - `"TRUST_AMENDMENT"`

      - `"TRANSFER_CONFIRMATION"`

      - `"EXISTING_REMAINDER_TRUST_DOCUMENT"`

      - `"BALANCE_SHEET"`

      - `"WILL"`

      - `"WILL_CODICIL"`

      - `"POWER_OF_ATTORNEY"`

      - `"ASSIGNMENT_OF_INTEREST"`

      - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"`

      - `"LOAN_NOTE_AGREEMENT"`

      - `"ARTICLES_OF_INCORPORATION"`

      - `"OPERATING_AGREEMENT"`

      - `"PARTNERSHIP_AGREEMENT"`

      - `"ACCOUNT_DOCUMENTATION_STATEMENT"`

      - `"TAX_ID_CONFIRMATION"`

      - `"GIFT_TAX_RETURN"`

      - `"INCOME_TAX_RETURN"`

      - `"TAX_RECEIPT"`

      - `"TAX_FILING"`

      - `"CORPORATE_BYLAWS"`

      - `"LLC_AGREEMENT"`

      - `"LLC_AGREEMENT_AMENDMENT"`

      - `"OPERATING_AGREEMENT_AMENDMENT"`

      - `"PARTNERSHIP_AGREEMENT_AMENDMENT"`

      - `"SHAREHOLDERS_AGREEMENT"`

      - `"STATE_BUSINESS_FILING"`

      - `"LOGGED_CONTRIBUTION"`

      - `"LOGGED_DISTRIBUTION"`

      - `"INSURANCE_POLICY"`

      - `"CRUMMEY_LETTER"`

      - `"INSURANCE_PREMIUM_PAYMENT"`

      - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"`

      - `"FINCEN_FILING"`

      - `"HEALTHCARE_PROXY"`

      - `"LIVING_WILL"`

      - `"DRIVERS_LICENSE"`

      - `"PASSPORT"`

      - `"DEED"`

      - `"OTHER"`

    - `updated_at: datetime`

      Timestamp when the document was last updated

    - `enable_ai_suggestions: Optional[bool]`

      Whether this document should be used for AI suggestions

    - `entity_id: Optional[str]`

      Entity ID if this document is owned by an entity

    - `individual_id: Optional[str]`

      Individual ID if this document is associated with an individual

  - `page_info: PageInfo`

    - `has_next_page: bool`

      When paginating forwards, are there more items?

    - `has_previous_page: bool`

      When paginating backwards, are there more items?

    - `end_cursor: Optional[str]`

      Cursor pointing to the last item in the current page

    - `start_cursor: Optional[str]`

      Cursor pointing to the first item in the current page

  - `total_count: int`

    Total number of items matching the query (across all pages)

### Document Type

- `Literal["GRAT_DESIGN_SUMMARY", "GENERATED_PRESENTATION", "ASSET_VALUATION", 40 more]`

  Type of document

  - `"GRAT_DESIGN_SUMMARY"`

  - `"GENERATED_PRESENTATION"`

  - `"ASSET_VALUATION"`

  - `"SIGNED_TRUST_DOCUMENT"`

  - `"TRUST_AMENDMENT"`

  - `"TRANSFER_CONFIRMATION"`

  - `"EXISTING_REMAINDER_TRUST_DOCUMENT"`

  - `"BALANCE_SHEET"`

  - `"WILL"`

  - `"WILL_CODICIL"`

  - `"POWER_OF_ATTORNEY"`

  - `"ASSIGNMENT_OF_INTEREST"`

  - `"ASSIGNMENT_OF_TANGIBLE_PROPERTY"`

  - `"LOAN_NOTE_AGREEMENT"`

  - `"ARTICLES_OF_INCORPORATION"`

  - `"OPERATING_AGREEMENT"`

  - `"PARTNERSHIP_AGREEMENT"`

  - `"ACCOUNT_DOCUMENTATION_STATEMENT"`

  - `"TAX_ID_CONFIRMATION"`

  - `"GIFT_TAX_RETURN"`

  - `"INCOME_TAX_RETURN"`

  - `"TAX_RECEIPT"`

  - `"TAX_FILING"`

  - `"CORPORATE_BYLAWS"`

  - `"LLC_AGREEMENT"`

  - `"LLC_AGREEMENT_AMENDMENT"`

  - `"OPERATING_AGREEMENT_AMENDMENT"`

  - `"PARTNERSHIP_AGREEMENT_AMENDMENT"`

  - `"SHAREHOLDERS_AGREEMENT"`

  - `"STATE_BUSINESS_FILING"`

  - `"LOGGED_CONTRIBUTION"`

  - `"LOGGED_DISTRIBUTION"`

  - `"INSURANCE_POLICY"`

  - `"CRUMMEY_LETTER"`

  - `"INSURANCE_PREMIUM_PAYMENT"`

  - `"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"`

  - `"FINCEN_FILING"`

  - `"HEALTHCARE_PROXY"`

  - `"LIVING_WILL"`

  - `"DRIVERS_LICENSE"`

  - `"PASSPORT"`

  - `"DEED"`

  - `"OTHER"`

### Document Get Summaries Response

- `class DocumentGetSummariesResponse: …`

  - `data: List[DocumentSummary]`

    - `id: str`

      Unique identifier for the document summary

    - `created_at: datetime`

      Timestamp when the summary was created

    - `display_name: str`

      Display name for the summary

    - `document_id: str`

      ID of the document this summary belongs to

    - `household_id: str`

      ID of the household this summary belongs to

    - `summary: str`

      The summary text content

    - `updated_at: datetime`

      Timestamp when the summary was last updated

    - `entry_mode: Optional[DocumentSummaryEntryMode]`

      Indicates if the summary was AI-generated or user-entered

      - `"AI_AUTO"`

      - `"USER"`

    - `summary_format: Optional[DocumentSummaryFormat]`

      Format of the summary content

      - `"MARKDOWN"`

      - `"PLAIN_TEXT"`