import Models from 'opengate-js/src/organization_manufacturer/Model.js'

public class | source

Models

Extends:

BaseProvision → Models

This is a base object that contains all you can do about Models.

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	deleteInCascade(): *
public	updateInCascade(): *
public	withDescription(description: string): Models Set the description attribute
public	withIdentifier(id: string): Models Set the identifier attribute
public	withName(name: string): Models Set the name attribute
public	withNotes(notes: string): Models Set the notes attribute
public	withUrl(url: string): Models Set the url attribute
public	withVersion(version: string): Models Set the version attribute

Inherited Summary

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

BaseProvision#constructor

Params:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public deleteInCascade(): * source

Return:

public updateInCascade(): * source

Return:

public withDescription(description: string): Models source

Set the description attribute

Params:

Name	Type	Attribute	Description
description	string		required field

Return:

Models

public withIdentifier(id: string): Models source

Set the identifier attribute

Params:

Name	Type	Attribute	Description
id	string		required field

Return:

Models

public withName(name: string): Models source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

Models

public withNotes(notes: string): Models source

Set the notes attribute

Params:

Name	Type	Attribute	Description
notes	string

Return:

Models

public withUrl(url: string): Models source

Set the url attribute

Params:

Name	Type	Attribute	Description
url	string

Return:

Models

public withVersion(version: string): Models source

Set the version attribute

Params:

Name	Type	Attribute	Description
version	string

Return:

Models