@epilot/sdk 2.9.0 → 2.9.2

package/dist/{user.d-D18fe97W.d.cts → user.d-L-C7_K84.d.cts}

@@ -54,6 +54,12 @@ declare namespace Components {
              * }
              */
             GroupImageUri;
+            /**
+             * A short abbreviation for the group, up to 2 characters.
+             * example:
+             * FN
+             */
+            abbreviation?: string | null;
         }
         export interface DataPoint {
             /**
@@ -130,6 +136,10 @@ declare namespace Components {
                  * User's pending email address
                  */
                 draft_email?: string | null; // email
+                /**
+                 * Server-set expiry for the pending email change verification link (ISO 8601). Read-only.
+                 */
+                draft_email_expires_at?: string | null; // date-time
                 /**
                  * User's department
                  * example:
@@ -154,6 +164,12 @@ declare namespace Components {
                  * false
                  */
                 mfa_enabled?: boolean;
+                /**
+                 * Whether the user has any registered passkeys
+                 * example:
+                 * false
+                 */
+                has_passkeys?: boolean;
                 /**
                  * User's phone number verification status
                  * example:
@@ -283,6 +299,12 @@ declare namespace Components {
              * }
              */
             GroupImageUri;
+            /**
+             * A short abbreviation for the group, up to 2 characters.
+             * example:
+             * FN
+             */
+            abbreviation?: string | null;
         }
         /**
          * Group unique identifier
@@ -736,6 +758,12 @@ declare namespace Components {
              * }
              */
             GroupImageUri;
