@epilot/sdk 2.7.0 → 2.8.0-rc.0

package/dist/data-governance-QYFHBCNB.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/data-governance.json
+var data_governance_default = '# Data Governance API\n\n- **Base URL:** `https://data-governance.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/data-governance](https://docs.epilot.io/api/data-governance)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.dataGovernance.queryEntities(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/data-governance\'\n\nconst dataGovernanceClient = getClient()\nauthorize(dataGovernanceClient, () => \'<token>\')\nconst { data } = await dataGovernanceClient.queryEntities(...)\n```\n\n## Operations\n\n**Query**\n- [`queryEntities`](#queryentities)\n\n**Auditable Jobs**\n- [`createJob`](#createjob)\n- [`updateJob`](#updatejob)\n- [`getJob`](#getjob)\n- [`getJobReportUrl`](#getjobreporturl)\n- [`createJobForConfig`](#createjobforconfig)\n- [`listJobs`](#listjobs)\n\n**Data Lifecycle Configs**\n- [`getConfig`](#getconfig)\n- [`upsertConfig`](#upsertconfig)\n- [`listConfigs`](#listconfigs)\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 matching a data lifecycle config\n\n`POST /data-governance/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-governance/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: \'string\',\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": "string",\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-governance/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": "string",\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-governance/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": "string",\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-governance/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-governance/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": "string",\n    "end_date": "string"\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": "string",\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-governance/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": "string",\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\nCreate or update a data lifecycle config\n\n`POST /data-governance/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: \'string\',\n      end_date: \'string\'\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": "string",\n    "end_date": "string"\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": "string",\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 data lifecycle configs\n\n`GET /data-governance/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": "string",\n        "end_date": "string"\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": "string",\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 job runs\n\n`GET /data-governance/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": "string",\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\nThe governance action type. Determines what operation is performed on\nmatched entities when a job runs. Currently only `deletion` is supported.\n\n\n```ts\ntype ConfigType = "deletion"\n```\n\n### `JobStatus`\n\nCurrent execution status of a job run.\n- `in_progress` \u2014 the job is actively processing entities.\n- `success` \u2014 the job completed without critical errors.\n- `failed` \u2014 the job terminated due to an error.\n\n\n```ts\ntype JobStatus = "in_progress" | "success" | "failed"\n```\n\n### `JobTrigger`\n\nIndicates how the job was initiated.\n- `schedule` \u2014 automatically created by the background scheduler.\n- `manual` \u2014 explicitly triggered by a user via the API.\n\n\n```ts\ntype JobTrigger = "schedule" | "manual"\n```\n\n### `JobReportFormat`\n\nFile format of the job report. Currently only CSV is supported.\n\n```ts\ntype JobReportFormat = "csv"\n```\n\n### `JobReport`\n\nReference to a report file stored in S3 that details the outcome of a\njob run (e.g., which entities were deleted or failed).\n\n\n```ts\ntype JobReport = {\n  bucket?: string\n  key?: string\n  format?: "csv"\n}\n```\n\n### `CreateJobRequest`\n\nRequest payload for creating a new job run.\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\nType-specific job outcome payload. The shape depends on the config type.\nFor `deletion` jobs, typical fields include:\n- `matched_count` \u2014 total entities matched by the query\n- `deleted_count` \u2014 entities successfully deleted\n- `failed_count` \u2014 entities that could not be deleted\n\n\n```ts\ntype JobDetails = Record<string, unknown>\n```\n\n### `UpdateJobRequest`\n\nPartial update payload for an existing job. Only the fields provided\nwill be merged into the job record.\n\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\nRepresents a single execution run of a data lifecycle config. Tracks the\nfull lifecycle from creation through completion, including outcome\ndetails and an optional downloadable report.\n\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\nPaginated response containing a list of job runs.\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\nContains a time-limited pre-signed URL to download a job report.\n\n```ts\ntype JobReportUrlResponse = {\n  url?: string\n  expires_in?: number\n}\n```\n\n### `QueryFilterType`\n\nPredefined data governance filter types that can be layered on top of\na saved view to narrow down target entities:\n- `entity_workflows_only_in_closed_or_cancelled_status` \u2014 include only\n  entities whose own workflows are all in a closed/cancelled state.\n- `no_related_entities` \u2014 include only entitie\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\nA single governance filter condition applied during entity querying.\nThe required and optional fields depend on the `type`.\n\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\nDefines the query used by a data lifecycle config to identify target\nentities. Combines a saved view with optional governance filters.\n\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\nRequest body for the query endpoint. Extends `QueryConfig` with\npagination and projection options.\n\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\nResponse from the entity query endpoint.\n\n```ts\ntype QueryEntitiesResult = {\n  hits?: number\n  results?: Record<string, unknown>[]\n}\n```\n\n### `ConfigSchedule`\n\nInterval-based schedule. The governance engine will create a job every\n`interval_days` days, optionally bounded by start and end dates.\n\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\nInterval-based schedule. The governance engine will create a job every\n`interval_days` days, optionally bounded by start and end dates.\n\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\nRequest payload for creating or updating a data lifecycle config.\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\nA data lifecycle config defining an automated policy (e.g., scheduled\nentity deletion) for a specific entity schema.\n\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\nEntity schema slug that can be specified as a cascading deletion\ntarget. When a primary entity is deleted, related entities of these\nschemas are also removed.\n\n\n```ts\ntype DeletionRelationEntitySchema = "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"\n```\n\n### `ListConfigsResponse`\n\nPaginated response containing a list of data lifecycle configs.\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';
+
+
+exports.default = data_governance_default;

package/dist/data-governance-YS2NA6W4.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/data-governance.json
+var data_governance_default = '# Data Governance API\n\n- **Base URL:** `https://data-governance.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/data-governance](https://docs.epilot.io/api/data-governance)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.dataGovernance.queryEntities(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/data-governance\'\n\nconst dataGovernanceClient = getClient()\nauthorize(dataGovernanceClient, () => \'<token>\')\nconst { data } = await dataGovernanceClient.queryEntities(...)\n```\n\n## Operations\n\n**Query**\n- [`queryEntities`](#queryentities)\n\n**Auditable Jobs**\n- [`createJob`](#createjob)\n- [`updateJob`](#updatejob)\n- [`getJob`](#getjob)\n- [`getJobReportUrl`](#getjobreporturl)\n- [`createJobForConfig`](#createjobforconfig)\n- [`listJobs`](#listjobs)\n\n**Data Lifecycle Configs**\n- [`getConfig`](#getconfig)\n- [`upsertConfig`](#upsertconfig)\n- [`listConfigs`](#listconfigs)\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 matching a data lifecycle config\n\n`POST /data-governance/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-governance/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: \'string\',\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": "string",\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-governance/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": "string",\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-governance/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": "string",\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-governance/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-governance/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": "string",\n    "end_date": "string"\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": "string",\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-governance/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": "string",\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\nCreate or update a data lifecycle config\n\n`POST /data-governance/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: \'string\',\n      end_date: \'string\'\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": "string",\n    "end_date": "string"\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": "string",\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 data lifecycle configs\n\n`GET /data-governance/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": "string",\n        "end_date": "string"\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": "string",\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 job runs\n\n`GET /data-governance/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": "string",\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\nThe governance action type. Determines what operation is performed on\nmatched entities when a job runs. Currently only `deletion` is supported.\n\n\n```ts\ntype ConfigType = "deletion"\n```\n\n### `JobStatus`\n\nCurrent execution status of a job run.\n- `in_progress` \u2014 the job is actively processing entities.\n- `success` \u2014 the job completed without critical errors.\n- `failed` \u2014 the job terminated due to an error.\n\n\n```ts\ntype JobStatus = "in_progress" | "success" | "failed"\n```\n\n### `JobTrigger`\n\nIndicates how the job was initiated.\n- `schedule` \u2014 automatically created by the background scheduler.\n- `manual` \u2014 explicitly triggered by a user via the API.\n\n\n```ts\ntype JobTrigger = "schedule" | "manual"\n```\n\n### `JobReportFormat`\n\nFile format of the job report. Currently only CSV is supported.\n\n```ts\ntype JobReportFormat = "csv"\n```\n\n### `JobReport`\n\nReference to a report file stored in S3 that details the outcome of a\njob run (e.g., which entities were deleted or failed).\n\n\n```ts\ntype JobReport = {\n  bucket?: string\n  key?: string\n  format?: "csv"\n}\n```\n\n### `CreateJobRequest`\n\nRequest payload for creating a new job run.\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\nType-specific job outcome payload. The shape depends on the config type.\nFor `deletion` jobs, typical fields include:\n- `matched_count` \u2014 total entities matched by the query\n- `deleted_count` \u2014 entities successfully deleted\n- `failed_count` \u2014 entities that could not be deleted\n\n\n```ts\ntype JobDetails = Record<string, unknown>\n```\n\n### `UpdateJobRequest`\n\nPartial update payload for an existing job. Only the fields provided\nwill be merged into the job record.\n\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\nRepresents a single execution run of a data lifecycle config. Tracks the\nfull lifecycle from creation through completion, including outcome\ndetails and an optional downloadable report.\n\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\nPaginated response containing a list of job runs.\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\nContains a time-limited pre-signed URL to download a job report.\n\n```ts\ntype JobReportUrlResponse = {\n  url?: string\n  expires_in?: number\n}\n```\n\n### `QueryFilterType`\n\nPredefined data governance filter types that can be layered on top of\na saved view to narrow down target entities:\n- `entity_workflows_only_in_closed_or_cancelled_status` \u2014 include only\n  entities whose own workflows are all in a closed/cancelled state.\n- `no_related_entities` \u2014 include only entitie\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\nA single governance filter condition applied during entity querying.\nThe required and optional fields depend on the `type`.\n\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\nDefines the query used by a data lifecycle config to identify target\nentities. Combines a saved view with optional governance filters.\n\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\nRequest body for the query endpoint. Extends `QueryConfig` with\npagination and projection options.\n\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\nResponse from the entity query endpoint.\n\n```ts\ntype QueryEntitiesResult = {\n  hits?: number\n  results?: Record<string, unknown>[]\n}\n```\n\n### `ConfigSchedule`\n\nInterval-based schedule. The governance engine will create a job every\n`interval_days` days, optionally bounded by start and end dates.\n\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\nInterval-based schedule. The governance engine will create a job every\n`interval_days` days, optionally bounded by start and end dates.\n\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\nRequest payload for creating or updating a data lifecycle config.\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\nA data lifecycle config defining an automated policy (e.g., scheduled\nentity deletion) for a specific entity schema.\n\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\nEntity schema slug that can be specified as a cascading deletion\ntarget. When a primary entity is deleted, related entities of these\nschemas are also removed.\n\n\n```ts\ntype DeletionRelationEntitySchema = "contact" | "file" | "opportunity" | "order" | "meter" | "ticket" | "message" | "account" | "submission" | "contract"\n```\n\n### `ListConfigsResponse`\n\nPaginated response containing a list of data lifecycle configs.\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';
+export {
+  data_governance_default as default
+};

package/dist/design-EWZQZ5KX.js

