@rustrak/client 0.14.2 → 0.14.3

package/dist/index.d.cts

@@ -1010,6 +1010,12 @@ declare const userSchema: z.ZodObject<{
         member: "member";
     }>;
     is_admin: z.ZodBoolean;
+    language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+declare const updatePreferencesRequestSchema: z.ZodObject<{
+    language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 declare const authResponseSchema: z.ZodObject<{
     user: z.ZodObject<{
@@ -1020,6 +1026,8 @@ declare const authResponseSchema: z.ZodObject<{
             member: "member";
         }>;
         is_admin: z.ZodBoolean;
+        language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 declare const loginResultSchema: z.ZodObject<{
@@ -1031,6 +1039,8 @@ declare const loginResultSchema: z.ZodObject<{
             member: "member";
         }>;
         is_admin: z.ZodBoolean;
+        language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>;
     cookies: z.ZodArray<z.ZodString>;
 }, z.core.$strip>;
@@ -1044,6 +1054,7 @@ declare const registerRequestSchema: z.ZodObject<{
 }, z.core.$strip>;
 
 type User = z.infer<typeof userSchema>;
+type UpdatePreferencesRequest = z.infer<typeof updatePreferencesRequestSchema>;
 type AuthResponse = z.infer<typeof authResponseSchema>;
 type LoginResult = z.infer<typeof loginResultSchema>;
 type LoginRequest = z.infer<typeof loginRequestSchema>;
@@ -1092,6 +1103,7 @@ declare class AuthResource extends BaseResource {
     login(credentials: LoginRequest): Promise<Result<LoginResult, RustrakError>>;
     logout(): Promise<Result<string[], RustrakError>>;
     getCurrentUser(): Promise<Result<User, RustrakError>>;
+    updatePreferences(preferences: UpdatePreferencesRequest): Promise<Result<User, RustrakError>>;
     getInvitation(token: string): Promise<Result<InvitationInfo, RustrakError>>;
     acceptInvitation(input: AcceptInvitation): Promise<Result<LoginResult, RustrakError>>;
     private readLoginResult;

package/dist/index.d.ts

@@ -1010,6 +1010,12 @@ declare const userSchema: z.ZodObject<{
         member: "member";
     }>;
     is_admin: z.ZodBoolean;
+    language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+declare const updatePreferencesRequestSchema: z.ZodObject<{
+    language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 declare const authResponseSchema: z.ZodObject<{
     user: z.ZodObject<{
@@ -1020,6 +1026,8 @@ declare const authResponseSchema: z.ZodObject<{
             member: "member";
         }>;
         is_admin: z.ZodBoolean;
+        language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 declare const loginResultSchema: z.ZodObject<{
@@ -1031,6 +1039,8 @@ declare const loginResultSchema: z.ZodObject<{
             member: "member";
         }>;
         is_admin: z.ZodBoolean;
+        language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>;
     cookies: z.ZodArray<z.ZodString>;
 }, z.core.$strip>;
@@ -1044,6 +1054,7 @@ declare const registerRequestSchema: z.ZodObject<{
 }, z.core.$strip>;
 
 type User = z.infer<typeof userSchema>;
+type UpdatePreferencesRequest = z.infer<typeof updatePreferencesRequestSchema>;
 type AuthResponse = z.infer<typeof authResponseSchema>;
 type LoginResult = z.infer<typeof loginResultSchema>;
 type LoginRequest = z.infer<typeof loginRequestSchema>;
@@ -1092,6 +1103,7 @@ declare class AuthResource extends BaseResource {
     login(credentials: LoginRequest): Promise<Result<LoginResult, RustrakError>>;
     logout(): Promise<Result<string[], RustrakError>>;
     getCurrentUser(): Promise<Result<User, RustrakError>>;
+    updatePreferences(preferences: UpdatePreferencesRequest): Promise<Result<User, RustrakError>>;
     getInvitation(token: string): Promise<Result<InvitationInfo, RustrakError>>;
     acceptInvitation(input: AcceptInvitation): Promise<Result<LoginResult, RustrakError>>;
     private readLoginResult;

package/dist/index.js

@@ -620,7 +620,21 @@ var userSchema = z.object({
   id: z.number().int().positive(),
   email: z.string().email(),
   role: globalRoleSchema,
-  is_admin: z.boolean()
+  is_admin: z.boolean(),
+  /**
+   * The dashboard language this user chose.
+   *
+   * `null` means they never chose one, which a consumer should treat as
+   * "infer it" rather than as English. Optional as well as nullable so a
+   * client stays compatible with a server predating the column.
+   */
+  language: z.string().nullable().optional(),
+  /** The IANA timezone this user chose, `null` when they never chose one. */
+  timezone: z.string().nullable().optional()
+});
+var updatePreferencesRequestSchema = z.object({
+  language: z.string().nullable().optional(),
+  timezone: z.string().nullable().optional()
 });
 var authResponseSchema = z.object({
   user: userSchema
@@ -1301,6 +1315,24 @@ var AuthResource = class extends BaseResource {
   async getCurrentUser() {
     return this.request(() => this.http.get("auth/me"), userSchema);
   }
+  /**
+   * Stores how this reader wants the dashboard presented to them.
+   *
+   * A key left out is left alone; a key sent as `null` is cleared. That is why
+   * the request type is optional *and* nullable rather than one or the other:
+   * "do not touch" and "forget my choice" are different instructions.
+   */
+  async updatePreferences(preferences) {
+    const validatedInput = this.validateInput(
+      preferences,
+      updatePreferencesRequestSchema
+    );
+    if (!validatedInput.success) return validatedInput;
+    return this.request(
+      () => this.http.patch("auth/me", { json: validatedInput.data }),
+      userSchema
+    );
+  }
   /**
    * Get the details of a pending invitation by its token (public endpoint)
    * Used by the accept-invitation page before the user has an account