@teemill/projects 1.4.0 → 1.5.0

package/src/apis/ProjectsApi.ts

@@ -4,7 +4,7 @@
  * Projects API
  * Manage Teemill Projects  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
  *
- * The version of the OpenAPI document: 1.4.0
+ * The version of the OpenAPI document: 1.5.0
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,38 +16,75 @@
 import * as runtime from '../runtime';
 import type {
   ApiError,
+  CreateInviteRequest,
   CreateProjectRequest,
+  CreateUserRequest,
   Integration,
   IntegrationsResponse,
   Project,
+  ProjectInvites,
+  ProjectUser,
+  ProjectUsers,
   ProjectsResponse,
   UpdateProjectRequest,
+  UpdateUserRequest,
 } from '../models/index';
 import {
     ApiErrorFromJSON,
     ApiErrorToJSON,
+    CreateInviteRequestFromJSON,
+    CreateInviteRequestToJSON,
     CreateProjectRequestFromJSON,
     CreateProjectRequestToJSON,
+    CreateUserRequestFromJSON,
+    CreateUserRequestToJSON,
     IntegrationFromJSON,
     IntegrationToJSON,
     IntegrationsResponseFromJSON,
     IntegrationsResponseToJSON,
     ProjectFromJSON,
     ProjectToJSON,
+    ProjectInvitesFromJSON,
+    ProjectInvitesToJSON,
+    ProjectUserFromJSON,
+    ProjectUserToJSON,
+    ProjectUsersFromJSON,
+    ProjectUsersToJSON,
     ProjectsResponseFromJSON,
     ProjectsResponseToJSON,
     UpdateProjectRequestFromJSON,
     UpdateProjectRequestToJSON,
+    UpdateUserRequestFromJSON,
+    UpdateUserRequestToJSON,
 } from '../models/index';
 
+export interface AcceptInviteRequest {
+    project: string;
+}
+
+export interface CreateInviteOperationRequest {
+    project: string;
+    createInviteRequest: CreateInviteRequest;
+}
+
 export interface CreateProjectOperationRequest {
     createProjectRequest: CreateProjectRequest;
 }
 
+export interface CreateUserOperationRequest {
+    project: string;
+    createUserRequest: CreateUserRequest;
+}
+
 export interface DeleteProjectRequest {
     project: string;
 }
 
