@ironcode/vas-lib 1.0.0 → 1.0.2

package/lib/entity/vas-group.model.d.ts

@@ -13,6 +13,8 @@ export declare class VasGroupModel extends VasBaseModel {
     modified: string;
     serverModified: string;
     modifiedBy: string;
+    createdByName: string;
+    modifiedByName: string;
     account: string;
     accessGroup: string;
     name: string;
@@ -24,29 +26,8 @@ export declare class VasGroupModel extends VasBaseModel {
     visibilityControl: string;
     visibleIfEquals: string;
     controls: VasControlModel[];
-    weight: number;
-    /**
-     * @param {string} id
-     * @param {string} created
-     * @param {string} serverCreated
-     * @param {string} createdBy
-     * @param {string} modified
-     * @param {string} serverModified
-     * @param {string} modifiedBy
-     * @param {string} account
-     * @param {string} accessGroup
-     * @param {string} name
-     * @param {string} title
-     * @param {string} description
-     * @param {number} sequence
-     * @param {boolean} includeInSummary
-     * @param {string[]} forms
-     * @param {string} visibilityControl
-     * @param {string} visibleIfEquals
-     * @param {VasControlModel[]} controls
-     * @param {number} weight
-     */
-    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, account: string, accessGroup: string, name: string, title: string, description: string, sequence: number, includeInSummary: boolean, forms: string[], visibilityControl: string, visibleIfEquals: string, controls: VasControlModel[], weight: number);
+    scoreWeight: number;
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, accessGroup: string, name: string, title: string, description: string, sequence: number, includeInSummary: boolean, forms: string[], visibilityControl: string, visibleIfEquals: string, controls: VasControlModel[], scoreWeight: number);
     /**
      * @param {VasGroupDto} dto
      * @return {VasGroupModel}

package/lib/entity/vas-instruction-job-field.dto.d.ts

@@ -0,0 +1,8 @@
+import { VasBaseDto } from './vas-base.dto';
+export interface VasInstructionJobFieldDto extends VasBaseDto {
+    value: string;
+    name: string;
+    title: string;
+    sequence: number;
+    controlType: string;
+}

package/lib/entity/vas-instruction-job-field.model.d.ts

@@ -0,0 +1,25 @@
+import { VasBaseModel } from './vas-base.model';
+import { VasInstructionJobFieldDto } from './vas-instruction-job-field.dto';
+/**
+ * VasInstructionJobFieldModel
+ */
+export declare class VasInstructionJobFieldModel extends VasBaseModel {
+    id: string;
+    created: string;
+    serverCreated: string;
+    createdBy: string;
+    modified: string;
+    serverModified: string;
+    modifiedBy: string;
+    createdByName: string;
+    modifiedByName: string;
+    value: string;
+    name: string;
+    title: string;
+    sequence: number;
+    controlType: string;
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, value: string, name: string, title: string, sequence: number, controlType: string);
+    static empty(): VasInstructionJobFieldModel;
+    static fromDto(dto: Partial<VasInstructionJobFieldDto>): VasInstructionJobFieldModel;
+    toDto(): VasInstructionJobFieldDto;
+}

package/lib/entity/vas-instruction-job.dto.d.ts

@@ -0,0 +1,15 @@
+import { VasBaseDto } from './vas-base.dto';
+import { VasNoteDto } from './vas-note.dto';
+import { VasInstructionJobFieldDto } from './vas-instruction-job-field.dto';
+import { VasReportDto } from './vas-report.dto';
+import { VasFileDto } from './vas-file.dto';
+export interface VasInstructionJobDto extends VasBaseDto {
+    reference: string;
+    jobStatus: string;
+    createdByName: string;
+    modifiedByName: string;
+    notes: Array<VasNoteDto>;
+    fields: Array<VasInstructionJobFieldDto>;
+    files: Array<VasFileDto>;
+    reports: Array<VasReportDto>;
+}

package/lib/entity/vas-instruction-job.model.d.ts

