Home Reference Source
public class | source

Client

You can directly use an instance of this class. client

Extends:

BaseModule → Client

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

Method Summary

Public Methods
public

create(organizationId: string, data: object): Promise<MClient, APIError>

public
public

get(clientId: *): Promise<MClient, APIError>

public

list(organizationId: *): Promise<MClient[], ResponseError|ServerError>

public

search(organizationId: string, term: string): Promise<MClient[], ResponseError|ServerError>

public

update(clientId: string, data: object): Promise<MClient, APIError>

Inherited Summary

From class BaseModule
public
public

call(endpoint: string, data: object | FilterBuilder, method: string): Promise

private

_transform(data: *): *

Public Constructors

public constructor() source

Override:

BaseModule#constructor

Public Members

public TransformModel: * source

Override:

BaseModule#TransformModel

Public Methods

public create(organizationId: string, data: object): Promise<MClient, APIError> source

Params:

NameTypeAttributeDescription
organizationId string
data object

Return:

Promise<MClient, APIError>

public delete(clientId: string): Promise<MClient, APIError> source

Params:

NameTypeAttributeDescription
clientId string

Return:

Promise<MClient, APIError>

public get(clientId: *): Promise<MClient, APIError> source

Params:

NameTypeAttributeDescription
clientId *

Return:

Promise<MClient, APIError>

public list(organizationId: *): Promise<MClient[], ResponseError|ServerError> source

Params:

NameTypeAttributeDescription
organizationId *

Return:

Promise<MClient[], ResponseError|ServerError>

Params:

NameTypeAttributeDescription
organizationId string
term string

Return:

Promise<MClient[], ResponseError|ServerError>

public update(clientId: string, data: object): Promise<MClient, APIError> source

Params:

NameTypeAttributeDescription
clientId string
data object

Return:

Promise<MClient, APIError>