Subsections of plan

Device Plans

This is a base object that contains everything you can do with device plans.

constructor

Parámetros

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

withFlowRate(flowRate)

Set the flowRate attribute

Parámetros

Nombre Tipo Opcional Descripción
flowRate object ❌ {value: number, unit: [SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS]}

Retorna

Tip

Tipo: OrganizationPlans

withIdentifier(identifier)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌ required field

Retorna

Tip

Tipo: DevicePlans

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: DevicePlans

Device Plans Finder

This class allows making GET requests to the organization device plans resource in the OpenGate North API.

constructor

Parámetros

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

administrable()

Marks visibility administrable for organization device plans list retrieval. ogapi.newDevicePlansFinder().administrable().findByOrganization('organization').then().catch();

Retorna

Tip

Tipo: this

assignable()

Marks visibility assignable for organization device plans list retrieval ogapi.newDevicePlansFinder().assignable().findByOrganization('organization').then().catch();

Retorna

Tip

Tipo: this

default()

Marks visibility default for organization device plans list list retrieval. ogapi.newDevicePlansFinder().default().findByOrganization('organization').then().catch();

Retorna

Tip

Tipo: this

findByOrganization(organization)

Retrieves all device plans from a organization ogapi.newDevicePlansFinder().findByOrganization('organization').then().catch();

Parámetros

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

Retorna

Tip

Tipo: Promise

findByOrganizationAndId(organization, identifier)

Retrieves a specific device plan from a organization ogapi.newDevicePlansFinder().findByOrganizationAndId('organization', 'identifier').then().catch();

Parámetros

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

Retorna

Tip

Tipo: Promise

Organization Plans

This is a base object that contains everything you can do with organization plans.

constructor

Parámetros

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

withFlowRate(flowRate)

Set the flowRate attribute

Parámetros

Nombre Tipo Opcional Descripción
flowRate object ❌ {value: number, unit: [SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS]}

Retorna

Tip

Tipo: OrganizationPlans

withIdentifier(identifier)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌ required field

Retorna

Tip

Tipo: OrganizationPlans

withMaxDeviceAmount(maxDeviceAmount)

Set the maxDeviceAmount attribute

Parámetros

Nombre Tipo Opcional Descripción
maxDeviceAmount object ❌ optional and greater than 0

Retorna

Tip

Tipo: OrganizationPlans

withMaxStorageLifeTime(maxStorageLifeTime)

Set the maxStorageLifeTime attribute

Parámetros

Nombre Tipo Opcional Descripción
maxStorageLifeTime object ❌ required field: {total: number, period: [SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS]}

Retorna

Tip

Tipo: OrganizationPlans

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: OrganizationPlans

Organization Plans Finder

This class allows making GET requests to the organization plans resource in the OpenGate North API.

constructor

Parámetros

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

administrable()

Marks visibility administrable for organization plans list retrieval. ogapi.newOrganizationPlansFinder().administrable().findByOrganization('organization').then().catch();

Retorna

Tip

Tipo: this

assignable()

Marks visibility assignable for organization plans list retrieval ogapi.newOrganizationPlansFinder().assignable().findByOrganization('organization').then().catch();

Retorna

Tip

Tipo: this

default()

Marks visibility default for plans list list retrieval. ogapi.newOrganizationPlansFinder().default().findByOrganization('organization').then().catch();

Retorna

Tip

Tipo: this

findByOrganization(organization)

Retrieves all plans from a organization ogapi.newOrganizationPlansFinder().findByOrganization('organization').then().catch();

Parámetros

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

Retorna

Tip

Tipo: Promise

findByOrganizationAndId(organization, identifier)

Retrieves a specific plan from a organization ogapi.newOrganizationPlansFinder().findByOrganizationAndId('organization', 'identifier').then().catch();

Parámetros

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

Retorna

Tip

Tipo: Promise