fsm-sdk
Version:
Node.JS sdk to interface with SAP Field Service Management APIs.
207 lines (206 loc) • 6.54 kB
TypeScript
export declare type ServiceCall = UnifiedIdentifier & Partial<{
activities: Activity[];
address: Address | null;
attachments: Attachment[];
businessPartner: BusinessPartner | null;
chargeableEfforts: boolean;
chargeableExpenses: boolean;
chargeableMaterials: boolean;
chargeableMileages: boolean;
code: string | null;
contact: Contact | null;
createPerson: CreatePerson | null;
dueDateTime: string | null;
durationInMinutes: number | null;
earliestStartDateTime: string | null;
equipments: Equipment[];
externalId: string | null;
id: string | null;
lastChanged: number | null;
orgLevelIds: string[];
origin: string | null;
priority: string | null;
problemType: string | null;
remarks: string | null;
requirements: Requirement[];
reservedMaterials: ReservedMaterial[];
resolution: string | null;
responsibles: Responsible[];
serviceContract: ServiceContract | null;
status: string | null;
subject: string | null;
type: string | null;
udfValues: UdfValue[];
}>;
export declare type UnifiedIdentifier = Partial<{
code: string | null;
externalId: string | null;
id: string | null;
}>;
export declare type Activity = UnifiedIdentifier & Partial<{
activityFeedbacks: ActivityFeedback[];
originActivity: OriginActivity | null;
businessPartner: BusinessPartner | null;
cancellationReason: string | null;
changelog: string | null;
checkedOut: boolean;
address: Address | null;
attachments: Attachment[];
code: string | null;
contact: Contact | null;
createDateTime: string | null;
createPerson: CreatePerson | null;
crew: Crew | null;
dueDateTime: string | null;
durationInMinutes: number | null;
earliestStartDateTime: string | null;
endDateTime: string | null;
equipment: Equipment | null;
executionStage: string | null;
hazardType: string | null;
externalId: string | null;
id: string | null;
internalRemarks: string | null;
internalRemarks2: string | null;
lastChanged: number | null;
location: Location | null;
orgLevelIds: string[];
milestone: boolean;
number: string | null;
object: {
objectId: string;
objectType: string;
} | null;
plannedDurationInMinutes: number | null;
plannedDurationType: 'AUTOMATIC' | null;
predecessorActivities: UnifiedIdentifier[];
previousActivity: UnifiedIdentifier | null;
plannedEndDate: string | null;
plannedStartDate: string | null;
project: UnifiedIdentifier | null;
projectOrdinal: number | null;
projectPhase: UnifiedIdentifier | null;
region: Region | null;
remarks: string | null;
reminderDateTime: string | null;
requirements: Requirement[];
reservedMaterials: ReservedMaterial[];
responsibles: Responsible[];
serviceProduct: ServiceProduct | null;
serviceAssignment: UnifiedIdentifier | null;
serviceWorkflow: UnifiedIdentifier | null;
startDateTime: string | null;
sourceActivity: SourceActivity | null;
status: string | null;
statusChangeReason: string | null;
subType: UnifiedIdentifier | null;
subject: string | null;
supportingPersons: UnifiedIdentifier[];
team: UnifiedIdentifier | null;
timeZoneId: string | null;
topic: UnifiedIdentifier | null;
travelTimeFromInMinutes: number | null;
travelTimeToInMinutes: number | null;
type: string | null;
udfValues: UdfValue[];
workflowStep: WorkflowStep | null;
workflowSteps: WorkflowStep[];
useAllEquipments: boolean;
}>;
declare type ActivityFeedback = Partial<{
activityCodes: ActivityCode[];
composedCode: string | null;
equipment: Equipment | null;
externalId: string | null;
externalText: string | null;
id: string | null;
internal: boolean;
internalRemarks: string | null;
orgLevelIds: string[];
}>;
declare type ReservedMaterial = Partial<{
arrivalDate: string | null;
externalId: string | null;
fromWarehouse: FromWarehouse | null;
id: string | null;
item: Item;
moved: number | null;
orgLevelIds: string[];
quantity: number | null;
serialNumber: SerialNumber | null;
shipped: number | null;
trackPartEquipmentUsage: boolean;
udfValues: UdfValue[];
used: number | null;
warehouse: Warehouse | null;
}>;
declare type WorkflowStep = Partial<{
createDateTime: string | null;
lastChanged: number | null;
name: string | null;
text: string | null;
}>;
declare type Requirement = Partial<{
inherited: boolean;
mandatory: boolean;
orgLevelIds: string[];
skill: Skill;
}>;
declare type Equipment = UnifiedIdentifier & Partial<{
objectCategory: string | null;
}>;
declare type Address = Partial<{
autoResolved: boolean;
block: string | null;
building: string | null;
city: string | null;
country: string | null;
externalAddressId: string | null;
floor: string | null;
location: Location | null;
orgLevelIds: string[];
room: string | null;
source: string | null;
sourceId: string | null;
state: string | null;
street: string | null;
streetNumber: string | null;
subType: string | null;
udfValues: UdfValue[];
zipCode: string | null;
}>;
declare type Location = Partial<{
latitude: number | null;
longitude: number | null;
}>;
declare type Attachment = Partial<{
category: string | null;
description: string | null;
fileName: string | null;
id: string | null;
title: string | null;
type: string | null;
}>;
export declare type UdfValue = Partial<{
key: string | null;
udfMeta: UdfMeta;
value: string | null;
}>;
declare type UdfMeta = UnifiedIdentifier;
declare type ActivityCode = UnifiedIdentifier;
declare type Contact = UnifiedIdentifier;
declare type CreatePerson = UnifiedIdentifier;
declare type Region = UnifiedIdentifier;
declare type ServiceContract = UnifiedIdentifier;
declare type Skill = UnifiedIdentifier;
declare type FromWarehouse = UnifiedIdentifier;
declare type Item = UnifiedIdentifier;
declare type SerialNumber = UnifiedIdentifier;
declare type Warehouse = UnifiedIdentifier;
declare type Responsible = UnifiedIdentifier;
declare type ServiceProduct = UnifiedIdentifier;
declare type SourceActivity = UnifiedIdentifier;
declare type OriginActivity = UnifiedIdentifier;
declare type BusinessPartner = UnifiedIdentifier;
declare type Crew = UnifiedIdentifier;
export {};