How alliance-gravity/xandr-sdk works
Xandr SDK is a TypeScript client for Xandr APIs. A consumer creates XandrClient with credentials, then uses its resource-specific clients; those clients issue operations through the shared request/authentication layer and receive typed results. The package documents token refresh and HTTP 429 handling, and includes a batch-segment upload capability alongside campaign, audience, reporting, and reference-data APIs. Several resource clients are represented from the tree and README rather than inspected source, so their individual operations and internal links are not inferred.
Main entry points: src/index.ts Xandr client · utils.ts Auth and requests · advertiser/index.ts Advertisers · insertion-order/index.ts Insertion orders
Components 24
Client and transport
- Xandr client
src/index.ts - Auth and requests
src/utils.ts - API errors
src/errors.ts - Shared API types
src/xandr-types.ts
Campaign resources
- Advertisers
src/advertiser/index.ts - Insertion orders
src/insertion-order/index.ts - Line items
src/line-item/index.ts - Placements
src/placement/index.ts - Publishers
src/publisher/index.ts
Audience and inventory
- Segments
src/segment/index.ts - Audience targeting
src/apd/index.ts - Batch segment upload
src/bss/index.ts - Inventory lists
src/inventory-list/index.ts - Domain lists
src/domain-list/index.ts - Custom models
src/custom-model/index.ts - Segment billing
src/segment-billing-category/index.ts
Reporting and reference data
- Reports
src/report/index.ts - Geographic data
src/city/index.ts - DMA data
src/dma/index.ts - Region data
src/region/index.ts - Currency data
src/currency/index.ts - Sites
src/site/index.ts
Other components
- SDK consumer
- Xandr APIs
Connections 39
- SDK consumer → Xandr client: configures
src/index.ts - Xandr client → Auth and requests: authenticates and requests
src/index.ts - Xandr client → Advertisers: exposes
src/index.ts - Xandr client → Insertion orders: exposes
src/index.ts - Xandr client → Line items: exposes
src/index.ts - Xandr client → Placements: exposes
src/index.ts - Xandr client → Publishers: exposes
src/index.ts - Xandr client → Segments: exposes
src/index.ts - Xandr client → Audience targeting: exposes
src/index.ts - Xandr client → Batch segment upload: exposes
src/index.ts - Xandr client → Inventory lists: exposes
src/index.ts - Xandr client → Domain lists: exposes
src/index.ts - Xandr client → Custom models: exposes
src/index.ts - Xandr client → Segment billing: exposes
src/index.ts - Xandr client → Reports: exposes
src/index.ts - Xandr client → Geographic data: exposes
src/index.ts - Xandr client → DMA data: exposes
src/index.ts - Xandr client → Region data: exposes
src/index.ts - Xandr client → Currency data: exposes
src/index.ts - Xandr client → Sites: exposes
src/index.ts - Advertisers → Xandr client: executes requests
src/advertiser/index.ts - Insertion orders → Xandr client: executes requests
src/insertion-order/index.ts - Line items → Xandr client: executes requests
src/line-item/index.ts - Placements → Xandr client: executes requests
src/placement/index.ts - Publishers → Xandr client: executes requests
src/publisher/index.ts - Segments → Xandr client: executes requests
src/segment/index.ts - Audience targeting → Xandr client: executes requests
src/apd/index.ts - Batch segment upload → Xandr client: requests and uploads
src/bss/index.ts - Inventory lists → Xandr client: executes requests
src/inventory-list/index.ts - Domain lists → Xandr client: executes requests
src/domain-list/index.ts - Custom models → Xandr client: executes requests
src/custom-model/index.ts - Segment billing → Xandr client: executes requests
src/segment-billing-category/index.ts - Reports → Xandr client: executes requests
src/report/index.ts - Geographic data → Xandr client: executes requests
src/city/index.ts - DMA data → Xandr client: executes requests
src/dma/index.ts - Region data → Xandr client: executes requests
src/region/index.ts - Currency data → Xandr client: executes requests
src/currency/index.ts - Sites → Xandr client: executes requests
src/site/index.ts - Auth and requests → Xandr APIs: sends API requests