Home Manual Reference Source Test Repository
public class | source

TicketBuilder

Extends:

BaseProvisionSimpleBuilder → TicketBuilder

Subscription builder. This builder give you the necessary tools to create a subscription using our OpenGate REST.

Constructor Summary

Public Constructor
public

constructor(ogapi: InternalOpenGateAPI, organization: string, allowedDatastreams: array, definedSchemas: array, jsonSchemaValidator: Validator)

Constructor

Inherited Summary

From class BaseProvision
public

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

This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

From class SimpleBuilder
public

This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision

public
public
public

initFromFlattened(_flattenedEntityData: *)

public

initFromJson(_jsonEntityData: *)

public

This invoke a request to OpenGate North API and the callback is managed by promises This function patch a entity of provision

public

This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

public

with(_id: string, val: objecr): *

Set new datastream value

Public Constructors

public constructor(ogapi: InternalOpenGateAPI, organization: string, allowedDatastreams: array, definedSchemas: array, jsonSchemaValidator: Validator) source

Constructor

Override:

SimpleBuilder#constructor

Params:

NameTypeAttributeDescription
ogapi InternalOpenGateAPI
  • nullable: false

this is ogapi instance

organization string
  • nullable: false

this is the organization name where subscription will be created

allowedDatastreams array
  • optional
  • nullable: false

Allowed datastreams to add into the new subscription

definedSchemas array
  • optional
  • nullable: false

Jsonschema about all OpenGate specific types

jsonSchemaValidator Validator
  • optional
  • nullable: false

Json schema validator tool