import DevicePlans from 'opengate-js/src/plan/DevicePlans.js'

public class | source

DevicePlans

BaseProvision → DevicePlans

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

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI)

Public Methods
public	withFlowRate(flowRate: object): OrganizationPlans Set the flowRate attribute
public	withIdentifier(identifier: string): DevicePlans Set the identifier attribute
public	withName(name: string): DevicePlans Set the name attribute

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

Constructor

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Set the flowRate attribute

Name	Type	Attribute	Description
flowRate	object		{value: number, unit: [SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS]}

Set the identifier attribute

Name	Type	Attribute	Description
identifier	string		required field

Set the name attribute

Name	Type	Attribute	Description
name	string		required field