@@ -0,0 +1,7 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/docs/design.json
+var design_default = '# Design Builder API v2\n\n- **Base URL:** `https://design-builder-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/design](https://docs.epilot.io/api/design)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.design.getAllDesigns(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/design\'\n\nconst designClient = getClient()\nauthorize(designClient, () => \'<token>\')\nconst { data } = await designClient.getAllDesigns(...)\n```\n\n## Operations\n\n**design-builder**\n- [`getAllDesigns`](#getalldesigns)\n- [`addDesign`](#adddesign)\n- [`getDesign`](#getdesign)\n- [`deleteDesign`](#deletedesign)\n- [`updateDesign`](#updatedesign)\n- [`getThemeFromDesign`](#getthemefromdesign)\n- [`uploadFile`](#uploadfile)\n- [`getFiles`](#getfiles)\n- [`getConsumerDesign`](#getconsumerdesign)\n- [`addConsumer`](#addconsumer)\n- [`removeConsumer`](#removeconsumer)\n\n**Schemas**\n- [`UploadFileReq`](#uploadfilereq)\n- [`UploadFileRes`](#uploadfileres)\n- [`GetFilesRes`](#getfilesres)\n- [`GetAllDesignsRes`](#getalldesignsres)\n- [`GetBrandsRes`](#getbrandsres)\n- [`AddDesignReq`](#adddesignreq)\n- [`AddDesignRes`](#adddesignres)\n- [`GetDesignRes`](#getdesignres)\n- [`UpdateDesignReq`](#updatedesignreq)\n- [`ItemMetada`](#itemmetada)\n- [`AddConsumerReq`](#addconsumerreq)\n- [`RemoveConsumerReq`](#removeconsumerreq)\n- [`DesignItem`](#designitem)\n- [`BrandItem`](#branditem)\n- [`Custom_Style`](#custom_style)\n- [`Journey`](#journey)\n- [`ConsumerData`](#consumerdata)\n- [`WidgetData`](#widgetdata)\n- [`CustomerPortalData`](#customerportaldata)\n- [`LogoData`](#logodata)\n- [`PaletteData`](#palettedata)\n- [`TypographyData`](#typographydata)\n- [`ShapeData`](#shapedata)\n- [`FontData`](#fontdata)\n- [`FontResponseUrl`](#fontresponseurl)\n- [`WidgetPortalData`](#widgetportaldata)\n- [`ErrorResp`](#errorresp)\n- [`FileData`](#filedata)\n- [`DesignId`](#designid)\n- [`Theme`](#theme)\n- [`Application`](#application)\n- [`DesignParameters`](#designparameters)\n\n### `getAllDesigns`\n\nScan all designs linked to a organization, based in orgId attribute from JWT auth token\n\n`GET /v1/designs`\n\n```ts\nconst { data } = await client.getAllDesigns()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "designs": [\n    {\n      "id": "string",\n      "created_at": "2021-01-30T08:30:00Z",\n      "created_by": "string",\n      "edited": true,\n      "last_modified_at": "string",\n      "brand_id": "string",\n      "brand_name": "string",\n      "user": {},\n      "style_name": "string",\n      "style": {},\n      "is_default": true,\n      "_manifest": ["string"],\n      "custom_theme": "string",\n      "use_custom_theme": true,\n      "design_tokens": {}\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `addDesign`\n\nCreate a brand new design linked to a organization, based in orgId attribute from JWT auth token\n\n`POST /v1/designs`\n\n```ts\nconst { data } = await client.addDesign(\n  null,\n  {\n    design: {\n      brand_id: \'string\',\n      brand_name: \'string\',\n      user: {\n        emailaddress: \'string\',\n        fullname: \'string\',\n        name: \'string\',\n        userid: \'string\'\n      },\n      style_name: \'string\',\n      style: {\n        logo: { /* ... */ },\n        palette: { /* ... */ },\n        typography: { /* ... */ },\n        shape: { /* ... */ },\n        consumer: { /* ... */ }\n      },\n      is_default: true,\n      _manifest: [\'string\'],\n      custom_theme: \'string\',\n      use_custom_theme: true,\n      design_tokens: {\n        coupon: \'string\',\n        cashback: \'string\',\n        custom_css: \'string\',\n        accent_color: \'string\',\n        outline_color: \'string\',\n        divider_color: \'string\',\n        link_color: \'string\',\n        link_hover_color: \'string\',\n        font_size_scale: \'xs\',\n        topbar_height: 0,\n        topbar_logo_alignment: \'flex-start\',\n        logo_size: 0,\n        input_background: \'string\',\n        input_border_color: \'string\',\n        input_text_color: \'string\',\n        input_label_color: \'string\',\n        input_border_radius: 0,\n        input_height: 0,\n        input_variant: \'outlined\',\n        button_primary_bg: \'string\',\n        button_primary_text: \'string\',\n        button_primary_hover_bg: \'string\',\n        button_primary_hover_text: \'string\',\n        button_outlined_border: \'string\',\n        button_outlined_text: \'string\',\n        button_outlined_hover_bg: \'string\',\n        button_outlined_hover_text: \'string\',\n        button_ghost_bg: \'string\',\n        button_ghost_text: \'string\',\n        button_ghost_hover_bg: \'string\',\n        button_ghost_hover_text: \'string\',\n        button_border_radius: 0,\n        button_height: 0,\n        card_background: \'string\',\n        card_border_color: \'string\',\n        card_variant: \'shadow\',\n        summary_card_background: \'string\',\n        toggle_selected_bg: \'string\',\n        toggle_selected_text: \'string\',\n        toggle_hover_bg: \'string\',\n        toggle_hover_text: \'string\',\n        toggle_border_color: \'string\',\n        dropdown_hover_bg: \'string\',\n        dropdown_hover_text: \'string\',\n        dropdown_selected_bg: \'string\',\n        dropdown_selected_text: \'string\',\n        switch_unchecked_color: \'string\',\n        switch_unchecked_bg: \'string\',\n        switch_border_radius: 0,\n        checkbox_unchecked_color: \'string\',\n        checkbox_label_color: \'string\',\n        radio_unchecked_color: \'string\',\n        radio_label_color: \'string\',\n        datepicker_selected_bg: \'string\',\n        datepicker_selected_color: \'string\',\n        datepicker_border_radius: 0,\n        chip_background: \'string\',\n        chip_hover_background: \'string\',\n        chip_text_color: \'string\',\n        chip_hover_text_color: \'string\'\n      }\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "design": {\n    "id": "string",\n    "created_at": "2021-01-30T08:30:00Z",\n    "created_by": "string",\n    "edited": true,\n    "last_modified_at": "string",\n    "brand_id": "string",\n    "brand_name": "string",\n    "user": {\n      "emailaddress": "string",\n      "fullname": "string",\n      "name": "string",\n      "userid": "string"\n    },\n    "style_name": "string",\n    "style": {\n      "logo": {},\n      "palette": {},\n      "typography": {},\n      "shape": {},\n      "consumer": {}\n    },\n    "is_default": true,\n    "_manifest": ["string"],\n    "custom_theme": "string",\n    "use_custom_theme": true,\n    "design_tokens": {\n      "coupon": "string",\n      "cashback": "string",\n      "custom_css": "string",\n      "accent_color": "string",\n      "outline_color": "string",\n      "divider_color": "string",\n      "link_color": "string",\n      "link_hover_color": "string",\n      "font_size_scale": "xs",\n      "topbar_height": 0,\n      "topbar_logo_alignment": "flex-start",\n      "logo_size": 0,\n      "input_background": "string",\n      "input_border_color": "string",\n      "input_text_color": "string",\n      "input_label_color": "string",\n      "input_border_radius": 0,\n      "input_height": 0,\n      "input_variant": "outlined",\n      "button_primary_bg": "string",\n      "button_primary_text": "string",\n      "button_primary_hover_bg": "string",\n      "button_primary_hover_text": "string",\n      "button_outlined_border": "string",\n      "button_outlined_text": "string",\n      "button_outlined_hover_bg": "string",\n      "button_outlined_hover_text": "string",\n      "button_ghost_bg": "string",\n      "button_ghost_text": "string",\n      "button_ghost_hover_bg": "string",\n      "button_ghost_hover_text": "string",\n      "button_border_radius": 0,\n      "button_height": 0,\n      "card_background": "string",\n      "card_border_color": "string",\n      "card_variant": "shadow",\n      "summary_card_background": "string",\n      "toggle_selected_bg": "string",\n      "toggle_selected_text": "string",\n      "toggle_hover_bg": "string",\n      "toggle_hover_text": "string",\n      "toggle_border_color": "string",\n      "dropdown_hover_bg": "string",\n      "dropdown_hover_text": "string",\n      "dropdown_selected_bg": "string",\n      "dropdown_selected_text": "string",\n      "switch_unchecked_color": "string",\n      "switch_unchecked_bg": "string",\n      "switch_border_radius": 0,\n      "checkbox_unchecked_color": "string",\n      "checkbox_label_color": "string",\n      "radio_unchecked_color": "string",\n      "radio_label_color": "string",\n      "datepicker_selected_bg": "string",\n      "datepicker_selected_color": "string",\n      "datepicker_border_radius": 0,\n      "chip_background": "string",\n      "chip_hover_background": "string",\n      "chip_text_color": "string",\n      "chip_hover_text_color": "string"\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `getDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.getDesign({\n  designId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "design": {\n    "id": "string",\n    "created_at": "2021-01-30T08:30:00Z",\n    "created_by": "string",\n    "edited": true,\n    "last_modified_at": "string",\n    "brand_id": "string",\n    "brand_name": "string",\n    "user": {\n      "emailaddress": "string",\n      "fullname": "string",\n      "name": "string",\n      "userid": "string"\n    },\n    "style_name": "string",\n    "style": {\n      "logo": {},\n      "palette": {},\n      "typography": {},\n      "shape": {},\n      "consumer": {}\n    },\n    "is_default": true,\n    "_manifest": ["string"],\n    "custom_theme": "string",\n    "use_custom_theme": true,\n    "design_tokens": {\n      "coupon": "string",\n      "cashback": "string",\n      "custom_css": "string",\n      "accent_color": "string",\n      "outline_color": "string",\n      "divider_color": "string",\n      "link_color": "string",\n      "link_hover_color": "string",\n      "font_size_scale": "xs",\n      "topbar_height": 0,\n      "topbar_logo_alignment": "flex-start",\n      "logo_size": 0,\n      "input_background": "string",\n      "input_border_color": "string",\n      "input_text_color": "string",\n      "input_label_color": "string",\n      "input_border_radius": 0,\n      "input_height": 0,\n      "input_variant": "outlined",\n      "button_primary_bg": "string",\n      "button_primary_text": "string",\n      "button_primary_hover_bg": "string",\n      "button_primary_hover_text": "string",\n      "button_outlined_border": "string",\n      "button_outlined_text": "string",\n      "button_outlined_hover_bg": "string",\n      "button_outlined_hover_text": "string",\n      "button_ghost_bg": "string",\n      "button_ghost_text": "string",\n      "button_ghost_hover_bg": "string",\n      "button_ghost_hover_text": "string",\n      "button_border_radius": 0,\n      "button_height": 0,\n      "card_background": "string",\n      "card_border_color": "string",\n      "card_variant": "shadow",\n      "summary_card_background": "string",\n      "toggle_selected_bg": "string",\n      "toggle_selected_text": "string",\n      "toggle_hover_bg": "string",\n      "toggle_hover_text": "string",\n      "toggle_border_color": "string",\n      "dropdown_hover_bg": "string",\n      "dropdown_hover_text": "string",\n      "dropdown_selected_bg": "string",\n      "dropdown_selected_text": "string",\n      "switch_unchecked_color": "string",\n      "switch_unchecked_bg": "string",\n      "switch_border_radius": 0,\n      "checkbox_unchecked_color": "string",\n      "checkbox_label_color": "string",\n      "radio_unchecked_color": "string",\n      "radio_label_color": "string",\n      "datepicker_selected_bg": "string",\n      "datepicker_selected_color": "string",\n      "datepicker_border_radius": 0,\n      "chip_background": "string",\n      "chip_hover_background": "string",\n      "chip_text_color": "string",\n      "chip_hover_text_color": "string"\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `deleteDesign`\n\nSearch and delete for a especific design owned by user organization\n\n`DELETE /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.deleteDesign({\n  designId: \'example\',\n})\n```\n\n---\n\n### `updateDesign`\n\nUpdate a especific design owned by user organization\n\n`PUT /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.updateDesign(\n  {\n    designId: \'example\',\n  },\n  {\n    design: {\n      brand_id: \'string\',\n      brand_name: \'string\',\n      user: {\n        emailaddress: \'string\',\n        fullname: \'string\',\n        name: \'string\',\n        userid: \'string\'\n      },\n      style_name: \'string\',\n      style: {\n        logo: { /* ... */ },\n        palette: { /* ... */ },\n        typography: { /* ... */ },\n        shape: { /* ... */ },\n        consumer: { /* ... */ }\n      },\n      is_default: true,\n      _manifest: [\'string\'],\n      custom_theme: \'string\',\n      use_custom_theme: true,\n      design_tokens: {\n        coupon: \'string\',\n        cashback: \'string\',\n        custom_css: \'string\',\n        accent_color: \'string\',\n        outline_color: \'string\',\n        divider_color: \'string\',\n        link_color: \'string\',\n        link_hover_color: \'string\',\n        font_size_scale: \'xs\',\n        topbar_height: 0,\n        topbar_logo_alignment: \'flex-start\',\n        logo_size: 0,\n        input_background: \'string\',\n        input_border_color: \'string\',\n        input_text_color: \'string\',\n        input_label_color: \'string\',\n        input_border_radius: 0,\n        input_height: 0,\n        input_variant: \'outlined\',\n        button_primary_bg: \'string\',\n        button_primary_text: \'string\',\n        button_primary_hover_bg: \'string\',\n        button_primary_hover_text: \'string\',\n        button_outlined_border: \'string\',\n        button_outlined_text: \'string\',\n        button_outlined_hover_bg: \'string\',\n        button_outlined_hover_text: \'string\',\n        button_ghost_bg: \'string\',\n        button_ghost_text: \'string\',\n        button_ghost_hover_bg: \'string\',\n        button_ghost_hover_text: \'string\',\n        button_border_radius: 0,\n        button_height: 0,\n        card_background: \'string\',\n        card_border_color: \'string\',\n        card_variant: \'shadow\',\n        summary_card_background: \'string\',\n        toggle_selected_bg: \'string\',\n        toggle_selected_text: \'string\',\n        toggle_hover_bg: \'string\',\n        toggle_hover_text: \'string\',\n        toggle_border_color: \'string\',\n        dropdown_hover_bg: \'string\',\n        dropdown_hover_text: \'string\',\n        dropdown_selected_bg: \'string\',\n        dropdown_selected_text: \'string\',\n        switch_unchecked_color: \'string\',\n        switch_unchecked_bg: \'string\',\n        switch_border_radius: 0,\n        checkbox_unchecked_color: \'string\',\n        checkbox_label_color: \'string\',\n        radio_unchecked_color: \'string\',\n        radio_label_color: \'string\',\n        datepicker_selected_bg: \'string\',\n        datepicker_selected_color: \'string\',\n        datepicker_border_radius: 0,\n        chip_background: \'string\',\n        chip_hover_background: \'string\',\n        chip_text_color: \'string\',\n        chip_hover_text_color: \'string\'\n      }\n    }\n  },\n)\n```\n\n---\n\n### `getThemeFromDesign`\n\nSearch for a especific design owned by user organization and parse them to a new or old theme\n\n`GET /v1/designs/{designId}/parse`\n\n```ts\nconst { data } = await client.getThemeFromDesign({\n  designId: \'example\',\n  orgId: \'example\',\n  theme: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `uploadFile`\n\nUpload a new file for the user organization bucket\n\n`POST /v1/designs/files`\n\n```ts\nconst { data } = await client.uploadFile()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "name": "string",\n  "display_name": "string",\n  "file_type": "LOGO",\n  "s3_object_key": "string",\n  "url": "string"\n}\n```\n\n</details>\n\n---\n\n### `getFiles`\n\nList all files for the user organization bucket\n\n`GET /v1/designs/files`\n\n```ts\nconst { data } = await client.getFiles({\n  type: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "name": "string",\n    "display_name": "string",\n    "file_type": "LOGO",\n    "s3_object_key": "string",\n    "url": "string"\n  }\n]\n```\n\n</details>\n\n---\n\n### `getConsumerDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/consumer/{application}/{consumerId}`\n\n```ts\nconst { data } = await client.getConsumerDesign({\n  consumerId: \'example\',\n  application: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "design": {\n    "id": "string",\n    "created_at": "2021-01-30T08:30:00Z",\n    "created_by": "string",\n    "edited": true,\n    "last_modified_at": "string",\n    "brand_id": "string",\n    "brand_name": "string",\n    "user": {\n      "emailaddress": "string",\n      "fullname": "string",\n      "name": "string",\n      "userid": "string"\n    },\n    "style_name": "string",\n    "style": {\n      "logo": {},\n      "palette": {},\n      "typography": {},\n      "shape": {},\n      "consumer": {}\n    },\n    "is_default": true,\n    "_manifest": ["string"],\n    "custom_theme": "string",\n    "use_custom_theme": true,\n    "design_tokens": {\n      "coupon": "string",\n      "cashback": "string",\n      "custom_css": "string",\n      "accent_color": "string",\n      "outline_color": "string",\n      "divider_color": "string",\n      "link_color": "string",\n      "link_hover_color": "string",\n      "font_size_scale": "xs",\n      "topbar_height": 0,\n      "topbar_logo_alignment": "flex-start",\n      "logo_size": 0,\n      "input_background": "string",\n      "input_border_color": "string",\n      "input_text_color": "string",\n      "input_label_color": "string",\n      "input_border_radius": 0,\n      "input_height": 0,\n      "input_variant": "outlined",\n      "button_primary_bg": "string",\n      "button_primary_text": "string",\n      "button_primary_hover_bg": "string",\n      "button_primary_hover_text": "string",\n      "button_outlined_border": "string",\n      "button_outlined_text": "string",\n      "button_outlined_hover_bg": "string",\n      "button_outlined_hover_text": "string",\n      "button_ghost_bg": "string",\n      "button_ghost_text": "string",\n      "button_ghost_hover_bg": "string",\n      "button_ghost_hover_text": "string",\n      "button_border_radius": 0,\n      "button_height": 0,\n      "card_background": "string",\n      "card_border_color": "string",\n      "card_variant": "shadow",\n      "summary_card_background": "string",\n      "toggle_selected_bg": "string",\n      "toggle_selected_text": "string",\n      "toggle_hover_bg": "string",\n      "toggle_hover_text": "string",\n      "toggle_border_color": "string",\n      "dropdown_hover_bg": "string",\n      "dropdown_hover_text": "string",\n      "dropdown_selected_bg": "string",\n      "dropdown_selected_text": "string",\n      "switch_unchecked_color": "string",\n      "switch_unchecked_bg": "string",\n      "switch_border_radius": 0,\n      "checkbox_unchecked_color": "string",\n      "checkbox_label_color": "string",\n      "radio_unchecked_color": "string",\n      "radio_label_color": "string",\n      "datepicker_selected_bg": "string",\n      "datepicker_selected_color": "string",\n      "datepicker_border_radius": 0,\n      "chip_background": "string",\n      "chip_hover_background": "string",\n      "chip_text_color": "string",\n      "chip_hover_text_color": "string"\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `addConsumer`\n\nAdd a consumer that uses a specific design\n\n`PUT /v1/designs/addConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.addConsumer(\n  {\n    designId: \'example\',\n    application: \'example\',\n  },\n  {\n    consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n    consumer_name: \'string\',\n    should_delete: \'string\'\n  },\n)\n```\n\n---\n\n### `removeConsumer`\n\nRemove a consumer that uses a specific design\n\n`PUT /v1/designs/removeConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.removeConsumer(\n  {\n    designId: \'example\',\n    application: \'example\',\n  },\n  {\n    consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n    should_delete: \'string\'\n  },\n)\n```\n\n---\n\n## Schemas\n\n### `UploadFileReq`\n\n```ts\ntype UploadFileReq = {\n  file_type: "LOGO" | "FONT" | "IMAGE"\n  file_data: string // base64\n  display_name?: string\n  file_name: string\n}\n```\n\n### `UploadFileRes`\n\n```ts\ntype UploadFileRes = {\n  name: string\n  display_name?: string\n  file_type?: "LOGO" | "FONT" | "IMAGE"\n  s3_object_key: string\n  url: string\n}\n```\n\n### `GetFilesRes`\n\n```ts\ntype GetFilesRes = Array<{\n  name: string\n  display_name?: string\n  file_type?: "LOGO" | "FONT" | "IMAGE"\n  s3_object_key: string\n  url: string\n}>\n```\n\n### `GetAllDesignsRes`\n\n```ts\ntype GetAllDesignsRes = {\n  designs?: Array<{\n    id?: string\n    created_at?: string\n    created_by?: string\n    edited: boolean\n    last_modified_at?: string\n    brand_id?: string\n    brand_name?: string\n    user?: {\n      emailaddress?: { ... }\n      fullname?: { ... }\n      name?: { ... }\n      userid?: { ... }\n    }\n    style_name: string\n    style: {\n      logo?: { ... }\n      palette: { ... }\n      typography: { ... }\n      shape?: { ... }\n      consumer: { ... }\n    }\n    is_default?: boolean\n    _manifest?: string[]\n    custom_theme?: string\n    use_custom_theme?: boolean\n    design_tokens?: {\n      coupon?: { ... }\n      cashback?: { ... }\n      custom_css?: { ... }\n      accent_color?: { ... }\n      outline_color?: { ... }\n      divider_color?: { ... }\n      link_color?: { ... }\n      link_hover_color?: { ... }\n      font_size_scale?: { ... }\n      topbar_height?: { ... }\n      topbar_logo_alignment?: { ... }\n      logo_size?: { ... }\n      input_background?: { ... }\n      input_border_color?: { ... }\n      input_text_color?: { ... }\n      input_label_color?: { ... }\n      input_border_radius?: { ... }\n      input_height?: { ... }\n      input_variant?: { ... }\n      button_primary_bg?: { ... }\n      button_primary_text?: { ... }\n      button_primary_hover_bg?: { ... }\n      button_primary_hover_text?: { ... }\n      button_outlined_border?: { ... }\n      button_outlined_text?: { ... }\n      button_outlined_hover_bg?: { ... }\n      button_outlined_hover_text?: { ... }\n      button_ghost_bg?: { ... }\n      button_ghost_text?: { ... }\n      button_ghost_hover_bg?: { ... }\n      button_ghost_hover_text?: { ... }\n      button_border_radius?: { ... }\n      button_height?: { ... }\n      card_background?: { ... }\n      card_border_color?: { ... }\n      card_variant?: { ... }\n      summary_card_background?: { ... }\n      toggle_selected_bg?: { ... }\n      toggle_selected_text?: { ... }\n      toggle_hover_bg?: { ... }\n      toggle_hover_text?: { ... }\n      toggle_border_color?: { ... }\n      dropdown_hover_bg?: { ... }\n      dropdown_hover_text?: { ... }\n      dropdown_selected_bg?: { ... }\n      dropdown_selected_text?: { ... }\n      switch_unchecked_color?: { ... }\n      switch_unchecked_bg?: { ... }\n      switch_border_radius?: { ... }\n      checkbox_unchecked_color?: { ... }\n      checkbox_label_color?: { ... }\n      radio_unchecked_color?: { ... }\n      radio_label_color?: { ... }\n      datepicker_selected_bg?: { ... }\n      datepicker_selected_color?: { ... }\n      datepicker_border_radius?: { ... }\n      chip_background?: { ... }\n      chip_hover_background?: { ... }\n      chip_text_color?: { ... }\n      chip_hover_text_color?: { ... }\n    }\n  }>\n}\n```\n\n### `GetBrandsRes`\n\n```ts\ntype GetBrandsRes = {\n  brands?: Array<{\n    id: string\n    name: string\n    created_by?: string\n    created_date?: string\n    main_brand?: string\n    organization_id?: string\n    updated_date?: string\n    updated_by?: string\n    status?: string\n  }>\n}\n```\n\n### `AddDesignReq`\n\n```ts\ntype AddDesignReq = {\n  design: {\n    brand_id?: string\n    brand_name?: string\n    user?: {\n      emailaddress?: { ... }\n      fullname?: { ... }\n      name?: { ... }\n      userid?: { ... }\n    }\n    style_name: string\n    style: {\n      logo?: { ... }\n      palette: { ... }\n      typography: { ... }\n      shape?: { ... }\n      consumer: { ... }\n    }\n    is_default?: boolean\n    _manifest?: string[]\n    custom_theme?: string\n    use_custom_theme?: boolean\n    design_tokens?: {\n      coupon?: { ... }\n      cashback?: { ... }\n      custom_css?: { ... }\n      accent_color?: { ... }\n      outline_color?: { ... }\n      divider_color?: { ... }\n      link_color?: { ... }\n      link_hover_color?: { ... }\n      font_size_scale?: { ... }\n      topbar_height?: { ... }\n      topbar_logo_alignment?: { ... }\n      logo_size?: { ... }\n      input_background?: { ... }\n      input_border_color?: { ... }\n      input_text_color?: { ... }\n      input_label_color?: { ... }\n      input_border_radius?: { ... }\n      input_height?: { ... }\n      input_variant?: { ... }\n      button_primary_bg?: { ... }\n      button_primary_text?: { ... }\n      button_primary_hover_bg?: { ... }\n      button_primary_hover_text?: { ... }\n      button_outlined_border?: { ... }\n      button_outlined_text?: { ... }\n      button_outlined_hover_bg?: { ... }\n      button_outlined_hover_text?: { ... }\n      button_ghost_bg?: { ... }\n      button_ghost_text?: { ... }\n      button_ghost_hover_bg?: { ... }\n      button_ghost_hover_text?: { ... }\n      button_border_radius?: { ... }\n      button_height?: { ... }\n      card_background?: { ... }\n      card_border_color?: { ... }\n      card_variant?: { ... }\n      summary_card_background?: { ... }\n      toggle_selected_bg?: { ... }\n      toggle_selected_text?: { ... }\n      toggle_hover_bg?: { ... }\n      toggle_hover_text?: { ... }\n      toggle_border_color?: { ... }\n      dropdown_hover_bg?: { ... }\n      dropdown_hover_text?: { ... }\n      dropdown_selected_bg?: { ... }\n      dropdown_selected_text?: { ... }\n      switch_unchecked_color?: { ... }\n      switch_unchecked_bg?: { ... }\n      switch_border_radius?: { ... }\n      checkbox_unchecked_color?: { ... }\n      checkbox_label_color?: { ... }\n      radio_unchecked_color?: { ... }\n      radio_label_color?: { ... }\n      datepicker_selected_bg?: { ... }\n      datepicker_selected_color?: { ... }\n      datepicker_border_radius?: { ... }\n      chip_background?: { ... }\n      chip_hover_background?: { ... }\n      chip_text_color?: { ... }\n      chip_hover_text_color?: { ... }\n    }\n  }\n}\n```\n\n### `AddDesignRes`\n\n```ts\ntype AddDesignRes = {\n  design?: {\n    id?: string\n    created_at?: string\n    created_by?: string\n    edited: boolean\n    last_modified_at?: string\n    brand_id?: string\n    brand_name?: string\n    user?: {\n      emailaddress?: { ... }\n      fullname?: { ... }\n      name?: { ... }\n      userid?: { ... }\n    }\n    style_name: string\n    style: {\n      logo?: { ... }\n      palette: { ... }\n      typography: { ... }\n      shape?: { ... }\n      consumer: { ... }\n    }\n    is_default?: boolean\n    _manifest?: string[]\n    custom_theme?: string\n    use_custom_theme?: boolean\n    design_tokens?: {\n      coupon?: { ... }\n      cashback?: { ... }\n      custom_css?: { ... }\n      accent_color?: { ... }\n      outline_color?: { ... }\n      divider_color?: { ... }\n      link_color?: { ... }\n      link_hover_color?: { ... }\n      font_size_scale?: { ... }\n      topbar_height?: { ... }\n      topbar_logo_alignment?: { ... }\n      logo_size?: { ... }\n      input_background?: { ... }\n      input_border_color?: { ... }\n      input_text_color?: { ... }\n      input_label_color?: { ... }\n      input_border_radius?: { ... }\n      input_height?: { ... }\n      input_variant?: { ... }\n      button_primary_bg?: { ... }\n      button_primary_text?: { ... }\n      button_primary_hover_bg?: { ... }\n      button_primary_hover_text?: { ... }\n      button_outlined_border?: { ... }\n      button_outlined_text?: { ... }\n      button_outlined_hover_bg?: { ... }\n      button_outlined_hover_text?: { ... }\n      button_ghost_bg?: { ... }\n      button_ghost_text?: { ... }\n      button_ghost_hover_bg?: { ... }\n      button_ghost_hover_text?: { ... }\n      button_border_radius?: { ... }\n      button_height?: { ... }\n      card_background?: { ... }\n      card_border_color?: { ... }\n      card_variant?: { ... }\n      summary_card_background?: { ... }\n      toggle_selected_bg?: { ... }\n      toggle_selected_text?: { ... }\n      toggle_hover_bg?: { ... }\n      toggle_hover_text?: { ... }\n      toggle_border_color?: { ... }\n      dropdown_hover_bg?: { ... }\n      dropdown_hover_text?: { ... }\n      dropdown_selected_bg?: { ... }\n      dropdown_selected_text?: { ... }\n      switch_unchecked_color?: { ... }\n      switch_unchecked_bg?: { ... }\n      switch_border_radius?: { ... }\n      checkbox_unchecked_color?: { ... }\n      checkbox_label_color?: { ... }\n      radio_unchecked_color?: { ... }\n      radio_label_color?: { ... }\n      datepicker_selected_bg?: { ... }\n      datepicker_selected_color?: { ... }\n      datepicker_border_radius?: { ... }\n      chip_background?: { ... }\n      chip_hover_background?: { ... }\n      chip_text_color?: { ... }\n      chip_hover_text_color?: { ... }\n    }\n  }\n}\n```\n\n### `GetDesignRes`\n\n```ts\ntype GetDesignRes = {\n  design?: {\n    id?: string\n    created_at?: string\n    created_by?: string\n    edited: boolean\n    last_modified_at?: string\n    brand_id?: string\n    brand_name?: string\n    user?: {\n      emailaddress?: { ... }\n      fullname?: { ... }\n      name?: { ... }\n      userid?: { ... }\n    }\n    style_name: string\n    style: {\n      logo?: { ... }\n      palette: { ... }\n      typography: { ... }\n      shape?: { ... }\n      consumer: { ... }\n    }\n    is_default?: boolean\n    _manifest?: string[]\n    custom_theme?: string\n    use_custom_theme?: boolean\n    design_tokens?: {\n      coupon?: { ... }\n      cashback?: { ... }\n      custom_css?: { ... }\n      accent_color?: { ... }\n      outline_color?: { ... }\n      divider_color?: { ... }\n      link_color?: { ... }\n      link_hover_color?: { ... }\n      font_size_scale?: { ... }\n      topbar_height?: { ... }\n      topbar_logo_alignment?: { ... }\n      logo_size?: { ... }\n      input_background?: { ... }\n      input_border_color?: { ... }\n      input_text_color?: { ... }\n      input_label_color?: { ... }\n      input_border_radius?: { ... }\n      input_height?: { ... }\n      input_variant?: { ... }\n      button_primary_bg?: { ... }\n      button_primary_text?: { ... }\n      button_primary_hover_bg?: { ... }\n      button_primary_hover_text?: { ... }\n      button_outlined_border?: { ... }\n      button_outlined_text?: { ... }\n      button_outlined_hover_bg?: { ... }\n      button_outlined_hover_text?: { ... }\n      button_ghost_bg?: { ... }\n      button_ghost_text?: { ... }\n      button_ghost_hover_bg?: { ... }\n      button_ghost_hover_text?: { ... }\n      button_border_radius?: { ... }\n      button_height?: { ... }\n      card_background?: { ... }\n      card_border_color?: { ... }\n      card_variant?: { ... }\n      summary_card_background?: { ... }\n      toggle_selected_bg?: { ... }\n      toggle_selected_text?: { ... }\n      toggle_hover_bg?: { ... }\n      toggle_hover_text?: { ... }\n      toggle_border_color?: { ... }\n      dropdown_hover_bg?: { ... }\n      dropdown_hover_text?: { ... }\n      dropdown_selected_bg?: { ... }\n      dropdown_selected_text?: { ... }\n      switch_unchecked_color?: { ... }\n      switch_unchecked_bg?: { ... }\n      switch_border_radius?: { ... }\n      checkbox_unchecked_color?: { ... }\n      checkbox_label_color?: { ... }\n      radio_unchecked_color?: { ... }\n      radio_label_color?: { ... }\n      datepicker_selected_bg?: { ... }\n      datepicker_selected_color?: { ... }\n      datepicker_border_radius?: { ... }\n      chip_background?: { ... }\n      chip_hover_background?: { ... }\n      chip_text_color?: { ... }\n      chip_hover_text_color?: { ... }\n    }\n  }\n}\n```\n\n### `UpdateDesignReq`\n\n```ts\ntype UpdateDesignReq = {\n  design: {\n    brand_id?: string\n    brand_name?: string\n    user?: {\n      emailaddress?: { ... }\n      fullname?: { ... }\n      name?: { ... }\n      userid?: { ... }\n    }\n    style_name: string\n    style: {\n      logo?: { ... }\n      palette: { ... }\n      typography: { ... }\n      shape?: { ... }\n      consumer: { ... }\n    }\n    is_default?: boolean\n    _manifest?: string[]\n    custom_theme?: string\n    use_custom_theme?: boolean\n    design_tokens?: {\n      coupon?: { ... }\n      cashback?: { ... }\n      custom_css?: { ... }\n      accent_color?: { ... }\n      outline_color?: { ... }\n      divider_color?: { ... }\n      link_color?: { ... }\n      link_hover_color?: { ... }\n      font_size_scale?: { ... }\n      topbar_height?: { ... }\n      topbar_logo_alignment?: { ... }\n      logo_size?: { ... }\n      input_background?: { ... }\n      input_border_color?: { ... }\n      input_text_color?: { ... }\n      input_label_color?: { ... }\n      input_border_radius?: { ... }\n      input_height?: { ... }\n      input_variant?: { ... }\n      button_primary_bg?: { ... }\n      button_primary_text?: { ... }\n      button_primary_hover_bg?: { ... }\n      button_primary_hover_text?: { ... }\n      button_outlined_border?: { ... }\n      button_outlined_text?: { ... }\n      button_outlined_hover_bg?: { ... }\n      button_outlined_hover_text?: { ... }\n      button_ghost_bg?: { ... }\n      button_ghost_text?: { ... }\n      button_ghost_hover_bg?: { ... }\n      button_ghost_hover_text?: { ... }\n      button_border_radius?: { ... }\n      button_height?: { ... }\n      card_background?: { ... }\n      card_border_color?: { ... }\n      card_variant?: { ... }\n      summary_card_background?: { ... }\n      toggle_selected_bg?: { ... }\n      toggle_selected_text?: { ... }\n      toggle_hover_bg?: { ... }\n      toggle_hover_text?: { ... }\n      toggle_border_color?: { ... }\n      dropdown_hover_bg?: { ... }\n      dropdown_hover_text?: { ... }\n      dropdown_selected_bg?: { ... }\n      dropdown_selected_text?: { ... }\n      switch_unchecked_color?: { ... }\n      switch_unchecked_bg?: { ... }\n      switch_border_radius?: { ... }\n      checkbox_unchecked_color?: { ... }\n      checkbox_label_color?: { ... }\n      radio_unchecked_color?: { ... }\n      radio_label_color?: { ... }\n      datepicker_selected_bg?: { ... }\n      datepicker_selected_color?: { ... }\n      datepicker_border_radius?: { ... }\n      chip_background?: { ... }\n      chip_hover_background?: { ... }\n      chip_text_color?: { ... }\n      chip_hover_text_color?: { ... }\n    }\n  }\n}\n```\n\n### `ItemMetada`\n\n```ts\ntype ItemMetada = {\n  id?: string\n  created_at?: string\n  created_by?: string\n  edited?: boolean\n  last_modified_at?: string\n}\n```\n\n### `AddConsumerReq`\n\n```ts\ntype AddConsumerReq = {\n  consumer_id: string\n  consumer_name: string\n  should_delete?: string\n}\n```\n\n### `RemoveConsumerReq`\n\n```ts\ntype RemoveConsumerReq = {\n  consumer_id: string\n  should_delete?: string\n}\n```\n\n### `DesignItem`\n\n```ts\ntype DesignItem = {\n  brand_id?: string\n  brand_name?: string\n  user?: {\n    emailaddress?: string\n    fullname?: string\n    name?: string\n    userid?: string\n  }\n  style_name: string\n  style: {\n    logo?: {\n      main?: { ... }\n    }\n    palette: {\n      primary: { ... }\n      secondary: { ... }\n      error: { ... }\n      background: { ... }\n      paper: { ... }\n      navbar: { ... }\n      portal_login_background?: { ... }\n    }\n    typography: {\n      font: { ... }\n      primary: { ... }\n      secondary: { ... }\n    }\n    shape?: {\n      border_radius?: { ... }\n    }\n    consumer: {\n      widgets: { ... }\n      customer_portals: { ... }\n    }\n  }\n  is_default?: boolean\n  _manifest?: string[]\n}\n```\n\n### `BrandItem`\n\n```ts\ntype BrandItem = {\n  id: string\n  name: string\n  created_by?: string\n  created_date?: string\n  main_brand?: string\n  organization_id?: string\n  updated_date?: string\n  updated_by?: string\n  status?: string\n}\n```\n\n### `Custom_Style`\n\n```ts\ntype Custom_Style = {\n  custom_theme?: string\n  use_custom_theme?: boolean\n}\n```\n\n### `Journey`\n\n```ts\ntype Journey = {\n  design_tokens?: {\n    coupon?: string\n    cashback?: string\n    custom_css?: string\n    accent_color?: string\n    outline_color?: string\n    divider_color?: string\n    link_color?: string\n    link_hover_color?: string\n    font_size_scale?: "xs" | "sm" | "md" | "lg" | "xl"\n    topbar_height?: number\n    topbar_logo_alignment?: "flex-start" | "center" | "flex-end"\n    logo_size?: number\n    input_background?: string\n    input_border_color?: string\n    input_text_color?: string\n    input_label_color?: string\n    input_border_radius?: number\n    input_height?: number\n    input_variant?: "outlined" | "filled" | "underlined"\n    button_primary_bg?: string\n    button_primary_text?: string\n    button_primary_hover_bg?: string\n    button_primary_hover_text?: string\n    button_outlined_border?: string\n    button_outlined_text?: string\n    button_outlined_hover_bg?: string\n    button_outlined_hover_text?: string\n    button_ghost_bg?: string\n    button_ghost_text?: string\n    button_ghost_hover_bg?: string\n    button_ghost_hover_text?: string\n    button_border_radius?: number\n    button_height?: number\n    card_background?: string\n    card_border_color?: string\n    card_variant?: "shadow" | "outlined"\n    summary_card_background?: string\n    toggle_selected_bg?: string\n    toggle_selected_text?: string\n    toggle_hover_bg?: string\n    toggle_hover_text?: string\n    toggle_border_color?: string\n    dropdown_hover_bg?: string\n    dropdown_hover_text?: string\n    dropdown_selected_bg?: string\n    dropdown_selected_text?: string\n    switch_unchecked_color?: string\n    switch_unchecked_bg?: string\n    switch_border_radius?: number\n    checkbox_unchecked_color?: string\n    checkbox_label_color?: string\n    radio_unchecked_color?: string\n    radio_label_color?: string\n    datepicker_selected_bg?: string\n    datepicker_selected_color?: string\n    datepicker_border_radius?: number\n    chip_background?: string\n    chip_hover_background?: string\n    chip_text_color?: string\n    chip_hover_text_color?: string\n  }\n}\n```\n\n### `ConsumerData`\n\n```ts\ntype ConsumerData = {\n  widgets: Array<{\n    id: string\n    name: string\n  }>\n  customer_portals: Array<{\n    id: string\n    name: string\n  }>\n}\n```\n\n### `WidgetData`\n\n```ts\ntype WidgetData = {\n  id: string\n  name: string\n}\n```\n\n### `CustomerPortalData`\n\n```ts\ntype CustomerPortalData = {\n  id: string\n  name: string\n}\n```\n\n### `LogoData`\n\n```ts\ntype LogoData = {\n  main?: {\n    name: string\n    display_name?: string\n    file_type?: "LOGO" | "FONT" | "IMAGE"\n    s3_object_key: string\n    url: string\n  }\n}\n```\n\n### `PaletteData`\n\n```ts\ntype PaletteData = {\n  primary: string\n  secondary: string\n  error: string\n  background: string\n  paper: string\n  navbar: string\n  portal_login_background?: string\n}\n```\n\n### `TypographyData`\n\n```ts\ntype TypographyData = {\n  font: {\n    font_id: string\n    font_name: string\n    font_family?: string\n    font_weight_regular?: string\n    font_weight_medium?: string\n    font_weight_bold?: string\n    urls: Array<{\n      type?: { ... }\n      url?: { ... }\n    }>\n  }\n  primary: string\n  secondary: string\n}\n```\n\n### `ShapeData`\n\n```ts\ntype ShapeData = {\n  border_radius?: number\n}\n```\n\n### `FontData`\n\n```ts\ntype FontData = {\n  font_id: string\n  font_name: string\n  font_family?: string\n  font_weight_regular?: string\n  font_weight_medium?: string\n  font_weight_bold?: string\n  urls: Array<{\n    type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n    url?: string\n  }>\n}\n```\n\n### `FontResponseUrl`\n\n```ts\ntype FontResponseUrl = {\n  type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n  url?: string\n}\n```\n\n### `WidgetPortalData`\n\n```ts\ntype WidgetPortalData = {\n  id: string\n  name: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n  message?: string\n  error?: object\n}\n```\n\n### `FileData`\n\n```ts\ntype FileData = {\n  name: string\n  display_name?: string\n  file_type?: "LOGO" | "FONT" | "IMAGE"\n  s3_object_key: string\n  url: string\n}\n```\n\n### `DesignId`\n\nId of the design\n\n```ts\ntype DesignId = string\n```\n\n### `Theme`\n\nType of theme to be parsed and returned\n\n```ts\ntype Theme = "NEW" | "OLD"\n```\n\n### `Application`\n\nType of application that uses the design\n\n```ts\ntype Application = string\n```\n\n### `DesignParameters`\n\n```ts\ntype DesignParameters = {\n  designId?: string\n  theme?: "NEW" | "OLD"\n  application?: string\n}\n```\n';
+export {
+  design_default as default
+};

