@flagpole/api-types 1.0.13 → 1.0.16

package/README.md

@@ -1,2 +1,2 @@
-# @flagpole/api-types v1.0.12
+# @flagpole/api-types v1.0.14
 TypeScript types for FlagPole API generated from OpenAPI specification.

package/lib/flagpole-api-types.d.ts

@@ -220,7 +220,21 @@ export interface ForgotPasswordDto {
      */
     email: string;
 }
-export type InviteUserDto = object;
+export interface InviteUserDto {
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    /**
+     * Array of project IDs the user should have access to
+     * @example ["507f1f77bcf86cd799439011","507f1f77bcf86cd799439012"]
+     */
+    projects?: string[];
+    /**
+     * User role in the organization
+     * @default "member"
+     */
+    role?: "owner" | "admin" | "member";
+}
 export interface LoginDto {
     /**
      * User's email address
@@ -341,12 +355,23 @@ export interface UpdateProjectDto {
      */
     name: string;
 }
+export interface UpdateUserDto {
+    /** User first name */
+    firstName?: string;
+    /** User last name */
+    lastName?: string;
+    /**
+     * Array of project IDs the user should have access to
+     * @example ["507f1f77bcf86cd799439011","507f1f77bcf86cd799439012"]
+     */
+    projects?: string[];
+    /** User role in the organization */
+    role?: "owner" | "admin" | "member";
+}
 export interface UpdateUserProfileDto {
     firstName?: string;
     lastName?: string;
 }
-export type UpdateUserProjectsDto = object;
-export type UpdateUserRoleDto = object;
 export type UsersControllerDeleteUserData = any;
 export type UsersControllerFindAllData = any;
 export type UsersControllerGetProfileData = any;
@@ -355,6 +380,7 @@ export type UsersControllerResendInvitationData = any;
 export type UsersControllerUpdateProfileData = any;
 export type UsersControllerUpdateProjectsData = any;
 export type UsersControllerUpdateRoleData = any;
