Subsections of organization_manufacturer

Manufacturer Finder

This class allows making GET requests to the hardware manufacturers resource in the OpenGate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

administrable()

Marks visibility administrable for manufacturer list retrieval

Retorna

Tip

Tipo: this

assignable()

Marks visibility assignable for manufacturer list retrieval

Retorna

Tip

Tipo: this

findByOrganization(organization)

Retrieves all manufacturer from a organization

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ organization name .

Retorna

Tip

Tipo: Promise

findByOrganizationAndId(organization, identifier)

Retrieves a specific manufacturer

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ organization name .
identifier string ❌ manufacturer name .

Retorna

Tip

Tipo: Promise

Manufacturers

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

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

withAddress(address)

Set the address attribute

Parámetros

Nombre Tipo Opcional Descripción
address string ❌

Retorna

Tip

Tipo: Manufacturers

withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌ required field

Retorna

Tip

Tipo: Manufacturers

withEmail(email)

Set the email attribute

Parámetros

Nombre Tipo Opcional Descripción
email string ❌

Retorna

Tip

Tipo: Manufacturers

withFax(fax)

Set the fax attribute

Parámetros

Nombre Tipo Opcional Descripción
fax string ❌

Retorna

Tip

Tipo: Manufacturers

withIdentifier(id)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ required field

Retorna

Tip

Tipo: Manufacturers

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: Manufacturers

withNotes(notes)

Set the notes attribute

Parámetros

Nombre Tipo Opcional Descripción
notes string ❌

Retorna

Tip

Tipo: Manufacturers

withTelephone(telephone)

Set the telephone attribute

Parámetros

Nombre Tipo Opcional Descripción
telephone string ❌

Retorna

Tip

Tipo: Manufacturers

withUrl(url)

Set the url attribute

Parámetros

Nombre Tipo Opcional Descripción
url string ❌

Retorna

Tip

Tipo: Manufacturers

Model Finder

This class allows making GET requests to the hardware models resource in the OpenGate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

findByOrganizationAndManufacturerAndId(organization, manufacturer, identifier)

Download a specific model by its id. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ model organization .
manufacturer string ❌ model manufacturer .
identifier string ❌ model name .

Retorna

Tip

Tipo: Promise

Models

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

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌ required field

Retorna

Tip

Tipo: Models

withIdentifier(id)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ required field

Retorna

Tip

Tipo: Models

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: Models

withNotes(notes)

Set the notes attribute

Parámetros

Nombre Tipo Opcional Descripción
notes string ❌

Retorna

Tip

Tipo: Models

withUrl(url)

Set the url attribute

Parámetros

Nombre Tipo Opcional Descripción
url string ❌

Retorna

Tip

Tipo: Models

withVersion(version)

Set the version attribute

Parámetros

Nombre Tipo Opcional Descripción
version string ❌

Retorna

Tip

Tipo: Models