import Document from 'spaceinvoices-js-sdk/src/modules/document.js'

public class | source

Document

Extends:

BaseModule → Document

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	TransformModel: *

Method Summary

Public Methods
public	create(organizationId: string, data: object): Promise<MDocument>
public	delete(documentId: string): Promise<MDocument>
public	get(documentId: *): Promise<MDocument>
public	list(organizationId: *, transform: boolean): Promise<MDocument[]>
public	payments(documentId: string): Promise<MPayment>
public	update(documentId: string, data: object): Promise<MDocument>

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<MDocument> source

Params:

Name	Type	Attribute	Description
organizationId	string
data	object

Return:

Promise<MDocument>

public delete(documentId: string): Promise<MDocument> source

Params:

Name	Type	Attribute	Description
documentId	string

Return:

Promise<MDocument>

public get(documentId: *): Promise<MDocument> source

Params:

Name	Type	Attribute	Description
documentId	*

Return:

Promise<MDocument>

public list(organizationId: *, transform: boolean): Promise<MDocument[]> source

Params:

Name	Type	Attribute	Description
organizationId	*
transform	boolean	optional default: true

Return:

Promise<MDocument[]>

public payments(documentId: string): Promise<MPayment> source

Params:

Name	Type	Attribute	Description
documentId	string

Return:

Promise<MPayment>

public update(documentId: string, data: object): Promise<MDocument> source

Params:

Name	Type	Attribute	Description
documentId	string
data	object

Return:

Promise<MDocument>