@epilot/sdk 2.8.1 → 2.8.3

package/docs/user.md

@@ -27,14 +27,21 @@ const { data } = await userClient.signUpUser(...)
 **User V2**
 - [`signUpUser`](#signupuser)
 - [`getMeV2`](#getmev2)
+- [`listUserSettings`](#listusersettings)
+- [`getUserSettingsScope`](#getusersettingsscope)
+- [`getUserSetting`](#getusersetting)
+- [`putUserSetting`](#putusersetting)
+- [`deleteUserSetting`](#deleteusersetting)
 - [`listUsersV2`](#listusersv2)
 - [`getUserV2`](#getuserv2)
 - [`updateUserV2`](#updateuserv2)
 - [`deleteUserV2`](#deleteuserv2)
 - [`inviteUser`](#inviteuser)
 - [`resendUserInvitation`](#resenduserinvitation)
+- [`sendUserPasswordReset`](#senduserpasswordreset)
 - [`getGroupsForUser`](#getgroupsforuser)
 - [`verifyEmailWithToken`](#verifyemailwithtoken)
+- [`requestPasswordReset`](#requestpasswordreset)
 - [`checkInviteToken`](#checkinvitetoken)
 - [`activateUser`](#activateuser)
 - [`rejectInvite`](#rejectinvite)
@@ -102,6 +109,12 @@ const { data } = await userClient.signUpUser(...)
 - [`Organization`](#organization)
 - [`DataPointsResponse`](#datapointsresponse)
 - [`DataPoint`](#datapoint)
+- [`UserSettingScope`](#usersettingscope)
+- [`UserSettingKey`](#usersettingkey)
+- [`UserSettingValue`](#usersettingvalue)
+- [`UserSetting`](#usersetting)
+- [`UserSettingsListResponse`](#usersettingslistresponse)
+- [`UserSettingsScopeResponse`](#usersettingsscoperesponse)
 - [`Passkey`](#passkey)
 - [`PasskeyAuthenticationOptions`](#passkeyauthenticationoptions)
 - [`PasskeyRegistrationOptions`](#passkeyregistrationoptions)
@@ -220,10 +233,12 @@ const { data } = await client.getMeV2()
   "status": "Active",
   "email": "user@example.com",
   "draft_email": "user@example.com",
+  "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
   "department": "Sales",
   "phone": 1234567890,
   "secondary_phone": 1234567890,
   "mfa_enabled": false,
+  "has_passkeys": false,
   "phone_verified": true,
   "token": "string",
   "signature": "<p>Thanks</p>",
@@ -273,6 +288,142 @@ const { data } = await client.getMeV2()
 
 ---
 
+### `listUserSettings`
+
+List all setting scopes and keys available for the currently logged in user. Does not return setting values.
+
+`GET /v2/users/me/settings`
+
+```ts
+const { data } = await client.listUserSettings()
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "results": [
+    {
+      "scope": "calendar",
+      "keys": ["visible_calendars"]
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
+### `getUserSettingsScope`
+
+Get all setting values for one scope for the currently logged in user.
+
+`GET /v2/users/me/settings/{scope}`
+
+```ts
+const { data } = await client.getUserSettingsScope({
+  scope: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "scope": "calendar",
+  "settings": {
+    "visible_calendars": {
+      "calendar_ids": ["holidays"]
+    }
+  }
+}
+```
+
+</details>
+
+---
+
+### `getUserSetting`
+
+Get one setting value by scope and key for the currently logged in user.
+
+`GET /v2/users/me/settings/{scope}/{key}`
+
+```ts
+const { data } = await client.getUserSetting({
+  scope: 'example',
+  key: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "scope": "calendar",
+  "key": "visible_calendars",
+  "value": {},
+  "created_at": "1970-01-01T00:00:00.000Z",
+  "updated_at": "1970-01-01T00:00:00.000Z"
+}
+```
+
+</details>
+
+---
+
+### `putUserSetting`
+
+Create or replace one setting value for the currently logged in user.
+
+`PUT /v2/users/me/settings/{scope}/{key}`
+
+```ts
+const { data } = await client.putUserSetting(
+  {
+    scope: 'example',
+    key: 'example',
+  },
+  {},
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "scope": "calendar",
+  "key": "visible_calendars",
+  "value": {},
+  "created_at": "1970-01-01T00:00:00.000Z",
+  "updated_at": "1970-01-01T00:00:00.000Z"
+}
+```
+
+</details>
+
+---
+
+### `deleteUserSetting`
+
+Delete one setting value for the currently logged in user.
+
+`DELETE /v2/users/me/settings/{scope}/{key}`
+
+```ts
+const { data } = await client.deleteUserSetting({
+  scope: 'example',
+  key: 'example',
+})
+```
+
+---
+
 ### `listUsersV2`
 
 Get the list of organization users
@@ -302,10 +453,12 @@ const { data } = await client.listUsersV2({
       "status": "Active",
       "email": "user@example.com",
       "draft_email": "user@example.com",
+      "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
       "department": "Sales",
       "phone": 1234567890,
       "secondary_phone": 1234567890,
       "mfa_enabled": false,
+      "has_passkeys": false,
       "phone_verified": true,
       "token": "string",
       "signature": "<p>Thanks</p>",
@@ -382,10 +535,12 @@ const { data } = await client.getUserV2({
   "status": "Active",
   "email": "user@example.com",
   "draft_email": "user@example.com",
+  "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
   "department": "Sales",
   "phone": 1234567890,
   "secondary_phone": 1234567890,
   "mfa_enabled": false,
+  "has_passkeys": false,
   "phone_verified": true,
   "token": "string",
   "signature": "<p>Thanks</p>",
@@ -455,10 +610,12 @@ const { data } = await client.updateUserV2(
     status: 'Active',
     email: 'user@example.com',
     draft_email: 'user@example.com',
+    draft_email_expires_at: '1970-01-01T00:00:00.000Z',
     department: 'Sales',
     phone: 1234567890,
     secondary_phone: 1234567890,
     mfa_enabled: false,
+    has_passkeys: false,
     phone_verified: true,
     token: 'string',
     signature: '<p>Thanks</p>',
@@ -518,10 +675,12 @@ const { data } = await client.updateUserV2(
   "status": "Active",
   "email": "user@example.com",
   "draft_email": "user@example.com",
+  "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
   "department": "Sales",
   "phone": 1234567890,
   "secondary_phone": 1234567890,
   "mfa_enabled": false,
+  "has_passkeys": false,
   "phone_verified": true,
   "token": "string",
   "signature": "<p>Thanks</p>",
@@ -644,10 +803,12 @@ const { data } = await client.inviteUser(
   "status": "Active",
   "email": "user@example.com",
   "draft_email": "user@example.com",
+  "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
   "department": "Sales",
   "phone": 1234567890,
   "secondary_phone": 1234567890,
   "mfa_enabled": false,
+  "has_passkeys": false,
   "phone_verified": true,
   "token": "string",
   "signature": "<p>Thanks</p>",
@@ -726,10 +887,12 @@ const { data } = await client.resendUserInvitation(
   "status": "Active",
   "email": "user@example.com",
   "draft_email": "user@example.com",
+  "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
   "department": "Sales",
   "phone": 1234567890,
   "secondary_phone": 1234567890,
   "mfa_enabled": false,
+  "has_passkeys": false,
   "phone_verified": true,
   "token": "string",
   "signature": "<p>Thanks</p>",
@@ -779,6 +942,35 @@ const { data } = await client.resendUserInvitation(
 
 ---
 
+### `sendUserPasswordReset`
+
+Send a password reset email to a user in your organization.
+Requires `user:edit` on the target user.
+
+`POST /v2/users:sendPasswordReset`
+
+```ts
+const { data } = await client.sendUserPasswordReset(
+  null,
+  {
+    email: 'test@example.com'
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "success": true
+}
+```
+
+</details>
+
+---
+
 ### `getGroupsForUser`
 
 Get groups of a user
@@ -812,10 +1004,12 @@ const { data } = await client.getGroupsForUser({
       "status": "Active",
       "email": "user@example.com",
       "draft_email": "user@example.com",
+      "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
       "department": "Sales",
       "phone": 1234567890,
       "secondary_phone": 1234567890,
       "mfa_enabled": false,
+      "has_passkeys": false,
       "phone_verified": true,
       "token": "string",
       "signature": "<p>Thanks</p>",
@@ -836,7 +1030,8 @@ const { data } = await client.getGroupsForUser({
     ],
     "image_uri": {
       "gradient_colors": ["#0588f0", "#3358d4"]
-    }
+    },
+    "abbreviation": "FN"
   }
 ]
 ```
@@ -876,7 +1071,8 @@ const { data } = await client.getGroups({
       "created_by": "123",
       "crt_assignee": {},
       "users": [],
-      "image_uri": {}
+      "image_uri": {},
+      "abbreviation": "FN"
     }
   ]
 }
@@ -900,7 +1096,8 @@ const { data } = await client.createGroup(
     user_ids: ['123', '456'],
     image_uri: {
       gradient_colors: ['#0588f0', '#3358d4']
-    }
+    },
+    abbreviation: 'FN'
   },
 )
 ```
@@ -925,10 +1122,12 @@ const { data } = await client.createGroup(
     "status": "Active",
     "email": "user@example.com",
     "draft_email": "user@example.com",
+    "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
     "department": "Sales",
     "phone": 1234567890,
     "secondary_phone": 1234567890,
     "mfa_enabled": false,
+    "has_passkeys": false,
     "phone_verified": true,
     "token": "string",
     "signature": "<p>Thanks</p>",
@@ -977,10 +1176,12 @@ const { data } = await client.createGroup(
       "status": "Active",
       "email": "user@example.com",
       "draft_email": "user@example.com",
+      "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
       "department": "Sales",
       "phone": 1234567890,
       "secondary_phone": 1234567890,
       "mfa_enabled": false,
+      "has_passkeys": false,
       "phone_verified": true,
       "token": "string",
       "signature": "<p>Thanks</p>",
@@ -998,7 +1199,8 @@ const { data } = await client.createGroup(
   ],
   "image_uri": {
     "gradient_colors": ["#0588f0", "#3358d4"]
-  }
+  },
+  "abbreviation": "FN"
 }
 ```
 
@@ -1039,10 +1241,12 @@ const { data } = await client.getGroup({
     "status": "Active",
     "email": "user@example.com",
     "draft_email": "user@example.com",
+    "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
     "department": "Sales",
     "phone": 1234567890,
     "secondary_phone": 1234567890,
     "mfa_enabled": false,
+    "has_passkeys": false,
     "phone_verified": true,
     "token": "string",
     "signature": "<p>Thanks</p>",
@@ -1091,10 +1295,12 @@ const { data } = await client.getGroup({
       "status": "Active",
       "email": "user@example.com",
       "draft_email": "user@example.com",
+      "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
       "department": "Sales",
       "phone": 1234567890,
       "secondary_phone": 1234567890,
       "mfa_enabled": false,
+      "has_passkeys": false,
       "phone_verified": true,
       "token": "string",
       "signature": "<p>Thanks</p>",
@@ -1112,7 +1318,8 @@ const { data } = await client.getGroup({
   ],
   "image_uri": {
     "gradient_colors": ["#0588f0", "#3358d4"]
-  }
+  },
+  "abbreviation": "FN"
 }
 ```
 
@@ -1136,7 +1343,8 @@ const { data } = await client.updateGroup(
     user_ids: ['123', '456'],
     image_uri: {
       gradient_colors: ['#0588f0', '#3358d4']
-    }
+    },
+    abbreviation: 'FN'
   },
 )
 ```
@@ -1161,10 +1369,12 @@ const { data } = await client.updateGroup(
     "status": "Active",
     "email": "user@example.com",
     "draft_email": "user@example.com",
+    "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
     "department": "Sales",
     "phone": 1234567890,
     "secondary_phone": 1234567890,
     "mfa_enabled": false,
+    "has_passkeys": false,
     "phone_verified": true,
     "token": "string",
     "signature": "<p>Thanks</p>",
@@ -1213,10 +1423,12 @@ const { data } = await client.updateGroup(
       "status": "Active",
       "email": "user@example.com",
       "draft_email": "user@example.com",
+      "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
       "department": "Sales",
       "phone": 1234567890,
       "secondary_phone": 1234567890,
       "mfa_enabled": false,
+      "has_passkeys": false,
       "phone_verified": true,
       "token": "string",
       "signature": "<p>Thanks</p>",
@@ -1234,7 +1446,8 @@ const { data } = await client.updateGroup(
   ],
   "image_uri": {
     "gradient_colors": ["#0588f0", "#3358d4"]
-  }
+  },
+  "abbreviation": "FN"
 }
 ```
 
@@ -1288,10 +1501,12 @@ const { data } = await client.advanceUserAssignment({
     "status": "Active",
     "email": "user@example.com",
     "draft_email": "user@example.com",
+    "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
     "department": "Sales",
     "phone": 1234567890,
     "secondary_phone": 1234567890,
     "mfa_enabled": false,
+    "has_passkeys": false,
     "phone_verified": true,
     "token": "string",
     "signature": "<p>Thanks</p>",
@@ -1340,10 +1555,12 @@ const { data } = await client.advanceUserAssignment({
       "status": "Active",
       "email": "user@example.com",
       "draft_email": "user@example.com",
+      "draft_email_expires_at": "1970-01-01T00:00:00.000Z",
       "department": "Sales",
       "phone": 1234567890,
       "secondary_phone": 1234567890,
       "mfa_enabled": false,
+      "has_passkeys": false,
       "phone_verified": true,
       "token": "string",
       "signature": "<p>Thanks</p>",
@@ -1361,7 +1578,8 @@ const { data } = await client.advanceUserAssignment({
   ],
   "image_uri": {
     "gradient_colors": ["#0588f0", "#3358d4"]
-  }
+  },
+  "abbreviation": "FN"
 }
 ```
 
@@ -1522,6 +1740,36 @@ const { data } = await client.verifyEmailWithToken(
 
 ---
 
+### `requestPasswordReset`
+
+Request a password reset email for the given email address. Always
+returns a success response whether or not an account exists with that
+email.
+
+`POST /v2/users/public/requestPasswordReset`
+
+```ts
+const { data } = await client.requestPasswordReset(
+  null,
+  {
+    email: 'test@example.com'
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "message": "If an account exists, a password reset email has been sent."
+}
+```
+
+</details>
+
+---
+
 ### `checkInviteToken`
 
 Check an invite token
@@ -2258,10 +2506,12 @@ type UserV2 = {
   status?: "Active" | "Pending" | "Deactivated" | "Deleted"
   email?: string // email
   draft_email?: string // email
+  draft_email_expires_at?: string // date-time
   department?: string
   phone?: string
   secondary_phone?: string
   mfa_enabled?: boolean
+  has_passkeys?: boolean
   phone_verified?: boolean
   token?: string
   signature?: string
@@ -2351,6 +2601,7 @@ type CreateGroupReq = {
     thumbnail_64?: string // uri
     gradient_colors?: string[]
   }
+  abbreviation?: string
 }
 ```
 
@@ -2366,6 +2617,7 @@ type UpdateGroupReq = {
     thumbnail_64?: string // uri
     gradient_colors?: string[]
   }
+  abbreviation?: string
 }
 ```
 
@@ -2388,10 +2640,12 @@ type Group = {
     status?: "Active" | "Pending" | "Deactivated" | "Deleted"
     email?: string // email
     draft_email?: string // email
+    draft_email_expires_at?: string // date-time
     department?: string
     phone?: string
     secondary_phone?: string
     mfa_enabled?: boolean
+    has_passkeys?: boolean
     phone_verified?: boolean
     token?: string
     signature?: string
@@ -2422,10 +2676,12 @@ type Group = {
     status?: "Active" | "Pending" | "Deactivated" | "Deleted"
     email?: string // email
     draft_email?: string // email
+    draft_email_expires_at?: string // date-time
     department?: string
     phone?: string
     secondary_phone?: string
     mfa_enabled?: boolean
+    has_passkeys?: boolean
     phone_verified?: boolean
     token?: string
     signature?: string
@@ -2452,6 +2708,7 @@ type Group = {
     thumbnail_64?: string // uri
     gradient_colors?: string[]
   }
+  abbreviation?: string
 }
 ```
 
@@ -2568,6 +2825,62 @@ type DataPoint = {
 }
 ```
 
+### `UserSettingScope`
+
+User setting scope. Values are limited to 64 characters.
+
+```ts
+type UserSettingScope = string
+```
+
+### `UserSettingKey`
+
+User setting key. Values are limited to 128 characters.
+
+```ts
+type UserSettingKey = string
+```
+
+### `UserSettingValue`
+
+The JSON value of a user setting. Objects are recommended for extensibility, but any JSON value is accepted up to 64 KiB when serialized as JSON.
+
+```ts
+type UserSettingValue = unknown
+```
+
+### `UserSetting`
+
+```ts
+type UserSetting = {
+  scope: string
+  key: string
+  value: unknown
+  created_at: string // date-time
+  updated_at: string // date-time
+}
+```
+
+### `UserSettingsListResponse`
+
+```ts
+type UserSettingsListResponse = {
+  results: Array<{
+    scope: string
+    keys: string[]
+  }>
+}
+```
+
+### `UserSettingsScopeResponse`
+
+```ts
+type UserSettingsScopeResponse = {
+  scope: string
+  settings: Record<string, unknown>
+}
+```
+
 ### `Passkey`
 
 ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.8.1",
+  "version": "2.8.3",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -267,6 +267,12 @@
       "require": "./dist/apis/sharing.cjs"
     },
     "./sharing/openapi.json": "./definitions/sharing.json",
+    "./snapshot": {
+      "types": "./dist/apis/snapshot.d.ts",
+      "import": "./dist/apis/snapshot.js",
+      "require": "./dist/apis/snapshot.cjs"
+    },
+    "./snapshot/openapi.json": "./definitions/snapshot.json",
     "./submission": {
       "types": "./dist/apis/submission.d.ts",
       "import": "./dist/apis/submission.js",
@@ -481,6 +487,9 @@
       "sharing": [
         "./dist/apis/sharing.d.ts"
       ],
+      "snapshot": [
+        "./dist/apis/snapshot.d.ts"
+      ],
       "submission": [
         "./dist/apis/submission.d.ts"
       ],