Class DocumentWebService

Hierarchy

NestedModelWebService<Document, DocumentSchema>
- DocumentWebService

Implements

NestedModelWebServiceIntf<Document, DocumentSchema>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DocumentWebService(options: DocumentWebServiceOptions): DocumentWebService

Overrides NestedModelWebService.constructor
- Defined in services/DocumentWebService.ts:7
Parameters
- options: DocumentWebServiceOptions
Returns DocumentWebService

Properties

Protected http

http: Http

Protected options

options: DocumentWebServiceOptions

Static Protected instance

instance: DocumentWebService

Methods

create

create(userId: string, document: DocumentSchema): Promise<Document>

Overrides NestedModelWebService.create
- Defined in services/DocumentWebService.ts:65
Create a new Document in the platform.

Parameters
- userId: string
  
  The Consumer's User ID.
- document: DocumentSchema
  
  The Document schema.
Returns Promise<Document>

delete

delete(userId: string, documentId: string): Promise<boolean>

Implementation of NestedModelWebServiceIntf.delete

Overrides NestedModelWebService.delete
- Defined in services/DocumentWebService.ts:146
Delete an Document from the platform.

Parameters
- userId: string
  
  The Consumer's User ID.
- documentId: string
  
  The Document ID.
Returns Promise<boolean>

findAll

findAll(userId: string, pagination: Pagination): Promise<PaginatedArray<Document>>

Implementation of NestedModelWebServiceIntf.findAll

Overrides NestedModelWebService.findAll
- Defined in services/DocumentWebService.ts:29
Find all Documents from a Consumer. This method won't return pictures.

Parameters
- userId: string
  
  The Consumer's User ID.
- pagination: Pagination
  
  The pagination parameters.
Returns Promise<PaginatedArray<Document>>

findOne

findOne(userId: string, documentIdOrType: string): Promise<Document>

Implementation of NestedModelWebServiceIntf.findOne

Overrides NestedModelWebService.findOne
- Defined in services/DocumentWebService.ts:49
Find an Document based on it's ID or type. This method will return pictures.

Parameters
- userId: string
  
  The Consumer's User ID.
- documentIdOrType: string
Returns Promise<Document>

update

update(userId: string, documentId: string, document: Partial<DocumentSchema>): Promise<Document>

Implementation of NestedModelWebServiceIntf.update

Overrides NestedModelWebService.update
- Defined in services/DocumentWebService.ts:82
Partially update an existing Document.

Parameters
- userId: string
  
  The Consumer's User ID.
- documentId: string
  
  The Document ID.
- document: Partial<DocumentSchema>
  
  The partial Document schema.
Returns Promise<Document>

uploadPicture

uploadPicture(userId: string, type: DocumentType, side: "front" | "back" | "selfie", picture: File): Promise<Document>

- Defined in services/DocumentWebService.ts:100
Upload a new Document picture.

Parameters
- userId: string
  
  The Consumer's User id.
- type: DocumentType
  
  The Document type.
- side: "front" | "back" | "selfie"
  
  The Document picture side.
- picture: File
  
  The picture to be uploaded.
Returns Promise<Document>

uploadPictureFromBase64

uploadPictureFromBase64(userId: string, type: DocumentType, side: "front" | "back" | "selfie", picture: string): Promise<Document>

- Defined in services/DocumentWebService.ts:125
Upload a new Document picture.

Parameters
- userId: string
  
  The Consumer's User id.
- type: DocumentType
  
  The Document type.
- side: "front" | "back" | "selfie"
  
  The Document picture side.
- picture: string
  
  The base64 representation of the picture to be uploaded.
Returns Promise<Document>

Static getInstance

getInstance(): DocumentWebService

- Defined in services/DocumentWebService.ts:13
Returns DocumentWebService

Static initialize

initialize(options: DocumentWebServiceOptions): DocumentWebService

- Defined in services/DocumentWebService.ts:17
Parameters
- options: DocumentWebServiceOptions
Returns DocumentWebService

Generated using TypeDoc