+export type UsersControllerUpdateUserData = any;
 export declare namespace Api {
     /**
      * No description
@@ -480,9 +506,12 @@ export declare namespace Api {
     }
     /**
      * No description
+     * @tags users
      * @name UsersControllerFindAll
+     * @summary Get all users in organization
      * @request GET:/api/users
-     * @response `200` `UsersControllerFindAllData`
+     * @secure
+     * @response `200` `UsersControllerFindAllData` Users retrieved successfully
      */
     namespace UsersControllerFindAll {
         type RequestParams = {};
@@ -493,9 +522,13 @@ export declare namespace Api {
     }
     /**
      * No description
+     * @tags users
      * @name UsersControllerInvite
+     * @summary Invite a new user to the organization
      * @request POST:/api/users/invite
-     * @response `201` `UsersControllerInviteData`
+     * @secure
+     * @response `201` `UsersControllerInviteData` User invited successfully
+     * @response `403` `void` Insufficient permissions
      */
     namespace UsersControllerInvite {
         type RequestParams = {};
@@ -506,54 +539,90 @@ export declare namespace Api {
     }
     /**
      * No description
-     * @name UsersControllerUpdateRole
-     * @request PATCH:/api/users/{id}/role
-     * @response `200` `UsersControllerUpdateRoleData`
+     * @tags users
+     * @name UsersControllerUpdateUser
+     * @summary Update user role and projects
+     * @request PATCH:/api/users/{id}
+     * @secure
+     * @response `200` `UsersControllerUpdateUserData` User updated successfully
+     * @response `403` `void` Insufficient permissions
+     * @response `404` `void` User not found
      */
-    namespace UsersControllerUpdateRole {
+    namespace UsersControllerUpdateUser {
         type RequestParams = {
             id: string;
         };
         type RequestQuery = {};
-        type RequestBody = UpdateUserRoleDto;
+        type RequestBody = UpdateUserDto;
         type RequestHeaders = {};
-        type ResponseBody = UsersControllerUpdateRoleData;
+        type ResponseBody = UsersControllerUpdateUserData;
     }
     /**
      * No description
-     * @name UsersControllerUpdateProjects
-     * @request PATCH:/api/users/{id}/projects
-     * @response `200` `UsersControllerUpdateProjectsData`
+     * @tags users
+     * @name UsersControllerDeleteUser
+     * @summary Remove user from organization
+     * @request DELETE:/api/users/{id}
+     * @secure
+     * @response `200` `UsersControllerDeleteUserData` User removed successfully
+     * @response `403` `void` Insufficient permissions - only owners can remove users
      */
-    namespace UsersControllerUpdateProjects {
+    namespace UsersControllerDeleteUser {
         type RequestParams = {
             id: string;
         };
         type RequestQuery = {};
-        type RequestBody = UpdateUserProjectsDto;
+        type RequestBody = never;
         type RequestHeaders = {};
-        type ResponseBody = UsersControllerUpdateProjectsData;
+        type ResponseBody = UsersControllerDeleteUserData;
     }
     /**
      * No description
-     * @name UsersControllerDeleteUser
-     * @request DELETE:/api/users/{id}
-     * @response `200` `UsersControllerDeleteUserData`
+     * @tags users
+     * @name UsersControllerUpdateRole
+     * @summary Update user role (deprecated - use PATCH /users/:id)
+     * @request PATCH:/api/users/{id}/role
+     * @deprecated
+     * @secure
+     * @response `200` `UsersControllerUpdateRoleData`
      */
-    namespace UsersControllerDeleteUser {
+    namespace UsersControllerUpdateRole {
         type RequestParams = {
             id: string;
         };
         type RequestQuery = {};
         type RequestBody = never;
         type RequestHeaders = {};
-        type ResponseBody = UsersControllerDeleteUserData;
+        type ResponseBody = UsersControllerUpdateRoleData;
     }
     /**
      * No description
+     * @tags users
+     * @name UsersControllerUpdateProjects
+     * @summary Update user projects (deprecated - use PATCH /users/:id)
+     * @request PATCH:/api/users/{id}/projects
+     * @deprecated
+     * @secure
+     * @response `200` `UsersControllerUpdateProjectsData`
+     */
+    namespace UsersControllerUpdateProjects {
+        type RequestParams = {
+            id: string;
+        };
+        type RequestQuery = {};
+        type RequestBody = never;
+        type RequestHeaders = {};
+        type ResponseBody = UsersControllerUpdateProjectsData;
+    }
+    /**
+     * No description
+     * @tags users
      * @name UsersControllerResendInvitation
+     * @summary Resend invitation to pending user
      * @request POST:/api/users/{id}/resend-invitation
-     * @response `201` `UsersControllerResendInvitationData`
+     * @secure
+     * @response `200` `UsersControllerResendInvitationData` Invitation resent successfully
+     * @response `403` `void` Insufficient permissions
      */
     namespace UsersControllerResendInvitation {
         type RequestParams = {
@@ -566,8 +635,11 @@ export declare namespace Api {
     }
     /**
      * No description
+     * @tags users
      * @name UsersControllerGetProfile
+     * @summary Get current user profile
      * @request GET:/api/users/profile
+     * @secure
      * @response `200` `UsersControllerGetProfileData`
      */
     namespace UsersControllerGetProfile {
@@ -579,8 +651,11 @@ export declare namespace Api {
     }
     /**
      * No description
+     * @tags users
      * @name UsersControllerUpdateProfile
+     * @summary Update current user profile
      * @request PATCH:/api/users/profile
+     * @secure
      * @response `200` `UsersControllerUpdateProfileData`
      */
     namespace UsersControllerUpdateProfile {
@@ -1278,64 +1353,106 @@ export declare class Api<SecurityDataType extends unknown> {
         /**
          * No description
          *
+         * @tags users
          * @name UsersControllerFindAll
+         * @summary Get all users in organization
          * @request GET:/api/users
-         * @response `200` `UsersControllerFindAllData`
+         * @secure
+         * @response `200` `UsersControllerFindAllData` Users retrieved successfully
          */
         usersControllerFindAll: (params?: RequestParams) => Promise<AxiosResponse<any, any>>;
         /**
          * No description
          *
+         * @tags users
          * @name UsersControllerInvite
+         * @summary Invite a new user to the organization
          * @request POST:/api/users/invite
-         * @response `201` `UsersControllerInviteData`
+         * @secure
+         * @response `201` `UsersControllerInviteData` User invited successfully
+         * @response `403` `void` Insufficient permissions
          */
         usersControllerInvite: (data: InviteUserDto, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
         /**
          * No description
          *
+         * @tags users
+         * @name UsersControllerUpdateUser
+         * @summary Update user role and projects
+         * @request PATCH:/api/users/{id}
+         * @secure
+         * @response `200` `UsersControllerUpdateUserData` User updated successfully
+         * @response `403` `void` Insufficient permissions
+         * @response `404` `void` User not found
+         */
+        usersControllerUpdateUser: (id: string, data: UpdateUserDto, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
+        /**
+         * No description
+         *
+         * @tags users
+         * @name UsersControllerDeleteUser
+         * @summary Remove user from organization
+         * @request DELETE:/api/users/{id}
+         * @secure
+         * @response `200` `UsersControllerDeleteUserData` User removed successfully
+         * @response `403` `void` Insufficient permissions - only owners can remove users
+         */
+        usersControllerDeleteUser: (id: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
+        /**
+         * No description
+         *
+         * @tags users
          * @name UsersControllerUpdateRole
+         * @summary Update user role (deprecated - use PATCH /users/:id)
          * @request PATCH:/api/users/{id}/role
+         * @deprecated
+         * @secure
          * @response `200` `UsersControllerUpdateRoleData`
          */
-        usersControllerUpdateRole: (id: string, data: UpdateUserRoleDto, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
+        usersControllerUpdateRole: (id: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
         /**
          * No description
          *
+         * @tags users
          * @name UsersControllerUpdateProjects
+         * @summary Update user projects (deprecated - use PATCH /users/:id)
          * @request PATCH:/api/users/{id}/projects
+         * @deprecated
+         * @secure
          * @response `200` `UsersControllerUpdateProjectsData`
          */
-        usersControllerUpdateProjects: (id: string, data: UpdateUserProjectsDto, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
-        /**
-         * No description
-         *
-         * @name UsersControllerDeleteUser
-         * @request DELETE:/api/users/{id}
-         * @response `200` `UsersControllerDeleteUserData`
-         */
-        usersControllerDeleteUser: (id: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
+        usersControllerUpdateProjects: (id: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
         /**
          * No description
          *
+         * @tags users
          * @name UsersControllerResendInvitation
+         * @summary Resend invitation to pending user
          * @request POST:/api/users/{id}/resend-invitation
-         * @response `201` `UsersControllerResendInvitationData`
+         * @secure
+         * @response `200` `UsersControllerResendInvitationData` Invitation resent successfully
+         * @response `403` `void` Insufficient permissions
          */
         usersControllerResendInvitation: (id: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
         /**
          * No description
          *
+         * @tags users
          * @name UsersControllerGetProfile
+         * @summary Get current user profile
          * @request GET:/api/users/profile
+         * @secure
          * @response `200` `UsersControllerGetProfileData`
          */
         usersControllerGetProfile: (params?: RequestParams) => Promise<AxiosResponse<any, any>>;
         /**
          * No description
          *
+         * @tags users
          * @name UsersControllerUpdateProfile
+         * @summary Update current user profile
          * @request PATCH:/api/users/profile
+         * @secure
          * @response `200` `UsersControllerUpdateProfileData`
          */
         usersControllerUpdateProfile: (data: UpdateUserProfileDto, params?: RequestParams) => Promise<AxiosResponse<any, any>>;

package/lib/flagpole-api-types.js

@@ -230,104 +230,157 @@ class Api {
             /**
              * No description
              *
+             * @tags users
              * @name UsersControllerFindAll
+             * @summary Get all users in organization
              * @request GET:/api/users
-             * @response `200` `UsersControllerFindAllData`
+             * @secure
+             * @response `200` `UsersControllerFindAllData` Users retrieved successfully
              */
             usersControllerFindAll: (params = {}) => this.http.request({
                 path: `/api/users`,
                 method: "GET",
+                secure: true,
                 ...params,
             }),
             /**
              * No description
              *
+             * @tags users
              * @name UsersControllerInvite
+             * @summary Invite a new user to the organization
              * @request POST:/api/users/invite
-             * @response `201` `UsersControllerInviteData`
+             * @secure
+             * @response `201` `UsersControllerInviteData` User invited successfully
+             * @response `403` `void` Insufficient permissions
              */
             usersControllerInvite: (data, params = {}) => this.http.request({
                 path: `/api/users/invite`,
                 method: "POST",
                 body: data,
+                secure: true,
                 type: ContentType.Json,
                 ...params,
             }),
             /**
              * No description
              *
-             * @name UsersControllerUpdateRole
-             * @request PATCH:/api/users/{id}/role
-             * @response `200` `UsersControllerUpdateRoleData`
+             * @tags users
+             * @name UsersControllerUpdateUser
+             * @summary Update user role and projects
+             * @request PATCH:/api/users/{id}
+             * @secure
+             * @response `200` `UsersControllerUpdateUserData` User updated successfully
+             * @response `403` `void` Insufficient permissions
+             * @response `404` `void` User not found
              */
-            usersControllerUpdateRole: (id, data, params = {}) => this.http.request({
-                path: `/api/users/${id}/role`,
+            usersControllerUpdateUser: (id, data, params = {}) => this.http.request({
+                path: `/api/users/${id}`,
                 method: "PATCH",
                 body: data,
+                secure: true,
                 type: ContentType.Json,
                 ...params,
             }),
             /**
              * No description
              *
-             * @name UsersControllerUpdateProjects
-             * @request PATCH:/api/users/{id}/projects
-             * @response `200` `UsersControllerUpdateProjectsData`
+             * @tags users
+             * @name UsersControllerDeleteUser
+             * @summary Remove user from organization
+             * @request DELETE:/api/users/{id}
+             * @secure
+             * @response `200` `UsersControllerDeleteUserData` User removed successfully
+             * @response `403` `void` Insufficient permissions - only owners can remove users
              */
-            usersControllerUpdateProjects: (id, data, params = {}) => this.http.request({
-                path: `/api/users/${id}/projects`,
+            usersControllerDeleteUser: (id, params = {}) => this.http.request({
+                path: `/api/users/${id}`,
+                method: "DELETE",
+                secure: true,
+                ...params,
+            }),
+            /**
+             * No description
+             *
+             * @tags users
+             * @name UsersControllerUpdateRole
+             * @summary Update user role (deprecated - use PATCH /users/:id)
+             * @request PATCH:/api/users/{id}/role
+             * @deprecated
+             * @secure
+             * @response `200` `UsersControllerUpdateRoleData`
+             */
+            usersControllerUpdateRole: (id, params = {}) => this.http.request({
+                path: `/api/users/${id}/role`,
                 method: "PATCH",
-                body: data,
-                type: ContentType.Json,
+                secure: true,
                 ...params,
             }),
             /**
              * No description
              *
-             * @name UsersControllerDeleteUser
-             * @request DELETE:/api/users/{id}
-             * @response `200` `UsersControllerDeleteUserData`
+             * @tags users
+             * @name UsersControllerUpdateProjects
+             * @summary Update user projects (deprecated - use PATCH /users/:id)
+             * @request PATCH:/api/users/{id}/projects
+             * @deprecated
+             * @secure
+             * @response `200` `UsersControllerUpdateProjectsData`
              */
-            usersControllerDeleteUser: (id, params = {}) => this.http.request({
-                path: `/api/users/${id}`,
-                method: "DELETE",
+            usersControllerUpdateProjects: (id, params = {}) => this.http.request({
+                path: `/api/users/${id}/projects`,
+                method: "PATCH",
+                secure: true,
                 ...params,
             }),
             /**
              * No description
              *
+             * @tags users
              * @name UsersControllerResendInvitation
+             * @summary Resend invitation to pending user
              * @request POST:/api/users/{id}/resend-invitation
-             * @response `201` `UsersControllerResendInvitationData`
+             * @secure
+             * @response `200` `UsersControllerResendInvitationData` Invitation resent successfully
+             * @response `403` `void` Insufficient permissions
              */
             usersControllerResendInvitation: (id, params = {}) => this.http.request({
                 path: `/api/users/${id}/resend-invitation`,
                 method: "POST",
+                secure: true,
                 ...params,
             }),
             /**
              * No description
              *
+             * @tags users
              * @name UsersControllerGetProfile
+             * @summary Get current user profile
              * @request GET:/api/users/profile
+             * @secure
              * @response `200` `UsersControllerGetProfileData`
              */
             usersControllerGetProfile: (params = {}) => this.http.request({
                 path: `/api/users/profile`,
                 method: "GET",
+                secure: true,
                 ...params,
             }),
             /**
              * No description
              *
+             * @tags users
              * @name UsersControllerUpdateProfile
+             * @summary Update current user profile
              * @request PATCH:/api/users/profile
+             * @secure
              * @response `200` `UsersControllerUpdateProfileData`
              */
             usersControllerUpdateProfile: (data, params = {}) => this.http.request({
                 path: `/api/users/profile`,
                 method: "PATCH",
                 body: data,
+                secure: true,
                 type: ContentType.Json,
                 ...params,
             }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flagpole/api-types",
-  "version": "1.0.13",
+  "version": "1.0.16",
   "description": "TypeScript types for FlagPole API",
   "main": "index.js",
   "types": "index.d.ts",