Migration Guide

# Find all read_data calls
grep -rn "read_data(" --include="*.py" .

# intapp-rest-client: same client with a context manager
from intapp_rest_client import RestClient, OAuth2Config
 
site = "yoursite.dealcloud.com"
with RestClient(
    base_url=f"https://{site}/",
    oauth2_config=OAuth2Config(
        token_url=f"https://{site}/api/rest/v1/oauth/token",
        client_id="your_client_id",
        client_secret="your_client_secret",
        scope="data",
    ),
) as client:
    rows = client.post(
        "/api/rest/v4/data/entrydata/rows/query",
        json={
            "objectApiName": "Company",
            "query": "Status = 'Active'",
        },
    )

from dealcloud_sdk import DealCloud
 
# After setting DEALCLOUD_* environment variables (see Configuration files doc)
dc = DealCloud.from_env()
 
# Legacy JSON: only credentials (snake_case)
dc = DealCloud.from_json("credentials.json")
 
# Legacy YAML: only credentials
dc = DealCloud.from_yaml("credentials.yaml")

{
  "site_url": "yoursite.dealcloud.com",
  "client_id": "12345",
  "client_secret": "your-secret"
}

from dealcloud_sdk import DealCloud
 
dc = DealCloud.from_config("dealcloud.json")
# or: DealCloud.from_config("dealcloud.yaml")

{
  "siteUrl": "yoursite.dealcloud.com",
  "clientId": "12345",
  "clientSecret": "your-secret",
  "connectorTimeoutSeconds": 100,
  "querySettings": {
    "pageSize": 1000,
    "cellPaginationLimit": 9000,
    "deletePageSize": 5000
  },
  "concurrencyLimits": {
    "read": 2,
    "delete": 2,
    "create": 2
  },
  "responseRetrySettings": {
    "tooManyRequests": 5,
    "backoffFactor": 2.0
  }
}

from dealcloud_sdk import DealCloud
from dealcloud_sdk.models import (
    DealCloudConfig,
    QuerySettings,
    ConcurrencyLimits,
    ResponseRetrySettings,
)
 
config = DealCloudConfig(
    siteUrl="yoursite.dealcloud.com",
    clientId="12345",
    clientSecret="your-secret",
    connectorTimeoutSeconds=120,
    querySettings=QuerySettings(pageSize=2000),
    concurrencyLimits=ConcurrencyLimits(read=2, delete=2, create=2),
    responseRetrySettings=ResponseRetrySettings(
        tooManyRequests=8,
        backoffFactor=2.0,
    ),
)
 
dc = DealCloud.from_config_object(config)

# Examples: add Polars, YAML config parsing, and S3 for fsspec URIs
pip install "dealcloud-sdk[polars,yaml,s3]"
# uv: uv add "dealcloud-sdk[polars,yaml,s3]"

# Process millions of rows without loading all into memory
for company in dc.read_data_streaming("Company"):
    process(company)
 
# Async version
async for company in dc.aread_data_streaming("Company"):
    await process_async(company)

from pydantic import BaseModel
from typing import Optional
 
class Company(BaseModel):
    EntryId: int
    CompanyName: str
    Industry: Optional[str] = None
 
# Read as typed models
companies = dc.typed_read_data(Company, object_id="Company")
 
for c in companies:
    print(c.CompanyName)  # Full IDE autocomplete!

from datetime import datetime, timedelta
 
# Get what changed since last sync
last_sync = datetime.now() - timedelta(hours=1)
result = dc.sync_delta("Company", last_sync)
 
print(f"Modified: {len(result.modified_ids)}")
print(f"Deleted: {len(result.deleted_ids)}")
 
# Process changes
for row in result.modified_data:
    your_db.upsert(row)
 
for entry_id in result.deleted_ids:
    your_db.delete(entry_id)

from dealcloud_sdk import ReferenceFormat, ReferenceCache
 
# Create a cache for efficient lookups
cache = ReferenceCache(max_entries=10000)
 
# Get just the display names
contacts = dc.read_data(
    "Contact",
    output="pandas",
    reference_format=ReferenceFormat.NAME,
    reference_cache=cache
)
# contacts["Company"] = "Acme Corp" instead of full object

# Export all company logos
result = dc.export_images(
    "./backup/logos",
    object_id="Company",
    field_ids=["Logo"]
)
print(f"Exported {result.exported} images")
 
# Export all documents
result = dc.export_documents("./backup/documents")