@epilot/sdk 2.1.0-rc.1 → 2.1.1

package/dist/access-token-RKP2A2F7.cjs

@@ -0,0 +1,633 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/definitions/access-token.json
+var openapi = "3.0.3";
+var info = {
+  title: "Access Token API",
+  version: "0.4.0",
+  description: "Generate Access Tokens for 3rd party applications that need access to epilot APIs.\n"
+};
+var tags = [
+  {
+    name: "Access Tokens",
+    description: "Create Access Tokens for epilot APIs"
+  },
+  {
+    name: "Public",
+    description: "Well known endpoints to verify tokens generated by this API"
+  }
+];
+var security = [
+  {
+    EpilotAuth: []
+  },
+  {
+    EpilotOrg: []
+  }
+];
+var paths = {
+  "/v1/access-tokens": {
+    post: {
+      operationId: "createAccessToken",
+      summary: "createAccessToken",
+      description: "**Access Token type: `API`** (default if not specified):\n\nGenerates a new Access Token to use for calling epilot APIs.\n\nTakes optionally a list of Roles assigned to the Access Token. Defaults to current user's assignments\n\nSee [Permissions API docs](https://docs.epilot.io/api/permissions)\n\n**Access Token type: `JOURNEY`**:\n\nGenerates a Public Access Token related to a journey.\nThe journey id should be specfied.\n",
+      tags: ["Access Tokens"],
+      requestBody: {
+        description: "Metadata for the Access Token",
+        content: {
+          "application/json": {
+            schema: {
+              $ref: "#/components/schemas/TokenParameters"
+            },
+            examples: {
+              api: {
+                value: {
+                  name: "API Access Token",
+                  token_type: "api",
+                  assignments: []
+                }
+              },
+              journey: {
+                value: {
+                  name: "Journey Access Token",
+                  token_type: "journey",
+                  journey_id: "u29g7-97gajsaog-028t02jag-a9a72tk"
+                }
+              },
+              portal: {
+                value: {
+                  name: "Installer /End Customer Portal Access Token",
+                  token_type: "portal",
+                  portal_id: "END_CUSTOMER_PORTAL"
+                }
+              },
+              assume: {
+                value: {
+                  name: "Assume Token intended for assuming a different role as a user",
+                  token_type: "assume",
+                  assignments: ["739224:employee"]
+                }
+              },
+              app: {
+                value: {
+                  name: "App Access Token",
+                  token_type: "app",
+                  assignments: ["739224:e5c1f9b1-e41d-421d-83c4-c5626e464430"]
+                }
+              }
+            }
+          }
+        }
+      },
+      responses: {
+        "201": {
+          description: "The new generated Access Token",
+          content: {
+            "application/json": {
+              schema: {
+                allOf: [
+                  {
+                    properties: {
+                      token: {
+                        $ref: "#/components/schemas/AccessToken"
+                      }
+                    }
+                  },
+                  {
+                    $ref: "#/components/schemas/AccessTokenItem"
+                  }
+                ]
+              }
+            }
+          }
+        },
+        "400": {
+          description: "Bad Request",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  status: {
+                    type: "integer"
+                  },
+                  error: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "500": {
+          description: "Internal Server Error",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  status: {
+                    type: "integer"
+                  },
+                  error: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    get: {
+      operationId: "listAccessTokens",
+      summary: "listAccessTokens",
+      description: "Lists all Access Tokens for current user (by default excludes system generated tokens)",
+      parameters: [
+        {
+          in: "query",
+          name: "token_type",
+          description: "Filter by token types",
+          schema: {
+            type: "array",
+            items: {
+              $ref: "#/components/schemas/AccessTokenType"
+            }
+          }
+        }
+      ],
+      tags: ["Access Tokens"],
+      responses: {
+        "200": {
+          description: "List of Access Tokens",
+          content: {
+            "application/json": {
+              schema: {
+                type: "array",
+                items: {
+                  $ref: "#/components/schemas/AccessTokenItem"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/v1/access-tokens/{id}": {
+    delete: {
+      operationId: "revokeAccessToken",
+      summary: "revokeAccessToken",
+      description: "Revokes an Access Token so it can't be used anymore.",
+      parameters: [
+        {
+          name: "id",
+          in: "path",
+          schema: {
+            $ref: "#/components/schemas/AccessTokenId"
+          },
+          required: true
+        }
+      ],
+      tags: ["Access Tokens"],
+      responses: {
+        "200": {
+          description: "The revoked generated Access Token",
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/AccessTokenItem"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/v1/access-tokens/.well-known/jwks.json": {
+    get: {
+      operationId: "getAccessTokenJwks",
+      summary: "getAccessTokenJwks",
+      description: "Get jwks public key set to verify access tokens generated by this API",
+      tags: ["Public"],
+      security: [],
+      responses: {
+        "200": {
+          description: "Set of jwks",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  keys: {
+                    type: "array",
+                    items: {
+                      type: "object",
+                      properties: {
+                        alg: {
+                          type: "string",
+                          example: "RS256"
+                        },
+                        e: {
+                          type: "string",
+                          example: "AQAB"
+                        },
+                        kid: {
+                          type: "string",
+                          example: "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw="
+                        },
+                        kty: {
+                          type: "string",
+                          example: "RSA"
+                        },
+                        n: {
+                          type: "string",
+                          example: "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ"
+                        },
+                        use: {
+                          type: "string",
+                          example: "sig"
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/v1/access-tokens/.well-known/openid-configuration": {
+    get: {
+      operationId: "getAccessTokenOIDC",
+      summary: "getAccessTokenOIDC",
+      description: "OpenID Connect configuration for Access Token API as identity provider\n\nNote: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to\nautomate the process of verifying JWT tokens.\n",
+      tags: ["Public"],
+      security: [],
+      responses: {
+        "200": {
+          description: "OpenID Configuration",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  issuer: {
+                    type: "string",
+                    format: "uri",
+                    example: "https://access-token.sls.epilot.io/v1/access-tokens"
+                  },
+                  jwks_uri: {
+                    type: "string",
+                    format: "uri",
+                    example: "https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/v1/access-tokens/public/.well-known/jwks.json": {
+    get: {
+      operationId: "getPublicTokenJwks",
+      summary: "getPublicTokenJwks",
+      description: "Get jwks public key set to verify public tokens generated by this API",
+      tags: ["Public"],
+      security: [],
+      responses: {
+        "200": {
+          description: "Set of jwks",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  keys: {
+                    type: "array",
+                    items: {
+                      type: "object",
+                      properties: {
+                        alg: {
+                          type: "string",
+                          example: "RS256"
+                        },
+                        e: {
+                          type: "string",
+                          example: "AQAB"
+                        },
+                        kid: {
+                          type: "string",
+                          example: "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw="
+                        },
+                        kty: {
+                          type: "string",
+                          example: "RSA"
+                        },
+                        n: {
+                          type: "string",
+                          example: "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ"
+                        },
+                        use: {
+                          type: "string",
+                          example: "sig"
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/v1/access-tokens/public/.well-known/openid-configuration": {
+    get: {
+      operationId: "getPublicTokenOIDC",
+      summary: "getPublicTokenOIDC",
+      description: "OpenID Connect configuration for Access Token API a a public identity provider\n\nNote: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to\nautomate the process of verifying JWT tokens.\n",
+      tags: ["Public"],
+      security: [],
+      responses: {
+        "200": {
+          description: "OpenID Configuration",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  issuer: {
+                    type: "string",
+                    format: "uri",
+                    example: "https://access-token.sls.epilot.io/v1/access-tokens"
+                  },
+                  jwks_uri: {
+                    type: "string",
+                    format: "uri",
+                    example: "https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+};
+var components = {
+  securitySchemes: {
+    EpilotAuth: {
+      type: "http",
+      scheme: "bearer",
+      description: "Authorization header with epilot OAuth2 bearer token",
+      bearerFormat: "JWT"
+    },
+    EpilotOrg: {
+      description: "Overrides the target organization to allow shared tenantaccess",
+      name: "x-epilot-org-id",
+      in: "header",
+      type: "apiKey"
+    }
+  },
+  schemas: {
+    AccessToken: {
+      type: "string",
+      description: "A JWT Access Token",
+      example: "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp..."
+    },
+    AccessTokenId: {
+      type: "string",
+      example: "api_5ZugdRXasLfWBypHi93Fk"
+    },
+    AccessTokenName: {
+      type: "string",
+      description: "Human readable name for access token",
+      example: "Postman Access Token"
+    },
+    AccessTokenType: {
+      type: "string",
+      enum: ["api", "journey", "portal", "assume", "app"],
+      description: "Access token type",
+      example: "api"
+    },
+    AccessTokenJourneyId: {
+      type: "string",
+      description: 'Journey ID for access token type "journey"'
+    },
+    PortalId: {
+      type: "string",
+      description: 'Portal ID for access token type "portal"'
+    },
+    TokenParameters: {
+      anyOf: [
+        {
+          $ref: "#/components/schemas/AccessTokenParameters"
+        },
+        {
+          $ref: "#/components/schemas/JourneyTokenParameters"
+        },
+        {
+          $ref: "#/components/schemas/PortalTokenParameters"
+        },
+        {
+          $ref: "#/components/schemas/AssumeTokenParameters"
+        },
+        {
+          $ref: "#/components/schemas/AppTokenParameters"
+        }
+      ]
+    },
+    ExpiresIn: {
+      oneOf: [
+        {
+          type: "integer",
+          format: "int32",
+          description: "Expiration time in seconds",
+          example: 3600,
+          minimum: 30,
+          maximum: 604800
+        },
+        {
+          type: "string",
+          description: "Expiration time as a string with time units (e.g., '10h', '7d', '2 days')",
+          example: "1h",
+          pattern: "^[0-9]+ ?(ms|milliseconds?|s|seconds?|m|minutes?|h|hours?|d|days?|w|weeks?|y|years?)?$"
+        }
+      ]
+    },
+    AccessTokenParameters: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        name: {
+          $ref: "#/components/schemas/AccessTokenName"
+        },
+        token_type: {
+          type: "string",
+          enum: ["api"]
+        },
+        assignments: {
+          $ref: "#/components/schemas/Assignments"
+        },
+        expires_in: {
+          $ref: "#/components/schemas/ExpiresIn"
+        }
+      },
+      required: ["name"]
+    },
+    JourneyTokenParameters: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        name: {
+          $ref: "#/components/schemas/AccessTokenName"
+        },
+        token_type: {
+          type: "string",
+          enum: ["journey"]
+        },
+        journey_id: {
+          $ref: "#/components/schemas/AccessTokenJourneyId"
+        },
+        expires_in: {
+          $ref: "#/components/schemas/ExpiresIn"
+        }
+      },
+      required: ["name", "journey_id"]
+    },
+    PortalTokenParameters: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        name: {
+          $ref: "#/components/schemas/AccessTokenName"
+        },
+        token_type: {
+          type: "string",
+          enum: ["portal"]
+        },
+        portal_id: {
+          $ref: "#/components/schemas/PortalId"
+        },
+        expires_in: {
+          $ref: "#/components/schemas/ExpiresIn"
+        }
+      },
+      required: ["name", "portal_id"]
+    },
+    AssumeTokenParameters: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        name: {
+          $ref: "#/components/schemas/AccessTokenName"
+        },
+        token_type: {
+          type: "string",
+          enum: ["assume"]
+        },
+        assignments: {
+          $ref: "#/components/schemas/Assignments"
+        }
+      },
+      required: ["name"]
+    },
+    AppTokenParameters: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        name: {
+          $ref: "#/components/schemas/AccessTokenName"
+        },
+        token_type: {
+          type: "string",
+          enum: ["app"]
+        },
+        assignments: {
+          $ref: "#/components/schemas/Assignments"
+        },
+        expires_in: {
+          $ref: "#/components/schemas/ExpiresIn"
+        }
+      },
+      required: ["name"]
+    },
+    AccessTokenItem: {
+      type: "object",
+      properties: {
+        id: {
+          $ref: "#/components/schemas/AccessTokenId"
+        },
+        created_at: {
+          type: "string",
+          format: "date-time"
+        },
+        name: {
+          $ref: "#/components/schemas/AccessTokenName"
+        },
+        token_type: {
+          $ref: "#/components/schemas/AccessTokenType"
+        },
+        journey_id: {
+          $ref: "#/components/schemas/AccessTokenJourneyId"
+        },
+        portal_id: {
+          $ref: "#/components/schemas/PortalId"
+        },
+        assignments: {
+          $ref: "#/components/schemas/Assignments"
+        },
+        last_used: {
+          type: "string",
+          format: "date",
+          description: "Last date the token was used (YYYY-MM-DD format, 1 day accuracy)",
+          example: "2026-02-24"
+        }
+      },
+      required: ["id", "created_at", "name"]
+    },
+    RoleId: {
+      type: "string",
+      example: "123:owner",
+      description: "Format: <organization_id>:<slug>"
+    },
+    Assignments: {
+      type: "array",
+      description: "List of role ids attached to an user",
+      items: {
+        $ref: "#/components/schemas/RoleId"
+      }
+    }
+  }
+};
+var servers = [
+  {
+    url: "https://access-token.sls.epilot.io"
+  }
+];
+var access_token_default = {
+  openapi,
+  info,
+  tags,
+  security,
+  paths,
+  components,
+  servers
+};
+
+
+
+
+
+
+
+
+
+exports.components = components; exports.default = access_token_default; exports.info = info; exports.openapi = openapi; exports.paths = paths; exports.security = security; exports.servers = servers; exports.tags = tags;

package/dist/access-token-runtime-KCKGT4O7.js

@@ -0,0 +1,5 @@
+import {
+  require_access_token_runtime
+} from "./chunk-XSE4CFSM.js";
+import "./chunk-YPSWSI3M.js";
+export default require_access_token_runtime();

package/dist/access-token-runtime-NZWZJPWV.cjs

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

package/dist/address-HA4RMRNQ.cjs

@@ -0,0 +1,7 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
+
+// src/docs/address.json
+var address_default = '# Address API\n\n- **Base URL:** `https://address.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/address](https://docs.epilot.io/api/address)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.address.getAddressSuggestions(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/address\'\n\nconst addressClient = getClient()\nauthorize(addressClient, () => \'<token>\')\nconst { data } = await addressClient.getAddressSuggestions(...)\n```\n\n## Operations\n\n**Address Suggestion**\n- [`getAddressSuggestions`](#getaddresssuggestions)\n\n**Availability**\n- [`availabilityCheck`](#availabilitycheck)\n- [`validateAvailabilityFile`](#validateavailabilityfile)\n\n**Schemas**\n- [`AvailabilityCheckParams`](#availabilitycheckparams)\n- [`AvailabilityFilters`](#availabilityfilters)\n- [`AvailabilityDate`](#availabilitydate)\n- [`AvailabilityLocation`](#availabilitylocation)\n- [`AvailabilityResult`](#availabilityresult)\n- [`ValidateAvailabilityFileResult`](#validateavailabilityfileresult)\n- [`ValidateAvailabilityFileError`](#validateavailabilityfileerror)\n- [`AddressSuggestion`](#addresssuggestion)\n- [`AddressSuggestions`](#addresssuggestions)\n- [`ErrorResponse`](#errorresponse)\n\n### `getAddressSuggestions`\n\nGet address suggestions for the given Availability File\n\n`GET /v1/public/suggestions`\n\n```ts\nconst { data } = await client.getAddressSuggestions({\n  fileRef: \'example\',\n  countryCodeSearchTerm: \'example\',\n  postalCodeSearchTerm: \'example\',\n  streetSearchTerm: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n  {\n    "country": "st",\n    "postal_code": "string",\n    "city": "string",\n    "street": "string",\n    "street_number": "string"\n  }\n]\n```\n\n</details>\n\n---\n\n### `availabilityCheck`\n\nCheck for Entities that contain a matching availability range in related availability files.\n\n`POST /v1/public/availability`\n\n```ts\nconst { data } = await client.availabilityCheck(\n  null,\n  {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "available_entities": [],\n  "check_results": [\n    {\n      "entity_id": "72c803b2-2e5d-4bd6-bffc-fad998bbbe36",\n      "matching_hits": 0\n    },\n    {\n      "entity_id": "72c803b2-2e5d-4bd6-bffc-fad998bbbe37",\n      "matching_hits": 0\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `validateAvailabilityFile`\n\nValidates an already uploaded availability file, it returns an array of errors if any errors are found in the file.\n\n`GET /v1/availability/{id}/validate`\n\n```ts\nconst { data } = await client.validateAvailabilityFile({\n  id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "status": "success",\n  "rules_parsed_count": 0,\n  "errors": [\n    {\n      "line": 0,\n      "message": "string",\n      "data": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `AvailabilityCheckParams`\n\n```ts\ntype AvailabilityCheckParams = {\n  entities: string // uuid[]\n  schemas?: string[]\n  filters: {\n    location: {\n      street?: { ... }\n      street_number?: { ... }\n      postal_code?: { ... }\n      city?: { ... }\n      country?: { ... }\n    }\n    available_date?: string // date\n  }\n}\n```\n\n### `AvailabilityFilters`\n\nAvailability filters dimensions\n\n```ts\ntype AvailabilityFilters = {\n  location: {\n    street?: string\n    street_number?: string\n    postal_code?: string\n    city?: string\n    country?: string\n  }\n  available_date?: string // date\n}\n```\n\n### `AvailabilityDate`\n\nA value to be matched against the availability window (start & end date)\n\n```ts\ntype AvailabilityDate = string // date\n```\n\n### `AvailabilityLocation`\n\n```ts\ntype AvailabilityLocation = {\n  street?: string\n  street_number?: string\n  postal_code?: string\n  city?: string\n  country?: string\n}\n```\n\n### `AvailabilityResult`\n\nThe availability check result payload\n\n```ts\ntype AvailabilityResult = {\n  available_entities: string[]\n  check_results: Array<{\n    entity_id: string // uuid\n    matching_hits: number\n    matching_error?: object\n  }>\n}\n```\n\n### `ValidateAvailabilityFileResult`\n\nThe availability map file result payload\n\n```ts\ntype ValidateAvailabilityFileResult = {\n  status: "success" | "error"\n  rules_parsed_count: number\n  errors: Array<{\n    line?: number\n    message: string\n    data?: string\n  }>\n}\n```\n\n### `ValidateAvailabilityFileError`\n\nThe availability rule error\n\n```ts\ntype ValidateAvailabilityFileError = {\n  line?: number\n  message: string\n  data?: string\n}\n```\n\n### `AddressSuggestion`\n\nThe address suggestions entity\n\n```ts\ntype AddressSuggestion = {\n  country?: string\n  postal_code?: string // postal-code\n  city?: string // city\n  street?: string // street-address\n  street_number?: string // street-number\n}\n```\n\n### `AddressSuggestions`\n\nThe address suggestions entity array\n\n```ts\ntype AddressSuggestions = Array<{\n  country?: string\n  postal_code?: string // postal-code\n  city?: string // city\n  street?: string // street-address\n  street_number?: string // street-number\n}>\n```\n\n### `ErrorResponse`\n\n```ts\ntype ErrorResponse = {\n  error: string\n}\n```\n';
+
+
+exports.default = address_default;