@examplary/sdk 2.17.0 → 2.18.0

package/dist/index.d.mts

@@ -268,7 +268,7 @@ interface paths {
         put?: never;
         /**
          * OAuth token endpoint
-         * @description Exchange authorization code for access token, or refresh an existing token.
+         * @description Exchange an authorization code for an access token, refresh an existing token, or obtain a client-credentials token (first-party clients only).
          */
         post: operations["oauth.token"];
         delete?: never;
@@ -1669,7 +1669,11 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        get?: never;
+        /**
+         * Get user
+         * @description Get details of a specific user within the workspace.
+         */
+        get: operations["users.get"];
         put?: never;
         post?: never;
         /**
@@ -1680,8 +1684,8 @@ interface paths {
         options?: never;
         head?: never;
         /**
-         * Update user role
-         * @description Update a user's role within the workspace.
+         * Update user
+         * @description Update a user's details within the workspace.
          */
         patch: operations["users.update"];
         trace?: never;
@@ -5473,17 +5477,32 @@ interface operations {
                      * @default teacher
                      * @enum {string}
                      */
-                    role?: "owner" | "admin" | "teacher" | "student" | "member";
+                    role?: "admin" | "teacher" | "student" | "member";
                     /**
                      * @description Whether to send an invitation email. Defaults to false.
                      * @default false
                      */
                     sendInvite?: boolean;
+                    metadata?: {
+                        [key: string]: string | number | boolean | null;
+                    };
                 };
             };
         };
         responses: never;
     };
