Class Account

Base class for all DataTrue resource types

Hierarchy

Constructors

Properties

allowanceResetAt?: Date
contextType: string = ""
name: string
options: ResourceOptions = {}
stepsTotal?: number
stepsUsed?: number
childTypes: readonly string[] = ...
resourceType: string = "account"
resourceTypeRun?: string

Methods

  • Set options from the passed options object

    Parameters

    • options: ResourceOptions

      the object to set options from

    • Optional override: boolean

      whether to override the options object

    Returns void

  • Convert the resource to an Object

    Returns

    object representation of the resource

    Returns Promise<Record<string, any>>

  • Convert the resource to a JSON string

    Returns

    the resource represented as a JSON string

    Returns Promise<string>

  • Create a resource from an object

    Returns

    new Resource

    Parameters

    • obj: Record<string, any>

      object to create resource from

    • copy: boolean = false

      whether to create a copy of the resource or not (removes resource IDs)

    Returns Account

Generated using TypeDoc