@epilot/sdk 2.1.0-rc.1 → 2.1.1

package/dist/consent-6SIH4NQS.cjs

@@ -0,0 +1,342 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/definitions/consent.json
+var openapi = "3.0.3";
+var info = {
+  title: "Consent API",
+  version: "1.0.0",
+  description: "Consent Management for epilot customer entities\n"
+};
+var tags = [
+  {
+    name: "consent",
+    description: "Consent Management"
+  }
+];
+var security = [
+  {
+    EpilotAuth: []
+  }
+];
+var paths = {
+  "/v1/consent/publish": {
+    post: {
+      operationId: "publishConsentEvent",
+      summary: "publishConsentEvent",
+      description: "Publishes consent event on event bus, which appends to consent store\n",
+      tags: ["consent"],
+      requestBody: {
+        content: {
+          "application/json": {
+            schema: {
+              $ref: "#/components/schemas/ConsentEventRequestBody"
+            },
+            examples: {
+              OptInEmailMarketing: {
+                $ref: "#/components/examples/ConsentOptInEmailMarketing"
+              },
+              OptInSMSMarketing: {
+                $ref: "#/components/examples/ConsentOptInSMSMarketing"
+              },
+              OptInPhoneCallMarketing: {
+                $ref: "#/components/examples/ConsentOptInPhoneCallMarketing"
+              },
+              OptOutEmailMarketing: {
+                $ref: "#/components/examples/ConsentOptOutEmailMarketing"
+              }
+            }
+          }
+        }
+      },
+      responses: {
+        "201": {
+          description: "The created opt-in",
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/ConsentEvent"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/v1/consent/{identifier}": {
+    get: {
+      operationId: "listConsentEvents",
+      summary: "listConsentEvents",
+      description: "List opt-ins and opt-outs by customer identifier\n",
+      tags: ["consent"],
+      parameters: [
+        {
+          name: "identifier",
+          in: "path",
+          required: true,
+          schema: {
+            $ref: "#/components/schemas/ConsentIdentifier"
+          }
+        },
+        {
+          name: "topic",
+          in: "query",
+          required: false,
+          schema: {
+            $ref: "#/components/schemas/ConsentTopic"
+          }
+        },
+        {
+          name: "limit",
+          in: "query",
+          required: false,
+          schema: {
+            type: "integer",
+            default: 50,
+            minimum: 1,
+            maximum: 100
+          }
+        },
+        {
+          name: "from",
+          in: "query",
+          required: false,
+          schema: {
+            type: "integer",
+            default: 0,
+            minimum: 0
+          }
+        }
+      ],
+      responses: {
+        "200": {
+          description: "list of opt-ins and opt-outs",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  events: {
+                    type: "array",
+                    items: {
+                      $ref: "#/components/schemas/ConsentEvent"
+                    }
+                  },
+                  total: {
+                    type: "integer",
+                    example: 1
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/v1/opt-in/{token}": {
+    get: {
+      operationId: "handleOptInWithToken",
+      summary: "handleOptInWithToken",
+      security: [],
+      description: "Endpoint to handle opt-in links\n",
+      tags: ["consent"],
+      parameters: [
+        {
+          name: "token",
+          in: "path",
+          required: true,
+          schema: {
+            type: "string"
+          }
+        },
+        {
+          name: "lang",
+          in: "query",
+          schema: {
+            type: "string",
+            default: "de"
+          }
+        }
+      ],
+      responses: {
+        "200": {
+          description: "Handler page for opt in links",
+          content: {
+            "text/html": {
+              example: "<p>You are subscribed!</p>\n"
+            }
+          }
+        }
+      }
+    }
+  }
+};
+var components = {
+  securitySchemes: {
+    EpilotAuth: {
+      type: "http",
+      scheme: "bearer",
+      description: "Epilot Id Token\n"
+    }
+  },
+  schemas: {
+    ConsentIdentifier: {
+      type: "string",
+      description: "Unique identifier for consent source (e.g. customer email or phone)",
+      example: "exampleuser@epilot.cloud"
+    },
+    ConsentTopic: {
+      type: "string",
+      description: "Consent Topic (what the person is opting into)",
+      example: "EMAIL_MARKETING"
+    },
+    ConsentSource: {
+      type: "string",
+      description: "Consent Source (Origin of the Consent Event)",
+      example: "www.frontend.epilot.cloud"
+    },
+    ConsentMeta: {
+      type: "object",
+      additionalProperties: true,
+      example: {
+        double_opt_in: true,
+        source_type: "journey",
+        source_id: "0e4f2a26-14f0-4ada-9294-a7d7a0b9b214",
+        ip_address: "1.1.1.1",
+        user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"
+      }
+    },
+    ConsentEventRequestBody: {
+      type: "object",
+      properties: {
+        type: {
+          type: "string",
+          enum: ["OPT_IN", "OPT_OUT"]
+        },
+        topic: {
+          $ref: "#/components/schemas/ConsentTopic"
+        },
+        source: {
+          $ref: "#/components/schemas/ConsentSource"
+        },
+        identifier: {
+          $ref: "#/components/schemas/ConsentIdentifier"
+        },
+        meta: {
+          $ref: "#/components/schemas/ConsentMeta"
+        }
+      },
+      required: ["type", "topic", "identifier"]
+    },
+    ConsentEvent: {
+      type: "object",
+      properties: {
+        type: {
+          type: "string",
+          enum: ["OPT_IN", "OPT_OUT", "DOUBLE_OPT_IN_REQUESTED", "DOUBLE_OPT_IN"]
+        },
+        created_at: {
+          type: "string",
+          format: "date-time"
+        },
+        topic: {
+          $ref: "#/components/schemas/ConsentTopic"
+        },
+        source: {
+          $ref: "#/components/schemas/ConsentSource"
+        },
+        organization_id: {
+          $ref: "#/components/schemas/OrganizationId"
+        },
+        identifier: {
+          $ref: "#/components/schemas/ConsentIdentifier"
+        },
+        meta: {
+          $ref: "#/components/schemas/ConsentMeta"
+        }
+      },
+      required: ["type", "topic", "identifier"]
+    },
+    OrganizationId: {
+      type: "string",
+      example: "123"
+    }
+  },
+  examples: {
+    ConsentOptInEmailMarketing: {
+      value: {
+        type: "OPT_IN",
+        topic: "EMAIL_MARKETING",
+        identifier: "exampleuser@epilot.cloud",
+        source: "frontend.epilot.cloud",
+        meta: {
+          ip_address: "1.1.1.1",
+          user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"
+        }
+      }
+    },
+    ConsentOptOutEmailMarketing: {
+      value: {
+        type: "OPT_OUT",
+        topic: "EMAIL_MARKETING",
+        identifier: "exampleuser@epilot.cloud",
+        source: "unsubscribe via email",
+        meta: {
+          ip_address: "1.1.1.1",
+          user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"
+        }
+      }
+    },
+    ConsentOptInSMSMarketing: {
+      value: {
+        type: "OPT_IN",
+        topic: "SMS_MARKETING",
+        identifier: "+49 123 1234567",
+        source: "frontend.epilot.cloud",
+        meta: {
+          ip_address: "1.1.1.1",
+          user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"
+        }
+      }
+    },
+    ConsentOptInPhoneCallMarketing: {
+      value: {
+        type: "OPT_IN",
+        topic: "PHONE_CALL_MARKETING",
+        identifier: "+49 123 1234567",
+        source: "frontend.epilot.cloud",
+        meta: {
+          ip_address: "1.1.1.1",
+          user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"
+        }
+      }
+    }
+  }
+};
+var servers = [
+  {
+    url: "https://consent.sls.epilot.io"
+  },
+  {
+    url: "https://consent.sls.epilot.io"
+  }
+];
+var consent_default = {
+  openapi,
+  info,
+  tags,
+  security,
+  paths,
+  components,
+  servers
+};
+
+
+
+
+
+
+
+
+
+exports.components = components; exports.default = consent_default; exports.info = info; exports.openapi = openapi; exports.paths = paths; exports.security = security; exports.servers = servers; exports.tags = tags;

package/dist/consent-7MNRAINV.js

@@ -0,0 +1,342 @@
+import "./chunk-YPSWSI3M.js";
+
+// src/definitions/consent.json
+var openapi = "3.0.3";
+var info = {
+  title: "Consent API",
+  version: "1.0.0",
+  description: "Consent Management for epilot customer entities\n"
+};
+var tags = [
+  {
+    name: "consent",
+    description: "Consent Management"
+  }
+];
+var security = [
+  {
+    EpilotAuth: []
+  }
+];
+var paths = {
+  "/v1/consent/publish": {
+    post: {
+      operationId: "publishConsentEvent",
+      summary: "publishConsentEvent",
+      description: "Publishes consent event on event bus, which appends to consent store\n",
+      tags: ["consent"],
+      requestBody: {
+        content: {
+          "application/json": {
+            schema: {
+              $ref: "#/components/schemas/ConsentEventRequestBody"
+            },
+            examples: {
+              OptInEmailMarketing: {
+                $ref: "#/components/examples/ConsentOptInEmailMarketing"
+              },
+              OptInSMSMarketing: {
+                $ref: "#/components/examples/ConsentOptInSMSMarketing"
+              },
+              OptInPhoneCallMarketing: {
+                $ref: "#/components/examples/ConsentOptInPhoneCallMarketing"
+              },
+              OptOutEmailMarketing: {
+                $ref: "#/components/examples/ConsentOptOutEmailMarketing"
+              }
+            }
+          }
+        }
+      },
+      responses: {
+        "201": {
+          description: "The created opt-in",
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/ConsentEvent"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/v1/consent/{identifier}": {
+    get: {
+      operationId: "listConsentEvents",
+      summary: "listConsentEvents",
+      description: "List opt-ins and opt-outs by customer identifier\n",
+      tags: ["consent"],
+      parameters: [
+        {
+          name: "identifier",
+          in: "path",
+          required: true,
+          schema: {
+            $ref: "#/components/schemas/ConsentIdentifier"
+          }
+        },
+        {
+          name: "topic",
+          in: "query",
+          required: false,
+          schema: {
+            $ref: "#/components/schemas/ConsentTopic"
+          }
+        },
+        {
+          name: "limit",
+          in: "query",
+          required: false,
+          schema: {
+            type: "integer",
+            default: 50,
+            minimum: 1,
+            maximum: 100
+          }
+        },
+        {
+          name: "from",
+          in: "query",
+          required: false,
+          schema: {
+            type: "integer",
+            default: 0,
+            minimum: 0
+          }
+        }
+      ],
+      responses: {
+        "200": {
+          description: "list of opt-ins and opt-outs",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  events: {
+                    type: "array",
+                    items: {
+                      $ref: "#/components/schemas/ConsentEvent"
+                    }
+                  },
+                  total: {
+                    type: "integer",
+                    example: 1
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/v1/opt-in/{token}": {
+    get: {
+      operationId: "handleOptInWithToken",
+      summary: "handleOptInWithToken",
+      security: [],
+      description: "Endpoint to handle opt-in links\n",
+      tags: ["consent"],
+      parameters: [
+        {
+          name: "token",
+          in: "path",
+          required: true,
+          schema: {
+            type: "string"
+          }
+        },
+        {
+          name: "lang",
+          in: "query",
+          schema: {
+            type: "string",
+            default: "de"
+          }
+        }
+      ],
+      responses: {
+        "200": {
+          description: "Handler page for opt in links",
+          content: {
+            "text/html": {
+              example: "<p>You are subscribed!</p>\n"
+            }
+          }
+        }
+      }
+    }
+  }
+};
+var components = {
+  securitySchemes: {
+    EpilotAuth: {
+      type: "http",
+      scheme: "bearer",
+      description: "Epilot Id Token\n"
+    }
+  },
+  schemas: {
+    ConsentIdentifier: {
+      type: "string",
+      description: "Unique identifier for consent source (e.g. customer email or phone)",
+      example: "exampleuser@epilot.cloud"
+    },
+    ConsentTopic: {
+      type: "string",
+      description: "Consent Topic (what the person is opting into)",
+      example: "EMAIL_MARKETING"
+    },
+    ConsentSource: {
+      type: "string",
+      description: "Consent Source (Origin of the Consent Event)",
+      example: "www.frontend.epilot.cloud"
+    },
+    ConsentMeta: {
+      type: "object",
+      additionalProperties: true,
+      example: {
+        double_opt_in: true,
+        source_type: "journey",
+        source_id: "0e4f2a26-14f0-4ada-9294-a7d7a0b9b214",
+        ip_address: "1.1.1.1",
+        user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"
+      }
+    },
+    ConsentEventRequestBody: {
+      type: "object",
+      properties: {
+        type: {
+          type: "string",
+          enum: ["OPT_IN", "OPT_OUT"]
+        },
+        topic: {
+          $ref: "#/components/schemas/ConsentTopic"
+        },
+        source: {
+          $ref: "#/components/schemas/ConsentSource"
+        },
+        identifier: {
+          $ref: "#/components/schemas/ConsentIdentifier"
+        },
+        meta: {
+          $ref: "#/components/schemas/ConsentMeta"
+        }
+      },
+      required: ["type", "topic", "identifier"]
+    },
+    ConsentEvent: {
+      type: "object",
+      properties: {
+        type: {
+          type: "string",
+          enum: ["OPT_IN", "OPT_OUT", "DOUBLE_OPT_IN_REQUESTED", "DOUBLE_OPT_IN"]
+        },
+        created_at: {
+          type: "string",
+          format: "date-time"
+        },
+        topic: {
+          $ref: "#/components/schemas/ConsentTopic"
+        },
+        source: {
+          $ref: "#/components/schemas/ConsentSource"
+        },
+        organization_id: {
+          $ref: "#/components/schemas/OrganizationId"
+        },
+        identifier: {
+          $ref: "#/components/schemas/ConsentIdentifier"
+        },
+        meta: {
+          $ref: "#/components/schemas/ConsentMeta"
+        }
+      },
+      required: ["type", "topic", "identifier"]
+    },
+    OrganizationId: {
+      type: "string",
+      example: "123"
+    }
+  },
+  examples: {
+    ConsentOptInEmailMarketing: {
+      value: {
+        type: "OPT_IN",
+        topic: "EMAIL_MARKETING",
+        identifier: "exampleuser@epilot.cloud",
+        source: "frontend.epilot.cloud",
+        meta: {
+          ip_address: "1.1.1.1",
+          user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"
+        }
+      }
+    },
+    ConsentOptOutEmailMarketing: {
+      value: {
+        type: "OPT_OUT",
+        topic: "EMAIL_MARKETING",
+        identifier: "exampleuser@epilot.cloud",
+        source: "unsubscribe via email",
+        meta: {
+          ip_address: "1.1.1.1",
+          user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"
+        }
+      }
+    },
+    ConsentOptInSMSMarketing: {
+      value: {
+        type: "OPT_IN",
+        topic: "SMS_MARKETING",
+        identifier: "+49 123 1234567",
+        source: "frontend.epilot.cloud",
+        meta: {
+          ip_address: "1.1.1.1",
+          user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"
+        }
+      }
+    },
+    ConsentOptInPhoneCallMarketing: {
+      value: {
+        type: "OPT_IN",
+        topic: "PHONE_CALL_MARKETING",
+        identifier: "+49 123 1234567",
+        source: "frontend.epilot.cloud",
+        meta: {
+          ip_address: "1.1.1.1",
+          user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"
+        }
+      }
+    }
+  }
+};
+var servers = [
+  {
+    url: "https://consent.sls.epilot.io"
+  },
+  {
+    url: "https://consent.sls.epilot.io"
+  }
+];
+var consent_default = {
+  openapi,
+  info,
+  tags,
+  security,
+  paths,
+  components,
+  servers
+};
+export {
+  components,
+  consent_default as default,
+  info,
+  openapi,
+  paths,
+  security,
+  servers,
+  tags
+};

package/dist/consent-CS2ZBZX4.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/consent.json
+var consent_default = '# Consent API\n\n- **Base URL:** `https://consent.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/consent](https://docs.epilot.io/api/consent)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.consent.publishConsentEvent(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/consent\'\n\nconst consentClient = getClient()\nauthorize(consentClient, () => \'<token>\')\nconst { data } = await consentClient.publishConsentEvent(...)\n```\n\n## Operations\n\n**consent**\n- [`publishConsentEvent`](#publishconsentevent)\n- [`listConsentEvents`](#listconsentevents)\n- [`handleOptInWithToken`](#handleoptinwithtoken)\n\n**Schemas**\n- [`ConsentIdentifier`](#consentidentifier)\n- [`ConsentTopic`](#consenttopic)\n- [`ConsentSource`](#consentsource)\n- [`ConsentMeta`](#consentmeta)\n- [`ConsentEventRequestBody`](#consenteventrequestbody)\n- [`ConsentEvent`](#consentevent)\n- [`OrganizationId`](#organizationid)\n\n### `publishConsentEvent`\n\nPublishes consent event on event bus, which appends to consent store\n\n`POST /v1/consent/publish`\n\n```ts\nconst { data } = await client.publishConsentEvent(\n  null,\n  {\n    type: \'OPT_IN\',\n    topic: \'EMAIL_MARKETING\',\n    source: \'www.frontend.epilot.cloud\',\n    identifier: \'exampleuser@epilot.cloud\',\n    meta: {\n      double_opt_in: true,\n      source_type: \'journey\',\n      source_id: \'0e4f2a26-14f0-4ada-9294-a7d7a0b9b214\',\n      ip_address: \'1.1.1.1\',\n      user_agent: \'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36\'\n    }\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "type": "OPT_IN",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "topic": "EMAIL_MARKETING",\n  "source": "www.frontend.epilot.cloud",\n  "organization_id": "123",\n  "identifier": "exampleuser@epilot.cloud",\n  "meta": {\n    "double_opt_in": true,\n    "source_type": "journey",\n    "source_id": "0e4f2a26-14f0-4ada-9294-a7d7a0b9b214",\n    "ip_address": "1.1.1.1",\n    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"\n  }\n}\n```\n\n</details>\n\n---\n\n### `listConsentEvents`\n\nList opt-ins and opt-outs by customer identifier\n\n`GET /v1/consent/{identifier}`\n\n```ts\nconst { data } = await client.listConsentEvents({\n  identifier: \'example\',\n  topic: \'example\',\n  limit: 1,\n  from: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "events": [\n    {\n      "type": "OPT_IN",\n      "created_at": "1970-01-01T00:00:00.000Z",\n      "topic": "EMAIL_MARKETING",\n      "source": "www.frontend.epilot.cloud",\n      "organization_id": "123",\n      "identifier": "exampleuser@epilot.cloud",\n      "meta": {\n        "double_opt_in": true,\n        "source_type": "journey",\n        "source_id": "0e4f2a26-14f0-4ada-9294-a7d7a0b9b214",\n        "ip_address": "1.1.1.1",\n        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36"\n      }\n    }\n  ],\n  "total": 1\n}\n```\n\n</details>\n\n---\n\n### `handleOptInWithToken`\n\nEndpoint to handle opt-in links\n\n`GET /v1/opt-in/{token}`\n\n```ts\nconst { data } = await client.handleOptInWithToken({\n  token: \'example\',\n  lang: \'example\',\n})\n```\n\n---\n\n## Schemas\n\n### `ConsentIdentifier`\n\nUnique identifier for consent source (e.g. customer email or phone)\n\n```ts\ntype ConsentIdentifier = string\n```\n\n### `ConsentTopic`\n\nConsent Topic (what the person is opting into)\n\n```ts\ntype ConsentTopic = string\n```\n\n### `ConsentSource`\n\nConsent Source (Origin of the Consent Event)\n\n```ts\ntype ConsentSource = string\n```\n\n### `ConsentMeta`\n\n```ts\ntype ConsentMeta = Record<string, unknown>\n```\n\n### `ConsentEventRequestBody`\n\n```ts\ntype ConsentEventRequestBody = {\n  type: "OPT_IN" | "OPT_OUT"\n  topic: string\n  source?: string\n  identifier: string\n  meta?: Record<string, unknown>\n}\n```\n\n### `ConsentEvent`\n\n```ts\ntype ConsentEvent = {\n  type: "OPT_IN" | "OPT_OUT" | "DOUBLE_OPT_IN_REQUESTED" | "DOUBLE_OPT_IN"\n  created_at?: string // date-time\n  topic: string\n  source?: string\n  organization_id?: string\n  identifier: string\n  meta?: Record<string, unknown>\n}\n```\n\n### `OrganizationId`\n\n```ts\ntype OrganizationId = string\n```\n';
+
+
+exports.default = consent_default;