@greensecurity/javascript-sdk 0.44.0-beta.24 → 0.44.0-beta.25

package/src/models/operations/getlinkedusers.ts

@@ -11,9 +11,14 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetLinkedUsersRequest = {
   /**
-   * The ID of the user to fetch linked users for. Required for API users.
+   * The user to fetch linked users for. Pass `me` for the authenticated user
+   *
+   * @remarks
+   * (allowed for any user type), or a positive numeric user ID. A numeric ID is
+   * only honored for API users with an active app activation for that user;
+   * non-API users must pass `me`.
    */
-  userId?: number | undefined;
+  userId: string;
 };
 
 export type LinkedUsers = {
@@ -33,7 +38,7 @@ export type GetLinkedUsersGetLinkedUsersOk = {
 
 /** @internal */
 export type GetLinkedUsersRequest$Outbound = {
-  user_id?: number | undefined;
+  user_id: string;
 };
 
 /** @internal */
@@ -42,7 +47,7 @@ export const GetLinkedUsersRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetLinkedUsersRequest
 > = z.object({
-  userId: z.number().int().optional(),
+  userId: z.string(),
 }).transform((v) => {
   return remap$(v, {
     userId: "user_id",

package/src/react-query/usersGetLinkedUsers.core.ts

@@ -67,7 +67,7 @@ export function buildUsersGetLinkedUsersQuery(
 }
 
 export function queryKeyUsersGetLinkedUsers(
-  parameters: { userId?: number | undefined },
+  parameters: { userId: string },
 ): QueryKey {
   return [
     "@greensecurity/javascript-sdk",

package/src/react-query/usersGetLinkedUsers.ts

@@ -56,12 +56,14 @@ export type UsersGetLinkedUsersQueryError =
  * Get linked users
  *
  * @remarks
- * Returns a list of users linked to the authenticated user.
+ * Returns a list of users linked to the requested user.
  *
- * For regular users, returns their own linked users.
+ * Pass `user_id=me` to fetch the linked users of the authenticated user. This
+ * is allowed for any authenticated user type.
  *
- * For API users, the `user_id` parameter is required. The API user must
- * have an active app activation for the requested user.
+ * API users may additionally pass a numeric `user_id` to fetch another user's
+ * linked users, provided they have an active app activation for that user.
+ * Non-API users may only pass `me`.
  */
 export function useUsersGetLinkedUsers(
   request: operations.GetLinkedUsersRequest,
@@ -85,12 +87,14 @@ export function useUsersGetLinkedUsers(
  * Get linked users
  *
  * @remarks
- * Returns a list of users linked to the authenticated user.
+ * Returns a list of users linked to the requested user.
  *
- * For regular users, returns their own linked users.
+ * Pass `user_id=me` to fetch the linked users of the authenticated user. This
+ * is allowed for any authenticated user type.
  *
- * For API users, the `user_id` parameter is required. The API user must
- * have an active app activation for the requested user.
+ * API users may additionally pass a numeric `user_id` to fetch another user's
+ * linked users, provided they have an active app activation for that user.
+ * Non-API users may only pass `me`.
  */
 export function useUsersGetLinkedUsersSuspense(
   request: operations.GetLinkedUsersRequest,
@@ -115,7 +119,7 @@ export function useUsersGetLinkedUsersSuspense(
 
 export function setUsersGetLinkedUsersData(
   client: QueryClient,
-  queryKeyBase: [parameters: { userId?: number | undefined }],
+  queryKeyBase: [parameters: { userId: string }],
   data: UsersGetLinkedUsersQueryData,
 ): UsersGetLinkedUsersQueryData | undefined {
   const key = queryKeyUsersGetLinkedUsers(...queryKeyBase);
@@ -125,7 +129,7 @@ export function setUsersGetLinkedUsersData(
 
 export function invalidateUsersGetLinkedUsers(
   client: QueryClient,
-  queryKeyBase: TupleToPrefixes<[parameters: { userId?: number | undefined }]>,
+  queryKeyBase: TupleToPrefixes<[parameters: { userId: string }]>,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
 ): Promise<void> {
   return client.invalidateQueries({

package/src/sdk/users.ts

@@ -173,12 +173,14 @@ export class Users extends ClientSDK {
    * Get linked users
    *
    * @remarks
-   * Returns a list of users linked to the authenticated user.
+   * Returns a list of users linked to the requested user.
    *
-   * For regular users, returns their own linked users.
+   * Pass `user_id=me` to fetch the linked users of the authenticated user. This
+   * is allowed for any authenticated user type.
    *
-   * For API users, the `user_id` parameter is required. The API user must
-   * have an active app activation for the requested user.
+   * API users may additionally pass a numeric `user_id` to fetch another user's
+   * linked users, provided they have an active app activation for that user.
+   * Non-API users may only pass `me`.
    */
   async getLinkedUsers(
     request: operations.GetLinkedUsersRequest,