@@ -0,0 +1,57 @@
+import { VasBaseModel } from './vas-base.model';
+import { VasInstructionJobDto } from './vas-instruction-job.dto';
+import { VasNoteModel } from './vas-note.model';
+import { VasInstructionJobFieldModel } from './vas-instruction-job-field.model';
+import { VasFileModel } from './vas-file.model';
+import { VasReportModel } from './vas-report.model';
+/**
+ * VasNoteModel
+ */
+export declare class VasInstructionJobModel extends VasBaseModel {
+    id: string;
+    created: string;
+    serverCreated: string;
+    createdBy: string;
+    modified: string;
+    serverModified: string;
+    modifiedBy: string;
+    createdByName: string;
+    modifiedByName: string;
+    reference: string;
+    jobStatus: string;
+    notes: Array<VasNoteModel>;
+    fields: Array<VasInstructionJobFieldModel>;
+    files: Array<VasFileModel>;
+    reports: Array<VasReportModel>;
+    /**
+     * @param id id
+     * @param created created
+     * @param serverCreated serverCreated
+     * @param createdBy createdBy
+     * @param modified modified
+     * @param serverModified serverModified
+     * @param modifiedBy modifiedBy
+     * @param reference reference
+     * @param jobStatus jobStatus
+     * @param createdByName createdByName
+     * @param modifiedByName modifiedByName
+     * @param notes notes
+     * @param fields fields
+     * @param files files
+     * @param reports reports
+     */
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, reference: string, jobStatus: string, notes: Array<VasNoteModel>, fields: Array<VasInstructionJobFieldModel>, files: Array<VasFileModel>, reports: Array<VasReportModel>);
+    /**
+     * @return empty VasInstructionJobModel
+     */
+    static empty(): VasInstructionJobModel;
+    /**
+     * @param dto VasInstructionDto
+     * @return VasInstructionModel
+     */
+    static fromDto(dto: Partial<VasInstructionJobDto>): VasInstructionJobModel;
+    /**
+     * @returns VasNoteDto
+     */
+    toDto(): VasInstructionJobDto;
+}

package/lib/entity/vas-instruction-provider.dto.d.ts

@@ -0,0 +1,8 @@
+import { VasAccountObjectDto } from './vas-account-object.dto';
+import { VasFormDto } from './vas-form.dto';
+export interface VasInstructionProviderDto extends VasAccountObjectDto {
+    form: VasFormDto;
+    title: string;
+    secret: string;
+    portalEnabled: boolean;
+}

package/lib/entity/vas-instruction-provider.model.d.ts

@@ -0,0 +1,33 @@
+import { VasAccountObjectModel } from './vas-account-object.model';
+import { VasInstructionProviderDto } from './vas-instruction-provider.dto';
+import { VasFormModel } from './vas-form.model';
+/**
+ * VasInstructionProviderModel
+ */
+export declare class VasInstructionProviderModel extends VasAccountObjectModel {
+    id: string;
+    created: string;
+    serverCreated: string;
+    createdBy: string;
+    modified: string;
+    serverModified: string;
+    modifiedBy: string;
+    createdByName: string;
+    modifiedByName: string;
+    account: string;
+    form: VasFormModel;
+    title: string;
+    secret: string;
+    portalEnabled: boolean;
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, form: VasFormModel, title: string, secret: string, portalEnabled: boolean);
+    /**
+     * @param dto VasInstructionDto
+     * @return VasInstructionModel
+     */
+    static fromDto(dto: Partial<VasInstructionProviderDto>): VasInstructionProviderModel;
+    /**
+     * @returns VasNoteDto
+     */
+    toDto(): VasInstructionProviderDto;
+    toApiDto(options?: any): Record<string, string | number | boolean>;
+}

package/lib/entity/vas-instruction.dto.d.ts

@@ -0,0 +1,7 @@
+import { VasAccountObjectDto } from './vas-account-object.dto';
+import { VasInstructionJobDto } from './vas-instruction-job.dto';
+import { VasInstructionProviderDto } from './vas-instruction-provider.dto';
+export interface VasInstructionDto extends VasAccountObjectDto {
+    job: VasInstructionJobDto;
+    instructionProvider: VasInstructionProviderDto;
+}

package/lib/entity/vas-instruction.model.d.ts

@@ -0,0 +1,31 @@
+import { VasAccountObjectModel } from './vas-account-object.model';
+import { VasInstructionDto } from './vas-instruction.dto';
+import { VasInstructionJobModel } from './vas-instruction-job.model';
+import { VasInstructionProviderModel } from './vas-instruction-provider.model';
+/**
+ * VasNoteModel
+ */
+export declare class VasInstructionModel extends VasAccountObjectModel {
+    id: string;
+    created: string;
+    serverCreated: string;
+    createdBy: string;
+    modified: string;
+    serverModified: string;
+    modifiedBy: string;
+    createdByName: string;
+    modifiedByName: string;
+    account: string;
+    job: VasInstructionJobModel;
+    instructionProvider: VasInstructionProviderModel;
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, job: VasInstructionJobModel, instructionProvider: VasInstructionProviderModel);
+    /**
+     * @param dto VasInstructionDto
+     * @return VasInstructionModel
+     */
+    static fromDto(dto: Partial<VasInstructionDto>): VasInstructionModel;
+    /**
+     * @returns VasNoteDto
+     */
+    toDto(): VasInstructionDto;
+}

