{"_rev":"38-516e29a8e394235d53b53a254cad2935","time":{"created":"2026-08-30T16:02:13.745Z","modified":"2026-08-30T16:02:14.328Z","1.0.0":"2026-05-21T23:04:29.584Z","1.0.1":"2026-05-22T21:18:59.283Z","1.0.2":"2026-05-24T18:47:45.028Z","1.0.3":"2026-05-24T19:24:09.712Z","1.0.4":"2026-05-24T19:29:45.646Z","1.0.5":"2026-05-24T19:43:50.925Z","1.0.6":"2026-05-24T20:01:09.755Z","1.0.7":"2026-05-24T20:02:20.616Z","1.0.8":"2026-05-24T20:05:38.816Z","1.0.9":"2026-05-25T07:07:57.121Z","1.0.10":"2026-05-25T09:50:04.825Z","1.0.11":"2026-05-27T07:48:00.005Z","0.0.1":"2026-05-27T07:58:28.844Z","0.0.2":"2026-05-29T18:06:09.934Z","0.0.3":"2026-06-01T12:35:53.513Z","0.0.4":"2026-06-03T20:21:23.007Z","0.0.5":"2026-06-04T17:39:05.394Z","0.0.6":"2026-06-04T18:04:31.422Z","0.0.7":"2026-06-12T11:26:23.498Z","0.0.8":"2026-06-14T19:56:24.883Z","0.0.9":"2026-06-15T07:06:03.964Z","0.0.10":"2026-06-15T07:50:00.335Z","0.0.11":"2026-06-15T08:33:43.845Z","0.0.12":"2026-06-15T11:12:22.151Z","0.0.13":"2026-06-15T11:55:57.703Z","0.0.14":"2026-06-15T13:55:42.011Z","0.0.15":"2026-06-15T16:49:20.822Z","0.0.16":"2026-06-15T19:25:26.186Z","0.0.17":"2026-06-16T21:16:46.835Z","0.0.18":"2026-06-18T14:43:47.422Z","0.0.19":"2026-06-18T18:10:44.944Z","0.0.20":"2026-07-08T09:18:04.540Z","4.0.0":"2026-08-30T16:02:14.111Z"},"_id":"@apollo-deploy/signal-sdk","name":"@apollo-deploy/signal-sdk","dist-tags":{"latest":"4.0.0"},"versions":{"4.0.0":{"name":"@apollo-deploy/signal-sdk","version":"4.0.0","type":"module","description":"TypeScript SDK for the Apollo Signal API","main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"scripts":{"build":"tsc","prepublishOnly":"tsc"},"dependencies":{"axios":"1.19.0"},"peerDependencies":{"zod":"^4.4.0"},"devDependencies":{"typescript":"^5.5.0","zod":"^4.4.0"},"license":"MIT","author":{"name":"Apollo Deploy"},"repository":{"type":"git","url":"git+https://github.com/Apollo-Deploy/signal-sdks.git"},"homepage":"https://github.com/Apollo-Deploy/signal-sdks#readme","bugs":{"url":"https://github.com/Apollo-Deploy/signal-sdks/issues"},"publishConfig":{"access":"public"},"_id":"@apollo-deploy/signal-sdk@4.0.0","_nodeVersion":"22.14.0","_npmVersion":"11.5.1","dist":{"integrity":"sha512-Z/AQaS2PH3knU1GKor4k/Ijlu1NiXDQrLQHByWZeO65LO8H2+Kvq4IGGbnWIcP5V5f3H2Y4+l4k1H19PY4e0PA==","shasum":"942ca0d4ee8b8cb5401639adc277e337bed4d809","tarball":"https://registry.npmjs.org/@apollo-deploy/signal-sdk/-/signal-sdk-4.0.0.tgz","fileCount":116,"unpackedSize":447558,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCICVJrmA0yug7LU1KXSkqFZXI2OsjRpUCQk920ZL9Tmo5AiAz5PTETF47nV14XhiryvnpmdllvX6XqHXw8vOqg+Kb7A=="}]},"_npmUser":{"name":"nanashili","email":"nanashili@auroraeditor.com"},"directories":{},"maintainers":[{"name":"nanashili","email":"nanashili@auroraeditor.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/signal-sdk_4.0.0_1788105733961_0.38624574555628"},"_hasShrinkwrap":false}},"maintainers":[{"name":"nanashili","email":"nanashili@auroraeditor.com"}],"description":"TypeScript SDK for the Apollo Signal API","homepage":"https://github.com/Apollo-Deploy/signal-sdks#readme","repository":{"type":"git","url":"git+https://github.com/Apollo-Deploy/signal-sdks.git"},"author":{"name":"Apollo Deploy"},"bugs":{"url":"https://github.com/Apollo-Deploy/signal-sdks/issues"},"license":"MIT","readme":"# Apollo Signal API SDK\n\nTypeScript client for the Apollo Signal API API.\n\n> Generated by [Tesseract](https://www.npmjs.com/package/@apollo-deploy/tesseract). Generated source files should not be edited manually.\n\n## Installation\n\n```bash\nnpm install @apollo-deploy/signal-sdk\n```\n\n## Quick start\n\n```typescript\nimport { createApolloSignalApiClient } from '@apollo-deploy/signal-sdk';\n\nconst client = createApolloSignalApiClient({\n  baseUrl: 'https://signal.apollodeploy.com',\n  timeoutMs: 15_000,\n});\n\n// Domain clients are available directly on the client.\nconst api = client.emails;\n```\n\n## Configuration and reliability\n\nThe generated transport supports:\n\n- Bounded request timeouts and `AbortSignal` cancellation\n- Exponential-backoff retries for transient failures\n- `Retry-After` handling for rate limits\n- Per-request headers, timeout, and retry overrides\n- Structured `SDKError` values with HTTP status, error code, and request ID\n- Request/response hooks and transport plugins for logging or telemetry\n\n```typescript\nconst client = createApolloSignalApiClient({\n  timeoutMs: 30_000,\n  defaultHeaders: { 'X-Application': 'my-service' },\n  retries: {\n    attempts: 3,\n    backoffMs: 400,\n    jitter: true,\n  },\n});\n```\n\nMutating requests are retried only when the request is considered idempotent, carries an idempotency key, or the retry policy explicitly allows it.\n\n## Documentation\n\n- [Documentation index](./docs/README.md)\n- [Generated types](./docs/types.md)\n\n| Domain | Description |\n|---|---|\n| [EmailsAPI](./docs/domains/emails.md) | emails operations |\n| [MetricsAPI](./docs/domains/metrics.md) | metrics operations |\n| [SuppressionsAPI](./docs/domains/suppressions.md) | suppressions operations |\n| [SegmentsAPI](./docs/domains/segments.md) | segments operations |\n| [TopicsAPI](./docs/domains/topics.md) | topics operations |\n| [ContactPropertiesAPI](./docs/domains/contact-properties.md) | contactProperties operations |\n| [ContactsAPI](./docs/domains/contacts.md) | contacts operations |\n| [WebhooksAPI](./docs/domains/webhooks.md) | webhooks operations |\n| [ApiKeysAPI](./docs/domains/api-keys.md) | apiKeys operations |\n| [ProjectsAPI](./docs/domains/projects.md) | projects operations |\n| [SendingDomainsAPI](./docs/domains/sending-domains.md) | sendingDomains operations |\n\n## Error handling\n\n```typescript\nimport { SDKError } from '@apollo-deploy/signal-sdk';\n\ntry {\n  // await client.someDomain.someOperation();\n} catch (error) {\n  if (error instanceof SDKError) {\n    console.error(error.status, error.code, error.requestId);\n  }\n  throw error;\n}\n```\n\n## License\n\nMIT\n","readmeFilename":"README.md"}