Skip to main content

Content & Resource Management

The Content & Resource Management submodule handles file operations, project notebook management, order tracking, and account resource monitoring within the DashClicks platform.

API Endpoints Overview

MethodEndpointDescription
GET/v1/accounts/filesGet account files
POST/v1/accounts/filesCreate account file
PUT/v1/accounts/filesUpdate account file
DELETE/v1/accounts/filesDelete account file
DELETE/v1/accounts/multiple-filesDelete multiple account files
GET/v1/accounts/notebooksGet account notebooks
POST/v1/accounts/notebooksCreate account notebook
PUT/v1/accounts/notebooksUpdate account notebook
DELETE/v1/accounts/notebooksDelete account notebook
GET/v1/accounts/ordersGet account orders
GET/v1/accounts/pocGet point-of-contact info

MongoDB Collections Used

Content Collections

  • projects-files - Account project files and documents
  • projects-notebooks - Account project notebooks and content
  • _store.orders - Store orders associated with accounts

Resource Collections

  • _accounts - Account records with resource usage and settings
  • crm.contacts - Contact information for point-of-contact services

Content Management Workflows

File Management Flow

graph TD
A[File Upload Request] --> B[Validate File Parameters]
B --> C[Store File Metadata]
C --> D[Upload to Wasabi Storage]
D --> E[Generate File Record]
E --> F[Update Account Association]
F --> G[Return File Information]

Notebook Management Flow

graph TD
A[Notebook Creation] --> B[Validate Content Structure]
B --> C[Create Notebook Record]
C --> D[Process Attachments]
D --> E[Link to Account/Project]
E --> F[Save Content Data]
F --> G[Return Notebook Details]

Order Tracking Flow

graph TD
A[Order Query Request] --> B[Apply Filters & Search]
B --> C[Retrieve Order Data]
C --> D[Generate Onboarding Links]
D --> E[Apply Admin Filters]
E --> F[Format Order Response]
F --> G[Return Paginated Results]

Service Methods & Functionality

File Management Services

getFiles() / createFiles() / updateFiles() / deleteFiles() / deleteMultipleFiles() - File operations

  • getFiles(): Retrieves account files with search and pagination support

    • Supports search term filtering across file names and metadata
    • Provides pagination with configurable page size and navigation
    • Returns file metadata including storage keys, sizes, and types
    • Includes account association and permission validation
  • createFiles(): Creates new file records with Wasabi cloud storage integration

    • Validates file parameters including size, type, and storage keys
    • Integrates with Wasabi cloud storage for secure file storage
    • Creates file metadata records with account and user associations
    • Returns created file information with storage confirmation
  • updateFiles(): Updates existing file metadata and properties

    • Modifies file metadata including names, descriptions, and categories
    • Handles file property updates with validation and authorization
    • Maintains file version history and change tracking
    • Returns updated file information with modification confirmation
  • deleteFiles(): Deletes individual files with permission validation

    • Validates user permissions for file deletion operations
    • Removes file records and associated metadata
    • Handles cloud storage cleanup and file removal
    • Returns deletion confirmation with operation status
  • deleteMultipleFiles(): Bulk deletion of multiple files with batch processing

    • Processes multiple file deletions in a single operation
    • Validates permissions for each file in the deletion batch
    • Handles batch cloud storage cleanup and optimization
    • Returns batch deletion results with individual file statuses

Notebook Management Services

getNotebooks() / createNotebooks() / updateNotebooks() / deleteNotebooks() - Notebook operations

  • getNotebooks(): Retrieves project notebooks with search and pagination

    • Supports search across notebook titles, descriptions, and content
    • Provides pagination for efficient notebook browsing
    • Returns notebook metadata including creation dates and authors
    • Includes attachment information and content previews
  • createNotebooks(): Creates new notebooks with title, description, and content

    • Validates notebook structure and content formatting
    • Handles attachment processing and file associations
    • Creates notebook records with account and project linking
    • Returns created notebook information with content confirmation
  • updateNotebooks(): Updates existing notebook content and metadata

    • Modifies notebook titles, descriptions, and content structure
    • Handles attachment updates and file relationship changes
    • Maintains notebook version history and revision tracking
    • Returns updated notebook information with change confirmation
  • deleteNotebooks(): Deletes notebooks with proper cleanup

    • Removes notebook records and associated content data
    • Handles attachment cleanup and file dissociation
    • Validates deletion permissions and account ownership
    • Returns deletion confirmation with cleanup status

