@epilot/sdk 2.8.9 → 2.9.0

package/docs/access-token.md

@@ -33,9 +33,7 @@ const { data } = await accessTokenClient.createAccessToken(...)
 - [`getAccessTokenJwks`](#getaccesstokenjwks)
 - [`getAccessTokenOIDC`](#getaccesstokenoidc)
 - [`getPublicTokenJwks`](#getpublictokenjwks)
-- [`getPortalPreviewTokenJwks`](#getportalpreviewtokenjwks)
 - [`getPublicTokenOIDC`](#getpublictokenoidc)
-- [`getPortalPreviewTokenOIDC`](#getportalpreviewtokenoidc)
 
 **Schemas**
 - [`AccessToken`](#accesstoken)
@@ -44,16 +42,13 @@ const { data } = await accessTokenClient.createAccessToken(...)
 - [`AccessTokenType`](#accesstokentype)
 - [`AccessTokenJourneyId`](#accesstokenjourneyid)
 - [`PortalId`](#portalid)
-- [`PortalUserId`](#portaluserid)
 - [`TokenParameters`](#tokenparameters)
 - [`ExpiresIn`](#expiresin)
-- [`ReadOnly`](#readonly)
 - [`AccessTokenParameters`](#accesstokenparameters)
 - [`JourneyTokenParameters`](#journeytokenparameters)
 - [`PortalTokenParameters`](#portaltokenparameters)
 - [`AssumeTokenParameters`](#assumetokenparameters)
 - [`AppTokenParameters`](#apptokenparameters)
-- [`PortalPreviewTokenParameters`](#portalpreviewtokenparameters)
 - [`AccessTokenItem`](#accesstokenitem)
 - [`RoleId`](#roleid)
 - [`Assignments`](#assignments)
@@ -71,8 +66,7 @@ const { data } = await client.createAccessToken(
     name: 'Postman Access Token',
     token_type: 'api',
     assignments: ['123:owner'],
-    expires_in: 3600,
-    read_only: true
+    expires_in: 3600
   },
 )
 ```
@@ -89,9 +83,7 @@ const { data } = await client.createAccessToken(
   "token_type": "api",
   "journey_id": "string",
   "portal_id": "string",
-  "portal_user_id": "string",
   "assignments": ["123:owner"],
-  "read_only": true,
   "last_used": "2026-02-24"
 }
 ```
@@ -124,9 +116,7 @@ const { data } = await client.listAccessTokens({
     "token_type": "api",
     "journey_id": "string",
     "portal_id": "string",
-    "portal_user_id": "string",
     "assignments": ["123:owner"],
-    "read_only": true,
     "last_used": "2026-02-24"
   }
 ]
@@ -159,9 +149,7 @@ const { data } = await client.revokeAccessToken({
   "token_type": "api",
   "journey_id": "string",
   "portal_id": "string",
-  "portal_user_id": "string",
   "assignments": ["123:owner"],
-  "read_only": true,
   "last_used": "2026-02-24"
 }
 ```
@@ -258,38 +246,6 @@ const { data } = await client.getPublicTokenJwks()
 
 ---
 
-### `getPortalPreviewTokenJwks`
-
-Get jwks public key set to verify portal preview tokens generated by this API
-
-`GET /v1/access-tokens/portal-preview/.well-known/jwks.json`
-
-```ts
-const { data } = await client.getPortalPreviewTokenJwks()
-```
-
-<details>
-<summary>Response</summary>
-
-```json
-{
-  "keys": [
-    {
-      "alg": "RS256",
-      "e": "AQAB",
-      "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",
-      "kty": "RSA",
-      "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",
-      "use": "sig"
-    }
-  ]
-}
-```
-
-</details>
-
----
-
 ### `getPublicTokenOIDC`
 
 OpenID Connect configuration for Access Token API a a public identity provider
@@ -314,30 +270,6 @@ const { data } = await client.getPublicTokenOIDC()
 
 ---
 
-### `getPortalPreviewTokenOIDC`
-
-OpenID Connect configuration for Access Token API a a portal preview identity provider
-
-`GET /v1/access-tokens/portal-preview/.well-known/openid-configuration`
-
-```ts
-const { data } = await client.getPortalPreviewTokenOIDC()
-```
-
-<details>
-<summary>Response</summary>
-
-```json
-{
-  "issuer": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview",
-  "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview/.well-known/jwks.json"
-}
-```
-
-</details>
-
----
-
 ## Schemas
 
 ### `AccessToken`
@@ -367,7 +299,7 @@ type AccessTokenName = string
 Access token type
 
 ```ts
-type AccessTokenType = "api" | "journey" | "portal" | "assume" | "app" | "portal_preview"
+type AccessTokenType = "api" | "journey" | "portal" | "assume" | "app"
 ```
 
 ### `AccessTokenJourneyId`
@@ -386,14 +318,6 @@ Portal ID for access token type "portal"
 type PortalId = string
 ```
 
-### `PortalUserId`
-
-Portal User ID for access token type "portal_preview"
-
-```ts
-type PortalUserId = string
-```
-
 ### `TokenParameters`
 
 ```ts
@@ -402,7 +326,6 @@ type TokenParameters = {
   token_type?: "api"
   assignments?: string[]
   expires_in?: number | string
-  read_only?: boolean
 } | {
   name: string
   token_type?: "journey"
@@ -417,18 +340,11 @@ type TokenParameters = {
   name: string
   token_type?: "assume"
   assignments?: string[]
-  read_only?: boolean
 } | {
   name: string
   token_type?: "app"
   assignments?: string[]
   expires_in?: number | string
-  read_only?: boolean
-} | {
-  name: string
-  token_type?: "portal_preview"
-  portal_id: string
-  portal_user_id: string
 }
 ```
 
@@ -438,14 +354,6 @@ type TokenParameters = {
 type ExpiresIn = number | string
 ```
 
-### `ReadOnly`
-
-When true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.
-
-```ts
-type ReadOnly = boolean
-```
-
 ### `AccessTokenParameters`
 
 ```ts
@@ -454,7 +362,6 @@ type AccessTokenParameters = {
   token_type?: "api"
   assignments?: string[]
   expires_in?: number | string
-  read_only?: boolean
 }
 ```
 
@@ -487,7 +394,6 @@ type AssumeTokenParameters = {
   name: string
   token_type?: "assume"
   assignments?: string[]
-  read_only?: boolean
 }
 ```
 
@@ -499,18 +405,6 @@ type AppTokenParameters = {
   token_type?: "app"
   assignments?: string[]
   expires_in?: number | string
-  read_only?: boolean
-}
-```
-
-### `PortalPreviewTokenParameters`
-
-```ts
-type PortalPreviewTokenParameters = {
-  name: string
-  token_type?: "portal_preview"
-  portal_id: string
-  portal_user_id: string
 }
 ```
 
@@ -521,12 +415,10 @@ type AccessTokenItem = {
   id: string
   created_at: string // date-time
   name: string
-  token_type?: "api" | "journey" | "portal" | "assume" | "app" | "portal_preview"
+  token_type?: "api" | "journey" | "portal" | "assume" | "app"
   journey_id?: string
   portal_id?: string
-  portal_user_id?: string
   assignments?: string[]
-  read_only?: boolean
   last_used?: string // date
 }
 ```