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

public class | source

OrganizationPlansFinder

Extends:

GenericFinder → ProvisionGenericFinder → OrganizationPlansFinder

This class allow make get request to organization plans resource into Opengate North API.

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI)

Method Summary

Public Methods
public	administrable(): this Marks visibility administrable for organization plans list retrieval.
public	assignable(): this Marks visibility assignable for organization plans list retrieval ogapi.newOrganizationPlansFinder().assignable().findByOrganization('organization').then().catch();
public	default(): this Marks visibility default for plans list list retrieval.
public	findByOrganization(organization: string): Promise Retrieves all plans from a organization ogapi.newOrganizationPlansFinder().findByOrganization('organization').then().catch();
public	findByOrganizationAndId(organization: string, identifier: string): Promise Retrieves a specific plan from a organization ogapi.newOrganizationPlansFinder().findByOrganizationAndId('organization', 'identifier').then().catch();

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

ProvisionGenericFinder#constructor

Params:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public administrable(): this source

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

Return:

this

public assignable(): this source

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

Return:

this

public default(): this source

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

Return:

this

public findByOrganization(organization: string): Promise source

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

Params:

Name	Type	Attribute	Description
organization	string		organization name .

Return:

Promise

public findByOrganizationAndId(organization: string, identifier: string): Promise source

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

Params:

Name	Type	Attribute	Description
organization	string		organization name .
identifier	string		plan name.

Return:

Promise