package/dist/design-MUUYXB2J.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/design.json
+var design_default = '# Design Builder API v2\n\n- **Base URL:** `https://design-builder-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/design](https://docs.epilot.io/api/design)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.design.getAllDesigns(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/design\'\n\nconst designClient = getClient()\nauthorize(designClient, () => \'<token>\')\nconst { data } = await designClient.getAllDesigns(...)\n```\n\n## Operations\n\n**design-builder**\n- [`getAllDesigns`](#getalldesigns)\n- [`addDesign`](#adddesign)\n- [`getDesign`](#getdesign)\n- [`deleteDesign`](#deletedesign)\n- [`updateDesign`](#updatedesign)\n- [`getThemeFromDesign`](#getthemefromdesign)\n- [`uploadFile`](#uploadfile)\n- [`getFiles`](#getfiles)\n- [`getConsumerDesign`](#getconsumerdesign)\n- [`addConsumer`](#addconsumer)\n- [`removeConsumer`](#removeconsumer)\n\n**Schemas**\n- [`UploadFileReq`](#uploadfilereq)\n- [`UploadFileRes`](#uploadfileres)\n- [`GetFilesRes`](#getfilesres)\n- [`GetAllDesignsRes`](#getalldesignsres)\n- [`GetBrandsRes`](#getbrandsres)\n- [`AddDesignReq`](#adddesignreq)\n- [`AddDesignRes`](#adddesignres)\n- [`GetDesignRes`](#getdesignres)\n- [`UpdateDesignReq`](#updatedesignreq)\n- [`ItemMetada`](#itemmetada)\n- [`AddConsumerReq`](#addconsumerreq)\n- [`RemoveConsumerReq`](#removeconsumerreq)\n- [`DesignItem`](#designitem)\n- [`BrandItem`](#branditem)\n- [`Custom_Style`](#custom_style)\n- [`Journey`](#journey)\n- [`ConsumerData`](#consumerdata)\n- [`WidgetData`](#widgetdata)\n- [`CustomerPortalData`](#customerportaldata)\n- [`LogoData`](#logodata)\n- [`PaletteData`](#palettedata)\n- [`TypographyData`](#typographydata)\n- [`ShapeData`](#shapedata)\n- [`FontData`](#fontdata)\n- [`FontResponseUrl`](#fontresponseurl)\n- [`WidgetPortalData`](#widgetportaldata)\n- [`ErrorResp`](#errorresp)\n- [`FileData`](#filedata)\n- [`DesignId`](#designid)\n- [`Theme`](#theme)\n- [`Application`](#application)\n- [`DesignParameters`](#designparameters)\n\n### `getAllDesigns`\n\nScan all designs linked to a organization, based in orgId attribute from JWT auth token\n\n`GET /v1/designs`\n\n```ts\nconst { data } = await client.getAllDesigns()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "designs": [\n    {\n      "id": "string",\n      "created_at": "2021-01-30T08:30:00Z",\n      "created_by": "string",\n      "edited": true,\n      "last_modified_at": "string",\n      "brand_id": "string",\n      "brand_name": "string",\n      "user": {},\n      "style_name": "string",\n      "style": {},\n      "is_default": true,\n      "_manifest": ["string"],\n      "custom_theme": "string",\n      "use_custom_theme": true,\n      "design_tokens": {}\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `addDesign`\n\nCreate a brand new design linked to a organization, based in orgId attribute from JWT auth token\n\n`POST /v1/designs`\n\n```ts\nconst { data } = await client.addDesign(\n  null,\n  {\n    design: {\n      brand_id: \'string\',\n      brand_name: \'string\',\n      user: {\n        emailaddress: \'string\',\n        fullname: \'string\',\n        name: \'string\',\n        userid: \'string\'\n      },\n      style_name: \'string\',\n      style: {\n        logo: { /* ... */ },\n        palette: { /* ... */ },\n        typography: { /* ... */ },\n        shape: { /* ... */ },\n        consumer: { /* ... */ }\n      },\n      is_default: true,\n      _manifest: [\'string\'],\n      custom_theme: \'string\',\n      use_custom_theme: true,\n      design_tokens: {\n        coupon: \'string\',\n        cashback: \'string\',\n        custom_css: \'string\',\n        accent_color: \'string\',\n        outline_color: \'string\',\n        divider_color: \'string\',\n        link_color: \'string\',\n        link_hover_color: \'string\',\n        font_size_scale: \'xs\',\n        topbar_height: 0,\n        topbar_logo_alignment: \'flex-start\',\n        logo_size: 0,\n        input_background: \'string\',\n        input_border_color: \'string\',\n        input_text_color: \'string\',\n        input_label_color: \'string\',\n        input_border_radius: 0,\n        input_height: 0,\n        input_variant: \'outlined\',\n        button_primary_bg: \'string\',\n        button_primary_text: \'string\',\n        button_primary_hover_bg: \'string\',\n        button_primary_hover_text: \'string\',\n        button_outlined_border: \'string\',\n        button_outlined_text: \'string\',\n        button_outlined_hover_bg: \'string\',\n        button_outlined_hover_text: \'string\',\n        button_ghost_bg: \'string\',\n        button_ghost_text: \'string\',\n        button_ghost_hover_bg: \'string\',\n        button_ghost_hover_text: \'string\',\n        button_border_radius: 0,\n        button_height: 0,\n        card_background: \'string\',\n        card_border_color: \'string\',\n        card_variant: \'shadow\',\n        summary_card_background: \'string\',\n        toggle_selected_bg: \'string\',\n        toggle_selected_text: \'string\',\n        toggle_hover_bg: \'string\',\n        toggle_hover_text: \'string\',\n        toggle_border_color: \'string\',\n        dropdown_hover_bg: \'string\',\n        dropdown_hover_text: \'string\',\n        dropdown_selected_bg: \'string\',\n        dropdown_selected_text: \'string\',\n        switch_unchecked_color: \'string\',\n        switch_unchecked_bg: \'string\',\n        switch_border_radius: 0,\n        checkbox_unchecked_color: \'string\',\n        checkbox_label_color: \'string\',\n        radio_unchecked_color: \'string\',\n        radio_label_color: \'string\',\n        datepicker_selected_bg: \'string\',\n        datepicker_selected_color: \'string\',\n        datepicker_border_radius: 0,\n        chip_background: \'string\',\n        chip_hover_background: \'string\',\n        chip_text_color: \'string\',\n        chip_hover_text_color: \'string\'\n      }\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "design": {\n    "id": "string",\n    "created_at": "2021-01-30T08:30:00Z",\n    "created_by": "string",\n    "edited": true,\n    "last_modified_at": "string",\n    "brand_id": "string",\n    "brand_name": "string",\n    "user": {\n      "emailaddress": "string",\n      "fullname": "string",\n      "name": "string",\n      "userid": "string"\n    },\n    "style_name": "string",\n    "style": {\n      "logo": {},\n      "palette": {},\n      "typography": {},\n      "shape": {},\n      "consumer": {}\n    },\n    "is_default": true,\n    "_manifest": ["string"],\n    "custom_theme": "string",\n    "use_custom_theme": true,\n    "design_tokens": {\n      "coupon": "string",\n      "cashback": "string",\n      "custom_css": "string",\n      "accent_color": "string",\n      "outline_color": "string",\n      "divider_color": "string",\n      "link_color": "string",\n      "link_hover_color": "string",\n      "font_size_scale": "xs",\n      "topbar_height": 0,\n      "topbar_logo_alignment": "flex-start",\n      "logo_size": 0,\n      "input_background": "string",\n      "input_border_color": "string",\n      "input_text_color": "string",\n      "input_label_color": "string",\n      "input_border_radius": 0,\n      "input_height": 0,\n      "input_variant": "outlined",\n      "button_primary_bg": "string",\n      "button_primary_text": "string",\n      "button_primary_hover_bg": "string",\n      "button_primary_hover_text": "string",\n      "button_outlined_border": "string",\n      "button_outlined_text": "string",\n      "button_outlined_hover_bg": "string",\n      "button_outlined_hover_text": "string",\n      "button_ghost_bg": "string",\n      "button_ghost_text": "string",\n      "button_ghost_hover_bg": "string",\n      "button_ghost_hover_text": "string",\n      "button_border_radius": 0,\n      "button_height": 0,\n      "card_background": "string",\n      "card_border_color": "string",\n      "card_variant": "shadow",\n      "summary_card_background": "string",\n      "toggle_selected_bg": "string",\n      "toggle_selected_text": "string",\n      "toggle_hover_bg": "string",\n      "toggle_hover_text": "string",\n      "toggle_border_color": "string",\n      "dropdown_hover_bg": "string",\n      "dropdown_hover_text": "string",\n      "dropdown_selected_bg": "string",\n      "dropdown_selected_text": "string",\n      "switch_unchecked_color": "string",\n      "switch_unchecked_bg": "string",\n      "switch_border_radius": 0,\n      "checkbox_unchecked_color": "string",\n      "checkbox_label_color": "string",\n      "radio_unchecked_color": "string",\n      "radio_label_color": "string",\n      "datepicker_selected_bg": "string",\n      "datepicker_selected_color": "string",\n      "datepicker_border_radius": 0,\n      "chip_background": "string",\n      "chip_hover_background": "string",\n      "chip_text_color": "string",\n      "chip_hover_text_color": "string"\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `getDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.getDesign({\n  designId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "design": {\n    "id": "string",\n    "created_at": "2021-01-30T08:30:00Z",\n    "created_by": "string",\n    "edited": true,\n    "last_modified_at": "string",\n    "brand_id": "string",\n    "brand_name": "string",\n    "user": {\n      "emailaddress": "string",\n      "fullname": "string",\n      "name": "string",\n      "userid": "string"\n    },\n    "style_name": "string",\n    "style": {\n      "logo": {},\n      "palette": {},\n      "typography": {},\n      "shape": {},\n      "consumer": {}\n    },\n    "is_default": true,\n    "_manifest": ["string"],\n    "custom_theme": "string",\n    "use_custom_theme": true,\n    "design_tokens": {\n      "coupon": "string",\n      "cashback": "string",\n      "custom_css": "string",\n      "accent_color": "string",\n      "outline_color": "string",\n      "divider_color": "string",\n      "link_color": "string",\n      "link_hover_color": "string",\n      "font_size_scale": "xs",\n      "topbar_height": 0,\n      "topbar_logo_alignment": "flex-start",\n      "logo_size": 0,\n      "input_background": "string",\n      "input_border_color": "string",\n      "input_text_color": "string",\n      "input_label_color": "string",\n      "input_border_radius": 0,\n      "input_height": 0,\n      "input_variant": "outlined",\n      "button_primary_bg": "string",\n      "button_primary_text": "string",\n      "button_primary_hover_bg": "string",\n      "button_primary_hover_text": "string",\n      "button_outlined_border": "string",\n      "button_outlined_text": "string",\n      "button_outlined_hover_bg": "string",\n      "button_outlined_hover_text": "string",\n      "button_ghost_bg": "string",\n      "button_ghost_text": "string",\n      "button_ghost_hover_bg": "string",\n      "button_ghost_hover_text": "string",\n      "button_border_radius": 0,\n      "button_height": 0,\n      "card_background": "string",\n      "card_border_color": "string",\n      "card_variant": "shadow",\n      "summary_card_background": "string",\n      "toggle_selected_bg": "string",\n      "toggle_selected_text": "string",\n      "toggle_hover_bg": "string",\n      "toggle_hover_text": "string",\n      "toggle_border_color": "string",\n      "dropdown_hover_bg": "string",\n      "dropdown_hover_text": "string",\n      "dropdown_selected_bg": "string",\n      "dropdown_selected_text": "string",\n      "switch_unchecked_color": "string",\n      "switch_unchecked_bg": "string",\n      "switch_border_radius": 0,\n      "checkbox_unchecked_color": "string",\n      "checkbox_label_color": "string",\n      "radio_unchecked_color": "string",\n      "radio_label_color": "string",\n      "datepicker_selected_bg": "string",\n      "datepicker_selected_color": "string",\n      "datepicker_border_radius": 0,\n      "chip_background": "string",\n      "chip_hover_background": "string",\n      "chip_text_color": "string",\n      "chip_hover_text_color": "string"\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `deleteDesign`\n\nSearch and delete for a especific design owned by user organization\n\n`DELETE /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.deleteDesign({\n  designId: \'example\',\n})\n```\n\n---\n\n### `updateDesign`\n\nUpdate a especific design owned by user organization\n\n`PUT /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.updateDesign(\n  {\n    designId: \'example\',\n  },\n  {\n    design: {\n      brand_id: \'string\',\n      brand_name: \'string\',\n      user: {\n        emailaddress: \'string\',\n        fullname: \'string\',\n        name: \'string\',\n        userid: \'string\'\n      },\n      style_name: \'string\',\n      style: {\n        logo: { /* ... */ },\n        palette: { /* ... */ },\n        typography: { /* ... */ },\n        shape: { /* ... */ },\n        consumer: { /* ... */ }\n      },\n      is_default: true,\n      _manifest: [\'string\'],\n      custom_theme: \'string\',\n      use_custom_theme: true,\n      design_tokens: {\n        coupon: \'string\',\n        cashback: \'string\',\n        custom_css: \'string\',\n        accent_color: \'string\',\n        outline_color: \'string\',\n        divider_color: \'string\',\n        link_color: \'string\',\n        link_hover_color: \'string\',\n        font_size_scale: \'xs\',\n        topbar_height: 0,\n        topbar_logo_alignment: \'flex-start\',\n        logo_size: 0,\n        input_background: \'string\',\n        input_border_color: \'string\',\n        input_text_color: \'string\',\n        input_label_color: \'string\',\n        input_border_radius: 0,\n        input_height: 0,\n        input_variant: \'outlined\',\n        button_primary_bg: \'string\',\n        button_primary_text: \'string\',\n        button_primary_hover_bg: \'string\',\n        button_primary_hover_text: \'string\',\n        button_outlined_border: \'string\',\n        button_outlined_text: \'string\',\n        button_outlined_hover_bg: \'string\',\n        button_outlined_hover_text: \'string\',\n        button_ghost_bg: \'string\',\n        button_ghost_text: \'string\',\n        button_ghost_hover_bg: \'string\',\n        button_ghost_hover_text: \'string\',\n        button_border_radius: 0,\n        button_height: 0,\n        card_background: \'string\',\n        card_border_color: \'string\',\n        card_variant: \'shadow\',\n        summary_card_background: \'string\',\n        toggle_selected_bg: \'string\',\n        toggle_selected_text: \'string\',\n        toggle_hover_bg: \'string\',\n        toggle_hover_text: \'string\',\n        toggle_border_color: \'string\',\n        dropdown_hover_bg: \'string\',\n        dropdown_hover_text: \'string\',\n        dropdown_selected_bg: \'string\',\n        dropdown_selected_text: \'string\',\n        switch_unchecked_color: \'string\',\n        switch_unchecked_bg: \'string\',\n        switch_border_radius: 0,\n        checkbox_unchecked_color: \'string\',\n        checkbox_label_color: \'string\',\n        radio_unchecked_color: \'string\',\n        radio_label_color: \'string\',\n        datepicker_selected_bg: \'string\',\n        datepicker_selected_color: \'string\',\n        datepicker_border_radius: 0,\n        chip_background: \'string\',\n        chip_hover_background: \'string\',\n        chip_text_color: \'string\',\n        chip_hover_text_color: \'string\'\n      }\n    }\n  },\n)\n```\n\n---\n\n### `getThemeFromDesign`\n\nSearch for a especific design owned by user organization and parse them to a new or old theme\n\n`GET /v1/designs/{designId}/parse`\n\n```ts\nconst { data } = await client.getThemeFromDesign({\n  designId: \'example\',\n  orgId: \'example\',\n  theme: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `uploadFile`\n\nUpload a new file for the user organization bucket\n\n`POST /v1/designs/files`\n\n```ts\nconst { data } = await client.uploadFile()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "name": "string",\n  "display_name": "string",\n  "file_type": "LOGO",\n  "s3_object_key": "string",\n  "url": "string"\n}\n```\n\n</details>\n\n---\n\n### `getFiles`\n\nList all files for the user organization bucket\n\n`GET /v1/designs/files`\n\n```ts\nconst { data } = await client.getFiles({\n  type: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "name": "string",\n    "display_name": "string",\n    "file_type": "LOGO",\n    "s3_object_key": "string",\n    "url": "string"\n  }\n]\n```\n\n</details>\n\n---\n\n### `getConsumerDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/consumer/{application}/{consumerId}`\n\n```ts\nconst { data } = await client.getConsumerDesign({\n  consumerId: \'example\',\n  application: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "design": {\n    "id": "string",\n    "created_at": "2021-01-30T08:30:00Z",\n    "created_by": "string",\n    "edited": true,\n    "last_modified_at": "string",\n    "brand_id": "string",\n    "brand_name": "string",\n    "user": {\n      "emailaddress": "string",\n      "fullname": "string",\n      "name": "string",\n      "userid": "string"\n    },\n    "style_name": "string",\n    "style": {\n      "logo": {},\n      "palette": {},\n      "typography": {},\n      "shape": {},\n      "consumer": {}\n    },\n    "is_default": true,\n    "_manifest": ["string"],\n    "custom_theme": "string",\n    "use_custom_theme": true,\n    "design_tokens": {\n      "coupon": "string",\n      "cashback": "string",\n      "custom_css": "string",\n      "accent_color": "string",\n      "outline_color": "string",\n      "divider_color": "string",\n      "link_color": "string",\n      "link_hover_color": "string",\n      "font_size_scale": "xs",\n      "topbar_height": 0,\n      "topbar_logo_alignment": "flex-start",\n      "logo_size": 0,\n      "input_background": "string",\n      "input_border_color": "string",\n      "input_text_color": "string",\n      "input_label_color": "string",\n      "input_border_radius": 0,\n      "input_height": 0,\n      "input_variant": "outlined",\n      "button_primary_bg": "string",\n      "button_primary_text": "string",\n      "button_primary_hover_bg": "string",\n      "button_primary_hover_text": "string",\n      "button_outlined_border": "string",\n      "button_outlined_text": "string",\n      "button_outlined_hover_bg": "string",\n      "button_outlined_hover_text": "string",\n      "button_ghost_bg": "string",\n      "button_ghost_text": "string",\n      "button_ghost_hover_bg": "string",\n      "button_ghost_hover_text": "string",\n      "button_border_radius": 0,\n      "button_height": 0,\n      "card_background": "string",\n      "card_border_color": "string",\n      "card_variant": "shadow",\n      "summary_card_background": "string",\n      "toggle_selected_bg": "string",\n      "toggle_selected_text": "string",\n      "toggle_hover_bg": "string",\n      "toggle_hover_text": "string",\n      "toggle_border_color": "string",\n      "dropdown_hover_bg": "string",\n      "dropdown_hover_text": "string",\n      "dropdown_selected_bg": "string",\n      "dropdown_selected_text": "string",\n      "switch_unchecked_color": "string",\n      "switch_unchecked_bg": "string",\n      "switch_border_radius": 0,\n      "checkbox_unchecked_color": "string",\n      "checkbox_label_color": "string",\n      "radio_unchecked_color": "string",\n      "radio_label_color": "string",\n      "datepicker_selected_bg": "string",\n      "datepicker_selected_color": "string",\n      "datepicker_border_radius": 0,\n      "chip_background": "string",\n      "chip_hover_background": "string",\n      "chip_text_color": "string",\n      "chip_hover_text_color": "string"\n    }\n  }\n}\n```\n\n</details>\n\n---\n\n### `addConsumer`\n\nAdd a consumer that uses a specific design\n\n`PUT /v1/designs/addConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.addConsumer(\n  {\n    designId: \'example\',\n    application: \'example\',\n  },\n  {\n    consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n    consumer_name: \'string\',\n    should_delete: \'string\'\n  },\n)\n```\n\n---\n\n### `removeConsumer`\n\nRemove a consumer that uses a specific design\n\n`PUT /v1/designs/removeConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.removeConsumer(\n  {\n    designId: \'example\',\n    application: \'example\',\n  },\n  {\n    consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n    should_delete: \'string\'\n  },\n)\n```\n\n---\n\n## Schemas\n\n### `UploadFileReq`\n\n```ts\ntype UploadFileReq = {\n  file_type: "LOGO" | "FONT" | "IMAGE"\n  file_data: string // base64\n  display_name?: string\n  file_name: string\n}\n```\n\n### `UploadFileRes`\n\n```ts\ntype UploadFileRes = {\n  name: string\n  display_name?: string\n  file_type?: "LOGO" | "FONT" | "IMAGE"\n  s3_object_key: string\n  url: string\n}\n```\n\n### `GetFilesRes`\n\n```ts\ntype GetFilesRes = Array<{\n  name: string\n  display_name?: string\n  file_type?: "LOGO" | "FONT" | "IMAGE"\n  s3_object_key: string\n  url: string\n}>\n```\n\n### `GetAllDesignsRes`\n\n```ts\ntype GetAllDesignsRes = {\n  designs?: Array<{\n    id?: string\n    created_at?: string\n    created_by?: string\n    edited: boolean\n    last_modified_at?: string\n    brand_id?: string\n    brand_name?: string\n    user?: {\n      emailaddress?: { ... }\n      fullname?: { ... }\n      name?: { ... }\n      userid?: { ... }\n    }\n    style_name: string\n    style: {\n      logo?: { ... }\n      palette: { ... }\n      typography: { ... }\n      shape?: { ... }\n      consumer: { ... }\n    }\n    is_default?: boolean\n    _manifest?: string[]\n    custom_theme?: string\n    use_custom_theme?: boolean\n    design_tokens?: {\n      coupon?: { ... }\n      cashback?: { ... }\n      custom_css?: { ... }\n      accent_color?: { ... }\n      outline_color?: { ... }\n      divider_color?: { ... }\n      link_color?: { ... }\n      link_hover_color?: { ... }\n      font_size_scale?: { ... }\n      topbar_height?: { ... }\n      topbar_logo_alignment?: { ... }\n      logo_size?: { ... }\n      input_background?: { ... }\n      input_border_color?: { ... }\n      input_text_color?: { ... }\n      input_label_color?: { ... }\n      input_border_radius?: { ... }\n      input_height?: { ... }\n      input_variant?: { ... }\n      button_primary_bg?: { ... }\n      button_primary_text?: { ... }\n      button_primary_hover_bg?: { ... }\n      button_primary_hover_text?: { ... }\n      button_outlined_border?: { ... }\n      button_outlined_text?: { ... }\n      button_outlined_hover_bg?: { ... }\n      button_outlined_hover_text?: { ... }\n      button_ghost_bg?: { ... }\n      button_ghost_text?: { ... }\n      button_ghost_hover_bg?: { ... }\n      button_ghost_hover_text?: { ... }\n      button_border_radius?: { ... }\n      button_height?: { ... }\n      card_background?: { ... }\n      card_border_color?: { ... }\n      card_variant?: { ... }\n      summary_card_background?: { ... }\n      toggle_selected_bg?: { ... }\n      toggle_selected_text?: { ... }\n      toggle_hover_bg?: { ... }\n      toggle_hover_text?: { ... }\n      toggle_border_color?: { ... }\n      dropdown_hover_bg?: { ... }\n      dropdown_hover_text?: { ... }\n      dropdown_selected_bg?: { ... }\n      dropdown_selected_text?: { ... }\n      switch_unchecked_color?: { ... }\n      switch_unchecked_bg?: { ... }\n      switch_border_radius?: { ... }\n      checkbox_unchecked_color?: { ... }\n      checkbox_label_color?: { ... }\n      radio_unchecked_color?: { ... }\n      radio_label_color?: { ... }\n      datepicker_selected_bg?: { ... }\n      datepicker_selected_color?: { ... }\n      datepicker_border_radius?: { ... }\n      chip_background?: { ... }\n      chip_hover_background?: { ... }\n      chip_text_color?: { ... }\n      chip_hover_text_color?: { ... }\n    }\n  }>\n}\n```\n\n### `GetBrandsRes`\n\n```ts\ntype GetBrandsRes = {\n  brands?: Array<{\n    id: string\n    name: string\n    created_by?: string\n    created_date?: string\n    main_brand?: string\n    organization_id?: string\n    updated_date?: string\n    updated_by?: string\n    status?: string\n  }>\n}\n```\n\n### `AddDesignReq`\n\n```ts\ntype AddDesignReq = {\n  design: {\n    brand_id?: string\n    brand_name?: string\n    user?: {\n      emailaddress?: { ... }\n      fullname?: { ... }\n      name?: { ... }\n      userid?: { ... }\n    }\n    style_name: string\n    style: {\n      logo?: { ... }\n      palette: { ... }\n      typography: { ... }\n      shape?: { ... }\n      consumer: { ... }\n    }\n    is_default?: boolean\n    _manifest?: string[]\n    custom_theme?: string\n    use_custom_theme?: boolean\n    design_tokens?: {\n      coupon?: { ... }\n      cashback?: { ... }\n      custom_css?: { ... }\n      accent_color?: { ... }\n      outline_color?: { ... }\n      divider_color?: { ... }\n      link_color?: { ... }\n      link_hover_color?: { ... }\n      font_size_scale?: { ... }\n      topbar_height?: { ... }\n      topbar_logo_alignment?: { ... }\n      logo_size?: { ... }\n      input_background?: { ... }\n      input_border_color?: { ... }\n      input_text_color?: { ... }\n      input_label_color?: { ... }\n      input_border_radius?: { ... }\n      input_height?: { ... }\n      input_variant?: { ... }\n      button_primary_bg?: { ... }\n      button_primary_text?: { ... }\n      button_primary_hover_bg?: { ... }\n      button_primary_hover_text?: { ... }\n      button_outlined_border?: { ... }\n      button_outlined_text?: { ... }\n      button_outlined_hover_bg?: { ... }\n      button_outlined_hover_text?: { ... }\n      button_ghost_bg?: { ... }\n      button_ghost_text?: { ... }\n      button_ghost_hover_bg?: { ... }\n      button_ghost_hover_text?: { ... }\n      button_border_radius?: { ... }\n      button_height?: { ... }\n      card_background?: { ... }\n      card_border_color?: { ... }\n      card_variant?: { ... }\n      summary_card_background?: { ... }\n      toggle_selected_bg?: { ... }\n      toggle_selected_text?: { ... }\n      toggle_hover_bg?: { ... }\n      toggle_hover_text?: { ... }\n      toggle_border_color?: { ... }\n      dropdown_hover_bg?: { ... }\n      dropdown_hover_text?: { ... }\n      dropdown_selected_bg?: { ... }\n      dropdown_selected_text?: { ... }\n      switch_unchecked_color?: { ... }\n      switch_unchecked_bg?: { ... }\n      switch_border_radius?: { ... }\n      checkbox_unchecked_color?: { ... }\n      checkbox_label_color?: { ... }\n      radio_unchecked_color?: { ... }\n      radio_label_color?: { ... }\n      datepicker_selected_bg?: { ... }\n      datepicker_selected_color?: { ... }\n      datepicker_border_radius?: { ... }\n      chip_background?: { ... }\n      chip_hover_background?: { ... }\n      chip_text_color?: { ... }\n      chip_hover_text_color?: { ... }\n    }\n  }\n}\n```\n\n### `AddDesignRes`\n\n```ts\ntype AddDesignRes = {\n  design?: {\n    id?: string\n    created_at?: string\n    created_by?: string\n    edited: boolean\n    last_modified_at?: string\n    brand_id?: string\n    brand_name?: string\n    user?: {\n      emailaddress?: { ... }\n      fullname?: { ... }\n      name?: { ... }\n      userid?: { ... }\n    }\n    style_name: string\n    style: {\n      logo?: { ... }\n      palette: { ... }\n      typography: { ... }\n      shape?: { ... }\n      consumer: { ... }\n    }\n    is_default?: boolean\n    _manifest?: string[]\n    custom_theme?: string\n    use_custom_theme?: boolean\n    design_tokens?: {\n      coupon?: { ... }\n      cashback?: { ... }\n      custom_css?: { ... }\n      accent_color?: { ... }\n      outline_color?: { ... }\n      divider_color?: { ... }\n      link_color?: { ... }\n      link_hover_color?: { ... }\n      font_size_scale?: { ... }\n      topbar_height?: { ... }\n      topbar_logo_alignment?: { ... }\n      logo_size?: { ... }\n      input_background?: { ... }\n      input_border_color?: { ... }\n      input_text_color?: { ... }\n      input_label_color?: { ... }\n      input_border_radius?: { ... }\n      input_height?: { ... }\n      input_variant?: { ... }\n      button_primary_bg?: { ... }\n      button_primary_text?: { ... }\n      button_primary_hover_bg?: { ... }\n      button_primary_hover_text?: { ... }\n      button_outlined_border?: { ... }\n      button_outlined_text?: { ... }\n      button_outlined_hover_bg?: { ... }\n      button_outlined_hover_text?: { ... }\n      button_ghost_bg?: { ... }\n      button_ghost_text?: { ... }\n      button_ghost_hover_bg?: { ... }\n      button_ghost_hover_text?: { ... }\n      button_border_radius?: { ... }\n      button_height?: { ... }\n      card_background?: { ... }\n      card_border_color?: { ... }\n      card_variant?: { ... }\n      summary_card_background?: { ... }\n      toggle_selected_bg?: { ... }\n      toggle_selected_text?: { ... }\n      toggle_hover_bg?: { ... }\n      toggle_hover_text?: { ... }\n      toggle_border_color?: { ... }\n      dropdown_hover_bg?: { ... }\n      dropdown_hover_text?: { ... }\n      dropdown_selected_bg?: { ... }\n      dropdown_selected_text?: { ... }\n      switch_unchecked_color?: { ... }\n      switch_unchecked_bg?: { ... }\n      switch_border_radius?: { ... }\n      checkbox_unchecked_color?: { ... }\n      checkbox_label_color?: { ... }\n      radio_unchecked_color?: { ... }\n      radio_label_color?: { ... }\n      datepicker_selected_bg?: { ... }\n      datepicker_selected_color?: { ... }\n      datepicker_border_radius?: { ... }\n      chip_background?: { ... }\n      chip_hover_background?: { ... }\n      chip_text_color?: { ... }\n      chip_hover_text_color?: { ... }\n    }\n  }\n}\n```\n\n### `GetDesignRes`\n\n```ts\ntype GetDesignRes = {\n  design?: {\n    id?: string\n    created_at?: string\n    created_by?: string\n    edited: boolean\n    last_modified_at?: string\n    brand_id?: string\n    brand_name?: string\n    user?: {\n      emailaddress?: { ... }\n      fullname?: { ... }\n      name?: { ... }\n      userid?: { ... }\n    }\n    style_name: string\n    style: {\n      logo?: { ... }\n      palette: { ... }\n      typography: { ... }\n      shape?: { ... }\n      consumer: { ... }\n    }\n    is_default?: boolean\n    _manifest?: string[]\n    custom_theme?: string\n    use_custom_theme?: boolean\n    design_tokens?: {\n      coupon?: { ... }\n      cashback?: { ... }\n      custom_css?: { ... }\n      accent_color?: { ... }\n      outline_color?: { ... }\n      divider_color?: { ... }\n      link_color?: { ... }\n      link_hover_color?: { ... }\n      font_size_scale?: { ... }\n      topbar_height?: { ... }\n      topbar_logo_alignment?: { ... }\n      logo_size?: { ... }\n      input_background?: { ... }\n      input_border_color?: { ... }\n      input_text_color?: { ... }\n      input_label_color?: { ... }\n      input_border_radius?: { ... }\n      input_height?: { ... }\n      input_variant?: { ... }\n      button_primary_bg?: { ... }\n      button_primary_text?: { ... }\n      button_primary_hover_bg?: { ... }\n      button_primary_hover_text?: { ... }\n      button_outlined_border?: { ... }\n      button_outlined_text?: { ... }\n      button_outlined_hover_bg?: { ... }\n      button_outlined_hover_text?: { ... }\n      button_ghost_bg?: { ... }\n      button_ghost_text?: { ... }\n      button_ghost_hover_bg?: { ... }\n      button_ghost_hover_text?: { ... }\n      button_border_radius?: { ... }\n      button_height?: { ... }\n      card_background?: { ... }\n      card_border_color?: { ... }\n      card_variant?: { ... }\n      summary_card_background?: { ... }\n      toggle_selected_bg?: { ... }\n      toggle_selected_text?: { ... }\n      toggle_hover_bg?: { ... }\n      toggle_hover_text?: { ... }\n      toggle_border_color?: { ... }\n      dropdown_hover_bg?: { ... }\n      dropdown_hover_text?: { ... }\n      dropdown_selected_bg?: { ... }\n      dropdown_selected_text?: { ... }\n      switch_unchecked_color?: { ... }\n      switch_unchecked_bg?: { ... }\n      switch_border_radius?: { ... }\n      checkbox_unchecked_color?: { ... }\n      checkbox_label_color?: { ... }\n      radio_unchecked_color?: { ... }\n      radio_label_color?: { ... }\n      datepicker_selected_bg?: { ... }\n      datepicker_selected_color?: { ... }\n      datepicker_border_radius?: { ... }\n      chip_background?: { ... }\n      chip_hover_background?: { ... }\n      chip_text_color?: { ... }\n      chip_hover_text_color?: { ... }\n    }\n  }\n}\n```\n\n### `UpdateDesignReq`\n\n```ts\ntype UpdateDesignReq = {\n  design: {\n    brand_id?: string\n    brand_name?: string\n    user?: {\n      emailaddress?: { ... }\n      fullname?: { ... }\n      name?: { ... }\n      userid?: { ... }\n    }\n    style_name: string\n    style: {\n      logo?: { ... }\n      palette: { ... }\n      typography: { ... }\n      shape?: { ... }\n      consumer: { ... }\n    }\n    is_default?: boolean\n    _manifest?: string[]\n    custom_theme?: string\n    use_custom_theme?: boolean\n    design_tokens?: {\n      coupon?: { ... }\n      cashback?: { ... }\n      custom_css?: { ... }\n      accent_color?: { ... }\n      outline_color?: { ... }\n      divider_color?: { ... }\n      link_color?: { ... }\n      link_hover_color?: { ... }\n      font_size_scale?: { ... }\n      topbar_height?: { ... }\n      topbar_logo_alignment?: { ... }\n      logo_size?: { ... }\n      input_background?: { ... }\n      input_border_color?: { ... }\n      input_text_color?: { ... }\n      input_label_color?: { ... }\n      input_border_radius?: { ... }\n      input_height?: { ... }\n      input_variant?: { ... }\n      button_primary_bg?: { ... }\n      button_primary_text?: { ... }\n      button_primary_hover_bg?: { ... }\n      button_primary_hover_text?: { ... }\n      button_outlined_border?: { ... }\n      button_outlined_text?: { ... }\n      button_outlined_hover_bg?: { ... }\n      button_outlined_hover_text?: { ... }\n      button_ghost_bg?: { ... }\n      button_ghost_text?: { ... }\n      button_ghost_hover_bg?: { ... }\n      button_ghost_hover_text?: { ... }\n      button_border_radius?: { ... }\n      button_height?: { ... }\n      card_background?: { ... }\n      card_border_color?: { ... }\n      card_variant?: { ... }\n      summary_card_background?: { ... }\n      toggle_selected_bg?: { ... }\n      toggle_selected_text?: { ... }\n      toggle_hover_bg?: { ... }\n      toggle_hover_text?: { ... }\n      toggle_border_color?: { ... }\n      dropdown_hover_bg?: { ... }\n      dropdown_hover_text?: { ... }\n      dropdown_selected_bg?: { ... }\n      dropdown_selected_text?: { ... }\n      switch_unchecked_color?: { ... }\n      switch_unchecked_bg?: { ... }\n      switch_border_radius?: { ... }\n      checkbox_unchecked_color?: { ... }\n      checkbox_label_color?: { ... }\n      radio_unchecked_color?: { ... }\n      radio_label_color?: { ... }\n      datepicker_selected_bg?: { ... }\n      datepicker_selected_color?: { ... }\n      datepicker_border_radius?: { ... }\n      chip_background?: { ... }\n      chip_hover_background?: { ... }\n      chip_text_color?: { ... }\n      chip_hover_text_color?: { ... }\n    }\n  }\n}\n```\n\n### `ItemMetada`\n\n```ts\ntype ItemMetada = {\n  id?: string\n  created_at?: string\n  created_by?: string\n  edited?: boolean\n  last_modified_at?: string\n}\n```\n\n### `AddConsumerReq`\n\n```ts\ntype AddConsumerReq = {\n  consumer_id: string\n  consumer_name: string\n  should_delete?: string\n}\n```\n\n### `RemoveConsumerReq`\n\n```ts\ntype RemoveConsumerReq = {\n  consumer_id: string\n  should_delete?: string\n}\n```\n\n### `DesignItem`\n\n```ts\ntype DesignItem = {\n  brand_id?: string\n  brand_name?: string\n  user?: {\n    emailaddress?: string\n    fullname?: string\n    name?: string\n    userid?: string\n  }\n  style_name: string\n  style: {\n    logo?: {\n      main?: { ... }\n    }\n    palette: {\n      primary: { ... }\n      secondary: { ... }\n      error: { ... }\n      background: { ... }\n      paper: { ... }\n      navbar: { ... }\n      portal_login_background?: { ... }\n    }\n    typography: {\n      font: { ... }\n      primary: { ... }\n      secondary: { ... }\n    }\n    shape?: {\n      border_radius?: { ... }\n    }\n    consumer: {\n      widgets: { ... }\n      customer_portals: { ... }\n    }\n  }\n  is_default?: boolean\n  _manifest?: string[]\n}\n```\n\n### `BrandItem`\n\n```ts\ntype BrandItem = {\n  id: string\n  name: string\n  created_by?: string\n  created_date?: string\n  main_brand?: string\n  organization_id?: string\n  updated_date?: string\n  updated_by?: string\n  status?: string\n}\n```\n\n### `Custom_Style`\n\n```ts\ntype Custom_Style = {\n  custom_theme?: string\n  use_custom_theme?: boolean\n}\n```\n\n### `Journey`\n\n```ts\ntype Journey = {\n  design_tokens?: {\n    coupon?: string\n    cashback?: string\n    custom_css?: string\n    accent_color?: string\n    outline_color?: string\n    divider_color?: string\n    link_color?: string\n    link_hover_color?: string\n    font_size_scale?: "xs" | "sm" | "md" | "lg" | "xl"\n    topbar_height?: number\n    topbar_logo_alignment?: "flex-start" | "center" | "flex-end"\n    logo_size?: number\n    input_background?: string\n    input_border_color?: string\n    input_text_color?: string\n    input_label_color?: string\n    input_border_radius?: number\n    input_height?: number\n    input_variant?: "outlined" | "filled" | "underlined"\n    button_primary_bg?: string\n    button_primary_text?: string\n    button_primary_hover_bg?: string\n    button_primary_hover_text?: string\n    button_outlined_border?: string\n    button_outlined_text?: string\n    button_outlined_hover_bg?: string\n    button_outlined_hover_text?: string\n    button_ghost_bg?: string\n    button_ghost_text?: string\n    button_ghost_hover_bg?: string\n    button_ghost_hover_text?: string\n    button_border_radius?: number\n    button_height?: number\n    card_background?: string\n    card_border_color?: string\n    card_variant?: "shadow" | "outlined"\n    summary_card_background?: string\n    toggle_selected_bg?: string\n    toggle_selected_text?: string\n    toggle_hover_bg?: string\n    toggle_hover_text?: string\n    toggle_border_color?: string\n    dropdown_hover_bg?: string\n    dropdown_hover_text?: string\n    dropdown_selected_bg?: string\n    dropdown_selected_text?: string\n    switch_unchecked_color?: string\n    switch_unchecked_bg?: string\n    switch_border_radius?: number\n    checkbox_unchecked_color?: string\n    checkbox_label_color?: string\n    radio_unchecked_color?: string\n    radio_label_color?: string\n    datepicker_selected_bg?: string\n    datepicker_selected_color?: string\n    datepicker_border_radius?: number\n    chip_background?: string\n    chip_hover_background?: string\n    chip_text_color?: string\n    chip_hover_text_color?: string\n  }\n}\n```\n\n### `ConsumerData`\n\n```ts\ntype ConsumerData = {\n  widgets: Array<{\n    id: string\n    name: string\n  }>\n  customer_portals: Array<{\n    id: string\n    name: string\n  }>\n}\n```\n\n### `WidgetData`\n\n```ts\ntype WidgetData = {\n  id: string\n  name: string\n}\n```\n\n### `CustomerPortalData`\n\n```ts\ntype CustomerPortalData = {\n  id: string\n  name: string\n}\n```\n\n### `LogoData`\n\n```ts\ntype LogoData = {\n  main?: {\n    name: string\n    display_name?: string\n    file_type?: "LOGO" | "FONT" | "IMAGE"\n    s3_object_key: string\n    url: string\n  }\n}\n```\n\n### `PaletteData`\n\n```ts\ntype PaletteData = {\n  primary: string\n  secondary: string\n  error: string\n  background: string\n  paper: string\n  navbar: string\n  portal_login_background?: string\n}\n```\n\n### `TypographyData`\n\n```ts\ntype TypographyData = {\n  font: {\n    font_id: string\n    font_name: string\n    font_family?: string\n    font_weight_regular?: string\n    font_weight_medium?: string\n    font_weight_bold?: string\n    urls: Array<{\n      type?: { ... }\n      url?: { ... }\n    }>\n  }\n  primary: string\n  secondary: string\n}\n```\n\n### `ShapeData`\n\n```ts\ntype ShapeData = {\n  border_radius?: number\n}\n```\n\n### `FontData`\n\n```ts\ntype FontData = {\n  font_id: string\n  font_name: string\n  font_family?: string\n  font_weight_regular?: string\n  font_weight_medium?: string\n  font_weight_bold?: string\n  urls: Array<{\n    type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n    url?: string\n  }>\n}\n```\n\n### `FontResponseUrl`\n\n```ts\ntype FontResponseUrl = {\n  type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n  url?: string\n}\n```\n\n### `WidgetPortalData`\n\n```ts\ntype WidgetPortalData = {\n  id: string\n  name: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n  message?: string\n  error?: object\n}\n```\n\n### `FileData`\n\n```ts\ntype FileData = {\n  name: string\n  display_name?: string\n  file_type?: "LOGO" | "FONT" | "IMAGE"\n  s3_object_key: string\n  url: string\n}\n```\n\n### `DesignId`\n\nId of the design\n\n```ts\ntype DesignId = string\n```\n\n### `Theme`\n\nType of theme to be parsed and returned\n\n```ts\ntype Theme = "NEW" | "OLD"\n```\n\n### `Application`\n\nType of application that uses the design\n\n```ts\ntype Application = string\n```\n\n### `DesignParameters`\n\n```ts\ntype DesignParameters = {\n  designId?: string\n  theme?: "NEW" | "OLD"\n  application?: string\n}\n```\n';
+
+
+exports.default = design_default;

