Class DepartmentsService

Departments service

Hierarchy

DepartmentsService

Index

Constructors

Properties

httpClient namespace

Methods

addUsersToDepartment createDepartment deleteDepartment deleteUsersFromDepartment getDepartmentById getDepartments updateDepartment updateDepartmentRolesById

Constructors

constructor

new DepartmentsService(httpClient): DepartmentsService
Parameters
- httpClient: HttpClient
Returns DepartmentsService

Properties

`Private` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/company/v1/departments'

Methods

addUsersToDepartment

addUsersToDepartment(id, users): Promise<AxiosResponse<IDepartment, any>>
Update department roles by id
Parameters
- id: string
  
  departament ID
- users: string[]
  
  users ids
Returns Promise<AxiosResponse<IDepartment, any>>

createDepartment

createDepartment(body): Promise<AxiosResponse<IDepartment, any>>
Create department
Parameters
- body: ICreateDepartmentDto
Returns Promise<AxiosResponse<IDepartment, any>>

deleteDepartment

deleteDepartment(id): Promise<AxiosResponse<IDepartment, any>>
Delete department.
Parameters
- id: string
  
  departament ID
Returns Promise<AxiosResponse<IDepartment, any>>

deleteUsersFromDepartment

deleteUsersFromDepartment(id, users): Promise<AxiosResponse<IDepartment, any>>
Update department roles by id
Parameters
- id: string
  
  departament ID
- users: string[]
  
  users ids
Returns Promise<AxiosResponse<IDepartment, any>>

getDepartmentById

getDepartmentById(id): Promise<AxiosResponse<IDepartment, any>>
Get department by id
Parameters
- id: string
  
  department id
Returns Promise<AxiosResponse<IDepartment, any>>
departament

getDepartments

getDepartments(page?, list?, show?): Promise<AxiosResponse<IResponseWithMeta<IDepartment>, any>>
Get departments list
Parameters
- Optional page: number
  
  page number
- Optional list: number
  
  elements count
- Optional show: "all"
  
  get list of with unactive departments (available only for admin or owner)
Returns Promise<AxiosResponse<IResponseWithMeta<IDepartment>, any>>
Array departments
getDepartments(page?, list?, show?): Promise<AxiosResponse<IDepartment[], any>>
Parameters
- Optional page: number
- Optional list: "all"
- Optional show: "all"
Returns Promise<AxiosResponse<IDepartment[], any>>

updateDepartment

updateDepartment(id, body): Promise<AxiosResponse<IDepartment, any>>
Update department data (set head department, move users, set parent department)
Parameters
- id: number
  
  department ID
- body: IUpdateDepartmentDto
  
  department data
Returns Promise<AxiosResponse<IDepartment, any>>
updated department data

updateDepartmentRolesById

updateDepartmentRolesById(id, roles): Promise<AxiosResponse<IDepartment, any>>
Update department roles by id
Parameters
- id: string
  
  departament ID
- roles: string[]
  
  roles
Returns Promise<AxiosResponse<IDepartment, any>>

Deprecated

Generated using TypeDoc