+export interface DeleteUserRequest {
+    project: string;
+    user: string;
+}
+
 export interface GetIntegrationRequest {
     project: string;
     integration: string;
@@ -57,10 +94,28 @@ export interface GetIntegrationsRequest {
     project: string;
 }
 
+export interface GetInviteTokenRequest {
+    project: string;
+    token: string;
+}
+
+export interface GetInvitesRequest {
+    project: string;
+}
+
 export interface GetProjectRequest {
     project: string;
 }
 
+export interface GetUserRequest {
+    project: string;
+    user: string;
+}
+
+export interface GetUsersRequest {
+    project: string;
+}
+
 export interface InstallIntegrationRequest {
     project: string;
     integration: string;
@@ -81,11 +136,120 @@ export interface UpdateProjectOperationRequest {
     updateProjectRequest: UpdateProjectRequest;
 }
 
+export interface UpdateUserOperationRequest {
+    project: string;
+    user: string;
+    updateUserRequest: UpdateUserRequest;
+}
+
 /**
  * 
  */
 export class ProjectsApi extends runtime.BaseAPI {
 
+    /**
+     * accepts an invite to the project
+     * accepts an invite
+     */
+    async acceptInviteRaw(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling acceptInvite.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/projects/{project}/invites/accept`.replace(`{${"project"}}`, encodeURIComponent(String(requestParameters.project))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * accepts an invite to the project
+     * accepts an invite
+     */
+    async acceptInvite(
+        project: string, 
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<void> {
+        await this.acceptInviteRaw(
+            {
+                project: project,
+            },
+            initOverrides
+        );
+    }
+
+    /**
+     * creates an invite for the project
+     * creates an invite
+     */
+    async createInviteRaw(requestParameters: CreateInviteOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling createInvite.');
+        }
+
+        if (requestParameters.createInviteRequest === null || requestParameters.createInviteRequest === undefined) {
+            throw new runtime.RequiredError('createInviteRequest','Required parameter requestParameters.createInviteRequest was null or undefined when calling createInvite.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/projects/{project}/invites`.replace(`{${"project"}}`, encodeURIComponent(String(requestParameters.project))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateInviteRequestToJSON(requestParameters.createInviteRequest),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * creates an invite for the project
+     * creates an invite
+     */
+    async createInvite(
+        project: string, createInviteRequest: CreateInviteRequest, 
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<void> {
+        await this.createInviteRaw(
+            {
+                project: project,createInviteRequest: createInviteRequest,
+            },
+            initOverrides
+        );
+    }
+
     /**
      * Create a new projects
      * Create project
@@ -131,7 +295,64 @@ export class ProjectsApi extends runtime.BaseAPI {
     ): Promise<Project> {
         const response = await this.createProjectRaw(
             {
-                createProjectRequest: createProjectRequest
+                createProjectRequest: createProjectRequest,
+            },
+            initOverrides
+        );
+
+        return await response.value();
+    }
+
+    /**
+     * Create a new project user
+     * Create project user
+     */
+    async createUserRaw(requestParameters: CreateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectUser>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling createUser.');
+        }
+
+        if (requestParameters.createUserRequest === null || requestParameters.createUserRequest === undefined) {
+            throw new runtime.RequiredError('createUserRequest','Required parameter requestParameters.createUserRequest was null or undefined when calling createUser.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/projects/{project}/users`.replace(`{${"project"}}`, encodeURIComponent(String(requestParameters.project))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateUserRequestToJSON(requestParameters.createUserRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProjectUserFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new project user
+     * Create project user
+     */
+    async createUser(
+        project: string, createUserRequest: CreateUserRequest, 
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<ProjectUser> {
+        const response = await this.createUserRaw(
+            {
+                project: project,createUserRequest: createUserRequest,
             },
             initOverrides
         );
@@ -181,7 +402,7 @@ export class ProjectsApi extends runtime.BaseAPI {
     ): Promise<Project> {
         const response = await this.deleteProjectRaw(
             {
-                project: project
+                project: project,
             },
             initOverrides
         );
@@ -189,6 +410,58 @@ export class ProjectsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Delete a project user by ID
+     * Delete a user by ID
+     */
+    async deleteUserRaw(requestParameters: DeleteUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling deleteUser.');
+        }
+
+        if (requestParameters.user === null || requestParameters.user === undefined) {
+            throw new runtime.RequiredError('user','Required parameter requestParameters.user was null or undefined when calling deleteUser.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/projects/{project}/users/{user}`.replace(`{${"project"}}`, encodeURIComponent(String(requestParameters.project))).replace(`{${"user"}}`, encodeURIComponent(String(requestParameters.user))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a project user by ID
+     * Delete a user by ID
+     */
+    async deleteUser(
+        project: string, user: string, 
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<void> {
+        await this.deleteUserRaw(
+            {
+                project: project,user: user,
+            },
+            initOverrides
+        );
+    }
+
     /**
      * Get an integration
      * Get integration
@@ -235,8 +508,7 @@ export class ProjectsApi extends runtime.BaseAPI {
     ): Promise<Integration> {
         const response = await this.getIntegrationRaw(
             {
-                project: project,
-                integration: integration
+                project: project,integration: integration,
             },
             initOverrides
         );
@@ -286,7 +558,109 @@ export class ProjectsApi extends runtime.BaseAPI {
     ): Promise<IntegrationsResponse> {
         const response = await this.getIntegrationsRaw(
             {
-                project: project
+                project: project,
+            },
+            initOverrides
+        );
+
+        return await response.value();
+    }
+
+    /**
+     * gets the invite token and sets it in the session. This is used to ensure the user accepting the invitation is the invited user.
+     * gets the invite token
+     */
+    async getInviteTokenRaw(requestParameters: GetInviteTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling getInviteToken.');
+        }
+
+        if (requestParameters.token === null || requestParameters.token === undefined) {
+            throw new runtime.RequiredError('token','Required parameter requestParameters.token was null or undefined when calling getInviteToken.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/projects/{project}/invites/{token}`.replace(`{${"project"}}`, encodeURIComponent(String(requestParameters.project))).replace(`{${"token"}}`, encodeURIComponent(String(requestParameters.token))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * gets the invite token and sets it in the session. This is used to ensure the user accepting the invitation is the invited user.
+     * gets the invite token
+     */
+    async getInviteToken(
+        project: string, token: string, 
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<void> {
+        await this.getInviteTokenRaw(
+            {
+                project: project,token: token,
+            },
+            initOverrides
+        );
+    }
+
+    /**
+     * List the invites associated with a project
+     * List Invites
+     */
+    async getInvitesRaw(requestParameters: GetInvitesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectInvites>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling getInvites.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/projects/{project}/invites`.replace(`{${"project"}}`, encodeURIComponent(String(requestParameters.project))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProjectInvitesFromJSON(jsonValue));
+    }
+
+    /**
+     * List the invites associated with a project
+     * List Invites
+     */
+    async getInvites(
+        project: string, 
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<ProjectInvites> {
+        const response = await this.getInvitesRaw(
+            {
+                project: project,
             },
             initOverrides
         );
@@ -336,7 +710,7 @@ export class ProjectsApi extends runtime.BaseAPI {
     ): Promise<Project> {
         const response = await this.getProjectRaw(
             {
-                project: project
+                project: project,
             },
             initOverrides
         );
@@ -388,6 +762,110 @@ export class ProjectsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Retrieve a project user by ID
+     * Retrieve a user by ID
+     */
+    async getUserRaw(requestParameters: GetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectUser>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling getUser.');
+        }
+
+        if (requestParameters.user === null || requestParameters.user === undefined) {
+            throw new runtime.RequiredError('user','Required parameter requestParameters.user was null or undefined when calling getUser.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/projects/{project}/users/{user}`.replace(`{${"project"}}`, encodeURIComponent(String(requestParameters.project))).replace(`{${"user"}}`, encodeURIComponent(String(requestParameters.user))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProjectUserFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a project user by ID
+     * Retrieve a user by ID
+     */
+    async getUser(
+        project: string, user: string, 
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<ProjectUser> {
+        const response = await this.getUserRaw(
+            {
+                project: project,user: user,
+            },
+            initOverrides
+        );
+
+        return await response.value();
+    }
+
+    /**
+     * List the users associated with a project
+     * List project users
+     */
+    async getUsersRaw(requestParameters: GetUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectUsers>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling getUsers.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/projects/{project}/users`.replace(`{${"project"}}`, encodeURIComponent(String(requestParameters.project))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProjectUsersFromJSON(jsonValue));
+    }
+
+    /**
+     * List the users associated with a project
+     * List project users
+     */
+    async getUsers(
+        project: string, 
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<ProjectUsers> {
+        const response = await this.getUsersRaw(
+            {
+                project: project,
+            },
+            initOverrides
+        );
+
+        return await response.value();
+    }
+
     /**
      * Install an integration on the project
      * Install integration
@@ -434,8 +912,7 @@ export class ProjectsApi extends runtime.BaseAPI {
     ): Promise<Integration> {
         const response = await this.installIntegrationRaw(
             {
-                project: project,
-                integration: integration
+                project: project,integration: integration,
             },
             initOverrides
         );
@@ -489,8 +966,7 @@ export class ProjectsApi extends runtime.BaseAPI {
     ): Promise<IntegrationsResponse> {
         const response = await this.installTemplateRaw(
             {
-                project: project,
-                template: template
+                project: project,template: template,
             },
             initOverrides
         );
@@ -542,7 +1018,12 @@ export class ProjectsApi extends runtime.BaseAPI {
         project: string, integration: string, 
         initOverrides?: RequestInit | runtime.InitOverrideFunction
     ): Promise<void> {
-        await this.uninstallIntegrationRaw({ project: project, integration: integration }, initOverrides);
+        await this.uninstallIntegrationRaw(
+            {
+                project: project,integration: integration,
+            },
+            initOverrides
+        );
     }
 
     /**
@@ -594,8 +1075,68 @@ export class ProjectsApi extends runtime.BaseAPI {
     ): Promise<Project> {
         const response = await this.updateProjectRaw(
             {
-                project: project,
-                updateProjectRequest: updateProjectRequest
+                project: project,updateProjectRequest: updateProjectRequest,
+            },
+            initOverrides
+        );
+
+        return await response.value();
+    }
+
+    /**
+     * Update a project user by ID
+     * Update a user by ID
+     */
+    async updateUserRaw(requestParameters: UpdateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectUser>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling updateUser.');
+        }
+
+        if (requestParameters.user === null || requestParameters.user === undefined) {
+            throw new runtime.RequiredError('user','Required parameter requestParameters.user was null or undefined when calling updateUser.');
+        }
+
+        if (requestParameters.updateUserRequest === null || requestParameters.updateUserRequest === undefined) {
+            throw new runtime.RequiredError('updateUserRequest','Required parameter requestParameters.updateUserRequest was null or undefined when calling updateUser.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/projects/{project}/users/{user}`.replace(`{${"project"}}`, encodeURIComponent(String(requestParameters.project))).replace(`{${"user"}}`, encodeURIComponent(String(requestParameters.user))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateUserRequestToJSON(requestParameters.updateUserRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ProjectUserFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a project user by ID
+     * Update a user by ID
+     */
+    async updateUser(
+        project: string, user: string, updateUserRequest: UpdateUserRequest, 
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<ProjectUser> {
+        const response = await this.updateUserRaw(
+            {
+                project: project,user: user,updateUserRequest: updateUserRequest,
             },
             initOverrides
         );