import Client from 'spaceinvoices-js-sdk/src/modules/client.js'

public class | source

Client

Extends:

BaseModule → Client

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	TransformModel: *

Method Summary

Public Methods
public	create(organizationId: string, data: object): Promise<MClient, APIError>
public	delete(clientId: string): Promise<MClient, APIError>
public	get(clientId: *): Promise<MClient, APIError>
public	list(organizationId: *): Promise<MClient[], APIError>
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	TransformModel: *
public	call(endpoint: string, data: object \| FilterBuilder, method: string, autoTransform: boolean): 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:

Name	Type	Attribute	Description
organizationId	string
data	object

Return:

Promise<MClient, APIError>

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

Params:

Name	Type	Attribute	Description
clientId	string

Return:

Promise<MClient, APIError>

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

Params:

Name	Type	Attribute	Description
clientId	*

Return:

Promise<MClient, APIError>

public list(organizationId: *): Promise<MClient[], APIError> source

Params:

Name	Type	Attribute	Description
organizationId	*

Return:

Promise<MClient[], APIError>

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

Params:

Name	Type	Attribute	Description
organizationId	string
term	string

Return:

Promise<MClient[], ResponseError|ServerError>

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

Params:

Name	Type	Attribute	Description
clientId	string
data	object

Return:

Promise<MClient, APIError>