package/lib/entity/vas-invitation.d.ts

@@ -0,0 +1,52 @@
+import { VasAccountObjectDto } from './vas-account-object.dto';
+import { VasAccessGroupDto } from './vas-access-group.dto';
+import { VasContactTypeDto } from './vas-contact-type.dto';
+import { VasInstructionProviderDto } from './vas-instruction-provider.dto';
+import { VasJobStatusDto } from './vas-job-status.dto';
+import { VasJobTypeDto } from './vas-job-type.dto';
+import { VasLookupTypeDto } from './vas-lookup-type.dto';
+import { VasTaskTypeDto } from './vas-task-type.dto';
+import { VasAccountObjectModel } from './vas-account-object.model';
+export declare enum VasInvitationTypeEnum {
+    TYPE_VAS_DESKTOP = "vas-desktop",
+    TYPE_VAS_MOBILE = "vas-mobile",
+    TYPE_VAS_PORTAL = "vas-portal",
+    TYPE_P2C_DESKTOP = "p2c-desktop",
+    TYPE_P2C_MOBILE = "p2c-mobile"
+}
+export interface VasInvitationDto extends VasAccountObjectDto {
+    secret: string;
+    type: VasInvitationTypeEnum;
+    accessGroups: Array<VasAccessGroupDto>;
+    contactTypes: Array<VasContactTypeDto>;
+    jobStatuses: Array<VasJobStatusDto>;
+    jobTypes: Array<VasJobTypeDto>;
+    lookupTypes: Array<VasLookupTypeDto>;
+    taskTypes: Array<VasTaskTypeDto>;
+    instructionProviders: Array<VasInstructionProviderDto>;
+}
+export declare class VasInvitationModel extends VasAccountObjectModel implements VasAccountObjectDto {
+    id: string;
+    created: string;
+    serverCreated: string;
+    createdBy: string;
+    modified: string;
+    serverModified: string;
+    modifiedBy: string;
+    createdByName: string;
+    modifiedByName: string;
+    account: string;
+    secret: string;
+    type: VasInvitationTypeEnum;
+    accessGroups: Array<VasAccessGroupDto>;
+    contactTypes: Array<VasContactTypeDto>;
+    jobStatuses: Array<VasJobStatusDto>;
+    jobTypes: Array<VasJobTypeDto>;
+    lookupTypes: Array<VasLookupTypeDto>;
+    taskTypes: Array<VasTaskTypeDto>;
+    instructionProviders: Array<VasInstructionProviderDto>;
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, secret: string, type: VasInvitationTypeEnum, accessGroups: Array<VasAccessGroupDto>, contactTypes: Array<VasContactTypeDto>, jobStatuses: Array<VasJobStatusDto>, jobTypes: Array<VasJobTypeDto>, lookupTypes: Array<VasLookupTypeDto>, taskTypes: Array<VasTaskTypeDto>, instructionProviders: Array<VasInstructionProviderDto>);
+    toDto(): VasInvitationDto;
+    static fromDto(dto: Partial<VasInvitationDto>): VasInvitationModel;
+    toApiDto(options?: any): Record<string, string | number | boolean>;
+}

package/lib/entity/vas-job-data.model.d.ts

@@ -0,0 +1,18 @@
+import { VasAccountObjectModel } from './vas-account-object.model';
+/**
+ * VasJobDataModel
+ */
+export declare abstract class VasJobDataModel extends VasAccountObjectModel {
+    id: string;
+    created: string;
+    serverCreated: string;
+    createdBy: string;
+    modified: string;
+    serverModified: string;
+    modifiedBy: string;
+    createdByName: string;
+    modifiedByName: string;
+    account: string;
+    job: string;
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, job: string);
+}

package/lib/entity/vas-job-status.dto.d.ts

@@ -0,0 +1,7 @@
+import { VasAccountObjectDto } from './vas-account-object.dto';
+export interface VasJobStatusDto extends VasAccountObjectDto {
+    title: string;
+    sequence: number;
+    categoryGroups: Array<string>;
+    closed: boolean;
+}

