Class CompaniesService

The companies service

extends: {BaseService}

Hierarchy

BaseService
- CompaniesService

Index

Constructors

constructor

Methods

Constructors

constructor

new CompaniesService(httpClient: HttpClient, authService: AuthService): CompaniesService

Inherited from BaseService.constructor
- Defined in app/services/base.service.ts:13
Inject all deps

Parameters
- httpClient: HttpClient
  
  The http client
- authService: AuthService
  
  The authentication service
Returns CompaniesService

Methods

create

create(company: Company): Promise<ApiResponseDto<Company>>

- Defined in app/services/companies.service.ts:27
Create a new company

Parameters
- company: Company
  
  The new company to create
Returns Promise<ApiResponseDto<Company>>

Protected deleteVerb

deleteVerb(path: string): Promise<any>

Inherited from BaseService.deleteVerb
- Defined in app/services/base.service.ts:75
Make a DELETE request to the specified path

Parameters
- path: string
  
  The path
Returns Promise<any>

getById

getById(id: string): Promise<ApiResponseDto<Company>>

- Defined in app/services/companies.service.ts:36
Return a company by id

Parameters
- id: string
  
  The company identifier
Returns Promise<ApiResponseDto<Company>>

getByOwnerId

getByOwnerId(ownerId: string): Promise<ApiResponseDto<Array<Company>>>

- Defined in app/services/companies.service.ts:18
Return all the companies of which the given id is a owner

Parameters
- ownerId: string
  
  The owner identifier
Returns Promise<ApiResponseDto<Array<Company>>>

Protected getVerb

getVerb(path: string, options?: any): Promise<any>

Inherited from BaseService.getVerb
- Defined in app/services/base.service.ts:60
Make a GET request to the specified path

Parameters
- path: string
  
  The path
- Optional options: any
Returns Promise<any>

Protected postVerb

postVerb(path: string, body: any): Promise<any>

Inherited from BaseService.postVerb
- Defined in app/services/base.service.ts:44
Make a POST request to the specified path

Parameters
- path: string
  
  The path
- body: any
  
  The request body
Returns Promise<any>

Protected postVerbObservable

postVerbObservable(path: string, body: any): Observable<any>

Inherited from BaseService.postVerbObservable
- Defined in app/services/base.service.ts:48
Parameters
- path: string
- body: any
Returns Observable<any>

Protected putVerb

putVerb(path: string, body: any): Promise<any>

Inherited from BaseService.putVerb
- Defined in app/services/base.service.ts:31
Make a PUT request to the specified path

Parameters
- path: string
  
  The path
- body: any
  
  The request body
Returns Promise<any>

update

update(company: Company): Promise<ApiResponseDto<Company>>

- Defined in app/services/companies.service.ts:45
Update an existing company

Parameters
- company: Company
  
  The company to update
Returns Promise<ApiResponseDto<Company>>

Generated using TypeDoc