+    "users.get": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
     "users.delete": {
         parameters: {
             query?: never;
@@ -5505,7 +5524,23 @@ interface operations {
             };
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody?: {
+            content: {
+                "application/json": {
+                    /** @description The user's name */
+                    name?: string;
+                    /** @enum {string} */
+                    role?: "admin" | "teacher" | "student" | "member";
+                    /** @description A map of user preferences */
+                    preferences?: {
+                        [key: string]: unknown;
+                    };
+                    metadata?: {
+                        [key: string]: string | number | boolean | null;
+                    };
+                };
+            };
+        };
         responses: never;
     };
     "users.resetTwoFactor": {
@@ -7434,6 +7469,9 @@ interface _PathOverrides {
         resource: string;
         actor: string;
     };
+    "users.get": {
+        id: string;
+    };
     "users.update": {
         id: string;
     };
@@ -7772,7 +7810,7 @@ declare class Oauth {
     /**
      * OAuth token endpoint
      *
-     * Exchange authorization code for access token, or refresh an existing token.
+     * Exchange an authorization code for an access token, refresh an existing token, or obtain a client-credentials token (first-party clients only).
      *
      * API endpoint: `POST /oauth/token`
      */
@@ -8631,13 +8669,21 @@ declare class Users {
      */
     create(args?: Args<"users.create">, options?: ExamplaryRequestOptions): Promise<Response<"users.create">>;
     /**
-     * Update user role
+     * Get user
+     *
+     * Get details of a specific user within the workspace.
+     *
+     * API endpoint: `GET /users/{id}`
+     */
+    get(id: string, options?: ExamplaryRequestOptions): Promise<Response<"users.get">>;
+    get(args: Args<"users.get">, options?: ExamplaryRequestOptions): Promise<Response<"users.get">>;
+    /**
+     * Update user
      *
-     * Update a user's role within the workspace.
+     * Update a user's details within the workspace.
      *
      * API endpoint: `PATCH /users/{id}`
      */
-    update(id: string, options?: ExamplaryRequestOptions): Promise<Response<"users.update">>;
     update(args: Args<"users.update">, options?: ExamplaryRequestOptions): Promise<Response<"users.update">>;
     /**
      * Delete user

package/dist/index.d.ts

@@ -268,7 +268,7 @@ interface paths {
         put?: never;
         /**
          * OAuth token endpoint
-         * @description Exchange authorization code for access token, or refresh an existing token.
+         * @description Exchange an authorization code for an access token, refresh an existing token, or obtain a client-credentials token (first-party clients only).
          */
         post: operations["oauth.token"];
         delete?: never;
@@ -1669,7 +1669,11 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        get?: never;
+        /**
+         * Get user
+         * @description Get details of a specific user within the workspace.
+         */
+        get: operations["users.get"];
         put?: never;
         post?: never;
         /**
@@ -1680,8 +1684,8 @@ interface paths {
         options?: never;
         head?: never;
         /**
-         * Update user role
-         * @description Update a user's role within the workspace.
+         * Update user
+         * @description Update a user's details within the workspace.
          */
         patch: operations["users.update"];
         trace?: never;
@@ -5473,17 +5477,32 @@ interface operations {
                      * @default teacher
                      * @enum {string}
                      */
-                    role?: "owner" | "admin" | "teacher" | "student" | "member";
+                    role?: "admin" | "teacher" | "student" | "member";
                     /**
                      * @description Whether to send an invitation email. Defaults to false.
                      * @default false
                      */
                     sendInvite?: boolean;
+                    metadata?: {
+                        [key: string]: string | number | boolean | null;
+                    };
                 };
             };
         };
         responses: never;
     };
+    "users.get": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: never;
+    };
     "users.delete": {
         parameters: {
             query?: never;
@@ -5505,7 +5524,23 @@ interface operations {
             };
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody?: {
+            content: {
+                "application/json": {
+                    /** @description The user's name */
+                    name?: string;
+                    /** @enum {string} */
+                    role?: "admin" | "teacher" | "student" | "member";
+                    /** @description A map of user preferences */
+                    preferences?: {
+                        [key: string]: unknown;
+                    };
+                    metadata?: {
+                        [key: string]: string | number | boolean | null;
+                    };
+                };
+            };
+        };
         responses: never;
     };
     "users.resetTwoFactor": {
@@ -7434,6 +7469,9 @@ interface _PathOverrides {
         resource: string;
         actor: string;
     };
+    "users.get": {
+        id: string;
+    };
     "users.update": {
         id: string;
     };
@@ -7772,7 +7810,7 @@ declare class Oauth {
     /**
      * OAuth token endpoint
      *
-     * Exchange authorization code for access token, or refresh an existing token.
+     * Exchange an authorization code for an access token, refresh an existing token, or obtain a client-credentials token (first-party clients only).
      *
      * API endpoint: `POST /oauth/token`
      */
@@ -8631,13 +8669,21 @@ declare class Users {
      */
     create(args?: Args<"users.create">, options?: ExamplaryRequestOptions): Promise<Response<"users.create">>;
     /**
-     * Update user role
+     * Get user
+     *
+     * Get details of a specific user within the workspace.
+     *
+     * API endpoint: `GET /users/{id}`
+     */
+    get(id: string, options?: ExamplaryRequestOptions): Promise<Response<"users.get">>;
+    get(args: Args<"users.get">, options?: ExamplaryRequestOptions): Promise<Response<"users.get">>;
+    /**
+     * Update user
      *
-     * Update a user's role within the workspace.
+     * Update a user's details within the workspace.
      *
      * API endpoint: `PATCH /users/{id}`
      */
-    update(id: string, options?: ExamplaryRequestOptions): Promise<Response<"users.update">>;
     update(args: Args<"users.update">, options?: ExamplaryRequestOptions): Promise<Response<"users.update">>;
     /**
      * Delete user

package/dist/index.js

@@ -774,9 +774,13 @@ var Users = class {
     const args = arg;
     return request(this.ctx, "POST", "/users", [], [], true, args, options);
   }
-  update(arg, options) {
+  get(arg, options) {
     const args = typeof arg === "string" ? { id: arg } : arg;
-    return request(this.ctx, "PATCH", "/users/{id}", ["id"], [], false, args, options);
+    return request(this.ctx, "GET", "/users/{id}", ["id"], [], false, args, options);
+  }
+  update(arg, options) {
+    const args = arg;
+    return request(this.ctx, "PATCH", "/users/{id}", ["id"], [], true, args, options);
   }
   delete(arg, options) {
     const args = typeof arg === "string" ? { id: arg } : arg;