package/lib/entity/vas-job-type.dto.d.ts

@@ -0,0 +1,7 @@
+import { VasAccountObjectDto } from './vas-account-object.dto';
+export interface VasJobTypeDto extends VasAccountObjectDto {
+    account: string;
+    title: string;
+    sequence: number;
+    categoryGroups: Array<string>;
+}

package/lib/entity/vas-job.dto.d.ts

@@ -1,11 +1,22 @@
+import { VasFileDto } from './vas-file.dto';
 import { VasRestrictedAccountObjectDto } from './vas-restricted-account-object.dto';
-import { VasFieldDtoValue } from './vas-field.dto';
+import { VasFieldDto, VasFieldDtoValue } from './vas-field.dto';
+import { GeoLocation } from '../model/geo-location';
 export interface VasJobStaticDto extends VasRestrictedAccountObjectDto {
     reference: string;
     jobDate: string;
     jobStatus: string;
     jobType: string;
-    assignee: string;
+    assigneeId: string;
     formId: string;
+    timeZoneOffset: number;
+    pendingFields: number;
+    childModified: string;
+    version: number;
+    files: Array<VasFileDto>;
+    fields: Array<VasFieldDto>;
+    createdByDisplayName: string;
+    modifiedByDisplayName: string;
+    geoLocation: GeoLocation;
 }
 export declare type VasJobDto = VasJobStaticDto & Record<string, VasFieldDtoValue>;

package/lib/entity/vas-job.model.d.ts

@@ -1,10 +1,21 @@
+import { VasFileDto } from './vas-file.dto';
+import { VasBaseDto } from './vas-base.dto';
+import { VasFieldDto, VasFieldDtoValue } from './vas-field.dto';
+import { VasFormModel } from './vas-form.model';
 import { VasJobDto } from './vas-job.dto';
-import { VasBaseModel } from './vas-base.model';
-import { VasFieldDtoValue } from './vas-field.dto';
+import { VasRestrictedAccountObjectModel } from './vas-restricted-account-object.model';
+import { GeoLocation } from '../model/geo-location';
+export declare interface VasJobModelDynamicInterface {
+    [s: string]: string | number | Record<string, VasFieldDtoValue>;
+}
+export interface ParseSyntaxOptions {
+    timeZoneOffset: number;
+    objects?: Record<string, Partial<VasBaseDto> | Record<string, VasFieldDtoValue>>;
+}
 /**
  * JobModel
  */
