Class GroupsService

Groups service

Hierarchy

GroupsService

Constructors

constructor

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

Properties

`Private` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/groups/v1/groups'

`Private` namespaceTransferGroups

namespaceTransferGroups: string = '/groups/v1/transfers'

`Private` namespacev1

namespacev1: string = '/groups/v1'

Methods

acceptUserInviteRequest

acceptUserInviteRequest(id, userId): Promise<AxiosResponse<any, any>>
Accept users invite request
Parameters
- id: string
  
  group id
- userId: number
  
  user id
Returns Promise<AxiosResponse<any, any>>

checkIfUserSendJoinRequest

checkIfUserSendJoinRequest(groupId, userId): Promise<AxiosResponse<any, any>>
Decline users invite request
Parameters
- groupId: string
  
  group id
- userId: number
  
  user id
Returns Promise<AxiosResponse<any, any>>

createGroup

createGroup(body): Promise<AxiosResponse<any, any>>
Create group
Parameters
- body: IGroupDto
Returns Promise<AxiosResponse<any, any>>

deleteGroup

deleteGroup(id): Promise<AxiosResponse<IGroup, any>>
Delete group
Parameters
- id: number
  
  group id
Returns Promise<AxiosResponse<IGroup, any>>

editGroup

editGroup(body): Promise<AxiosResponse<IGroup, any>>
Edit group
Parameters
- body: IGroupDto
Returns Promise<AxiosResponse<IGroup, any>>

getGroup

getGroup(id): Promise<AxiosResponse<IGroup, any>>
Get group item
Parameters
- id: string
  
  group id
Returns Promise<AxiosResponse<IGroup, any>>
Group entity

getGroupForTask

getGroupForTask(id): Promise<AxiosResponse<IGroup, any>>
Get group for task item
Parameters
- id: string
  
  group id
Returns Promise<AxiosResponse<IGroup, any>>
Group entity

getGroups

getGroups(page?, list?, userId?, q?): Promise<AxiosResponse<IResponseWithMeta<IGroup>, any>>
Get groups
Parameters
- Optional page: number
  
  group page number
- Optional list: number
  
  group list number
- Optional userId: number
  
  group user id
- Optional q: string
Returns Promise<AxiosResponse<IResponseWithMeta<IGroup>, any>>
Groups entities array

getTransferGroupsQuantity

getTransferGroupsQuantity(body): Promise<AxiosResponse<ITransferGroupsData, any>>
Transfer groups quantity
Parameters
- body: Partial<ITransferGroupsData>
Returns Promise<AxiosResponse<ITransferGroupsData, any>>
transfer groups quantity

getUsersRequestedForJoing

getUsersRequestedForJoing(id): Promise<AxiosResponse<any, any>>
Join the group
Parameters
- id: string
  
  group id
Returns Promise<AxiosResponse<any, any>>

inviteUsersInGroup

inviteUsersInGroup(body): Promise<AxiosResponse<any, any>>
Invite users group
Parameters
- body: IInviteUsersDto
  
  invite users Dto
Returns Promise<AxiosResponse<any, any>>

joinGroup

joinGroup(id): Promise<AxiosResponse<any, any>>
Join the group
Parameters
- id: string
  
  group id
Returns Promise<AxiosResponse<any, any>>

leaveGroup

leaveGroup(id): Promise<AxiosResponse<any, any>>
Leave from the group
Parameters
- id: string
  
  group id
Returns Promise<AxiosResponse<any, any>>

rejectUserInviteRequest

rejectUserInviteRequest(id, userId): Promise<AxiosResponse<any, any>>
Decline users invite request
Parameters
- id: string
  
  group id
- userId: number
  
  user id
Returns Promise<AxiosResponse<any, any>>

transferGroups

transferGroups(body): Promise<AxiosResponse<ITransferGroupsData, any>>
Transfer groups
Parameters
- body: Partial<ITransferGroupsData>
Returns Promise<AxiosResponse<ITransferGroupsData, any>>
transfer groups quantity

uploadLogo

uploadLogo(id, logo?): Promise<AxiosResponse<any, any>>
Decline users invite request
Parameters
- id: string
  
  group id
- Optional logo: File
  
  logo File
Returns Promise<AxiosResponse<any, any>>

userApplyToJoinGroup

userApplyToJoinGroup(id): Promise<AxiosResponse<any, any>>
User apply to join to the group
Parameters
- id: string
  
  user id
Returns Promise<AxiosResponse<any, any>>

Generated using TypeDoc