@nextplus/js-sdk
Version:
A TypeScript SDK for interacting with the NextPlus API, automatically generated from OpenAPI specifications.
2,174 lines (2,173 loc) • 1.37 MB
TypeScript
import { T as TDataShape, O as Options$1, C as Client, R as RequestResult } from './types.gen-vDP9AbtO.js';
type XAny = {
[key: string]: unknown;
};
type Station = {
id: string;
name: string;
userIds?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type DeviceFamily = {
id: string;
name: string;
type: string;
ranges?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type Gateway = {
id: string;
macAddress: string;
name?: string;
lastSeen?: Date;
interfaces?: {
[key: string]: unknown;
};
authorized?: boolean;
stationId?: string;
accessTokenSend?: boolean;
_devices?: Array<Device>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type Document = {
id: string;
name?: string;
originalName?: string;
icon?: string;
plainContent?: string;
content?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
recordId: string;
releaseStatus?: string;
releaseName?: string;
releaseMessage?: string;
releasePlainMessage?: string;
releaseType?: string;
releaseDate?: Date;
currentReleasedVersion?: boolean;
latestVersion?: boolean;
deletedAt?: Date;
deletedBy?: string;
contentPackageId?: string;
UserId?: string;
};
type ContentPackage = {
id: string;
name?: string;
image?: string;
template?: string;
have_index?: boolean;
sideBySideMinWidth?: number;
sideBySideMinHeight?: number;
tags?: Array<XAny>;
documentStructure?: XAny;
categories?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
groups?: Array<string>;
UserId?: string;
C_Translation?: string;
C_blabla?: string;
C_booleann?: boolean;
C_TranslationSelect?: string;
};
type ContentPackageSession = {
id: string;
viewingDate?: Date;
firstName?: string;
lastName?: string;
contentPackageId?: string;
scromSessionIds?: Array<string>;
created?: Date;
modified?: Date;
serverModified?: Date;
UserId?: string;
};
type ContentPackageView = {
id: string;
contentPackageId?: string;
userIds?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type Timeline = {
id: string;
name: string;
tags?: Array<XAny>;
categories?: Array<XAny>;
oldContentPackageId?: string;
columns?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
groups?: Array<string>;
ResourceId?: string;
};
type PartAssembly = {
id: string;
recordId: string;
name?: string;
number?: string;
is_avaliable?: boolean;
is_assembly?: boolean;
isCombinated?: boolean;
hasExpirationDate?: boolean;
timeTracking?: boolean;
cage_code?: string;
quantity?: string;
options?: {
[key: string]: unknown;
};
description?: string;
imageReady?: boolean;
alternatives?: Array<XAny>;
nodes?: Array<XAny>;
convertible?: Array<XAny>;
shapes?: Array<XAny>;
combinationParts?: Array<XAny>;
methods?: Array<XAny>;
unitId?: string;
productId?: string;
familyCode?: string;
familyDesc?: string;
revisions?: Array<Revision>;
isSerial?: boolean;
isManuallyIssued?: boolean;
isIssuedToKit?: boolean;
serialNumberRequiredAtStart?: boolean;
workorderNumbers?: Array<XAny>;
serials?: Array<XAny>;
freeStock?: boolean;
autoCreate?: string;
changeLog?: Array<XAny>;
isPhantom?: boolean;
bulkProduction?: string;
managedByRevision?: boolean;
generateSerials?: boolean;
numerator?: number;
paddingZeros?: number;
pattern?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
_documents?: Array<PartAssemblyDocument>;
image?: string;
picture?: string;
C_customField?: string;
};
type Group = {
id: string;
name: string;
created?: Date;
modified?: Date;
serverModified?: Date;
UserId?: string;
};
type Catalog = {
id: string;
name?: string;
options?: {
[key: string]: unknown;
};
picture?: string;
categories?: Array<XAny>;
tags?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
partNumber?: string;
groups?: Array<string>;
};
type PartAssemblyDocument = {
id: string;
title?: string;
type?: string;
url?: string;
externalId?: string;
resourceId?: string;
ResourceId?: string;
};
type Unit = {
id: string;
name: string;
each: boolean;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type Resource = {
id: string;
name: string;
originalFilename: string;
mediatype?: string;
folderName?: string;
folderId?: XAny;
checksum: string;
ext: string;
type?: string;
hidden?: boolean;
container: string;
size: number;
rev?: string;
sku?: string;
optimizedSizes?: Array<XAny>;
optimalFiles?: Array<XAny>;
posters?: Array<XAny>;
UserId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
_meta?: Array<Meta>;
};
type Revision = {
id: string;
revision?: string;
valid?: boolean;
active?: boolean;
_documents?: Array<PartAssemblyDocument>;
};
type Wire = {
id: string;
name?: string;
resource_id?: string;
wires?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type Wiringlist = {
id: string;
name?: string;
resource_id?: string;
wiresStructure?: XAny;
_v?: number;
wireIds?: Array<string>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
groups?: Array<string>;
};
type UserModel = {
id: string;
firstName?: string;
lastName?: string;
displayName?: string;
/**
* Is user is online or not
*/
status?: boolean;
/**
* API User
*/
api?: boolean;
otherId?: XAny;
supervisor?: boolean;
lang?: string;
employeeNumber?: string;
profileResourceId?: string;
bookmarks?: Array<XAny>;
/**
* Is user is Active User? Inactive users can't login to the app
*/
active?: boolean;
/**
* Is user for NPO usage
*/
internal?: boolean;
lastSeen?: Date;
/**
* Auto loading media - 3D
*/
mediaAutoLoad?: boolean;
/**
* User's phone number with country code separate by '_'
*/
phone?: string;
/**
* indicate if user doesn't complete is registration process
*/
waitingForValidation?: boolean;
blockUntil?: Date;
lastPasswordChange?: Date;
resetPassword?: boolean;
stationId?: string;
source?: string;
manager?: string;
EULAv1?: Date;
EULAv8?: Date;
EULAv9?: Date;
EULAv11?: Date;
sendDigestEmail?: boolean;
displayRecordsApprovalPopup?: boolean;
timezone?: string;
digestEmailScheduling?: Array<XAny>;
realm?: string;
username?: string;
email: string;
emailVerified?: boolean;
created?: Date;
modified?: Date;
serverModified?: Date;
userPreferences?: Array<UserPreferences>;
locationIds?: Array<string>;
workorderIds?: Array<string>;
stockIds?: Array<string>;
groups?: Array<string>;
C_test?: string;
};
type Acl = {
/**
* The name of the model
*/
model?: string;
/**
* The name of the property, method, scope, or relation
*/
property?: string;
accessType?: string;
permission?: string;
principalType?: string;
principalId?: string;
id: string;
created?: Date;
modified?: Date;
serverModified?: Date;
C_test?: string;
};
type AccessToken = {
id: string;
/**
* time to live in seconds (2 weeks by default)
*/
ttl?: number;
/**
* Array of scopes granted to this access token.
*/
scopes?: Array<string>;
created?: Date;
};
/**
* Map principals to roles
*/
type RoleMapping = {
id: string;
/**
* The principal type, such as USER, APPLICATION, ROLE, or user model name in case of multiple user models
*/
principalType?: string;
principalId?: string;
roleId?: ObjectId;
created?: Date;
modified?: Date;
serverModified?: Date;
userModelId?: string;
};
type Role = {
id: string;
name: string;
description?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
};
type Meta = {
id: string;
key: string;
value?: {
[key: string]: unknown;
};
};
type Connection = {
id: string;
conditions?: {
[key: string]: unknown;
};
name?: string;
fromId?: string;
toId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
};
type Node = {
id: string;
name?: string;
title?: string;
description?: string;
plainDescription?: string;
x: number;
y: number;
is_root?: boolean;
serial?: boolean;
supervisor?: boolean;
milestone?: boolean;
action?: boolean;
optional?: boolean;
signsSettings?: {
[key: string]: unknown;
};
data?: {
[key: string]: unknown;
};
actCode?: string;
bomItems?: Array<XAny>;
chapterId?: string;
listItemIds?: Array<string>;
expressions?: Array<XAny>;
resourceIds?: Array<string>;
LocationId?: string;
toolIds?: Array<string>;
fieldIds?: Array<string>;
created?: Date;
modified?: Date;
serverModified?: Date;
ResourceId?: string;
C_index?: number;
};
type Tool = {
id: string;
name: string;
sku?: string;
description?: string;
isSerial: boolean;
serials?: Array<XAny>;
resourceId?: string;
workflowId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
ResourceId?: string;
UserId?: string;
};
type Field = {
id: string;
type: string;
subtype?: string;
title: string;
helpText?: string;
helpImage?: string;
placeholder?: string;
required: boolean;
maxSelections?: number;
direction?: string;
options?: Array<XAny>;
fieldIds?: Array<XAny>;
minDate?: Date;
maxDate?: Date;
tableId?: string;
lookupField?: string;
minRequiredRows?: number;
images?: Array<XAny>;
lookupFieldType?: string;
multiple?: boolean;
mode?: string;
visionAi?: boolean;
aiPrompt?: string;
validateFileUniqueness?: boolean;
workflowId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type ListItem = {
id: string;
name: string;
link?: string;
listId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
ResourceId?: string;
};
type Chapter = {
id: string;
name?: string;
color?: string;
parentId?: string;
};
type Workflow = {
id: string;
name?: string;
description?: string;
parts?: Array<XAny>;
recordId?: string;
version: number;
subVersion?: number;
normalizedVersion?: string;
currentReleasedVersion: boolean;
released_at?: Date;
materials?: Array<XAny>;
categories?: Array<XAny>;
template?: string;
tags?: Array<XAny>;
toolIds?: Array<XAny>;
fieldIds?: Array<XAny>;
variables?: Array<XAny>;
timerOnNodes?: boolean;
formIds?: Array<XAny>;
bom?: Array<XAny>;
globalFormIds?: Array<XAny>;
globalVariables?: Array<XAny>;
referencedWorkflowIds?: Array<XAny>;
chaptersByNodeId?: Array<XAny>;
bomByWorkflowId?: Array<XAny>;
listItemIds?: Array<string>;
workflowTimer?: number;
addToHomePage?: boolean;
workflowTypeIds?: Array<XAny>;
_v?: number;
locked?: Date;
lockId?: string;
lockedBy?: string;
releasedBy?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
_globalConnections?: Array<Connection>;
_connections?: Array<Connection>;
_globalNodes?: Array<Node>;
_nodes?: Array<Node>;
_chapters?: Array<Chapter>;
ResourceId?: string;
UserId?: string;
groups?: Array<string>;
C_test?: string;
};
type AiPrompt = {
prompt: string;
type: string;
maxTokens: number;
temperature: number;
state?: string;
default?: boolean;
resourceIds?: Array<string>;
id: string;
created?: Date;
modified?: Date;
serverModified?: Date;
};
type Location = {
id: string;
name: string;
otherId?: string;
description?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
C_Table_Test?: string;
};
type Part = {
id: string;
sku: string;
rev?: string;
description?: string;
unit?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
};
type Project = {
id: string;
name: string;
otherId: string;
description?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
ResourceId?: string;
};
type UpdateInfo = {
id: string;
key?: string;
value?: XAny;
created?: Date;
modified?: Date;
serverModified?: Date;
};
type Workorder = {
id: string;
tags?: Array<XAny>;
workorderNumber: string;
sku?: string;
engineeringPart?: string;
partDesc?: string;
productRev?: string;
quantity: number;
sufficientQuantity?: number;
issueSufficientQuantity?: number;
priority?: number;
createdAt?: Date;
releasedAt?: Date;
expectedDate?: Date;
start?: Date;
end?: Date;
synced?: Date;
parentWorkorderNumber?: string;
project?: {
[key: string]: unknown;
};
statusId?: string;
statusName?: string;
statusType?: string;
erpStatus?: string;
name?: string;
workflowRecordId?: string;
nextChapterIds?: Array<XAny>;
nextChapterNames?: Array<XAny>;
isSerial: boolean;
erpClosed: boolean;
closed: boolean;
missingKit: boolean;
sendToNextPlus?: boolean;
supplier?: {
[key: string]: unknown;
};
customer?: {
[key: string]: unknown;
};
orderLines?: Array<XAny>;
issueStarted: boolean;
rmaNumber?: string;
serviceType?: string;
callType?: string;
progress?: number;
orderNumber?: string;
orderNumberLine?: string;
TRANSORDER_K_SUBFORM?: Array<XAny>;
KITITEMS_SUBFORM?: Array<XAny>;
orderLine?: string;
source?: string;
externalType?: string;
purchaseOrderNumber?: string;
purchaseOrderLine?: string;
sessionIds?: Array<string>;
assignedUsers?: Array<XAny>;
nextNodeNames?: Array<XAny>;
activeUserIds?: Array<XAny>;
serials?: Array<XAny>;
extraProperties?: {
[key: string]: unknown;
};
erpProductionStartDate?: Date;
erpProductionEndDate?: Date;
runningOnOldVersion?: boolean;
workflowRev?: string;
changeLog?: Array<XAny>;
workorderTypeId?: string;
parentWorkorderId?: string;
priorityDocIds?: Array<XAny>;
workflowName?: string;
customerDiagnosis?: string;
description?: string;
faultDescription?: string;
fixDescription?: string;
balance?: number;
invalidQuantity?: number;
validQuantity?: number;
malfunctionCode?: string;
externalId?: string;
partIds?: Array<string>;
locationIds?: Array<string>;
parentId?: string;
kitItems?: Array<Kit>;
workflowId?: string;
unmatchRevApprovedUserId?: string;
newVersionApprovedUserId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
_actions?: Array<WorkorderAction>;
stockIds?: Array<string>;
groups?: Array<string>;
C_BATCH_NUMBER?: string;
C_ROUTING_NO?: string;
C_date?: Date;
};
type Stock = {
id: string;
kitStatus?: boolean;
tags?: Array<XAny>;
serviceCalls?: Array<XAny>;
issueSufficientQuantity?: number;
needTimeLogCheck?: boolean;
status?: string;
serial?: string;
workorderNumber?: string;
sku?: string;
skuDesc?: string;
skuRev?: string;
priority?: number;
indicator?: number;
quantity: number;
start?: Date;
end?: Date;
expirationDate?: Date;
progress?: number;
usedTools?: Array<XAny>;
stockStatus?: string;
source?: string;
changeLog?: Array<XAny>;
priorityDocIds?: Array<XAny>;
otherId?: number;
_v?: number;
invalidQuantity?: number;
validQuantity?: number;
productionStatus?: string;
availableQuantity: number;
productionQuantity: number;
actions?: Array<WorkorderAction>;
partId?: string;
locationId?: string;
locationIds?: Array<string>;
workorderId?: string;
activeUserId?: string;
parentStockId?: string;
stockIds?: Array<string>;
userModelIds?: Array<string>;
workWithoutKitApprovedId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
timeLogs?: Array<TimeLog>;
stockItems?: Array<StockItem>;
workflowSessionItemId?: string;
UserId?: string;
};
type Pages = {
id: string;
title?: string;
content?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type Menus = {
id: string;
title?: string;
baseId?: string;
settings?: {
[key: string]: unknown;
};
created?: Date;
modified?: Date;
serverModified?: Date;
UserId?: string;
};
type Rule = {
id: string;
name: string;
description?: string;
builtin?: boolean;
disableUse?: boolean;
created?: Date;
modified?: Date;
serverModified?: Date;
UserId?: string;
};
type Category = {
id: string;
name: string;
parentId?: string;
weight?: number;
created?: Date;
modified?: Date;
serverModified?: Date;
UserId?: string;
};
type Forum = {
id: string;
name?: string;
image?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
groups?: Array<string>;
};
type Post = {
id: string;
name?: string;
content?: string;
plainContent?: string;
forumId?: string;
contentPackageId?: string;
workflowId?: string;
nodeId?: string;
UserId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type Comment = {
id: string;
content?: string;
plainContent?: string;
postId?: string;
parentId?: string;
UserId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type PriorityLabel = {
id: string;
name: string;
description?: string;
models?: Array<XAny>;
workorderFieldMapping?: Array<XAny>;
sessionFieldMapping?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
};
type VoteMapping = {
id: string;
commentId?: string;
postId?: string;
value?: number;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type ConnectorFunction = {
id: string;
name: string;
code?: string;
input?: Array<XAny>;
output?: Array<XAny>;
connectorId: string;
created?: Date;
modified?: Date;
serverModified?: Date;
UserId?: string;
};
type Connector = {
id: string;
name: string;
description?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
UserId?: string;
};
type ScromSession = {
id: string;
model?: string;
modelId?: string;
resourceId?: string;
data?: {
[key: string]: unknown;
};
created?: Date;
modified?: Date;
serverModified?: Date;
UserId?: string;
};
type Translation = {
id: string;
langCode?: string;
translateCode?: string;
originalTranslation?: string;
overrideTranslation?: string;
userable?: boolean;
created?: Date;
modified?: Date;
serverModified?: Date;
UserId?: string;
};
type CustomField = {
id: string;
key: string;
modelName: Array<XAny>;
type?: string;
element?: string;
searchable?: boolean;
filterable?: boolean;
display?: boolean;
default?: XAny;
weight?: number;
options?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
UserId?: string;
};
type Form = {
id: string;
name: string;
global?: boolean;
singleton?: boolean;
sendNotificationEmail?: boolean;
icon?: string;
hasStatus?: boolean;
removeAssignee?: boolean;
unassigned?: boolean;
viewCertificate?: Array<XAny>;
createCertificate?: Array<XAny>;
closeCertificate?: Array<XAny>;
defaultAssignee?: Array<XAny>;
fields: Array<XAny>;
defaultStatus?: string;
_v?: number;
statuses?: Array<XAny>;
approvalWorkflows?: Array<XAny>;
presaveTriggers?: Array<XAny>;
postsaveTriggers?: Array<XAny>;
fieldSettings?: string;
showInWorkflow?: boolean;
isTemplate?: boolean;
includeInDigestEmail?: boolean;
viewForDigestEmail?: string;
closeStatusOnWorkflowRelease?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
C_test?: string;
};
type FormDataComment = {
id: string;
content: string;
plainContent: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
parentId?: string;
UserId?: string;
createdBy?: string;
};
type FormData = {
id: string;
number?: number;
formId: string;
sessionId?: string;
serial?: string;
workorderId?: string;
workorderNumber?: string;
sessionNodeId?: string;
nodeId?: string;
originalNodeId?: string;
nodeName?: string;
workflowId?: string;
originalWorkflowId?: string;
workflowName?: string;
recordId?: string;
workflowVersion?: number;
workflowSubVersion?: number;
workflowNormalizedVersion?: string;
openInPreview?: boolean;
partSku?: string;
partRev?: string;
hasStatus: boolean;
unassigned?: boolean;
removeAssignee?: boolean;
assignee?: Array<XAny>;
viewers?: Array<XAny>;
status?: string;
ownerId?: string;
closedBy?: string;
closedAt?: Date;
closeComments?: string;
fields: Array<XAny>;
statuses?: Array<XAny>;
changeLog?: Array<XAny>;
approvalWorkflow?: {
[key: string]: unknown;
};
_v?: number;
stockSku?: string;
stockSerial?: string;
stockLot?: string;
requireDeviceLink?: boolean;
linkedTo?: Array<string>;
linkedFrom?: Array<string>;
stringNumber?: string;
originStockId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
productionEntityId?: string;
UserId?: string;
createdBy?: string;
};
type Folder = {
id: string;
name: string;
parentFolderId?: string;
UserId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
};
type WorkflowSessionItem = {
id: string;
name?: string;
timeLogs?: Array<XAny>;
timeReports?: Array<XAny>;
tags?: Array<XAny>;
tools?: Array<XAny>;
location?: Array<XAny>;
currentNodeId?: string;
currentSessionNodeId?: string;
currentWorkflowId?: string;
recordId?: string;
sessionNodes?: Array<XAny>;
nodesPath?: Array<XAny>;
variables?: Array<XAny>;
customFields?: Array<XAny>;
usedTools?: Array<XAny>;
userModelIds?: Array<XAny>;
needTimeLogCheck?: boolean;
status?: string;
progress?: number;
netTimeSpent?: number;
usersNetTimeSpent?: Array<XAny>;
start?: Date;
end?: Date;
UserId?: string;
activeUserId?: Array<string>;
stockIds?: Array<string>;
nextChapterId?: string;
nextChapterName?: string;
nextNodeId?: string;
nextNodeName?: string;
workorderId?: string;
indicator?: number;
serials?: Array<XAny>;
configuration?: Array<XAny>;
parentSessionId?: string;
partSku?: string;
partRev?: string;
bom?: Array<XAny>;
activeUserIdsByUniqueId?: Array<XAny>;
connectionsPath?: Array<XAny>;
quantity?: number;
invalidQuantity?: number;
validQuantity?: number;
groups?: Array<XAny>;
workflowId?: string;
scromSessionIds?: Array<string>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
createdBy?: string;
};
type Certificate = {
id: string;
name: string;
description?: string;
daysToExpire?: number;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type CertificateMapping = {
id: string;
certificateId: string;
expireDate?: Date;
UserId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type SyncClients = {
id: string;
mac?: string;
hostname?: string;
name?: string;
lastSeen?: Date;
lastSuccessfulReplication?: Date;
created?: Date;
modified?: Date;
serverModified?: Date;
UserId?: string;
};
type SyncHistory = {
id: string;
clientId?: string;
start?: Date;
end?: Date;
status?: string;
error?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
UserId?: string;
};
type BreakType = {
id: string;
name: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type Event = {
id: string;
userId?: string;
type?: string;
date?: Date;
model?: string;
query?: string;
modelId?: string;
recordId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type Configuration = {
id: string;
name: string;
required?: boolean;
options: Array<XAny>;
relatedWorkflows?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
groups?: Array<string>;
createdBy?: string;
};
type Variant = {
id: string;
name?: string;
page?: string;
value?: {
[key: string]: unknown;
};
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
createdBy?: string;
UserId?: string;
};
type WorkorderTemplate = {
id: string;
name: string;
quantity?: number;
recordId?: string;
sku: string;
rev?: string;
dueDateInHours?: number;
releasedBefore?: number;
workflowName?: string;
workorderTypeId?: string;
assignedUsers?: Array<XAny>;
scheduling?: Array<XAny>;
_v?: number;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
groups?: Array<string>;
};
type Table = {
id: string;
name: string;
columns?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type TableSetup = {
id: string;
state: string;
name?: string;
default?: boolean;
public?: boolean;
columns?: Array<XAny>;
filters?: {
[key: string]: unknown;
};
_v?: number;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
createdBy?: string;
UserId?: string;
};
type FileParser = {
id: string;
name: string;
regex: string;
functionName?: string;
tableId?: string;
_v?: number;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
fileParserJobId?: string;
UserId?: string;
};
type FileParserJob = {
id: string;
resourceId: string;
fileParserIds?: Array<XAny>;
_v?: number;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type FileParserStrategyJob = {
id: string;
resourceId: string;
fileParserJobId: string;
fileParserId: string;
logs?: Array<XAny>;
status?: string;
_v?: number;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type List = {
id: string;
name: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type Nps = {
id: string;
score?: number;
description?: string;
opened?: boolean;
ignored?: boolean;
latest?: boolean;
answerDate?: Date;
_v?: number;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type WorkflowType = {
id: string;
name: string;
default?: boolean;
createStock?: boolean;
erpWorkorderDefault?: boolean;
erpServiceDefault?: boolean;
localDefault?: boolean;
builtin?: boolean;
_v?: number;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type WorkorderStatus = {
id: string;
name: string;
color: string;
systemDefault?: boolean;
onCreateDefault?: boolean;
onStartDefault?: boolean;
onEndDefault?: boolean;
statusType: string;
isChangeReasonRequired: boolean;
changeReasonFields?: Array<XAny>;
transitionToPermitRoleIds?: Array<XAny>;
transitionToPermitCertificateIds?: Array<XAny>;
_v?: number;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type TimeLogReport = {
id: string;
workorderNumber?: string;
workorderId?: string;
sku?: string;
serials?: Array<XAny>;
sessionIds?: Array<XAny>;
recordType: string;
chapterName?: string;
chapterId?: string;
type?: string;
start?: Date;
end?: Date;
firstEnd?: Date;
duration?: number;
userId?: string;
changeLog?: Array<XAny>;
managerApprovalStatus: string;
managerApprovalId?: string;
managerApprovalTime?: Date;
workflowId?: string;
comment?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type Operation = {
id: string;
actCode: string;
name?: string;
workCenterId?: string;
workCenterName?: string;
externalId?: string;
reported?: boolean;
_v?: number;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type PrintPreset = {
id: string;
name: string;
hideChapterTitle?: boolean;
hideTitle?: boolean;
hideDescription?: boolean;
hideMedia?: boolean;
hideFields?: boolean;
hideSignatures?: boolean;
removeBreak?: boolean;
removeChapterBreak?: boolean;
removeUnsignedSteps?: boolean;
printChangeLog?: boolean;
printFullyChangeLog?: boolean;
nodes?: Array<XAny>;
allNodesChecked?: boolean;
allNodesInSameOrder?: boolean;
nodesOrder?: Array<XAny>;
chapters?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type Webhook = {
id: string;
name: string;
active: boolean;
url: string;
events?: Array<XAny>;
model?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type InventoryTransaction = {
id: string;
type: string;
fromId?: string;
fromSku?: string;
fromSerial?: string;
fromLot?: string;
toId?: string;
toSku?: string;
toSerial?: string;
toLot?: string;
quantity: number;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type ProductionEntityType = {
id: string;
name: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type ProductionEntity = {
id: string;
name: string;
productionEntityTypeId: string;
status: string;
statusId: string;
statuses: Array<XAny>;
triggers?: Array<XAny>;
parameters?: Array<XAny>;
items?: {
[key: string]: unknown;
};
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type ProductionEntityEvent = {
id: string;
productionEntityId: string;
start: Date;
end?: Date;
parameterName?: string;
parameterValueString?: string;
parameterValueNumber?: number;
parameterValueBoolean?: boolean;
parameterValueDate?: Date;
type: string;
items?: Array<XAny>;
forms?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type OpcUaServer = {
id: string;
name: string;
endpointUrl: string;
securityMode: number;
securityPolicy: string;
username?: string;
active: boolean;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
};
type ProductionEntityTransaction = {
id: string;
stockId?: string;
sessionId: string;
workorderId?: string;
sessionNodeId: string;
productionEntityId?: string;
quantity: number;
type: string;
userId?: string;
workorderNumber?: string;
sku?: string;
serial?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type ShiftType = {
id: string;
/**
* The display name of the shift type, e.g., 'Morning Shift'.
*/
name: string;
/**
* The start time of the shift as a time-only string, e.g., '08:00'.
*/
startTime: string;
/**
* The end time of the shift as a time-only string, e.g., '16:00'.
*/
endTime: string;
/**
* The background color (hex code) for display purposes.
*/
backgroundColor: string;
/**
* The foreground color (text color, hex code) for display purposes.
*/
foregroundColor: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type Shift = {
id: string;
/**
* The ID of the production entity (machine) this shift is assigned to.
*/
productionEntityId: string;
/**
* The ID of the shift type.
*/
shiftTypeId: string;
/**
* The actual start time of the shift in UTC (ISODate).
*/
startTime: Date;
/**
* The actual end time of the shift in UTC (ISODate).
*/
endTime: Date;
/**
* Whether this shift is part of the default schedule to be repeated for the next two weeks.
*/
isDefault: boolean;
created?: Date;
modified?: Date;
serverModified?: Date;
};
type Warehouse = {
id: string;
name: string;
description?: string;
location?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
};
type ApiMethod = {
id: string;
model: string;
name: string;
method: string;
url: string;
deprecated?: boolean;
tracked?: boolean;
disabled?: boolean;
created?: Date;
modified?: Date;
serverModified?: Date;
};
type ApiMethodLog = {
id: string;
model: string;
name: string;
method: string;
url: string;
userId: string;
reqQuery: string;
reqBody: string;
resBody?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
};
type Addon = {
id: string;
name: string;
active?: boolean;
features?: Array<XAny>;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
UserId?: string;
createdBy?: string;
};
type Device = {
id: string;
pinNumber: number;
deviceFamilyId?: string;
created?: Date;
modified?: Date;
serverModified?: Date;
deletedAt?: Date;
deletedBy?: string;
};
type UserPreferences = {
id: string;
key?: string;
value?: XAny;
};
type ObjectId = string;
type Kit = {
id: string;
quantity: number;
issuedQuantity: number;
sku: string;
partDesc: string;
isSerial: boolean;
issuedToKit: boolean;
manualIssue?: boolean;
unit: string;
rev?: string;
act?: string;
serials?: {
[key: string]: unknown;
};
created?: Date;
modified?: Date;
serverModified?: Date;
};
type WorkorderAction = {
id: string;
actCode?: string;
actDesc?: string;
workCenter?: string;
allowedQty?: number;
completedQty?: number;
};
type TimeLog = {
id: string;
preparationTime?: Array<XAny>;
applyTime?: Date;
cureTime?: Date;
};
type StockItem = {
id: string;
sku: string;
serial?: string;
batch?: string;
quantity?: number;
};
type ContainerGetContainersData = {
body?: never;
path?: never;
query?: never;
url: '/containers';
};
type ContainerGetContainersResponses = {
/**
* Request was successful
*/
200: Array<XAny>;
};
type ContainerGetContainersResponse = ContainerGetContainersResponses[keyof ContainerGetContainersResponses];
type ContainerCreateContainerData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: never;
url: '/containers';
};
type ContainerCreateContainerResponses = {
/**
* Request was successful
*/
200: {
[key: string]: unknown;
};
};
type ContainerCreateContainerResponse = ContainerCreateContainerResponses[keyof ContainerCreateContainerResponses];
type ContainerDestroyContainerData = {
body?: never;
path: {
container: string;
};
query?: never;
url: '/containers/{container}';
};
type ContainerDestroyContainerResponses = {
/**
* Request was successful
*/
200: {
undefined?: {
[key: string]: unknown;
};
};
};
type ContainerDestroyContainerResponse = ContainerDestroyContainerResponses[keyof ContainerDestroyContainerResponses];
type ContainerGetContainerData = {
body?: never;
path: {
container: string;
};
query?: never;
url: '/containers/{container}';
};
type ContainerGetContainerResponses = {
/**
* Request was successful
*/
200: {
[key: string]: unknown;
};
};
type ContainerGetContainerResponse = ContainerGetContainerResponses[keyof ContainerGetContainerResponses];
type ContainerGetFilesData = {
body?: never;
path: {
container: string;
};
query?: never;
url: '/containers/{container}/files';
};
type ContainerGetFilesResponses = {
/**
* Request was successful
*/
200: Array<XAny>;
};
type ContainerGetFilesResponse = ContainerGetFilesResponses[keyof ContainerGetFilesResponses];
type ContainerRemoveFileData = {
body?: never;
path: {
container: string;
file: string;
};
query?: never;
url: '/containers/{container}/files/{file}';
};
type ContainerRemoveFileResponses = {
/**
* Request was successful
*/
200: {
undefined?: {
[key: string]: unknown;
};
};
};
type ContainerRemoveFileResponse = ContainerRemoveFileResponses[keyof ContainerRemoveFileResponses];
type ContainerGetFileData = {
body?: never;
path: {
container: string;
file: string;
};
query?: never;
url: '/containers/{container}/files/{file}';
};
type ContainerGetFileResponses = {
/**
* Request was successful
*/
200: {
[key: string]: unknown;
};
};
type ContainerGetFileResponse = ContainerGetFileResponses[keyof ContainerGetFileResponses];
type ContainerUploadData = {
body?: never;
path: {
container: string;
};
query?: never;
url: '/containers/{container}/upload';
};
type ContainerUploadResponses = {
/**
* Request was successful
*/
200: {
result?: {
[key: string]: unknown;
};
};
};
type ContainerUploadResponse = ContainerUploadResponses[keyof ContainerUploadResponses];
type ContainerDownloadData = {
body?: never;
path: {
container: string;
file: string;
};
query?: never;
url: '/containers/{container}/download/{file}';
};
type ContainerDownloadResponses = {
/**
* Request was successful
*/
204: unknown;
};
type StationFindData = {
body?: never;
path?: never;
query?: {
/**
* Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string (`{"where":{"something":"value"}}`). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.
*/
filter?: string;
};
url: '/Stations';
};
type StationFindResponses = {
/**
* Request was successful
*/
200: Array<Station>;
};
type StationFindResponse = StationFindResponses[keyof StationFindResponses];
type StationCreateData = {
/**
* Model instance data
*/
body?: Station;
path?: never;
query?: never;
url: '/Stations';
};
type StationCreateResponses = {
/**
* Request was successful
*/
200: Station;
};
type StationCreateResponse = StationCreateResponses[keyof StationCreateResponses];
type StationFindOneData = {
body?: never;
path?: never;
query?: {
/**
* Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string (`{"where":{"something":"value"}}`). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.
*/
filter?: string;
};
url: '/Stations/findOne';
};
type StationFindOneResponses = {
/**
* Request was successful
*/
200: Station;
};
type StationFindOneResponse = StationFindOneResponses[keyof StationFindOneResponses];
type StationCountData = {
body?: never;
path?: never;
query?: {
/**
* Criteria to match model instances
*/
where?: string;
};
url: '/Stations/count';
};
type StationCountResponses = {
/**
* Request was successful
*/
200: {
count?: number;
};
};
type StationCountResponse = StationCountResponses[keyof StationCountResponses];
type StationPrototypePatchAttributesData = {
/**
* An object of model property name/value pairs
*/
body?: Station;
path: {
/**
* Station id
*/
id: string;
};
query?: never;
url: '/Stations/{id}';
};
type StationPrototypePatchAttributesResponses = {
/**
* Request was successful
*/
200: Station;
};
type StationPrototypePatchAttributesResponse = StationPrototypePatchAttributesResponses[keyof StationPrototypePatchAttributesResponses];
type StationDeleteStationData = {
body?: {
obj?: string;
};
path?: never;
query?: never;
url: '/Stations/deleteStation';
};
type StationDeleteStationResponses = {
/**
* Request was successful
*/
200: {
result?: {
[key: string]: unknown;
};
};
};
type StationDeleteStationResponse = StationDeleteStationResponses[keyof StationDeleteStationResponses];
type DeviceFamilyFindData = {
body?: never;
path?: never;
query?: {
/**
* Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string (`{"where":{"something":"value"}}`). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.
*/
filter?: string;
};
url: '/DeviceFamilies';
};
type DeviceFamilyFindResponses = {
/**
* Request was successful
*/
200: Array<DeviceFamily>;
};
type DeviceFamilyFindResponse = DeviceFamilyFindResponses[keyof DeviceFamilyFindResponses];
type DeviceFamilyCreateData = {
/**
* Model instance data
*/
body?: DeviceFamily;
path?: never;
query?: never;
url: '/DeviceFamilies';
};
type DeviceFamilyCreateResponses = {
/**
* Request was successful
*/
200: DeviceFamily;
};
type DeviceFamilyCreateResponse = DeviceFamilyCreateResponses[keyof DeviceFamilyCreateResponses];
type DeviceFamilyFindOneData = {
body?: never;
path?: never;
query?: {
/**
* Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string (`{"where":{"something":"value"}}`). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.
*/
filter?: string;
};
url: '/DeviceFamilies/findOne';
};
type DeviceFamilyFindOneResponses = {
/**
* Request was successful
*/
200: DeviceFamily;
};
type DeviceFamilyFindOneResponse = DeviceFamilyFindOneResponses[keyof DeviceFamilyFindOneResponses];
type DeviceFamilyDeleteByIdData = {
body?: never;
path: {
/**
* Model id
*/
id: string;
};
query?: never;
url: '/DeviceFamilies/{id}';
};
type DeviceFamilyDeleteByIdResponses = {
/**
* Request was successful
*/
200: {
[key: string]: unknown;
};
};
type DeviceFamilyDeleteByIdResponse = DeviceFamilyDeleteByIdResponses[keyof DeviceFamilyDeleteByIdResponses];
type DeviceFamilyPrototypePatchAttributesData = {
/**
* An object of model property name/value pairs
*/
body?: DeviceFamily;
path: {
/**
* DeviceFamily id
*/
id: string;
};
query?: never;
url: '/DeviceFamilies/{id}';
};
type DeviceFamilyPrototypePatchAttributesResponses = {
/**
* Request was successful
*/
200: DeviceFamily;
};
type DeviceFamilyPrototypePatchAttributesResponse = DeviceFamilyPrototypePatchAttributesResponses[keyof DeviceFamilyPrototypePatchAttributesResponses];
type DeviceFamilyCountData = {
body?: never;
path?: never;
query?: {
/**
* Criteria to match model instances
*/
where?: string;
};
url: '/DeviceFamilies/count';
};
type DeviceFamilyCountResponses = {
/**
* Request was successful
*/
200: {
count?: number;
};
};
type DeviceFamilyCountResponse = DeviceFamilyCountResponses[keyof DeviceFamilyCountResponses];
type DeviceFamilyGetAllRelatedGatewaysData = {
body?: never;
path?: never;
query: {
deviceFamilyId: string;
};
url: '/DeviceFamilies/getAllRelatedGateways';
};
type DeviceFamilyGetAllRelatedGatewaysResponses = {
/**
* Request was successful
*/
200: Array<XAny>;
};
type DeviceFamilyGetAllRelatedGatewaysResponse = DeviceFamilyGetAllRelatedGatewaysResponses[keyof DeviceFamilyGetAllRelatedGatewaysResponses];
type DeviceFamilyDeleteDeviceFamilyData = {
body: {
deviceFamilyId: string;
};
path?: never;
query?: never;
url: '/DeviceFamilies/deleteDeviceFamily';
};
type DeviceFamilyDeleteDeviceFamilyResponses = {
/**
* Request was successful
*/
200: {
result?: {
[key: string]: unknown;
};
};
};
type DeviceFamilyDeleteDeviceFamilyResponse = DeviceFamilyDeleteDeviceFamilyResponses[keyof DeviceFamilyDeleteDeviceFamilyResponses];
type DevicePrototypeGetDeviceFamilyData = {
body?: never;
path: {
/**
* Device id
*/
id: string;
};
query?: {
refresh?: boolean;
};
url: '/Devices/{id}/deviceFamily';
};
type DevicePrototypeGetDeviceFamilyResponses = {
/**
* Request was successful
*/
200: DeviceFamily;
};
type DevicePrototypeGetDeviceFamilyResponse = DevicePrototypeGetDeviceFamilyResponses[keyof DevicePrototypeGetDeviceFamilyResponses];
type DeviceCountWithDeletedData = {
body?: never;
path?: never;
query?: {
/**
* Criteria to match model instances
*/
where?: string;
};
url: '/Devices/countWithDeleted';
};
type DeviceCountWithDeletedResponses = {
/**
* Request was successful
*/
200: {
count?: number