package/dist/design-runtime-3RHYNHUV.cjs

@@ -0,0 +1,5 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkWHXYES2Dcjs = require('./chunk-WHXYES2D.cjs');
+require('./chunk-NJK5F5TF.cjs');
+exports. default = _chunkWHXYES2Dcjs.require_design_runtime.call(void 0, );

package/dist/{design-runtime-QMJM4FAF.js → design-runtime-DLMA4EHQ.js}

@@ -1,5 +1,5 @@
 import {
   require_design_runtime
-} from "./chunk-KIWRGUKM.js";
+} from "./chunk-P4NA7NWG.js";
 import "./chunk-YPSWSI3M.js";
 export default require_design_runtime();

package/dist/email-settings-YJ4X5VFU.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/email-settings.json
+var email_settings_default = '# Messaging Settings API\n\n- **Base URL:** `https://email-settings.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/email-settings](https://docs.epilot.io/api/email-settings)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.emailSettings.provisionEpilotEmailAddress(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/email-settings\'\n\nconst emailSettingsClient = getClient()\nauthorize(emailSettingsClient, () => \'<token>\')\nconst { data } = await emailSettingsClient.provisionEpilotEmailAddress(...)\n```\n\n## Operations\n\n**Email addresses**\n- [`provisionEpilotEmailAddress`](#provisionepilotemailaddress)\n- [`setEmailAddressPrimary`](#setemailaddressprimary)\n- [`getEmailAddress`](#getemailaddress)\n- [`deleteEmailAddress`](#deleteemailaddress)\n- [`updateEmailAddress`](#updateemailaddress)\n- [`listEmailAddresses`](#listemailaddresses)\n- [`addEmailAddress`](#addemailaddress)\n\n**Shared inboxes**\n- [`getSharedInbox`](#getsharedinbox)\n- [`deleteSharedInbox`](#deletesharedinbox)\n- [`updateSharedInbox`](#updatesharedinbox)\n- [`listSharedInboxes`](#listsharedinboxes)\n- [`addSharedInbox`](#addsharedinbox)\n\n**Inbox buckets**\n- [`listInboxBuckets`](#listinboxbuckets)\n\n**O365 Outlook Connection**\n- [`connectOutlook`](#connectoutlook)\n- [`getOutlookConnectionStatus`](#getoutlookconnectionstatus)\n- [`disconnectOutlook`](#disconnectoutlook)\n- [`connectOutlookMailbox`](#connectoutlookmailbox)\n- [`disconnectOutlookMailbox`](#disconnectoutlookmailbox)\n- [`startMailboxSync`](#startmailboxsync)\n- [`getMailboxSyncStatus`](#getmailboxsyncstatus)\n- [`retryMailboxSync`](#retrymailboxsync)\n- [`getConnectedOutlookEmails`](#getconnectedoutlookemails)\n- [`outlookOAuthCallback`](#outlookoauthcallback)\n\n**Channels**\n- [`connectMsTeams`](#connectmsteams)\n- [`disconnectMsTeams`](#disconnectmsteams)\n- [`getMsTeamsStatus`](#getmsteamsstatus)\n\n**Settings**\n- [`getSettings`](#getsettings)\n- [`addSetting`](#addsetting)\n- [`deleteSetting`](#deletesetting)\n- [`updateSetting`](#updatesetting)\n\n**Domains**\n- [`addDomain`](#adddomain)\n- [`deleteDomain`](#deletedomain)\n- [`getDomains`](#getdomains)\n- [`verifyNameServers`](#verifynameservers)\n- [`verifyDnsRecords`](#verifydnsrecords)\n- [`verifyDomain`](#verifydomain)\n\n**Schemas**\n- [`ConnectOutlookRequest`](#connectoutlookrequest)\n- [`MailboxSyncStatus`](#mailboxsyncstatus)\n- [`MailboxSyncStatuses`](#mailboxsyncstatuses)\n- [`MailboxSyncFolderStatuses`](#mailboxsyncfolderstatuses)\n- [`MailboxSyncTimeframePeriods`](#mailboxsynctimeframeperiods)\n- [`InboxBucketResponse`](#inboxbucketresponse)\n- [`ProvisionEpilotEmailAddressPayload`](#provisionepilotemailaddresspayload)\n- [`SetEmailAddressPrimaryPayload`](#setemailaddressprimarypayload)\n- [`UpdateEmailAddressPayload`](#updateemailaddresspayload)\n- [`CreateEmailAddressPayload`](#createemailaddresspayload)\n- [`EmailAddressResponse`](#emailaddressresponse)\n- [`ErrorResponse`](#errorresponse)\n- [`SettingMeta`](#settingmeta)\n- [`UpdateSharedInboxPayload`](#updatesharedinboxpayload)\n- [`CreateSharedInboxPayload`](#createsharedinboxpayload)\n- [`SharedInboxResponse`](#sharedinboxresponse)\n- [`SettingsResponse`](#settingsresponse)\n- [`ConnectedOutlookEmail`](#connectedoutlookemail)\n- [`OutlookConnectionError`](#outlookconnectionerror)\n- [`OutlookConnectionStatus`](#outlookconnectionstatus)\n- [`SignatureSetting`](#signaturesetting)\n- [`EmailDomainSetting`](#emaildomainsetting)\n- [`EmailAddressSetting`](#emailaddresssetting)\n- [`WhitelistEmailAddressSetting`](#whitelistemailaddresssetting)\n- [`RestrictDuplicatesWithinSetting`](#restrictduplicateswithinsetting)\n- [`SettingType`](#settingtype)\n- [`Setting`](#setting)\n- [`Domain`](#domain)\n\n### `provisionEpilotEmailAddress`\n\nProvisions or reactivates an epilot-managed email address for the organization.\n\n`PUT /v2/email-settings/email-addresses/epilot:provision`\n\n```ts\nconst { data } = await client.provisionEpilotEmailAddress(\n  null,\n  {\n    address: \'mycompany@epilot.cloud\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n  "created_at": "2024-01-15T10:30:00Z",\n  "updated_at": "2024-01-20T14:45:00Z",\n  "created_by": "user-123",\n  "updated_by": "user-456",\n  "address": "sales@yourcompany.com",\n  "name": "Sales Team",\n  "user_ids": ["user-123", "user-456"],\n  "group_ids": ["group-789"],\n  "default_signature_id": "sig-abc",\n  "shared_inbox_id": "inbox-xyz",\n  "is_active": true,\n  "is_primary": false,\n  "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `setEmailAddressPrimary`\n\nSets the specified email address as the primary address for the organization.\n\n`POST /v2/email-settings/email-addresses/primary`\n\n```ts\nconst { data } = await client.setEmailAddressPrimary(\n  null,\n  {\n    address: \'sales@yourcompany.com\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n  "created_at": "2024-01-15T10:30:00Z",\n  "updated_at": "2024-01-20T14:45:00Z",\n  "created_by": "user-123",\n  "updated_by": "user-456",\n  "address": "sales@yourcompany.com",\n  "name": "Sales Team",\n  "user_ids": ["user-123", "user-456"],\n  "group_ids": ["group-789"],\n  "default_signature_id": "sig-abc",\n  "shared_inbox_id": "inbox-xyz",\n  "is_active": true,\n  "is_primary": false,\n  "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `getEmailAddress`\n\nRetrieves the details of a specific email address by its ID.\n\n`GET /v2/email-settings/email-addresses/{id}`\n\n```ts\nconst { data } = await client.getEmailAddress({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n  "created_at": "2024-01-15T10:30:00Z",\n  "updated_at": "2024-01-20T14:45:00Z",\n  "created_by": "user-123",\n  "updated_by": "user-456",\n  "address": "sales@yourcompany.com",\n  "name": "Sales Team",\n  "user_ids": ["user-123", "user-456"],\n  "group_ids": ["group-789"],\n  "default_signature_id": "sig-abc",\n  "shared_inbox_id": "inbox-xyz",\n  "is_active": true,\n  "is_primary": false,\n  "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `deleteEmailAddress`\n\nPermanently deletes an email address from the organization.\n\n`DELETE /v2/email-settings/email-addresses/{id}`\n\n```ts\nconst { data } = await client.deleteEmailAddress({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `updateEmailAddress`\n\nUpdates the configuration of an existing email address.\n\n`PUT /v2/email-settings/email-addresses/{id}`\n\n```ts\nconst { data } = await client.updateEmailAddress(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    name: \'Sales Team\',\n    user_ids: [\'user-123\', \'user-456\'],\n    group_ids: [\'group-789\'],\n    default_signature_id: \'sig-abc\',\n    shared_inbox_id: \'inbox-xyz\',\n    is_active: true\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n  "created_at": "2024-01-15T10:30:00Z",\n  "updated_at": "2024-01-20T14:45:00Z",\n  "created_by": "user-123",\n  "updated_by": "user-456",\n  "address": "sales@yourcompany.com",\n  "name": "Sales Team",\n  "user_ids": ["user-123", "user-456"],\n  "group_ids": ["group-789"],\n  "default_signature_id": "sig-abc",\n  "shared_inbox_id": "inbox-xyz",\n  "is_active": true,\n  "is_primary": false,\n  "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `listEmailAddresses`\n\nRetrieves all email addresses configured for the organization.\n\n`GET /v2/email-settings/email-addresses`\n\n```ts\nconst { data } = await client.listEmailAddresses()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n    "created_at": "2024-01-15T10:30:00Z",\n    "updated_at": "2024-01-20T14:45:00Z",\n    "created_by": "user-123",\n    "updated_by": "user-456",\n    "address": "sales@yourcompany.com",\n    "name": "Sales Team",\n    "user_ids": ["user-123", "user-456"],\n    "group_ids": ["group-789"],\n    "default_signature_id": "sig-abc",\n    "shared_inbox_id": "inbox-xyz",\n    "is_active": true,\n    "is_primary": false,\n    "is_epilot_email_address": false\n  }\n]\n```\n\n</details>\n\n---\n\n### `addEmailAddress`\n\nAdds a new email address to the organization.\n\n`POST /v2/email-settings/email-addresses`\n\n```ts\nconst { data } = await client.addEmailAddress(\n  null,\n  {\n    address: \'support@yourcompany.com\',\n    name: \'Customer Support\',\n    user_ids: [\'user-123\'],\n    group_ids: [\'group-456\'],\n    default_signature_id: \'sig-789\',\n    shared_inbox_id: \'inbox-abc\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n  "created_at": "2024-01-15T10:30:00Z",\n  "updated_at": "2024-01-20T14:45:00Z",\n  "created_by": "user-123",\n  "updated_by": "user-456",\n  "address": "sales@yourcompany.com",\n  "name": "Sales Team",\n  "user_ids": ["user-123", "user-456"],\n  "group_ids": ["group-789"],\n  "default_signature_id": "sig-abc",\n  "shared_inbox_id": "inbox-xyz",\n  "is_active": true,\n  "is_primary": false,\n  "is_epilot_email_address": false\n}\n```\n\n</details>\n\n---\n\n### `getSharedInbox`\n\nRetrieves the details of a specific shared inbox by its ID.\n\n`GET /v2/email-settings/shared-inboxes/{id}`\n\n```ts\nconst { data } = await client.getSharedInbox({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n  "created_at": "2024-01-15T10:30:00Z",\n  "updated_at": "2024-01-20T14:45:00Z",\n  "created_by": "user-123",\n  "updated_by": "user-456",\n  "name": "Customer Support",\n  "color": "#4CAF50",\n  "assignees": ["user-123", "user-456"],\n  "description": "Incoming customer support requests",\n  "bucket_id": "bucket-xyz"\n}\n```\n\n</details>\n\n---\n\n### `deleteSharedInbox`\n\nDeletes a shared inbox and reroutes all associated emails to a successor inbox.\n\n`DELETE /v2/email-settings/shared-inboxes/{id}`\n\n```ts\nconst { data } = await client.deleteSharedInbox({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n  successorInboxId: \'example\',\n})\n```\n\n---\n\n### `updateSharedInbox`\n\nUpdates the configuration of an existing shared inbox.\n\n`PUT /v2/email-settings/shared-inboxes/{id}`\n\n```ts\nconst { data } = await client.updateSharedInbox(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    color: \'#4CAF50\',\n    name: \'Customer Support\',\n    assignees: [\'user-123\', \'user-456\'],\n    description: \'Incoming customer support requests\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n  "created_at": "2024-01-15T10:30:00Z",\n  "updated_at": "2024-01-20T14:45:00Z",\n  "created_by": "user-123",\n  "updated_by": "user-456",\n  "name": "Customer Support",\n  "color": "#4CAF50",\n  "assignees": ["user-123", "user-456"],\n  "description": "Incoming customer support requests",\n  "bucket_id": "bucket-xyz"\n}\n```\n\n</details>\n\n---\n\n### `listSharedInboxes`\n\nRetrieves all shared inboxes configured for the organization.\n\n`GET /v2/email-settings/shared-inboxes`\n\n```ts\nconst { data } = await client.listSharedInboxes()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n    "created_at": "2024-01-15T10:30:00Z",\n    "updated_at": "2024-01-20T14:45:00Z",\n    "created_by": "user-123",\n    "updated_by": "user-456",\n    "name": "Customer Support",\n    "color": "#4CAF50",\n    "assignees": ["user-123", "user-456"],\n    "description": "Incoming customer support requests",\n    "bucket_id": "bucket-xyz"\n  }\n]\n```\n\n</details>\n\n---\n\n### `addSharedInbox`\n\nCreates a new shared inbox for the organization.\n\n`POST /v2/email-settings/shared-inboxes`\n\n```ts\nconst { data } = await client.addSharedInbox(\n  null,\n  {\n    id: \'support-inbox\',\n    color: \'#2196F3\',\n    name: \'Sales Inquiries\',\n    assignees: [\'user-123\', \'user-456\'],\n    description: \'Inbound sales and pricing requests\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n  "created_at": "2024-01-15T10:30:00Z",\n  "updated_at": "2024-01-20T14:45:00Z",\n  "created_by": "user-123",\n  "updated_by": "user-456",\n  "name": "Customer Support",\n  "color": "#4CAF50",\n  "assignees": ["user-123", "user-456"],\n  "description": "Incoming customer support requests",\n  "bucket_id": "bucket-xyz"\n}\n```\n\n</details>\n\n---\n\n### `listInboxBuckets`\n\nRetrieves all inbox buckets for the organization.\n\n`GET /v2/email-settings/inbox-buckets`\n\n```ts\nconst { data } = await client.listInboxBuckets()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "id": "bucket-abc",\n    "inbox_id": "inbox-xyz"\n  }\n]\n```\n\n</details>\n\n---\n\n### `connectOutlook`\n\nReturns the Microsoft authorization URL for Outlook OAuth.\n\n`POST /v2/outlook/connect`\n\n```ts\nconst { data } = await client.connectOutlook(\n  null,\n  {\n    mail: true,\n    calendar: true\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "authorization_url": "string"\n}\n```\n\n</details>\n\n---\n\n### `getOutlookConnectionStatus`\n\nReturns all Microsoft 365 / Outlook connections for the organization.\nSupports multiple connections (one per Azure AD tenant).\n\n`GET /v2/outlook/connection/status`\n\n```ts\nconst { data } = await client.getOutlookConnectionStatus()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "connections": [\n    {\n      "status": "connected",\n      "action": "connect",\n      "action_reason": "expired",\n      "connected_by_display_name": "string",\n      "connected_by_email": "user@example.com",\n      "connected_by_user_id": "string",\n      "connected_at": "1970-01-01T00:00:00.000Z",\n      "updated_at": "1970-01-01T00:00:00.000Z",\n      "tenant_id": "string",\n      "scopes": ["string"],\n      "expires_at": "1970-01-01T00:00:00.000Z",\n      "is_token_valid": true\n    }\n  ],\n  "has_connections": true,\n  "teams_enabled": true\n}\n```\n\n</details>\n\n---\n\n### `disconnectOutlook`\n\nRemoves the Microsoft 365 / Outlook connection for a specific tenant.\nThis deletes the stored tokens and disconnects the integration.\n\n`POST /v2/outlook/connection/disconnect`\n\n```ts\nconst { data } = await client.disconnectOutlook(\n  null,\n  {\n    tenant_id: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "success": true,\n  "tenant_id": "string",\n  "affected_shared_inboxes": ["string"]\n}\n```\n\n</details>\n\n---\n\n### `connectMsTeams`\n\nConnects Microsoft Teams channel (click-to-call deep links, meetings) for the organization.\nRequires an active Microsoft 365 / Outlook connection.\n\n`POST /v2/channels/msteams/connect`\n\n```ts\nconst { data } = await client.connectMsTeams()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "connected": true,\n  "connected_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `disconnectMsTeams`\n\nDisconnects Microsoft Teams channel for the organization.\n\n`POST /v2/channels/msteams/disconnect`\n\n```ts\nconst { data } = await client.disconnectMsTeams()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "connected": true\n}\n```\n\n</details>\n\n---\n\n### `getMsTeamsStatus`\n\nReturns the connection status of the Microsoft Teams channel for the organization.\n\n`GET /v2/channels/msteams/status`\n\n```ts\nconst { data } = await client.getMsTeamsStatus()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "connected": true,\n  "connected_at": "1970-01-01T00:00:00.000Z",\n  "connected_by_user_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `connectOutlookMailbox`\n\nConnects an Outlook mailbox:\n  1. Validates the user has access to the mailbox via Microsoft Graph API\n  2. Creates a mapping between the email address of the mailbox and the outlook connection\n  3. E\n\n`POST /v2/outlook/mailbox/connect`\n\n```ts\nconst { data } = await client.connectOutlookMailbox(\n  null,\n  {\n    email: \'user@example.com\',\n    shared_inbox_id: \'default\',\n    mailboxSyncTimeframe: \'5m\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "email_address": {\n    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n    "created_at": "2024-01-15T10:30:00Z",\n    "updated_at": "2024-01-20T14:45:00Z",\n    "created_by": "user-123",\n    "updated_by": "user-456",\n    "address": "sales@yourcompany.com",\n    "name": "Sales Team",\n    "user_ids": ["user-123", "user-456"],\n    "group_ids": ["group-789"],\n    "default_signature_id": "sig-abc",\n    "shared_inbox_id": "inbox-xyz",\n    "is_active": true,\n    "is_primary": false,\n    "is_epilot_email_address": false\n  },\n  "outlook_email": "user@example.com",\n  "tenant_id": "string",\n  "provider": "outlook"\n}\n```\n\n</details>\n\n---\n\n### `disconnectOutlookMailbox`\n\nDisconnect Outlook Mailbox\n\n`POST /v2/outlook/mailbox/{email}/disconnect`\n\n```ts\nconst { data } = await client.disconnectOutlookMailbox({\n  email: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "success": true,\n  "email": "user@example.com"\n}\n```\n\n</details>\n\n---\n\n### `startMailboxSync`\n\nStart Mailbox Sync\n\n`POST /v2/outlook/mailbox/{email}/sync`\n\n```ts\nconst { data } = await client.startMailboxSync(\n  {\n    email: \'example\',\n  },\n  {\n    timeframe: \'5m\'\n  },\n)\n```\n\n---\n\n### `getMailboxSyncStatus`\n\nGet Mailbox Sync Status\n\n`GET /v2/outlook/mailbox/{email}/sync/status`\n\n```ts\nconst { data } = await client.getMailboxSyncStatus({\n  email: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "execution_id": "string",\n  "status": "RUNNING",\n  "timeframe": "5m",\n  "started_at": "1970-01-01T00:00:00.000Z",\n  "completed_at": "1970-01-01T00:00:00.000Z",\n  "inbox": {\n    "status": "PENDING",\n    "total_messages": 0,\n    "processed_messages": 0,\n    "failed_messages": 0\n  },\n  "sent_items": {\n    "status": "PENDING",\n    "total_messages": 0,\n    "processed_messages": 0,\n    "failed_messages": 0\n  }\n}\n```\n\n</details>\n\n---\n\n### `retryMailboxSync`\n\nRetry Failed Messages\n\n`POST /v2/outlook/mailbox/{email}/sync/retry`\n\n```ts\nconst { data } = await client.retryMailboxSync(\n  {\n    email: \'example\',\n  },\n  {\n    sync_id: \'string\',\n    scope: \'all_failed\',\n    message_ids: [\'string\']\n  },\n)\n```\n\n---\n\n### `getConnectedOutlookEmails`\n\nReturns all Outlook email addresses connected to the organization.\n\n`GET /v2/outlook/mailbox/mappings`\n\n```ts\nconst { data } = await client.getConnectedOutlookEmails()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "outlook_emails": [\n    {\n      "outlook_email": "user@example.com",\n      "tenant_id": "string",\n      "provider": "outlook",\n      "connected_at": "1970-01-01T00:00:00.000Z",\n      "connected_by_user_id": "string"\n    }\n  ],\n  "count": 0\n}\n```\n\n</details>\n\n---\n\n### `outlookOAuthCallback`\n\nExchanges authorization code for tokens and stores them.\n\n`GET /v2/outlook/oauth/callback`\n\n```ts\nconst { data } = await client.outlookOAuthCallback({\n  code: \'example\',\n  state: \'example\',\n  session_state: \'example\',\n  error: \'example\',\n  error_description: \'example\',\n  error_subcode: \'example\',\n  client_info: \'example\',\n  error_uri: \'example\',\n  admin_consent: \'example\',\n  tenant: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "connected": true,\n  "expires_at": "1970-01-01T00:00:00.000Z",\n  "scope": "string"\n}\n```\n\n</details>\n\n---\n\n### `getSettings`\n\nRetrieves settings of a specific type for the organization.\n\n`GET /v1/email-settings`\n\n```ts\nconst { data } = await client.getSettings({\n  type: \'example\',\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n    "name": "Default Signature",\n    "org_id": "org-123",\n    "type": "signature",\n    "value": "Best regards, The Team",\n    "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n    "created_at": "2024-01-15T10:30:00Z",\n    "updated_at": "2024-01-20T14:45:00Z",\n    "created_by": "user-123",\n    "updated_by": "user-456"\n  }\n]\n```\n\n</details>\n\n---\n\n### `addSetting`\n\nCreates a new setting of the specified type.\n\n`POST /v1/email-settings`\n\n```ts\nconst { data } = await client.addSetting(\n  null,\n  {\n    id: \'a10bd0ff-4391-4cfc-88ee-b19d718a9bf7\',\n    name: \'Default Signature\',\n    org_id: \'org-123\',\n    type: \'signature\',\n    value: \'Best regards, The Team\',\n    html: \'<p>Best regards,<br/><strong>The Team</strong></p>\',\n    created_at: \'2024-01-15T10:30:00Z\',\n    updated_at: \'2024-01-20T14:45:00Z\',\n    created_by: \'user-123\',\n    updated_by: \'user-456\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n    "name": "Default Signature",\n    "org_id": "org-123",\n    "type": "signature",\n    "value": "Best regards, The Team",\n    "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n    "created_at": "2024-01-15T10:30:00Z",\n    "updated_at": "2024-01-20T14:45:00Z",\n    "created_by": "user-123",\n    "updated_by": "user-456"\n  }\n]\n```\n\n</details>\n\n---\n\n### `deleteSetting`\n\nDeletes a setting by its ID and type.\n\n`DELETE /v1/email-settings`\n\n```ts\nconst { data } = await client.deleteSetting(\n  null,\n  {\n    type: \'signature\',\n    id: \'a10bd0ff-4391-4cfc-88ee-b19d718a9bf7\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n  "name": "Default Signature",\n  "org_id": "org-123",\n  "type": "signature",\n  "value": "Best regards, The Team",\n  "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n  "created_at": "2024-01-15T10:30:00Z",\n  "updated_at": "2024-01-20T14:45:00Z",\n  "created_by": "user-123",\n  "updated_by": "user-456"\n}\n```\n\n</details>\n\n---\n\n### `updateSetting`\n\nUpdates an existing setting identified by its ID.\n\n`POST /v1/email-settings/{id}`\n\n```ts\nconst { data } = await client.updateSetting(\n  {\n    id: \'123e4567-e89b-12d3-a456-426614174000\',\n  },\n  {\n    id: \'a10bd0ff-4391-4cfc-88ee-b19d718a9bf7\',\n    name: \'Default Signature\',\n    org_id: \'org-123\',\n    type: \'signature\',\n    value: \'Best regards, The Team\',\n    html: \'<p>Best regards,<br/><strong>The Team</strong></p>\',\n    created_at: \'2024-01-15T10:30:00Z\',\n    updated_at: \'2024-01-20T14:45:00Z\',\n    created_by: \'user-123\',\n    updated_by: \'user-456\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n  "name": "Default Signature",\n  "org_id": "org-123",\n  "type": "signature",\n  "value": "Best regards, The Team",\n  "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n  "created_at": "2024-01-15T10:30:00Z",\n  "updated_at": "2024-01-20T14:45:00Z",\n  "created_by": "user-123",\n  "updated_by": "user-456"\n}\n```\n\n</details>\n\n---\n\n### `addDomain`\n\nAdds a custom email domain to the organization.\n\n`POST /v1/email-settings/domain`\n\n```ts\nconst { data } = await client.addDomain(\n  null,\n  {\n    domain: \'mail.yourcompany.com\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n    "name": "Default Signature",\n    "org_id": "org-123",\n    "type": "signature",\n    "value": "Best regards, The Team",\n    "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n    "created_at": "2024-01-15T10:30:00Z",\n    "updated_at": "2024-01-20T14:45:00Z",\n    "created_by": "user-123",\n    "updated_by": "user-456"\n  }\n]\n```\n\n</details>\n\n---\n\n### `deleteDomain`\n\nRemoves a custom email domain from the organization.\n\n`DELETE /v1/email-settings/domain`\n\n```ts\nconst { data } = await client.deleteDomain(\n  null,\n  {\n    domain: \'mail.yourcompany.com\'\n  },\n)\n```\n\n---\n\n### `getDomains`\n\nRetrieves all custom email domains for the organization.\n\n`GET /v1/email-settings/domain`\n\n```ts\nconst { data } = await client.getDomains()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n["string"]\n```\n\n</details>\n\n---\n\n### `verifyNameServers`\n\nVerifies that the domain\'s name server (NS) records are correctly configured.\n\n`POST /v1/email-settings/domain/name-servers:verify`\n\n```ts\nconst { data } = await client.verifyNameServers(\n  null,\n  {\n    domain: \'mail.yourcompany.com\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n    "name": "Default Signature",\n    "org_id": "org-123",\n    "type": "signature",\n    "value": "Best regards, The Team",\n    "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n    "created_at": "2024-01-15T10:30:00Z",\n    "updated_at": "2024-01-20T14:45:00Z",\n    "created_by": "user-123",\n    "updated_by": "user-456"\n  }\n]\n```\n\n</details>\n\n---\n\n### `verifyDnsRecords`\n\nVerifies that the domain\'s DNS records (MX, TXT, CNAME) are correctly configured\nin the customer\'s DNS provider.\n\n`POST /v1/email-settings/domain/dns-records:verify`\n\n```ts\nconst { data } = await client.verifyDnsRecords(\n  null,\n  {\n    domain: \'mail.yourcompany.com\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n    "name": "Default Signature",\n    "org_id": "org-123",\n    "type": "signature",\n    "value": "Best regards, The Team",\n    "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n    "created_at": "2024-01-15T10:30:00Z",\n    "updated_at": "2024-01-20T14:45:00Z",\n    "created_by": "user-123",\n    "updated_by": "user-456"\n  }\n]\n```\n\n</details>\n\n---\n\n### `verifyDomain`\n\nVerifies ownership and configuration of a custom email domain.\n\n`POST /v1/email-settings/domain:verify`\n\n```ts\nconst { data } = await client.verifyDomain(\n  null,\n  {\n    domain: \'mail.yourcompany.com\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "id": "a10bd0ff-4391-4cfc-88ee-b19d718a9bf7",\n    "name": "Default Signature",\n    "org_id": "org-123",\n    "type": "signature",\n    "value": "Best regards, The Team",\n    "html": "<p>Best regards,<br/><strong>The Team</strong></p>",\n    "created_at": "2024-01-15T10:30:00Z",\n    "updated_at": "2024-01-20T14:45:00Z",\n    "created_by": "user-123",\n    "updated_by": "user-456"\n  }\n]\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ConnectOutlookRequest`\n\nFeature flags selecting which Microsoft Graph scopes to request.\nAt least one flag must be true. Passing a superset of previously\ngranted features triggers incremental consent for the delta only.\n\n\n```ts\ntype ConnectOutlookRequest = {\n  mail?: boolean\n  calendar?: boolean\n}\n```\n\n### `MailboxSyncStatus`\n\n```ts\ntype MailboxSyncStatus = {\n  execution_id: string\n  status: "RUNNING" | "COMPLETED" | "COMPLETED_WITH_ERRORS" | "FAILED" | "CANCELLED"\n  timeframe: "5m" | "1w" | "2w" | "1m"\n  started_at: string // date-time\n  completed_at?: string // date-time\n  inbox?: {\n    status?: "PENDING" | "RUNNING" | "COMPLETED" | "FAILED" | "SKIPPED"\n    total_messages?: number\n    processed_messages?: number\n    failed_messages?: number\n  }\n  sent_items?: {\n    status?: "PENDING" | "RUNNING" | "COMPLETED" | "FAILED" | "SKIPPED"\n    total_messages?: number\n    processed_messages?: number\n    failed_messages?: number\n  }\n}\n```\n\n### `MailboxSyncStatuses`\n\n```ts\ntype MailboxSyncStatuses = "RUNNING" | "COMPLETED" | "COMPLETED_WITH_ERRORS" | "FAILED" | "CANCELLED"\n```\n\n### `MailboxSyncFolderStatuses`\n\n```ts\ntype MailboxSyncFolderStatuses = "PENDING" | "RUNNING" | "COMPLETED" | "FAILED" | "SKIPPED"\n```\n\n### `MailboxSyncTimeframePeriods`\n\n```ts\ntype MailboxSyncTimeframePeriods = "5m" | "1w" | "2w" | "1m"\n```\n\n### `InboxBucketResponse`\n\nInbox bucket representing the storage container for a shared inbox.\n\n```ts\ntype InboxBucketResponse = {\n  id: string\n  inbox_id: string\n}\n```\n\n### `ProvisionEpilotEmailAddressPayload`\n\nRequest payload for provisioning an epilot-managed email address.\n\n```ts\ntype ProvisionEpilotEmailAddressPayload = {\n  address: string\n}\n```\n\n### `SetEmailAddressPrimaryPayload`\n\nRequest payload for setting an email address as the organization\'s primary address.\n\n```ts\ntype SetEmailAddressPrimaryPayload = {\n  address: string\n}\n```\n\n### `UpdateEmailAddressPayload`\n\nRequest payload for updating an email address configuration.\nAll fields are optional; only provided fields will be updated.\n\n\n```ts\ntype UpdateEmailAddressPayload = {\n  name?: string\n  user_ids?: string[]\n  group_ids?: string[]\n  default_signature_id?: string\n  shared_inbox_id?: string\n  is_active?: boolean\n}\n```\n\n### `CreateEmailAddressPayload`\n\nRequest payload for creating a new email address.\n\n```ts\ntype CreateEmailAddressPayload = {\n  address: string\n  name?: string\n  user_ids?: string[]\n  group_ids?: string[]\n  default_signature_id?: string\n  shared_inbox_id?: string\n}\n```\n\n### `EmailAddressResponse`\n\nEmail address configuration with all associated metadata.\n\n```ts\ntype EmailAddressResponse = {\n  id: string\n  created_at: string // date-time\n  updated_at?: string // date-time\n  created_by?: string\n  updated_by?: string\n  address: string\n  name?: string\n  user_ids?: string[]\n  group_ids?: string[]\n  default_signature_id?: string\n  shared_inbox_id?: string\n  is_active?: boolean\n  is_primary?: boolean\n  is_epilot_email_address?: boolean\n}\n```\n\n### `ErrorResponse`\n\nStandard error response format for all API errors.\n\n```ts\ntype ErrorResponse = {\n  error: string\n  status: number\n}\n```\n\n### `SettingMeta`\n\nCommon metadata fields for all settings and resources.\n\n```ts\ntype SettingMeta = {\n  id: string\n  created_at: string // date-time\n  updated_at?: string // date-time\n  created_by?: string\n  updated_by?: string\n}\n```\n\n### `UpdateSharedInboxPayload`\n\nRequest payload for updating a shared inbox configuration.\nAll fields are optional; only provided fields will be updated.\n\n\n```ts\ntype UpdateSharedInboxPayload = {\n  color?: string\n  name?: string\n  assignees?: string[]\n  description?: string\n}\n```\n\n### `CreateSharedInboxPayload`\n\nRequest payload for creating a new shared inbox.\n\n```ts\ntype CreateSharedInboxPayload = {\n  id?: string\n  color: string\n  name: string\n  assignees?: string[]\n  description?: string\n}\n```\n\n### `SharedInboxResponse`\n\nShared inbox configuration with all associated metadata.\n\n```ts\ntype SharedInboxResponse = {\n  id: string\n  created_at: string // date-time\n  updated_at?: string // date-time\n  created_by?: string\n  updated_by?: string\n  name: string\n  color: string\n  assignees: string[]\n  description?: string\n  bucket_id: string\n}\n```\n\n### `SettingsResponse`\n\n```ts\ntype SettingsResponse = Array<{\n  id?: string\n  name?: string\n  org_id?: string\n  type: "signature" | "email_domain" | "email_address" | "whitelist_email_address" | "restrict_duplicates_within"\n  value?: string\n  html?: string\n  created_at?: string\n  updated_at?: string\n  created_by?: string\n  updated_by?: string\n}> | {\n  id?: string\n  name?: string\n  org_id?: string\n  type: "signature" | "email_domain" | "email_address" | "whitelist_email_address" | "restrict_duplicates_within"\n  value?: string\n  html?: string\n  created_at?: string\n  updated_at?: string\n  created_by?: string\n  updated_by?: string\n}\n```\n\n### `ConnectedOutlookEmail`\n\nMapping between an Outlook email and its Outlook Connection.\nThis tracks which provider/tenant provisions each Outlook email.\n\n\n```ts\ntype ConnectedOutlookEmail = {\n  outlook_email: string // email\n  tenant_id?: string\n  provider?: "outlook"\n  connected_at?: string // date-time\n  connected_by_user_id?: string\n}\n```\n\n### `OutlookConnectionError`\n\n```ts\ntype OutlookConnectionError = {\n  error: string\n  error_description?: string\n  admin_consent_url?: string // uri\n}\n```\n\n### `OutlookConnectionStatus`\n\n```ts\ntype OutlookConnectionStatus = {\n  status: "connected" | "expired" | "pending_auth" | "not_connected"\n  action: "connect" | "authorize" | "reconnect" | "none"\n  action_reason?: "expired" | "permission_update"\n  connected_by_display_name?: string\n  connected_by_email?: string // email\n  connected_by_user_id?: string\n  connected_at?: string // date-time\n  updated_at?: string // date-time\n  tenant_id: string\n  scopes?: string[]\n  expires_at?: string // date-time\n  is_token_valid?: boolean\n}\n```\n\n### `SignatureSetting`\n\nSetting that allows to add a signature.\n\n```ts\ntype SignatureSetting = "signature"\n```\n\n### `EmailDomainSetting`\n\nSetting that allows to add a custom domain. For e.g; doe.com\n\n```ts\ntype EmailDomainSetting = "email_domain"\n```\n\n### `EmailAddressSetting`\n\nSetting that allows to add an email address on the custom domain. For e.g; john@doe.com\n\n```ts\ntype EmailAddressSetting = "email_address"\n```\n\n### `WhitelistEmailAddressSetting`\n\n- Setting that specifies a list of addresses exempt from being flagged as duplicate emails.\n- An email will be flagged as a duplicate if it has the same content and is sent to the same recipient within the time frame specified in the RestrictDuplicatesWithinSetting.\n\n\n```ts\ntype WhitelistEmailAddressSetting = "whitelist_email_address"\n```\n\n### `RestrictDuplicatesWithinSetting`\n\n- Restrict duplicates within:\n  * 10s\n  * 5m\n  * 1d\n  * 5000 // It converts to 5 seconds.When expressed as a numerical value, it will be interpreted as being in milliseconds.\n- Defaults to 3 minutes\n- Negative values will be treated same as positive values\n- If not set, defaults to 3 min\n- If set as\n\n```ts\ntype RestrictDuplicatesWithinSetting = "restrict_duplicates_within"\n```\n\n### `SettingType`\n\n```ts\ntype SettingType = "signature" | "email_domain" | "email_address" | "whitelist_email_address" | "restrict_duplicates_within"\n```\n\n### `Setting`\n\nGeneric setting object used for various email configuration types.\nThe applicable fields depend on the setting type:\n- **signature**: Uses `name`, `value` (plain text), and `html` (rich text)\n- **email_domain**: Uses `value` (domain name)\n- **whitelist_email_address**: Uses `value` (email address)\n-\n\n```ts\ntype Setting = {\n  id?: string\n  name?: string\n  org_id?: string\n  type: "signature" | "email_domain" | "email_address" | "whitelist_email_address" | "restrict_duplicates_within"\n  value?: string\n  html?: string\n  created_at?: string\n  updated_at?: string\n  created_by?: string\n  updated_by?: string\n}\n```\n\n### `Domain`\n\nCustom email domain configuration.\n\n```ts\ntype Domain = {\n  domain?: string\n}\n```\n';
+
+
+exports.default = email_settings_default;