@epilot/sdk 2.2.3 → 2.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/data-management-runtime.json +1 -1
- package/definitions/data-management.json +11 -5
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-management.cjs +8 -8
- package/dist/apis/data-management.d.cts +2 -2
- package/dist/apis/data-management.d.ts +2 -2
- package/dist/apis/data-management.js +2 -2
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/erp-integration.cjs +6 -6
- package/dist/apis/erp-integration.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/chunk-4BCQGZJB.cjs +14 -0
- package/dist/chunk-6GC363VV.js +14 -0
- package/dist/{chunk-TUSCE6W2.js → chunk-I3TEIPPB.js} +2 -2
- package/dist/{chunk-EH7KVFLO.cjs → chunk-KLVWUQMJ.cjs} +2 -2
- package/dist/data-management-3N3A3XBM.js +7 -0
- package/dist/data-management-YXFLQWLV.cjs +7 -0
- package/dist/{data-management-runtime-XZ347IUB.js → data-management-runtime-DN7FGK7G.js} +1 -1
- package/dist/{data-management-runtime-PAC7UFGT.cjs → data-management-runtime-J5IS7T47.cjs} +2 -2
- package/dist/{data-management.d-CkDmJwpx.d.cts → data-management.d-BXS5jbJY.d.cts} +1 -0
- package/dist/{data-management.d-CkDmJwpx.d.ts → data-management.d-BXS5jbJY.d.ts} +1 -0
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/docs/data-management.md +15 -6
- package/package.json +1 -1
- package/dist/chunk-JICWF5VI.cjs +0 -14
- package/dist/chunk-QT44OHHL.js +0 -14
- package/dist/data-management-QH2IJ5QV.js +0 -7
- package/dist/data-management-TEFRLGSU.cjs +0 -7
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/data-management.json
|
|
4
|
+
var data_management_default = '# Data Management API\n\n- **Full API Docs:** [https://docs.epilot.io/api/data-management](https://docs.epilot.io/api/data-management)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.dataManagement.queryEntities(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/data-management\'\n\nconst dataManagementClient = getClient()\nauthorize(dataManagementClient, () => \'<token>\')\nconst { data } = await dataManagementClient.queryEntities(...)\n```\n\n## Operations\n\n**Data Management**\n- [`queryEntities`](#queryentities)\n- [`createJob`](#createjob)\n- [`updateJob`](#updatejob)\n- [`getJob`](#getjob)\n- [`getJobReportUrl`](#getjobreporturl)\n- [`getConfig`](#getconfig)\n- [`createJobForConfig`](#createjobforconfig)\n- [`upsertConfig`](#upsertconfig)\n- [`listConfigs`](#listconfigs)\n- [`listJobs`](#listjobs)\n\n**Schemas**\n- [`ConfigType`](#configtype)\n- [`JobStatus`](#jobstatus)\n- [`JobTrigger`](#jobtrigger)\n- [`JobReportFormat`](#jobreportformat)\n- [`JobReport`](#jobreport)\n- [`CreateJobRequest`](#createjobrequest)\n- [`JobDetails`](#jobdetails)\n- [`UpdateJobRequest`](#updatejobrequest)\n- [`Job`](#job)\n- [`ListJobsResponse`](#listjobsresponse)\n- [`JobReportUrlResponse`](#jobreporturlresponse)\n- [`QueryFilterType`](#queryfiltertype)\n- [`QueryFilter`](#queryfilter)\n- [`QueryConfig`](#queryconfig)\n- [`QueryEntitiesRequest`](#queryentitiesrequest)\n- [`QueryEntitiesResult`](#queryentitiesresult)\n- [`ConfigSchedule`](#configschedule)\n- [`IntervalConfigSchedule`](#intervalconfigschedule)\n- [`UpsertConfigRequest`](#upsertconfigrequest)\n- [`Config`](#config)\n- [`DeletionRelationEntitySchema`](#deletionrelationentityschema)\n- [`ListConfigsResponse`](#listconfigsresponse)\n\n### `queryEntities`\n\nQuery entities using a saved view with additional data filters\n\n`POST /data-management/v1/{entity_schema}/query`\n\n```ts\nconst { data } = await client.queryEntities(\n {\n entity_schema: \'example\',\n },\n {\n saved_view_id: \'string\',\n include_deleted: \'true\',\n filters: [\n {\n type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n related_entity_schemas: [\'string\'],\n lookback_period_days: 0,\n message_type: [\'SENT\'],\n workflow_status: [\'CLOSED\']\n }\n ],\n from: 0,\n size: 0,\n hydrate: true,\n fields: [\'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 0,\n "results": [\n {}\n ]\n}\n```\n\n</details>\n\n---\n\n### `createJob`\n\nCreate a new job run\n\n`POST /data-management/v1/{entity_schema}/jobs`\n\n```ts\nconst { data } = await client.createJob(\n {\n entity_schema: \'example\',\n },\n {\n type: \'deletion\',\n config_id: \'string\',\n scheduled_for: \'1970-01-01\',\n status: \'in_progress\',\n started_at: \'1970-01-01T00:00:00.000Z\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateJob`\n\nUpdate an existing job run\n\n`PATCH /data-management/v1/{entity_schema}/jobs/{job_id}`\n\n```ts\nconst { data } = await client.updateJob(\n {\n entity_schema: \'example\',\n job_id: \'example\',\n },\n {\n status: \'in_progress\',\n details: {},\n completed_at: \'1970-01-01T00:00:00.000Z\',\n error: \'string\',\n report: {\n bucket: \'string\',\n key: \'string\',\n format: \'csv\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJob`\n\nGet a job by id\n\n`GET /data-management/v1/jobs/{job_id}`\n\n```ts\nconst { data } = await client.getJob({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJobReportUrl`\n\nGet report download URL for a job\n\n`GET /data-management/v1/jobs/{job_id}/report-url`\n\n```ts\nconst { data } = await client.getJobReportUrl({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "url": "string",\n "expires_in": 0\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet a config by id\n\n`GET /data-management/v1/configs/{config_id}`\n\n```ts\nconst { data } = await client.getConfig({\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"],\n "workflow_status": ["CLOSED"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `createJobForConfig`\n\nTrigger a manual job run for a config\n\n`POST /data-management/v1/configs/{config_id}/jobs`\n\n```ts\nconst { data } = await client.createJobForConfig({\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `upsertConfig`\n\nUpsert config\n\n`POST /data-management/v1/{entity_schema}/configs`\n\n```ts\nconst { data } = await client.upsertConfig(\n {\n entity_schema: \'example\',\n },\n {\n type: \'deletion\',\n query: {\n saved_view_id: \'string\',\n include_deleted: \'true\',\n filters: [\n {\n type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n related_entity_schemas: [\'string\'],\n lookback_period_days: 0,\n message_type: [\'SENT\'],\n workflow_status: [\'CLOSED\']\n }\n ]\n },\n schedule: {\n frequency: \'interval\',\n interval_days: 1,\n start_date: \'1970-01-01\',\n end_date: \'1970-01-01\'\n },\n relations_for_deletion: [\'contact\'],\n enabled: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"],\n "workflow_status": ["CLOSED"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listConfigs`\n\nList configs\n\n`GET /data-management/v1/configs`\n\n```ts\nconst { data } = await client.listConfigs({\n limit: 1,\n cursor: \'example\',\n entity_schema: \'example\',\n type: \'example\',\n next_run_at: \'example\',\n enabled: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "configs": [\n {\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"],\n "workflow_status": ["CLOSED"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `listJobs`\n\nList jobs\n\n`GET /data-management/v1/jobs`\n\n```ts\nconst { data } = await client.listJobs({\n limit: 1,\n cursor: \'example\',\n entity_schema: \'example\',\n type: \'example\',\n status: \'example\',\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "jobs": [\n {\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n }\n ],\n "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ConfigType`\n\nType of configuration (e.g. deletion)\n\n```ts\ntype ConfigType = "deletion"\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = "in_progress" | "success" | "failed"\n```\n\n### `JobTrigger`\n\n```ts\ntype JobTrigger = "schedule" | "manual"\n```\n\n### `JobReportFormat`\n\n```ts\ntype JobReportFormat = "csv"\n```\n\n### `JobReport`\n\n```ts\ntype JobReport = {\n bucket?: string\n key?: string\n format?: "csv"\n}\n```\n\n### `CreateJobRequest`\n\n```ts\ntype CreateJobRequest = {\n type: "deletion"\n config_id: string\n scheduled_for: string // date\n status?: "in_progress" | "success" | "failed"\n started_at?: string // date-time\n}\n```\n\n### `JobDetails`\n\nGeneric, type-specific job details payload (e.g. matched count, deleted count, failed count, etc.).\n\n```ts\ntype JobDetails = Record<string, unknown>\n```\n\n### `UpdateJobRequest`\n\n```ts\ntype UpdateJobRequest = {\n status?: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: string\n key?: string\n format?: "csv"\n }\n}\n```\n\n### `Job`\n\n```ts\ntype Job = {\n id: string\n type: "deletion"\n config_id: string\n entity_schema: string\n scheduled_for: string // date\n status: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n started_at?: string // date-time\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: string\n key?: string\n format?: "csv"\n }\n created_at: string // date-time\n last_updated_at: string // date-time\n trigger?: "schedule" | "manual"\n triggered_by?: string\n}\n```\n\n### `ListJobsResponse`\n\n```ts\ntype ListJobsResponse = {\n jobs?: Array<{\n id: string\n type: "deletion"\n config_id: string\n entity_schema: string\n scheduled_for: string // date\n status: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n started_at?: string // date-time\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: { ... }\n key?: { ... }\n format?: { ... }\n }\n created_at: string // date-time\n last_updated_at: string // date-time\n trigger?: "schedule" | "manual"\n triggered_by?: string\n }>\n cursor?: string\n}\n```\n\n### `JobReportUrlResponse`\n\n```ts\ntype JobReportUrlResponse = {\n url?: string\n expires_in?: number\n}\n```\n\n### `QueryFilterType`\n\n```ts\ntype QueryFilterType = "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n```\n\n### `QueryFilter`\n\n```ts\ntype QueryFilter = {\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n workflow_status?: "CLOSED" | "DONE"[]\n}\n```\n\n### `QueryConfig`\n\n```ts\ntype QueryConfig = {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n workflow_status?: "CLOSED" | "DONE"[]\n }>\n}\n```\n\n### `QueryEntitiesRequest`\n\n```ts\ntype QueryEntitiesRequest = {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n workflow_status?: "CLOSED" | "DONE"[]\n }>\n from?: number\n size?: number\n hydrate?: boolean\n fields?: string[]\n}\n```\n\n### `QueryEntitiesResult`\n\n```ts\ntype QueryEntitiesResult = {\n hits?: number\n results?: Record<string, unknown>[]\n}\n```\n\n### `ConfigSchedule`\n\n```ts\ntype ConfigSchedule = {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n}\n```\n\n### `IntervalConfigSchedule`\n\n```ts\ntype IntervalConfigSchedule = {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n}\n```\n\n### `UpsertConfigRequest`\n\n```ts\ntype UpsertConfigRequest = {\n type: "deletion"\n query: {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: { ... }\n related_entity_schemas?: { ... }\n lookback_period_days?: { ... }\n message_type?: { ... }\n workflow_status?: { ... }\n }>\n }\n schedule: {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n }\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n enabled?: boolean\n}\n```\n\n### `Config`\n\n```ts\ntype Config = {\n id: string\n type: "deletion"\n entity_schema: string\n query: {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: { ... }\n related_entity_schemas?: { ... }\n lookback_period_days?: { ... }\n message_type?: { ... }\n workflow_status?: { ... }\n }>\n }\n schedule?: {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n }\n enabled?: boolean\n created_at?: string // date-time\n last_updated_at?: string // date-time\n next_run_at?: string // date\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n last_run_at?: string // date-time\n}\n```\n\n### `DeletionRelationEntitySchema`\n\n```ts\ntype DeletionRelationEntitySchema = "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"\n```\n\n### `ListConfigsResponse`\n\n```ts\ntype ListConfigsResponse = {\n configs?: Array<{\n id: string\n type: "deletion"\n entity_schema: string\n query: {\n saved_view_id: { ... }\n include_deleted?: { ... }\n filters?: { ... }\n }\n schedule?: {\n frequency: { ... }\n interval_days: { ... }\n start_date?: { ... }\n end_date?: { ... }\n }\n enabled?: boolean\n created_at?: string // date-time\n last_updated_at?: string // date-time\n next_run_at?: string // date\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n last_run_at?: string // date-time\n }>\n cursor?: string\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = data_management_default;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var _chunk4BCQGZJBcjs = require('./chunk-4BCQGZJB.cjs');
|
|
4
4
|
require('./chunk-NJK5F5TF.cjs');
|
|
5
|
-
exports. default =
|
|
5
|
+
exports. default = _chunk4BCQGZJBcjs.require_data_management_runtime.call(void 0, );
|
|
@@ -111,6 +111,7 @@ declare namespace Components {
|
|
|
111
111
|
related_entity_schemas?: string[];
|
|
112
112
|
lookback_period_days?: number;
|
|
113
113
|
message_type?: ("SENT" | "RECEIVED")[];
|
|
114
|
+
workflow_status?: ("CLOSED" | "DONE")[];
|
|
114
115
|
}
|
|
115
116
|
export type QueryFilterType = "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since";
|
|
116
117
|
export interface UpdateJobRequest {
|
|
@@ -111,6 +111,7 @@ declare namespace Components {
|
|
|
111
111
|
related_entity_schemas?: string[];
|
|
112
112
|
lookback_period_days?: number;
|
|
113
113
|
message_type?: ("SENT" | "RECEIVED")[];
|
|
114
|
+
workflow_status?: ("CLOSED" | "DONE")[];
|
|
114
115
|
}
|
|
115
116
|
export type QueryFilterType = "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since";
|
|
116
117
|
export interface UpdateJobRequest {
|
package/dist/index.cjs
CHANGED
|
@@ -108,7 +108,7 @@ var _chunkYWDWPVICcjs = require('./chunk-YWDWPVIC.cjs');
|
|
|
108
108
|
var _chunkM2UDF7PYcjs = require('./chunk-M2UDF7PY.cjs');
|
|
109
109
|
|
|
110
110
|
|
|
111
|
-
var
|
|
111
|
+
var _chunk4BCQGZJBcjs = require('./chunk-4BCQGZJB.cjs');
|
|
112
112
|
|
|
113
113
|
|
|
114
114
|
var _chunkHAZ3WP7Vcjs = require('./chunk-HAZ3WP7V.cjs');
|
|
@@ -143,7 +143,7 @@ var _chunkRXMOHUBPcjs = require('./chunk-RXMOHUBP.cjs');
|
|
|
143
143
|
|
|
144
144
|
|
|
145
145
|
|
|
146
|
-
var
|
|
146
|
+
var _chunkKLVWUQMJcjs = require('./chunk-KLVWUQMJ.cjs');
|
|
147
147
|
|
|
148
148
|
|
|
149
149
|
var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
|
|
@@ -210,7 +210,7 @@ var resolveClient = (params) => {
|
|
|
210
210
|
}
|
|
211
211
|
if (!entry.instance) {
|
|
212
212
|
const definition = entry.loader();
|
|
213
|
-
entry.instance =
|
|
213
|
+
entry.instance = _chunkKLVWUQMJcjs.createApiClient.call(void 0, {
|
|
214
214
|
definition,
|
|
215
215
|
token: state.token,
|
|
216
216
|
headers: state.globalHeaders,
|
|
@@ -243,7 +243,7 @@ var resetAllClients = (registry) => {
|
|
|
243
243
|
};
|
|
244
244
|
|
|
245
245
|
// src/apis/_registry.ts
|
|
246
|
-
var expandDef = (mod) =>
|
|
246
|
+
var expandDef = (mod) => _chunkKLVWUQMJcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
247
247
|
var registerBuiltinApis = (registry) => {
|
|
248
248
|
registerApi({
|
|
249
249
|
registry,
|
|
@@ -308,7 +308,7 @@ var registerBuiltinApis = (registry) => {
|
|
|
308
308
|
registerApi({
|
|
309
309
|
registry,
|
|
310
310
|
name: "dataManagement",
|
|
311
|
-
loader: () => expandDef(
|
|
311
|
+
loader: () => expandDef(_chunk4BCQGZJBcjs.require_data_management_runtime.call(void 0, ))
|
|
312
312
|
});
|
|
313
313
|
registerApi({
|
|
314
314
|
registry,
|
|
@@ -545,9 +545,9 @@ var createSDK = () => {
|
|
|
545
545
|
const available = [...registry.keys()].join(", ");
|
|
546
546
|
throw new Error(`Unknown API: "${name}". Available: ${available}`);
|
|
547
547
|
}
|
|
548
|
-
return
|
|
548
|
+
return _chunkKLVWUQMJcjs.createApiHandle.call(void 0, {
|
|
549
549
|
resolveClient: () => resolveClient({ registry, name, state }),
|
|
550
|
-
createClient: () =>
|
|
550
|
+
createClient: () => _chunkKLVWUQMJcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
|
|
551
551
|
apiName: name
|
|
552
552
|
});
|
|
553
553
|
};
|
|
@@ -595,9 +595,9 @@ var createSDK = () => {
|
|
|
595
595
|
return interceptorUse;
|
|
596
596
|
}
|
|
597
597
|
case "help":
|
|
598
|
-
return (apiName) =>
|
|
598
|
+
return (apiName) => _chunkKLVWUQMJcjs.help.call(void 0, apiName);
|
|
599
599
|
case "openapi":
|
|
600
|
-
return (apiName) =>
|
|
600
|
+
return (apiName) => _chunkKLVWUQMJcjs.openapi.call(void 0, apiName);
|
|
601
601
|
case "then":
|
|
602
602
|
case "catch":
|
|
603
603
|
case "finally":
|
|
@@ -624,4 +624,4 @@ var epilot = createSDK();
|
|
|
624
624
|
|
|
625
625
|
|
|
626
626
|
|
|
627
|
-
exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize =
|
|
627
|
+
exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkKLVWUQMJcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkKLVWUQMJcjs.help; exports.openapi = _chunkKLVWUQMJcjs.openapi;
|
package/dist/index.d.cts
CHANGED
|
@@ -15,7 +15,7 @@ import { C as Client$8 } from './blueprint-manifest.d-DECw6HdM.cjs';
|
|
|
15
15
|
import { C as Client$9 } from './consent.d-C2PROHhX.cjs';
|
|
16
16
|
import { C as Client$a } from './customer-portal.d-BJNWYMt9.cjs';
|
|
17
17
|
import { C as Client$b } from './dashboard.d-CsGcA74I.cjs';
|
|
18
|
-
import { C as Client$c } from './data-management.d-
|
|
18
|
+
import { C as Client$c } from './data-management.d-BXS5jbJY.cjs';
|
|
19
19
|
import { C as Client$d } from './deduplication.d-w_2aJD5f.cjs';
|
|
20
20
|
import { C as Client$e } from './design.d-eA-irKEX.cjs';
|
|
21
21
|
import { C as Client$f } from './document.d-DN37pjdx.cjs';
|
package/dist/index.d.ts
CHANGED
|
@@ -15,7 +15,7 @@ import { C as Client$8 } from './blueprint-manifest.d-DECw6HdM.js';
|
|
|
15
15
|
import { C as Client$9 } from './consent.d-C2PROHhX.js';
|
|
16
16
|
import { C as Client$a } from './customer-portal.d-BJNWYMt9.js';
|
|
17
17
|
import { C as Client$b } from './dashboard.d-CsGcA74I.js';
|
|
18
|
-
import { C as Client$c } from './data-management.d-
|
|
18
|
+
import { C as Client$c } from './data-management.d-BXS5jbJY.js';
|
|
19
19
|
import { C as Client$d } from './deduplication.d-w_2aJD5f.js';
|
|
20
20
|
import { C as Client$e } from './design.d-eA-irKEX.js';
|
|
21
21
|
import { C as Client$f } from './document.d-DN37pjdx.js';
|
package/dist/index.js
CHANGED
|
@@ -108,7 +108,7 @@ import {
|
|
|
108
108
|
} from "./chunk-SZMCMLOQ.js";
|
|
109
109
|
import {
|
|
110
110
|
require_data_management_runtime
|
|
111
|
-
} from "./chunk-
|
|
111
|
+
} from "./chunk-6GC363VV.js";
|
|
112
112
|
import {
|
|
113
113
|
require_deduplication_runtime
|
|
114
114
|
} from "./chunk-3YSEO476.js";
|
|
@@ -143,7 +143,7 @@ import {
|
|
|
143
143
|
expand,
|
|
144
144
|
help,
|
|
145
145
|
openapi
|
|
146
|
-
} from "./chunk-
|
|
146
|
+
} from "./chunk-I3TEIPPB.js";
|
|
147
147
|
import {
|
|
148
148
|
__require
|
|
149
149
|
} from "./chunk-YPSWSI3M.js";
|
package/docs/data-management.md
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
# Data Management API
|
|
2
2
|
|
|
3
|
-
- **Base URL:** `https://data-management.sls.epilot.io`
|
|
4
3
|
- **Full API Docs:** [https://docs.epilot.io/api/data-management](https://docs.epilot.io/api/data-management)
|
|
5
4
|
|
|
6
5
|
## Usage
|
|
@@ -79,7 +78,8 @@ const { data } = await client.queryEntities(
|
|
|
79
78
|
type: 'entity_workflows_only_in_closed_or_cancelled_status',
|
|
80
79
|
related_entity_schemas: ['string'],
|
|
81
80
|
lookback_period_days: 0,
|
|
82
|
-
message_type: ['SENT']
|
|
81
|
+
message_type: ['SENT'],
|
|
82
|
+
workflow_status: ['CLOSED']
|
|
83
83
|
}
|
|
84
84
|
],
|
|
85
85
|
from: 0,
|
|
@@ -312,7 +312,8 @@ const { data } = await client.getConfig({
|
|
|
312
312
|
"type": "entity_workflows_only_in_closed_or_cancelled_status",
|
|
313
313
|
"related_entity_schemas": ["string"],
|
|
314
314
|
"lookback_period_days": 0,
|
|
315
|
-
"message_type": ["SENT"]
|
|
315
|
+
"message_type": ["SENT"],
|
|
316
|
+
"workflow_status": ["CLOSED"]
|
|
316
317
|
}
|
|
317
318
|
]
|
|
318
319
|
},
|
|
@@ -399,7 +400,8 @@ const { data } = await client.upsertConfig(
|
|
|
399
400
|
type: 'entity_workflows_only_in_closed_or_cancelled_status',
|
|
400
401
|
related_entity_schemas: ['string'],
|
|
401
402
|
lookback_period_days: 0,
|
|
402
|
-
message_type: ['SENT']
|
|
403
|
+
message_type: ['SENT'],
|
|
404
|
+
workflow_status: ['CLOSED']
|
|
403
405
|
}
|
|
404
406
|
]
|
|
405
407
|
},
|
|
@@ -431,7 +433,8 @@ const { data } = await client.upsertConfig(
|
|
|
431
433
|
"type": "entity_workflows_only_in_closed_or_cancelled_status",
|
|
432
434
|
"related_entity_schemas": ["string"],
|
|
433
435
|
"lookback_period_days": 0,
|
|
434
|
-
"message_type": ["SENT"]
|
|
436
|
+
"message_type": ["SENT"],
|
|
437
|
+
"workflow_status": ["CLOSED"]
|
|
435
438
|
}
|
|
436
439
|
]
|
|
437
440
|
},
|
|
@@ -489,7 +492,8 @@ const { data } = await client.listConfigs({
|
|
|
489
492
|
"type": "entity_workflows_only_in_closed_or_cancelled_status",
|
|
490
493
|
"related_entity_schemas": ["string"],
|
|
491
494
|
"lookback_period_days": 0,
|
|
492
|
-
"message_type": ["SENT"]
|
|
495
|
+
"message_type": ["SENT"],
|
|
496
|
+
"workflow_status": ["CLOSED"]
|
|
493
497
|
}
|
|
494
498
|
]
|
|
495
499
|
},
|
|
@@ -720,6 +724,7 @@ type QueryFilter = {
|
|
|
720
724
|
related_entity_schemas?: string[]
|
|
721
725
|
lookback_period_days?: number
|
|
722
726
|
message_type?: "SENT" | "RECEIVED"[]
|
|
727
|
+
workflow_status?: "CLOSED" | "DONE"[]
|
|
723
728
|
}
|
|
724
729
|
```
|
|
725
730
|
|
|
@@ -734,6 +739,7 @@ type QueryConfig = {
|
|
|
734
739
|
related_entity_schemas?: string[]
|
|
735
740
|
lookback_period_days?: number
|
|
736
741
|
message_type?: "SENT" | "RECEIVED"[]
|
|
742
|
+
workflow_status?: "CLOSED" | "DONE"[]
|
|
737
743
|
}>
|
|
738
744
|
}
|
|
739
745
|
```
|
|
@@ -749,6 +755,7 @@ type QueryEntitiesRequest = {
|
|
|
749
755
|
related_entity_schemas?: string[]
|
|
750
756
|
lookback_period_days?: number
|
|
751
757
|
message_type?: "SENT" | "RECEIVED"[]
|
|
758
|
+
workflow_status?: "CLOSED" | "DONE"[]
|
|
752
759
|
}>
|
|
753
760
|
from?: number
|
|
754
761
|
size?: number
|
|
@@ -801,6 +808,7 @@ type UpsertConfigRequest = {
|
|
|
801
808
|
related_entity_schemas?: { ... }
|
|
802
809
|
lookback_period_days?: { ... }
|
|
803
810
|
message_type?: { ... }
|
|
811
|
+
workflow_status?: { ... }
|
|
804
812
|
}>
|
|
805
813
|
}
|
|
806
814
|
schedule: {
|
|
@@ -829,6 +837,7 @@ type Config = {
|
|
|
829
837
|
related_entity_schemas?: { ... }
|
|
830
838
|
lookback_period_days?: { ... }
|
|
831
839
|
message_type?: { ... }
|
|
840
|
+
workflow_status?: { ... }
|
|
832
841
|
}>
|
|
833
842
|
}
|
|
834
843
|
schedule?: {
|
package/package.json
CHANGED
package/dist/chunk-JICWF5VI.cjs
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
|
-
|
|
3
|
-
var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
|
|
4
|
-
|
|
5
|
-
// src/definitions/data-management-runtime.json
|
|
6
|
-
var require_data_management_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
|
|
7
|
-
"src/definitions/data-management-runtime.json"(exports, module) {
|
|
8
|
-
module.exports = { s: "https://data-management.sls.epilot.io", o: [["queryEntities", "post", "/data-management/v1/{entity_schema}/query", [["entity_schema", "p", true]], 1], ["createJob", "post", "/data-management/v1/{entity_schema}/jobs", [["entity_schema", "p", true]], 1], ["updateJob", "patch", "/data-management/v1/{entity_schema}/jobs/{job_id}", [["entity_schema", "p", true], ["job_id", "p", true]], 1], ["getJob", "get", "/data-management/v1/jobs/{job_id}", [["job_id", "p", true]]], ["getJobReportUrl", "get", "/data-management/v1/jobs/{job_id}/report-url", [["job_id", "p", true]]], ["getConfig", "get", "/data-management/v1/configs/{config_id}", [["config_id", "p", true]]], ["createJobForConfig", "post", "/data-management/v1/configs/{config_id}/jobs", [["config_id", "p", true]]], ["upsertConfig", "post", "/data-management/v1/{entity_schema}/configs", [["entity_schema", "p", true]], 1], ["listConfigs", "get", "/data-management/v1/configs", [["limit", "q"], ["cursor", "q"], ["entity_schema", "q"], ["type", "q"], ["next_run_at", "q"], ["enabled", "q"]]], ["listJobs", "get", "/data-management/v1/jobs", [["limit", "q"], ["cursor", "q"], ["entity_schema", "q"], ["type", "q"], ["status", "q"], ["config_id", "q"]]]], v: "3.0.3" };
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
exports.require_data_management_runtime = require_data_management_runtime;
|
package/dist/chunk-QT44OHHL.js
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import {
|
|
2
|
-
__commonJS
|
|
3
|
-
} from "./chunk-YPSWSI3M.js";
|
|
4
|
-
|
|
5
|
-
// src/definitions/data-management-runtime.json
|
|
6
|
-
var require_data_management_runtime = __commonJS({
|
|
7
|
-
"src/definitions/data-management-runtime.json"(exports, module) {
|
|
8
|
-
module.exports = { s: "https://data-management.sls.epilot.io", o: [["queryEntities", "post", "/data-management/v1/{entity_schema}/query", [["entity_schema", "p", true]], 1], ["createJob", "post", "/data-management/v1/{entity_schema}/jobs", [["entity_schema", "p", true]], 1], ["updateJob", "patch", "/data-management/v1/{entity_schema}/jobs/{job_id}", [["entity_schema", "p", true], ["job_id", "p", true]], 1], ["getJob", "get", "/data-management/v1/jobs/{job_id}", [["job_id", "p", true]]], ["getJobReportUrl", "get", "/data-management/v1/jobs/{job_id}/report-url", [["job_id", "p", true]]], ["getConfig", "get", "/data-management/v1/configs/{config_id}", [["config_id", "p", true]]], ["createJobForConfig", "post", "/data-management/v1/configs/{config_id}/jobs", [["config_id", "p", true]]], ["upsertConfig", "post", "/data-management/v1/{entity_schema}/configs", [["entity_schema", "p", true]], 1], ["listConfigs", "get", "/data-management/v1/configs", [["limit", "q"], ["cursor", "q"], ["entity_schema", "q"], ["type", "q"], ["next_run_at", "q"], ["enabled", "q"]]], ["listJobs", "get", "/data-management/v1/jobs", [["limit", "q"], ["cursor", "q"], ["entity_schema", "q"], ["type", "q"], ["status", "q"], ["config_id", "q"]]]], v: "3.0.3" };
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
|
|
12
|
-
export {
|
|
13
|
-
require_data_management_runtime
|
|
14
|
-
};
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import "./chunk-YPSWSI3M.js";
|
|
2
|
-
|
|
3
|
-
// src/docs/data-management.json
|
|
4
|
-
var data_management_default = '# Data Management API\n\n- **Base URL:** `https://data-management.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/data-management](https://docs.epilot.io/api/data-management)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.dataManagement.queryEntities(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/data-management\'\n\nconst dataManagementClient = getClient()\nauthorize(dataManagementClient, () => \'<token>\')\nconst { data } = await dataManagementClient.queryEntities(...)\n```\n\n## Operations\n\n**Data Management**\n- [`queryEntities`](#queryentities)\n- [`createJob`](#createjob)\n- [`updateJob`](#updatejob)\n- [`getJob`](#getjob)\n- [`getJobReportUrl`](#getjobreporturl)\n- [`getConfig`](#getconfig)\n- [`createJobForConfig`](#createjobforconfig)\n- [`upsertConfig`](#upsertconfig)\n- [`listConfigs`](#listconfigs)\n- [`listJobs`](#listjobs)\n\n**Schemas**\n- [`ConfigType`](#configtype)\n- [`JobStatus`](#jobstatus)\n- [`JobTrigger`](#jobtrigger)\n- [`JobReportFormat`](#jobreportformat)\n- [`JobReport`](#jobreport)\n- [`CreateJobRequest`](#createjobrequest)\n- [`JobDetails`](#jobdetails)\n- [`UpdateJobRequest`](#updatejobrequest)\n- [`Job`](#job)\n- [`ListJobsResponse`](#listjobsresponse)\n- [`JobReportUrlResponse`](#jobreporturlresponse)\n- [`QueryFilterType`](#queryfiltertype)\n- [`QueryFilter`](#queryfilter)\n- [`QueryConfig`](#queryconfig)\n- [`QueryEntitiesRequest`](#queryentitiesrequest)\n- [`QueryEntitiesResult`](#queryentitiesresult)\n- [`ConfigSchedule`](#configschedule)\n- [`IntervalConfigSchedule`](#intervalconfigschedule)\n- [`UpsertConfigRequest`](#upsertconfigrequest)\n- [`Config`](#config)\n- [`DeletionRelationEntitySchema`](#deletionrelationentityschema)\n- [`ListConfigsResponse`](#listconfigsresponse)\n\n### `queryEntities`\n\nQuery entities using a saved view with additional data filters\n\n`POST /data-management/v1/{entity_schema}/query`\n\n```ts\nconst { data } = await client.queryEntities(\n {\n entity_schema: \'example\',\n },\n {\n saved_view_id: \'string\',\n include_deleted: \'true\',\n filters: [\n {\n type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n related_entity_schemas: [\'string\'],\n lookback_period_days: 0,\n message_type: [\'SENT\']\n }\n ],\n from: 0,\n size: 0,\n hydrate: true,\n fields: [\'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 0,\n "results": [\n {}\n ]\n}\n```\n\n</details>\n\n---\n\n### `createJob`\n\nCreate a new job run\n\n`POST /data-management/v1/{entity_schema}/jobs`\n\n```ts\nconst { data } = await client.createJob(\n {\n entity_schema: \'example\',\n },\n {\n type: \'deletion\',\n config_id: \'string\',\n scheduled_for: \'1970-01-01\',\n status: \'in_progress\',\n started_at: \'1970-01-01T00:00:00.000Z\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateJob`\n\nUpdate an existing job run\n\n`PATCH /data-management/v1/{entity_schema}/jobs/{job_id}`\n\n```ts\nconst { data } = await client.updateJob(\n {\n entity_schema: \'example\',\n job_id: \'example\',\n },\n {\n status: \'in_progress\',\n details: {},\n completed_at: \'1970-01-01T00:00:00.000Z\',\n error: \'string\',\n report: {\n bucket: \'string\',\n key: \'string\',\n format: \'csv\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJob`\n\nGet a job by id\n\n`GET /data-management/v1/jobs/{job_id}`\n\n```ts\nconst { data } = await client.getJob({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJobReportUrl`\n\nGet report download URL for a job\n\n`GET /data-management/v1/jobs/{job_id}/report-url`\n\n```ts\nconst { data } = await client.getJobReportUrl({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "url": "string",\n "expires_in": 0\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet a config by id\n\n`GET /data-management/v1/configs/{config_id}`\n\n```ts\nconst { data } = await client.getConfig({\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `createJobForConfig`\n\nTrigger a manual job run for a config\n\n`POST /data-management/v1/configs/{config_id}/jobs`\n\n```ts\nconst { data } = await client.createJobForConfig({\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `upsertConfig`\n\nUpsert config\n\n`POST /data-management/v1/{entity_schema}/configs`\n\n```ts\nconst { data } = await client.upsertConfig(\n {\n entity_schema: \'example\',\n },\n {\n type: \'deletion\',\n query: {\n saved_view_id: \'string\',\n include_deleted: \'true\',\n filters: [\n {\n type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n related_entity_schemas: [\'string\'],\n lookback_period_days: 0,\n message_type: [\'SENT\']\n }\n ]\n },\n schedule: {\n frequency: \'interval\',\n interval_days: 1,\n start_date: \'1970-01-01\',\n end_date: \'1970-01-01\'\n },\n relations_for_deletion: [\'contact\'],\n enabled: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listConfigs`\n\nList configs\n\n`GET /data-management/v1/configs`\n\n```ts\nconst { data } = await client.listConfigs({\n limit: 1,\n cursor: \'example\',\n entity_schema: \'example\',\n type: \'example\',\n next_run_at: \'example\',\n enabled: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "configs": [\n {\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `listJobs`\n\nList jobs\n\n`GET /data-management/v1/jobs`\n\n```ts\nconst { data } = await client.listJobs({\n limit: 1,\n cursor: \'example\',\n entity_schema: \'example\',\n type: \'example\',\n status: \'example\',\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "jobs": [\n {\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n }\n ],\n "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ConfigType`\n\nType of configuration (e.g. deletion)\n\n```ts\ntype ConfigType = "deletion"\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = "in_progress" | "success" | "failed"\n```\n\n### `JobTrigger`\n\n```ts\ntype JobTrigger = "schedule" | "manual"\n```\n\n### `JobReportFormat`\n\n```ts\ntype JobReportFormat = "csv"\n```\n\n### `JobReport`\n\n```ts\ntype JobReport = {\n bucket?: string\n key?: string\n format?: "csv"\n}\n```\n\n### `CreateJobRequest`\n\n```ts\ntype CreateJobRequest = {\n type: "deletion"\n config_id: string\n scheduled_for: string // date\n status?: "in_progress" | "success" | "failed"\n started_at?: string // date-time\n}\n```\n\n### `JobDetails`\n\nGeneric, type-specific job details payload (e.g. matched count, deleted count, failed count, etc.).\n\n```ts\ntype JobDetails = Record<string, unknown>\n```\n\n### `UpdateJobRequest`\n\n```ts\ntype UpdateJobRequest = {\n status?: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: string\n key?: string\n format?: "csv"\n }\n}\n```\n\n### `Job`\n\n```ts\ntype Job = {\n id: string\n type: "deletion"\n config_id: string\n entity_schema: string\n scheduled_for: string // date\n status: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n started_at?: string // date-time\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: string\n key?: string\n format?: "csv"\n }\n created_at: string // date-time\n last_updated_at: string // date-time\n trigger?: "schedule" | "manual"\n triggered_by?: string\n}\n```\n\n### `ListJobsResponse`\n\n```ts\ntype ListJobsResponse = {\n jobs?: Array<{\n id: string\n type: "deletion"\n config_id: string\n entity_schema: string\n scheduled_for: string // date\n status: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n started_at?: string // date-time\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: { ... }\n key?: { ... }\n format?: { ... }\n }\n created_at: string // date-time\n last_updated_at: string // date-time\n trigger?: "schedule" | "manual"\n triggered_by?: string\n }>\n cursor?: string\n}\n```\n\n### `JobReportUrlResponse`\n\n```ts\ntype JobReportUrlResponse = {\n url?: string\n expires_in?: number\n}\n```\n\n### `QueryFilterType`\n\n```ts\ntype QueryFilterType = "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n```\n\n### `QueryFilter`\n\n```ts\ntype QueryFilter = {\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n}\n```\n\n### `QueryConfig`\n\n```ts\ntype QueryConfig = {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n }>\n}\n```\n\n### `QueryEntitiesRequest`\n\n```ts\ntype QueryEntitiesRequest = {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n }>\n from?: number\n size?: number\n hydrate?: boolean\n fields?: string[]\n}\n```\n\n### `QueryEntitiesResult`\n\n```ts\ntype QueryEntitiesResult = {\n hits?: number\n results?: Record<string, unknown>[]\n}\n```\n\n### `ConfigSchedule`\n\n```ts\ntype ConfigSchedule = {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n}\n```\n\n### `IntervalConfigSchedule`\n\n```ts\ntype IntervalConfigSchedule = {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n}\n```\n\n### `UpsertConfigRequest`\n\n```ts\ntype UpsertConfigRequest = {\n type: "deletion"\n query: {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: { ... }\n related_entity_schemas?: { ... }\n lookback_period_days?: { ... }\n message_type?: { ... }\n }>\n }\n schedule: {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n }\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n enabled?: boolean\n}\n```\n\n### `Config`\n\n```ts\ntype Config = {\n id: string\n type: "deletion"\n entity_schema: string\n query: {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: { ... }\n related_entity_schemas?: { ... }\n lookback_period_days?: { ... }\n message_type?: { ... }\n }>\n }\n schedule?: {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n }\n enabled?: boolean\n created_at?: string // date-time\n last_updated_at?: string // date-time\n next_run_at?: string // date\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n last_run_at?: string // date-time\n}\n```\n\n### `DeletionRelationEntitySchema`\n\n```ts\ntype DeletionRelationEntitySchema = "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"\n```\n\n### `ListConfigsResponse`\n\n```ts\ntype ListConfigsResponse = {\n configs?: Array<{\n id: string\n type: "deletion"\n entity_schema: string\n query: {\n saved_view_id: { ... }\n include_deleted?: { ... }\n filters?: { ... }\n }\n schedule?: {\n frequency: { ... }\n interval_days: { ... }\n start_date?: { ... }\n end_date?: { ... }\n }\n enabled?: boolean\n created_at?: string // date-time\n last_updated_at?: string // date-time\n next_run_at?: string // date\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n last_run_at?: string // date-time\n }>\n cursor?: string\n}\n```\n';
|
|
5
|
-
export {
|
|
6
|
-
data_management_default as default
|
|
7
|
-
};
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
-
|
|
3
|
-
// src/docs/data-management.json
|
|
4
|
-
var data_management_default = '# Data Management API\n\n- **Base URL:** `https://data-management.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/data-management](https://docs.epilot.io/api/data-management)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.dataManagement.queryEntities(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/data-management\'\n\nconst dataManagementClient = getClient()\nauthorize(dataManagementClient, () => \'<token>\')\nconst { data } = await dataManagementClient.queryEntities(...)\n```\n\n## Operations\n\n**Data Management**\n- [`queryEntities`](#queryentities)\n- [`createJob`](#createjob)\n- [`updateJob`](#updatejob)\n- [`getJob`](#getjob)\n- [`getJobReportUrl`](#getjobreporturl)\n- [`getConfig`](#getconfig)\n- [`createJobForConfig`](#createjobforconfig)\n- [`upsertConfig`](#upsertconfig)\n- [`listConfigs`](#listconfigs)\n- [`listJobs`](#listjobs)\n\n**Schemas**\n- [`ConfigType`](#configtype)\n- [`JobStatus`](#jobstatus)\n- [`JobTrigger`](#jobtrigger)\n- [`JobReportFormat`](#jobreportformat)\n- [`JobReport`](#jobreport)\n- [`CreateJobRequest`](#createjobrequest)\n- [`JobDetails`](#jobdetails)\n- [`UpdateJobRequest`](#updatejobrequest)\n- [`Job`](#job)\n- [`ListJobsResponse`](#listjobsresponse)\n- [`JobReportUrlResponse`](#jobreporturlresponse)\n- [`QueryFilterType`](#queryfiltertype)\n- [`QueryFilter`](#queryfilter)\n- [`QueryConfig`](#queryconfig)\n- [`QueryEntitiesRequest`](#queryentitiesrequest)\n- [`QueryEntitiesResult`](#queryentitiesresult)\n- [`ConfigSchedule`](#configschedule)\n- [`IntervalConfigSchedule`](#intervalconfigschedule)\n- [`UpsertConfigRequest`](#upsertconfigrequest)\n- [`Config`](#config)\n- [`DeletionRelationEntitySchema`](#deletionrelationentityschema)\n- [`ListConfigsResponse`](#listconfigsresponse)\n\n### `queryEntities`\n\nQuery entities using a saved view with additional data filters\n\n`POST /data-management/v1/{entity_schema}/query`\n\n```ts\nconst { data } = await client.queryEntities(\n {\n entity_schema: \'example\',\n },\n {\n saved_view_id: \'string\',\n include_deleted: \'true\',\n filters: [\n {\n type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n related_entity_schemas: [\'string\'],\n lookback_period_days: 0,\n message_type: [\'SENT\']\n }\n ],\n from: 0,\n size: 0,\n hydrate: true,\n fields: [\'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 0,\n "results": [\n {}\n ]\n}\n```\n\n</details>\n\n---\n\n### `createJob`\n\nCreate a new job run\n\n`POST /data-management/v1/{entity_schema}/jobs`\n\n```ts\nconst { data } = await client.createJob(\n {\n entity_schema: \'example\',\n },\n {\n type: \'deletion\',\n config_id: \'string\',\n scheduled_for: \'1970-01-01\',\n status: \'in_progress\',\n started_at: \'1970-01-01T00:00:00.000Z\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `updateJob`\n\nUpdate an existing job run\n\n`PATCH /data-management/v1/{entity_schema}/jobs/{job_id}`\n\n```ts\nconst { data } = await client.updateJob(\n {\n entity_schema: \'example\',\n job_id: \'example\',\n },\n {\n status: \'in_progress\',\n details: {},\n completed_at: \'1970-01-01T00:00:00.000Z\',\n error: \'string\',\n report: {\n bucket: \'string\',\n key: \'string\',\n format: \'csv\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJob`\n\nGet a job by id\n\n`GET /data-management/v1/jobs/{job_id}`\n\n```ts\nconst { data } = await client.getJob({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJobReportUrl`\n\nGet report download URL for a job\n\n`GET /data-management/v1/jobs/{job_id}/report-url`\n\n```ts\nconst { data } = await client.getJobReportUrl({\n job_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "url": "string",\n "expires_in": 0\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet a config by id\n\n`GET /data-management/v1/configs/{config_id}`\n\n```ts\nconst { data } = await client.getConfig({\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `createJobForConfig`\n\nTrigger a manual job run for a config\n\n`POST /data-management/v1/configs/{config_id}/jobs`\n\n```ts\nconst { data } = await client.createJobForConfig({\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `upsertConfig`\n\nUpsert config\n\n`POST /data-management/v1/{entity_schema}/configs`\n\n```ts\nconst { data } = await client.upsertConfig(\n {\n entity_schema: \'example\',\n },\n {\n type: \'deletion\',\n query: {\n saved_view_id: \'string\',\n include_deleted: \'true\',\n filters: [\n {\n type: \'entity_workflows_only_in_closed_or_cancelled_status\',\n related_entity_schemas: [\'string\'],\n lookback_period_days: 0,\n message_type: [\'SENT\']\n }\n ]\n },\n schedule: {\n frequency: \'interval\',\n interval_days: 1,\n start_date: \'1970-01-01\',\n end_date: \'1970-01-01\'\n },\n relations_for_deletion: [\'contact\'],\n enabled: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listConfigs`\n\nList configs\n\n`GET /data-management/v1/configs`\n\n```ts\nconst { data } = await client.listConfigs({\n limit: 1,\n cursor: \'example\',\n entity_schema: \'example\',\n type: \'example\',\n next_run_at: \'example\',\n enabled: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "configs": [\n {\n "id": "string",\n "type": "deletion",\n "entity_schema": "string",\n "query": {\n "saved_view_id": "string",\n "include_deleted": "true",\n "filters": [\n {\n "type": "entity_workflows_only_in_closed_or_cancelled_status",\n "related_entity_schemas": ["string"],\n "lookback_period_days": 0,\n "message_type": ["SENT"]\n }\n ]\n },\n "schedule": {\n "frequency": "interval",\n "interval_days": 1,\n "start_date": "1970-01-01",\n "end_date": "1970-01-01"\n },\n "enabled": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "next_run_at": "1970-01-01",\n "relations_for_deletion": ["contact"],\n "last_run_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `listJobs`\n\nList jobs\n\n`GET /data-management/v1/jobs`\n\n```ts\nconst { data } = await client.listJobs({\n limit: 1,\n cursor: \'example\',\n entity_schema: \'example\',\n type: \'example\',\n status: \'example\',\n config_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "jobs": [\n {\n "id": "string",\n "type": "deletion",\n "config_id": "string",\n "entity_schema": "string",\n "scheduled_for": "1970-01-01",\n "status": "in_progress",\n "details": {},\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "error": "string",\n "report": {\n "bucket": "string",\n "key": "string",\n "format": "csv"\n },\n "created_at": "1970-01-01T00:00:00.000Z",\n "last_updated_at": "1970-01-01T00:00:00.000Z",\n "trigger": "schedule",\n "triggered_by": "string"\n }\n ],\n "cursor": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ConfigType`\n\nType of configuration (e.g. deletion)\n\n```ts\ntype ConfigType = "deletion"\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = "in_progress" | "success" | "failed"\n```\n\n### `JobTrigger`\n\n```ts\ntype JobTrigger = "schedule" | "manual"\n```\n\n### `JobReportFormat`\n\n```ts\ntype JobReportFormat = "csv"\n```\n\n### `JobReport`\n\n```ts\ntype JobReport = {\n bucket?: string\n key?: string\n format?: "csv"\n}\n```\n\n### `CreateJobRequest`\n\n```ts\ntype CreateJobRequest = {\n type: "deletion"\n config_id: string\n scheduled_for: string // date\n status?: "in_progress" | "success" | "failed"\n started_at?: string // date-time\n}\n```\n\n### `JobDetails`\n\nGeneric, type-specific job details payload (e.g. matched count, deleted count, failed count, etc.).\n\n```ts\ntype JobDetails = Record<string, unknown>\n```\n\n### `UpdateJobRequest`\n\n```ts\ntype UpdateJobRequest = {\n status?: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: string\n key?: string\n format?: "csv"\n }\n}\n```\n\n### `Job`\n\n```ts\ntype Job = {\n id: string\n type: "deletion"\n config_id: string\n entity_schema: string\n scheduled_for: string // date\n status: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n started_at?: string // date-time\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: string\n key?: string\n format?: "csv"\n }\n created_at: string // date-time\n last_updated_at: string // date-time\n trigger?: "schedule" | "manual"\n triggered_by?: string\n}\n```\n\n### `ListJobsResponse`\n\n```ts\ntype ListJobsResponse = {\n jobs?: Array<{\n id: string\n type: "deletion"\n config_id: string\n entity_schema: string\n scheduled_for: string // date\n status: "in_progress" | "success" | "failed"\n details?: Record<string, unknown>\n started_at?: string // date-time\n completed_at?: string // date-time\n error?: string\n report?: {\n bucket?: { ... }\n key?: { ... }\n format?: { ... }\n }\n created_at: string // date-time\n last_updated_at: string // date-time\n trigger?: "schedule" | "manual"\n triggered_by?: string\n }>\n cursor?: string\n}\n```\n\n### `JobReportUrlResponse`\n\n```ts\ntype JobReportUrlResponse = {\n url?: string\n expires_in?: number\n}\n```\n\n### `QueryFilterType`\n\n```ts\ntype QueryFilterType = "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n```\n\n### `QueryFilter`\n\n```ts\ntype QueryFilter = {\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n}\n```\n\n### `QueryConfig`\n\n```ts\ntype QueryConfig = {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n }>\n}\n```\n\n### `QueryEntitiesRequest`\n\n```ts\ntype QueryEntitiesRequest = {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: "entity_workflows_only_in_closed_or_cancelled_status" | "no_related_entities" | "related_entities_all_in_closed_or_cancelled_status" | "related_entities_workflows_only_in_closed_or_cancelled_status" | "no_email_communication_since"\n related_entity_schemas?: string[]\n lookback_period_days?: number\n message_type?: "SENT" | "RECEIVED"[]\n }>\n from?: number\n size?: number\n hydrate?: boolean\n fields?: string[]\n}\n```\n\n### `QueryEntitiesResult`\n\n```ts\ntype QueryEntitiesResult = {\n hits?: number\n results?: Record<string, unknown>[]\n}\n```\n\n### `ConfigSchedule`\n\n```ts\ntype ConfigSchedule = {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n}\n```\n\n### `IntervalConfigSchedule`\n\n```ts\ntype IntervalConfigSchedule = {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n}\n```\n\n### `UpsertConfigRequest`\n\n```ts\ntype UpsertConfigRequest = {\n type: "deletion"\n query: {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: { ... }\n related_entity_schemas?: { ... }\n lookback_period_days?: { ... }\n message_type?: { ... }\n }>\n }\n schedule: {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n }\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n enabled?: boolean\n}\n```\n\n### `Config`\n\n```ts\ntype Config = {\n id: string\n type: "deletion"\n entity_schema: string\n query: {\n saved_view_id: string\n include_deleted?: "true" | "false" | "only"\n filters?: Array<{\n type: { ... }\n related_entity_schemas?: { ... }\n lookback_period_days?: { ... }\n message_type?: { ... }\n }>\n }\n schedule?: {\n frequency: "interval"\n interval_days: number\n start_date?: string // date\n end_date?: string // date\n }\n enabled?: boolean\n created_at?: string // date-time\n last_updated_at?: string // date-time\n next_run_at?: string // date\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n last_run_at?: string // date-time\n}\n```\n\n### `DeletionRelationEntitySchema`\n\n```ts\ntype DeletionRelationEntitySchema = "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"\n```\n\n### `ListConfigsResponse`\n\n```ts\ntype ListConfigsResponse = {\n configs?: Array<{\n id: string\n type: "deletion"\n entity_schema: string\n query: {\n saved_view_id: { ... }\n include_deleted?: { ... }\n filters?: { ... }\n }\n schedule?: {\n frequency: { ... }\n interval_days: { ... }\n start_date?: { ... }\n end_date?: { ... }\n }\n enabled?: boolean\n created_at?: string // date-time\n last_updated_at?: string // date-time\n next_run_at?: string // date\n relations_for_deletion?: "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"[]\n last_run_at?: string // date-time\n }>\n cursor?: string\n}\n```\n';
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
exports.default = data_management_default;
|