Class DomainWebService

Hierarchy

BaseModelWebService<Domain, DomainSchema>
- DomainWebService

Implements

BaseModelWebServiceIntf<Domain, DomainSchema>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DomainWebService(options: DomainWebServiceOptions): DomainWebService

Overrides BaseModelWebService.constructor
- Defined in services/DomainWebService.ts:24
Parameters
- options: DomainWebServiceOptions
Returns DomainWebService

Properties

Protected http

http: Http

Protected options

options: BaseModelWebServiceOptions

Static Protected instance

instance: DomainWebService

Methods

create

create(domain: DomainSchema): Promise<Domain>

- Defined in services/DomainWebService.ts:118
Create a new Domain.

Parameters
- domain: DomainSchema
  
  The Domain schema.
Returns Promise<Domain>

delete

delete(id: string): Promise<boolean>

Implementation of BaseModelWebServiceIntf.delete
- Defined in services/DomainWebService.ts:149
Delete a Domain.

Parameters
- id: string
  
  The Domain ID.
Returns Promise<boolean>

findAll

findAll(pagination: Pagination): Promise<PaginatedArray<Domain>>

Implementation of BaseModelWebServiceIntf.findAll
- Defined in services/DomainWebService.ts:42
Find all Domains.

Parameters
- pagination: Pagination
Returns Promise<PaginatedArray<Domain>>

findConsumersById

findConsumersById(id: string): Promise<User[]>

- Defined in services/DomainWebService.ts:88
Find the Users with role Consumer from a Domain.

Parameters
- id: string
  
  The Domain ID.
Returns Promise<User[]>

findMediatorsById

findMediatorsById(id: string): Promise<User[]>

- Defined in services/DomainWebService.ts:103
Find the Users with role Mediator from a Domain.

Parameters
- id: string
  
  The Domain ID.
Returns Promise<User[]>

findOne

findOne(id: string): Promise<Domain>

Overrides BaseModelWebService.findOne
- Defined in services/DomainWebService.ts:60
Find a Domain.

Parameters
- id: string
  
  The Domain ID.
Returns Promise<Domain>

findRootDomain

findRootDomain(): Promise<Domain>

- Defined in services/DomainWebService.ts:73
Find the Root Domain.

Returns Promise<Domain>

getActiveUserCountMetrics

getActiveUserCountMetrics(id: string, options?: DomainMetricsOptions): Promise<CountMetricsResponse[]>

- Defined in services/DomainWebService.ts:197
Gets the cumulative count of active users grouped by time

Parameters
- id: string
- Optional options: DomainMetricsOptions
Returns Promise<CountMetricsResponse[]>

getBalanceMetrics

getBalanceMetrics(id: string, options?: DomainMetricsOptions): Promise<TotalMetricsResponse[]>

- Defined in services/DomainWebService.ts:213
Gets the cumulative balance grouped by time

Parameters
- id: string
- Optional options: DomainMetricsOptions
Returns Promise<TotalMetricsResponse[]>

getPaymentsAmountMetrics

getPaymentsAmountMetrics(id: string, options?: DomainMetricsOptions): Promise<TotalMetricsResponse[]>

- Defined in services/DomainWebService.ts:165
Gets the cumulative sum of payment amounts grouped by time

Parameters
- id: string
- Optional options: DomainMetricsOptions
Returns Promise<TotalMetricsResponse[]>

getPaymentsCountMetrics

getPaymentsCountMetrics(id: string, options?: DomainMetricsOptions): Promise<CountMetricsResponse[]>

- Defined in services/DomainWebService.ts:181
Gets the cumulative count of payment amounts grouped by time

Parameters
- id: string
- Optional options: DomainMetricsOptions
Returns Promise<CountMetricsResponse[]>

update

update(id: string, domain: Partial<DomainSchema>): Promise<Domain>

Implementation of BaseModelWebServiceIntf.update
- Defined in services/DomainWebService.ts:134
Partially update an existing Domain.

Parameters
- id: string
  
  The Domain ID.
- domain: Partial<DomainSchema>
  
  The partial Domain schema.
Returns Promise<Domain>

Static getInstance

getInstance(): DomainWebService

- Defined in services/DomainWebService.ts:30
Returns DomainWebService

Static initialize

initialize(options: DomainWebServiceOptions): DomainWebService

- Defined in services/DomainWebService.ts:34
Parameters
- options: DomainWebServiceOptions
Returns DomainWebService

Generated using TypeDoc