Order Management Services

getOrders() - Account order management

  • Retrieves account orders with comprehensive filtering and pagination support
  • Supports filtering by date range, onboarding status, product type, and setup status
  • Includes order inactivity filtering for account management and follow-up
  • Provides product-specific filtering for targeted order management
  • Generates onboarding links for orders with form and recipient data
  • Integrates with admin filters for enhanced order management capabilities
  • Returns paginated order data with administrative filters and detailed metadata

Support Services

getPoc() - Point-of-contact information retrieval

  • Retrieves point-of-contact information for account support and communication
  • Provides contact details for account management and customer service
  • Includes primary contact information and communication preferences
  • Supports contact validation and information verification
  • Returns comprehensive contact information for support operations

Technical Implementation Details

File Storage Integration

  • Wasabi Cloud Storage: Secure cloud storage integration for file management
  • Metadata Management: Comprehensive file metadata storage and retrieval
  • Permission System: Role-based permission system for file access and operations
  • Storage Optimization: Efficient storage management with cleanup and optimization

Content Processing

  • Search Integration: Full-text search across file names, notebook content, and metadata
  • Pagination Framework: Efficient pagination for large content datasets
  • Version Control: Content version tracking and revision management
  • Attachment Handling: Comprehensive attachment processing and file relationships

Order Integration

  • Filter System: Advanced filtering system for order management and tracking
  • Onboarding Integration: Automatic onboarding link generation for order fulfillment
  • Admin Integration: Integration with administrative filters and management tools
  • Status Tracking: Comprehensive order status tracking and management

Business Logic Implementation

File Management Workflow

  1. Permission Validation: Validate user permissions for file operations
  2. Parameter Validation: Validate file parameters and metadata
  3. Storage Integration: Process file storage with cloud storage services
  4. Metadata Creation: Create comprehensive file metadata records
  5. Account Association: Link files with account and project associations
  6. Status Management: Update file status and operation confirmation
  7. Cleanup Processing: Handle file cleanup and storage optimization

Notebook Management Workflow

  1. Content Validation: Validate notebook content structure and formatting
  2. Attachment Processing: Process notebook attachments and file relationships
  3. Account Linking: Link notebooks with account and project associations
  4. Version Management: Handle notebook versioning and revision tracking
  5. Search Indexing: Index notebook content for search and discovery
  6. Permission Management: Apply permission controls for notebook access
  7. Status Updates: Update notebook status and operation confirmation

Key Features

Comprehensive File Management

  • Cloud Storage Integration: Secure file storage with Wasabi cloud integration
  • Bulk Operations: Efficient bulk file operations with batch processing
  • Search Capabilities: Full-text search across file names and metadata
  • Permission System: Granular permission system for file access control

Advanced Notebook System

  • Rich Content Support: Support for rich content notebooks with attachments
  • Version Control: Comprehensive version tracking and revision management
  • Search Integration: Full-text search across notebook titles and content
  • Project Integration: Seamless integration with project management workflows

Order Management Integration

  • Advanced Filtering: Comprehensive order filtering with multiple criteria
  • Onboarding Automation: Automatic onboarding link generation for orders
  • Status Tracking: Real-time order status tracking and management
  • Admin Integration: Integration with administrative management tools

Resource Monitoring

  • Usage Tracking: Comprehensive resource usage monitoring and reporting
  • Storage Management: Efficient storage management with optimization features
  • Performance Monitoring: Real-time performance monitoring and optimization
  • Contact Management: Comprehensive point-of-contact information management
💬

Documentation Assistant

Ask me anything about the docs

Hi! I'm your documentation assistant. Ask me anything about the docs!

I can help you with:
- Code examples
- Configuration details
- Troubleshooting
- Best practices

Try asking: How do I configure the API?
09:31 AM