+            /**
+             * A short abbreviation for the group, up to 2 characters.
+             * example:
+             * FN
+             */
+            abbreviation?: string | null;
         }
         export interface User {
             id: /* User's unique identifier */ UserId;
@@ -842,6 +870,82 @@ declare namespace Components {
             language?: "en" | "de";
             roles?: string[];
         }
+        export interface UserSetting {
+            scope: /**
+             * User setting scope. Values are limited to 64 characters.
+             * example:
+             * calendar
+             */
+            UserSettingScope;
+            key: /**
+             * User setting key. Values are limited to 128 characters.
+             * example:
+             * visible_calendars
+             */
+            UserSettingKey;
+            value: /* 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. */ UserSettingValue;
+            created_at: string; // date-time
+            updated_at: string; // date-time
+        }
+        /**
+         * User setting key. Values are limited to 128 characters.
+         * example:
+         * visible_calendars
+         */
+        export type UserSettingKey = string;
+        /**
+         * User setting scope. Values are limited to 64 characters.
+         * example:
+         * calendar
+         */
+        export type UserSettingScope = string;
+        /**
+         * 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.
+         */
+        export type UserSettingValue = any;
+        export interface UserSettingsListResponse {
+            results: {
+                scope: /**
+                 * User setting scope. Values are limited to 64 characters.
+                 * example:
+                 * calendar
+                 */
+                UserSettingScope;
+                /**
+                 * example:
+                 * [
+                 *   "visible_calendars"
+                 * ]
+                 */
+                keys: /**
+                 * User setting key. Values are limited to 128 characters.
+                 * example:
+                 * visible_calendars
+                 */
+                UserSettingKey[];
+            }[];
+        }
+        export interface UserSettingsScopeResponse {
+            scope: /**
+             * User setting scope. Values are limited to 64 characters.
+             * example:
+             * calendar
+             */
+            UserSettingScope;
+            /**
+             * example:
+             * {
+             *   "visible_calendars": {
+             *     "calendar_ids": [
+             *       "holidays"
+             *     ]
+             *   }
+             * }
+             */
+            settings: {
+                [name: string]: /* 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. */ UserSettingValue;
+            };
+        }
         export interface UserV2 {
             id?: /* User's unique identifier */ UserId;
             organization_id?: OrganizationId;
@@ -862,6 +966,10 @@ declare namespace Components {
              * User's pending email address
              */
             draft_email?: string | null; // email
+            /**
+             * Server-set expiry for the pending email change verification link (ISO 8601). Read-only.
+             */
+            draft_email_expires_at?: string | null; // date-time
             /**
              * User's department
              * example:
@@ -886,6 +994,12 @@ declare namespace Components {
              * false
              */
             mfa_enabled?: boolean;
+            /**
+             * Whether the user has any registered passkeys
+             * example:
+             * false
+             */
+            has_passkeys?: boolean;
             /**
              * User's phone number verification status
              * example:
@@ -1148,6 +1262,30 @@ declare namespace Paths {
             }
         }
     }
+    namespace DeleteUserSetting {
+        namespace Parameters {
+            export type Key = /**
+             * User setting key. Values are limited to 128 characters.
+             * example:
+             * visible_calendars
+             */
+            Components.Schemas.UserSettingKey;
+            export type Scope = /**
+             * User setting scope. Values are limited to 64 characters.
+             * example:
+             * calendar
+             */
+            Components.Schemas.UserSettingScope;
+        }
+        export interface PathParameters {
+            scope: Parameters.Scope;
+            key: Parameters.Key;
+        }
+        namespace Responses {
+            export interface $204 {
+            }
+        }
+    }
     namespace DeleteUserV2 {
         namespace Parameters {
             export type Id = /* User's unique identifier */ Components.Schemas.UserId;
@@ -1276,6 +1414,47 @@ declare namespace Paths {
             }
         }
     }
+    namespace GetUserSetting {
+        namespace Parameters {
+            export type Key = /**
+             * User setting key. Values are limited to 128 characters.
+             * example:
+             * visible_calendars
+             */
+            Components.Schemas.UserSettingKey;
+            export type Scope = /**
+             * User setting scope. Values are limited to 64 characters.
+             * example:
+             * calendar
+             */
+            Components.Schemas.UserSettingScope;
+        }
+        export interface PathParameters {
+            scope: Parameters.Scope;
+            key: Parameters.Key;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.UserSetting;
+            export interface $404 {
+            }
+        }
+    }
+    namespace GetUserSettingsScope {
+        namespace Parameters {
+            export type Scope = /**
+             * User setting scope. Values are limited to 64 characters.
+             * example:
+             * calendar
+             */
+            Components.Schemas.UserSettingScope;
+        }
+        export interface PathParameters {
+            scope: Parameters.Scope;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.UserSettingsScopeResponse;
+        }
+    }
     namespace GetUserV2 {
         namespace Parameters {
             export type Id = /* User's unique identifier */ Components.Schemas.UserId;
@@ -1302,6 +1481,11 @@ declare namespace Paths {
             }
         }
     }
+    namespace ListUserSettings {
+        namespace Responses {
+            export type $200 = Components.Schemas.UserSettingsListResponse;
+        }
+    }
     namespace ListUsers {
         namespace Parameters {
             export type Limit = Components.Schemas.Limit;
@@ -1338,6 +1522,30 @@ declare namespace Paths {
             }
         }
     }
+    namespace PutUserSetting {
+        namespace Parameters {
+            export type Key = /**
+             * User setting key. Values are limited to 128 characters.
+             * example:
+             * visible_calendars
+             */
+            Components.Schemas.UserSettingKey;
+            export type Scope = /**
+             * User setting scope. Values are limited to 64 characters.
+             * example:
+             * calendar
+             */
+            Components.Schemas.UserSettingScope;
+        }
+        export interface PathParameters {
+            scope: Parameters.Scope;
+            key: Parameters.Key;
+        }
+        export type RequestBody = /* 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. */ Components.Schemas.UserSettingValue;
+        namespace Responses {
+            export type $200 = Components.Schemas.UserSetting;
+        }
+    }
     namespace RejectInvite {
         namespace Parameters {
             export type Token = /* Token used to invite a user to epilot */ Components.Schemas.InviteToken;
@@ -1357,6 +1565,25 @@ declare namespace Paths {
             }
         }
     }
+    namespace RequestPasswordReset {
+        export interface RequestBody {
+            /**
+             * Email address of the account to reset
+             * example:
+             * test@example.com
+             */
+            email: string;
+        }
+        namespace Responses {
+            export interface $200 {
+                /**
+                 * example:
+                 * If an account exists, a password reset email has been sent.
+                 */
+                message: string;
+            }
+        }
+    }
     namespace ResendUserInvitation {
         export interface RequestBody {
             /**
@@ -1400,6 +1627,29 @@ declare namespace Paths {
             }
         }
     }
+    namespace SendUserPasswordReset {
+        export interface RequestBody {
+            /**
+             * Email address of the user to reset
+             * example:
+             * test@example.com
+             */
+            email: string;
+        }
+        namespace Responses {
+            export interface $200 {
+                /**
+                 * example:
+                 * true
+                 */
+                success: boolean;
+            }
+            export interface $400 {
+            }
+            export interface $403 {
+            }
+        }
+    }
     namespace SignUpUser {
         namespace Parameters {
             export type Token = /* Token used to invite a partner user to epilot */ Components.Schemas.PartnerInvitationToken;
@@ -1465,8 +1715,12 @@ declare namespace Paths {
         namespace Responses {
             export interface $200 {
             }
+            export interface $400 {
+            }
             export interface $404 {
             }
+            export interface $409 {
+            }
         }
     }
 }
@@ -1491,6 +1745,56 @@ interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetMeV2.Responses.$200>
+  /**
+   * listUserSettings - listUserSettings
+   * 
+   * List all setting scopes and keys available for the currently logged in user. Does not return setting values.
+   */
+  'listUserSettings'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListUserSettings.Responses.$200>
+  /**
+   * getUserSettingsScope - getUserSettingsScope
+   * 
+   * Get all setting values for one scope for the currently logged in user.
+   */
+  'getUserSettingsScope'(
+    parameters?: Parameters<Paths.GetUserSettingsScope.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetUserSettingsScope.Responses.$200>
+  /**
+   * getUserSetting - getUserSetting
+   * 
+   * Get one setting value by scope and key for the currently logged in user.
+   */
+  'getUserSetting'(
+    parameters?: Parameters<Paths.GetUserSetting.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetUserSetting.Responses.$200>
+  /**
+   * putUserSetting - putUserSetting
+   * 
+   * Create or replace one setting value for the currently logged in user.
+   */
+  'putUserSetting'(
+    parameters?: Parameters<Paths.PutUserSetting.PathParameters> | null,
+    data?: Paths.PutUserSetting.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PutUserSetting.Responses.$200>
+  /**
+   * deleteUserSetting - deleteUserSetting
+   * 
+   * Delete one setting value for the currently logged in user.
+   */
+  'deleteUserSetting'(
+    parameters?: Parameters<Paths.DeleteUserSetting.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteUserSetting.Responses.$204>
   /**
    * listUsersV2 - listUsersV2
    * 
@@ -1552,6 +1856,18 @@ interface OperationMethods {
     data?: Paths.ResendUserInvitation.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ResendUserInvitation.Responses.$200>
+  /**
+   * sendUserPasswordReset - sendUserPasswordReset
+   * 
+   * Send a password reset email to a user in your organization.
+   * Requires `user:edit` on the target user.
+   * 
+   */
+  'sendUserPasswordReset'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.SendUserPasswordReset.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.SendUserPasswordReset.Responses.$200>
   /**
    * getGroupsForUser - getGroupsForUser
    * 
@@ -1654,6 +1970,19 @@ interface OperationMethods {
     data?: Paths.VerifyEmailWithToken.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.VerifyEmailWithToken.Responses.$200>
+  /**
+   * requestPasswordReset - 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.
+   * 
+   */
+  'requestPasswordReset'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.RequestPasswordReset.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.RequestPasswordReset.Responses.$200>
   /**
    * checkInviteToken - checkInviteToken
    * 
@@ -1842,6 +2171,62 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetMeV2.Responses.$200>
   }
+  ['/v2/users/me/settings']: {
+    /**
+     * listUserSettings - listUserSettings
+     * 
+     * List all setting scopes and keys available for the currently logged in user. Does not return setting values.
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListUserSettings.Responses.$200>
+  }
+  ['/v2/users/me/settings/{scope}']: {
+    /**
+     * getUserSettingsScope - getUserSettingsScope
+     * 
+     * Get all setting values for one scope for the currently logged in user.
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetUserSettingsScope.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetUserSettingsScope.Responses.$200>
+  }
+  ['/v2/users/me/settings/{scope}/{key}']: {
+    /**
+     * getUserSetting - getUserSetting
+     * 
+     * Get one setting value by scope and key for the currently logged in user.
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetUserSetting.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetUserSetting.Responses.$200>
+    /**
+     * putUserSetting - putUserSetting
+     * 
+     * Create or replace one setting value for the currently logged in user.
+     */
+    'put'(
+      parameters?: Parameters<Paths.PutUserSetting.PathParameters> | null,
+      data?: Paths.PutUserSetting.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PutUserSetting.Responses.$200>
+    /**
+     * deleteUserSetting - deleteUserSetting
+     * 
+     * Delete one setting value for the currently logged in user.
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteUserSetting.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteUserSetting.Responses.$204>
+  }
   ['/v2/users']: {
     /**
      * listUsersV2 - listUsersV2
@@ -1911,6 +2296,20 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ResendUserInvitation.Responses.$200>
   }
+  ['/v2/users:sendPasswordReset']: {
+    /**
+     * sendUserPasswordReset - sendUserPasswordReset
+     * 
+     * Send a password reset email to a user in your organization.
+     * Requires `user:edit` on the target user.
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.SendUserPasswordReset.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.SendUserPasswordReset.Responses.$200>
+  }
   ['/v2/users/{id}/groups']: {
     /**
      * getGroupsForUser - getGroupsForUser
@@ -2027,6 +2426,21 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.VerifyEmailWithToken.Responses.$200>
   }
+  ['/v2/users/public/requestPasswordReset']: {
+    /**
+     * requestPasswordReset - 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'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.RequestPasswordReset.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.RequestPasswordReset.Responses.$200>
+  }
   ['/v2/users/public/checkToken']: {
     /**
      * checkInviteToken - checkInviteToken
@@ -2262,9 +2676,15 @@ type UserActivationPayload = Components.Schemas.UserActivationPayload;
 type UserDetail = Components.Schemas.UserDetail;
 type UserId = Components.Schemas.UserId;
 type UserInvitationPayload = Components.Schemas.UserInvitationPayload;
+type UserSetting = Components.Schemas.UserSetting;
+type UserSettingKey = Components.Schemas.UserSettingKey;
+type UserSettingScope = Components.Schemas.UserSettingScope;
+type UserSettingValue = Components.Schemas.UserSettingValue;
+type UserSettingsListResponse = Components.Schemas.UserSettingsListResponse;
+type UserSettingsScopeResponse = Components.Schemas.UserSettingsScopeResponse;
 type UserV2 = Components.Schemas.UserV2;
 type UserVerificationPayload = Components.Schemas.UserVerificationPayload;
 type Username = Components.Schemas.Username;
 type VerificationToken = Components.Schemas.VerificationToken;
 
-export { type UserId as A, type UserInvitationPayload as B, type Client as C, type DataPoint as D, type UserV2 as E, type UserVerificationPayload as F, type Group as G, type Hydrate as H, type InviteToken as I, type Username as J, type Limit as L, type Navigation as N, type OperationMethods as O, Paths as P, type Query as Q, type SignupUserPayload as S, type UpdateGroupReq as U, type VerificationToken as V, Components as a, type PathsDictionary as b, type CognitoDetails as c, type CreateGroupReq as d, type DataPointsResponse as e, type GroupId as f, type GroupImageUri as g, type LoginParameters as h, type NavigationConfiguration as i, type NavigationCreateRequest as j, type NavigationGroupItem as k, type NavigationId as l, type NavigationItem as m, type NavigationKeyItem as n, type Offset as o, type Organization as p, type OrganizationDetail as q, type OrganizationId as r, type PartnerInvitationToken as s, type Passkey as t, type PasskeyAuthenticationOptions as u, type PasskeyRegistrationOptions as v, type PasskeyRegistrationResponse as w, type User as x, type UserActivationPayload as y, type UserDetail as z };
+export { type UserId as A, type UserInvitationPayload as B, type Client as C, type DataPoint as D, type UserSetting as E, type UserSettingKey as F, type Group as G, type Hydrate as H, type InviteToken as I, type UserSettingScope as J, type UserSettingValue as K, type Limit as L, type UserSettingsListResponse as M, type Navigation as N, type OperationMethods as O, Paths as P, type Query as Q, type UserSettingsScopeResponse as R, type SignupUserPayload as S, type UserV2 as T, type UpdateGroupReq as U, type UserVerificationPayload as V, type Username as W, type VerificationToken as X, Components as a, type PathsDictionary as b, type CognitoDetails as c, type CreateGroupReq as d, type DataPointsResponse as e, type GroupId as f, type GroupImageUri as g, type LoginParameters as h, type NavigationConfiguration as i, type NavigationCreateRequest as j, type NavigationGroupItem as k, type NavigationId as l, type NavigationItem as m, type NavigationKeyItem as n, type Offset as o, type Organization as p, type OrganizationDetail as q, type OrganizationId as r, type PartnerInvitationToken as s, type Passkey as t, type PasskeyAuthenticationOptions as u, type PasskeyRegistrationOptions as v, type PasskeyRegistrationResponse as w, type User as x, type UserActivationPayload as y, type UserDetail as z };