api: Add updateUserSettings binding, for PATCH /settings

Author: chrisbobbe

src/api/index.js

@@ -53,6 +53,7 @@ import tryGetFileTemporaryUrl from './tryGetFileTemporaryUrl';
 import getUsers from './users/getUsers';
 import createUser from './users/createUser';
 import getUserProfile from './users/getUserProfile';
+import updateUserSettings from './users/updateUserSettings';
 import updateUserStatus from './users/updateUserStatus';
 import getFileTemporaryUrl from './messages/getFileTemporaryUrl';
 import getReadReceipts from './messages/getReadReceipts';
@@ -103,6 +104,7 @@ export {
   getUsers,
   createUser,
   getUserProfile,
+  updateUserSettings,
   updateUserStatus,
   getFileTemporaryUrl,
   getReadReceipts,

src/api/modelTypes.js

@@ -166,8 +166,10 @@ export type RealmLinkifier = $ReadOnly<{|
 // response in FL 89.
 //
 // Current to FL 152; property ordering follows the /register doc. See the
-// "Current to" note on the InitialDataUserSettings type and update that as
-// needed too.
+// "Current to" notes in the two places we use this, and update them as
+// needed:
+// - InitialDataUserSettings (for POST /register response)
+// - api.updateUserSettings (for the PATCH /settings endpoint)
 //
 // TODO(server-5.0): Remove FL 89+ comment.
 export type UserSettings = {|

src/api/users/updateUserSettings.js

@@ -0,0 +1,42 @@
+/* @flow strict-local */
+import invariant from 'invariant';
+
+import type { UserSettings } from '../modelTypes';
+import type { ApiResponseSuccess, Auth } from '../transportTypes';
+import { apiPatch } from '../apiFetch';
+
+// Assumes FL 89+ because the UserSettings type does; see note there.
+//
+// Current to FL 152. See the "Current to" note on the UserSettings type and
+// update that as needed too.
+//
+// TODO(server-5.0): Remove FL 89+ comment.
+type Args = {|
+  ...$Rest<UserSettings, { ... }>,
+
+  // These might move to a different endpoint in the future; see
+  //   https://chat.zulip.org/#narrow/stream/378-api-design/topic/User.20settings.20discrepancies/near/1457451
+  +full_name?: string,
+  +email?: string,
+  +old_password?: string,
+  +new_password?: string,
+|};
+
+/**
+ * https://zulip.com/api/update-settings
+ *
+ * NOTE: Only supports servers at feature level 89+ because UserSettings
+ * assumes 89+; see there.
+ */
+// TODO(server-5.0): Simplify FL 89+ requirement
+export default (
+  auth: Auth,
+  args: Args,
+
+  // TODO(#4659): Don't get this from callers.
+  zulipFeatureLevel: number,
+): Promise<ApiResponseSuccess> => {
+  invariant(zulipFeatureLevel >= 89, 'api.updateUserSettings not supported with FL <89');
+
+  return apiPatch(auth, 'settings', args);
+};