-export declare class VasJobModel extends VasBaseModel {
+export declare class VasJobModel extends VasRestrictedAccountObjectModel {
     id: string;
     created: string;
     serverCreated: string;
@@ -12,71 +23,156 @@ export declare class VasJobModel extends VasBaseModel {
     modified: string;
     serverModified: string;
     modifiedBy: string;
+    createdByName: string;
+    modifiedByName: string;
     account: string;
     accessGroup: string;
     reference: string;
     jobDate: string;
     jobStatus: string;
     jobType: string;
-    assignee: string;
+    assigneeId: string;
     formId: string;
-    [prop: string]: VasFieldDtoValue;
+    timeZoneOffset: number;
+    pendingFields: number;
+    childModified: string;
+    version: number;
+    fields: Array<VasFieldDto>;
+    files: Array<VasFileDto>;
+    createdByDisplayName: string;
+    modifiedByDisplayName: string;
+    geoLocation: GeoLocation;
+    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, createdByName: string, modifiedByName: string, account: string, accessGroup: string, reference: string, jobDate: string, jobStatus: string, jobType: string, assigneeId: string, formId: string, timeZoneOffset: number, pendingFields: number, childModified: string, version: number, fields: Array<VasFieldDto>, files: Array<VasFileDto>, createdByDisplayName: string, modifiedByDisplayName: string, geoLocation: GeoLocation);
     /**
-     * @param {string} id
-     * @param {string} created
-     * @param {string} serverCreated
-     * @param {string} createdBy
-     * @param {string} modified
-     * @param {string} serverModified
-     * @param {string} modifiedBy
-     * @param {string} account
-     * @param {string} accessGroup
-     * @param {string} reference
-     * @param {string} jobDate
-     * @param {string} jobStatus
-     * @param {string} jobType
-     * @param {string} assignee
-     * @param {string} formId
+     * Returns this with the dynamic interface
+     * @return {VasJobModelDynamicInterface}
      */
-    constructor(id: string, created: string, serverCreated: string, createdBy: string, modified: string, serverModified: string, modifiedBy: string, account: string, accessGroup: string, reference: string, jobDate: string, jobStatus: string, jobType: string, assignee: string, formId: string);
-    /**
-     * Returns a list of Job static properties
-     */
-    get staticProperties(): Array<keyof VasJobModel>;
+    get $this(): VasJobModelDynamicInterface;
     /**
      * Returns a list of Job dynamic properties i.e. those that are added by the
      * dynamic forms
      */
-    get dynamicProperties(): Array<keyof VasJobModel>;
+    get dynamicProperties(): Array<string>;
+    /**
+     * Returns a list of Job static properties i.e. those that are declared by
+     * the type
+     */
+    get staticProperties(): Array<string>;
     /**
      * @return {VasJobModel}
      */
     static empty(): VasJobModel;
+    static fromDto(dto: Partial<VasJobDto>): VasJobModel;
     /**
-     * @param {VasJobDto} jobDto
-     * @return {VasJobModel}
+     * @param {VasFormModel} formModel
+     * @return {Record<string, VasFieldDtoValue>}
      */
-    static fromDto(jobDto: Partial<VasJobDto>): VasJobModel;
+    getFields(formModel: VasFormModel): Record<string, VasFieldDtoValue>;
     /**
-     * A very non sophisticated way to get values from the job via paths
-     *
-     * For example:
-     *
-     * getValueByPath(['foo', 'bar']);
+     * Will return an object whose keys are the names of all fields in the job.
+     * This method is similar to `getFields` except that this method will only
+     * return values where a value was set, as opposed to `getFields` which
+     * return a property regardless (because it uses the form to drive the logic)
+     * @return {Record<string, VasFieldDtoValue>}
+     */
+    getFields2(): Record<string, VasFieldDtoValue>;
+    /**
+     * Returns an object describing how many attachments were added to this job
+     * (camera controls and files), and how many have not been uploaded yet.
      *
-     * if job is
+     * @param formModel instance of {@link VasFormModel} that was used when the
+     * job was created
+     */
+    getFilesUploadStatus(formModel: VasFormModel): {
+        pending: number;
+        total: number;
+    };
+    /**
+     * This method will hydrate the `fields` property of the model. The reason for
+     * this is that we have different ways to store the field data. One way, is
+     * we store them as dynamic properties of the job. For example job.foo.bar,
+     * where `foo` is the name of a Group, and `bar` is the name of a control.
+     * Thus, when we create a job using a form in the client, the job object will
+     * have its static properties (id, account, reference etc), and also a number
+     * of dynamic properties determined by the Groups and Controls. This kind of
+     * object is nice to work with in certain circumstances. However, the api
+     * works differently. In the API a Job is a record, and references a number of
+     * Field records. Each Field stores the value. Comparing these two models we
+     * have:
+     * A) job with dynamic properties, e.g.
      * {
+     *   id: <guid>,
+     *   reference: "something"
+     *   <other static job properties>...
      *   foo: {
-     *     bar: 'value'
+     *     bar: "value"
      *   }
      * }
      *
-     * will return "value"
+     * B) job with fields
+     * {
+     *   id: <guid>,
+     *   reference: "something"
+     *   <other static job properties>...
+     *   <will not have dynamic properties>...
+     *   fields: [
+     *     {
+     *       id: <guid>,
+     *       <other field properties>,
+     *       value: "value"
+     *     }
+     *   ]
+     * }
+     *
+     * So, what this method does is given a JobModel in the form of A, read all
+     * of those dynamic properties and set them into `fields`. Doing this requires
+     * knowledge of the Form that was used to create the job. Moreover, since the
+     * dynamic properties do not contain the ids of the fields, we also allow to
+     * pass in a `controlFieldIdMap`. This map stores the mapping between Control
+     * and the Field that was created in the Job to store the value for that
+     * Control. This is useful, if for example you want to compare a Job in form A
+     * with a Job in form B, for example if you want to update the Job on the API
+     * with a Job that was saved by a client in form A.
+     *
+     * E.g.
+     * Client -> API: client requests form
+     * User -> Client: user fills in the form and submits
+     * Client -> Firestore: client saves the Job in form A i.e. dynamic props
+     * Firestore -> Function: A function is triggered to sync the job to the API
+     * Function -> API: Function checks if job already exists, it receives 404
+     * Function -> Function: The function calls `hydrateFields(...)`
+     * Function -> API: The function POST the Job to /jobs
+     * Function -> API: The function POST each field to /fields
      *
+     * Similarly, if the user updates the job
+     * Client -> API: client requests form
+     * User -> Client: user fills in the form and submits an update
+     * Client -> Firestore: client saves the Job in form A i.e. dynamic props
+     * Firestore -> Function: A function is triggered to sync the job to the API
+     * Function -> API: Function checks if job already exists, it receives 200
+     * Function -> Function: The function calls `hydrateFields(...)` passing in
+     *                       the map is made by iterating over the fields it
+     *                       received from the API and storing the mappings
+     *                       between controlId and fieldId for each field
+     * Function -> API: The function PATCH the Job to /jobs
+     * Function -> API: The function POST/PATCH each field to /fields
+     * treated as new
+     *
+     * @param {VasFormModel} formModel the VasFormModel that was used to create
+     * the job
+     * @param {Map<string, string>} controlFieldIdMap a mapping of control to
+     * field ids. This is used to determine whether a new id for the field should
+     * be generated, or to reuse an existing one from the map.
+     * @param {Array<string>} controlNames if a value is provided, it will be used
+     * to filter the fields that are returned.
+     * @return {Array<VasFieldDto>}
+     */
+    hydrateFields(formModel: VasFormModel, controlFieldIdMap?: Map<string, string>, controlNames?: Array<string>): void;
+    /**
      * @param {string[]} path path segments
      * @return {void}
      */
-    getValueByPath(path?: string[]): VasFieldDtoValue | undefined;
+    getValueByPath<T extends VasFieldDtoValue>(path?: string[]): T | undefined;
     /**
      * A very non sophisticated way to set values in the job via paths
      *
@@ -94,9 +190,42 @@ export declare class VasJobModel extends VasBaseModel {
      * @param {any} value the value to set
      * @param {string[]} path path segments
      */
-    setValueByPath(value: any, path?: string[]): void;
+    setValueByPath(value: VasFieldDtoValue, path?: string[]): void;
     /**
+     * @param {boolean} staticOnly if true, will only output values for the static
+     * properties in the dto
      * @return {VasJobDto}
      */
-    toDto(): VasJobDto;
+    toDto(staticOnly?: boolean): VasJobDto;
+    /**
+     * This method will parse a syntax that allows us to build strings from the
+     * values of from the job model. For example if the job model was:
+     *
+     * {
+     *   foo: 'bar'
+     * }
+     *
+     * and we pass "i am foo {foo}", the result would be:
+     *
+     * "i am foo bar"
+     *
+     * we can also use moment to parse dates, for example if the job model was:
+     *
+     * {
+     *   created: "2022-01-01T00:00:00+0000"
+     * }
+     *
+     * and we pass "{created|date:YY-MM-DD}", the result would be:
+     *
+     * "2022-01-01"
+     *
+     * @param {string} value a string with the syntax
+     * @param {ParseSyntaxOptions} options
+     * @return {string} the results of parsing the syntax on this job
+     */
+    parseSyntax(value: string, options?: ParseSyntaxOptions): string;
+    /**
+     * @return {object}
+     */
+    toApiDto(): Record<string, string | number | boolean>;
 }

package/lib/entity/vas-lookup-type.dto.d.ts

@@ -0,0 +1,6 @@
+import { VasAccountObjectDto } from './vas-account-object.dto';
+export interface VasLookupTypeDto extends VasAccountObjectDto {
+    title: string;
+    sequence: number;
+    categoryGroups: Array<string>;
+}

package/lib/entity/vas-lookup.dto.d.ts

@@ -0,0 +1,15 @@
+import { VasAccountObjectDto } from './vas-account-object.dto';
+export interface VasLookupDto extends VasAccountObjectDto {
+    id: string;
+    created: string;
+    serverCreated: string;
+    createdBy: string;
+    serverModified: string;
+    modifiedBy: string;
+    account: string;
+    accessGroup: string;
+    lookupType: string;
+    title: string;
+    content: string;
+    sequence: number;
+}

package/lib/entity/vas-membership.dto.d.ts

@@ -0,0 +1,11 @@
+import { VasAccountObjectDto } from './vas-account-object.dto';
+export interface VasMembershipDto extends VasAccountObjectDto {
+    user: string;
+    admin: boolean;
+    lookupTypes: Array<string>;
+    contactTypes: Array<string>;
+    accessGroups: Array<string>;
+    jobStatuses: Array<string>;
+    jobTypes: Array<string>;
+    taskTypes: Array<string>;
+}