@trakit/objects 0.0.1 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (155) hide show
  1. package/API/Base.d.ts +3 -2
  2. package/API/BaseComponent.d.ts +9 -6
  3. package/API/Codifier.d.ts +11 -1
  4. package/API/Encoding.d.ts +9 -0
  5. package/API/Files.d.ts +4 -4
  6. package/API/Functions.d.ts +26 -21
  7. package/API/Geography/Functions.d.ts +4 -0
  8. package/API/Geography/Interfaces.d.ts +19 -14
  9. package/API/Geography/LatLng.d.ts +9 -1
  10. package/API/Geography/LatLngBounds.d.ts +2 -1
  11. package/API/Geography/Position.d.ts +23 -11
  12. package/API/Geography/StreetAddress.d.ts +3 -2
  13. package/API/Geometry/Functions.d.ts +1 -1
  14. package/API/Geometry/Point.d.ts +4 -3
  15. package/API/Geometry/Radial.d.ts +5 -4
  16. package/API/Geometry/Rectangle.d.ts +3 -7
  17. package/API/Geometry/Size.d.ts +8 -2
  18. package/API/Interfaces/IAuditable.d.ts +31 -0
  19. package/API/Interfaces/IDeserializable.d.ts +2 -1
  20. package/API/Interfaces/ILabelled.d.ts +2 -1
  21. package/API/Interfaces/IRequestable.d.ts +5 -1
  22. package/API/Objects.d.ts +0 -28
  23. package/API/SearchPattern.d.ts +3 -2
  24. package/API/TimeSpan.d.ts +7 -38
  25. package/API/Timezone.d.ts +3 -3
  26. package/API/Types.d.ts +18 -0
  27. package/Accounts/Contact.d.ts +10 -10
  28. package/Accounts/Machine.d.ts +14 -6
  29. package/Accounts/Permissions/Permission.d.ts +3 -3
  30. package/Accounts/Permissions/PermissionEscalation.d.ts +11 -3
  31. package/Accounts/Permissions/PermissionEscalationState.d.ts +5 -3
  32. package/Accounts/Session.d.ts +2 -2
  33. package/Accounts/User.d.ts +10 -10
  34. package/Accounts/UserAdvanced.d.ts +2 -2
  35. package/Accounts/UserGeneral.d.ts +5 -5
  36. package/Accounts/UserGroup.d.ts +3 -3
  37. package/Accounts/UserNotifications.d.ts +2 -2
  38. package/Assets/Asset.d.ts +56 -24
  39. package/Assets/AssetAdvanced.d.ts +8 -20
  40. package/Assets/AssetAttribute.d.ts +2 -2
  41. package/Assets/AssetDispatch.d.ts +5 -12
  42. package/Assets/AssetGeneral.d.ts +44 -24
  43. package/Assets/AssetPlaceStatus.d.ts +2 -2
  44. package/Behaviours/Behaviour.d.ts +4 -4
  45. package/Behaviours/BehaviourLog.d.ts +3 -3
  46. package/Behaviours/BehaviourParameter.d.ts +2 -1
  47. package/Behaviours/BehaviourScript.d.ts +4 -4
  48. package/Billing/BillableBase.d.ts +3 -3
  49. package/Billing/BillableSmsProfile.d.ts +2 -2
  50. package/Billing/BillingProfile.d.ts +3 -3
  51. package/Billing/Hosting/BillableHostingBase.d.ts +2 -2
  52. package/Billing/Hosting/BillableHostingDiscount.d.ts +2 -1
  53. package/Billing/Hosting/BillableHostingLicense.d.ts +2 -1
  54. package/Billing/Hosting/BillableHostingRule.d.ts +2 -1
  55. package/Billing/Report/BillingReport.d.ts +3 -3
  56. package/Billing/Report/BillingReportBreakdown.d.ts +2 -2
  57. package/Billing/Report/BillingReportHostingSummary.d.ts +2 -2
  58. package/Billing/Report/BillingReportLicenseBreakdown.d.ts +2 -2
  59. package/Billing/Report/BillingReportServiceBreakdown.d.ts +2 -2
  60. package/Billing/Report/BillingReportSummary.d.ts +2 -2
  61. package/Companies/ColourStyle.d.ts +2 -2
  62. package/Companies/Company.d.ts +48 -33
  63. package/Companies/CompanyDirectory.d.ts +10 -5
  64. package/Companies/CompanyGeneral.d.ts +10 -5
  65. package/Companies/{CompanyPolicies.d.ts → CompanyPolicy.d.ts} +9 -4
  66. package/Companies/CompanyReseller.d.ts +14 -9
  67. package/Companies/{CompanyStyles.d.ts → CompanyStyle.d.ts} +11 -6
  68. package/Companies/LabelStyle.d.ts +2 -2
  69. package/Companies/NotificationServerEmail.d.ts +2 -2
  70. package/Companies/NotificationServerSms.d.ts +3 -3
  71. package/Companies/PasswordPolicy.d.ts +2 -2
  72. package/Companies/SessionPolicy.d.ts +2 -2
  73. package/Dispatch/DispatchDirection.d.ts +3 -3
  74. package/Dispatch/DispatchJob.d.ts +4 -4
  75. package/Dispatch/DispatchStep.d.ts +4 -4
  76. package/Dispatch/DispatchStepState.d.ts +3 -3
  77. package/Dispatch/DispatchTask.d.ts +5 -5
  78. package/Hosting/Document.d.ts +3 -3
  79. package/Hosting/Fields/FormFieldAttachments.d.ts +4 -11
  80. package/Hosting/Fields/FormFieldBase.d.ts +8 -23
  81. package/Hosting/Fields/FormFieldBase_fromJSON.d.ts +1 -0
  82. package/Hosting/Fields/FormFieldBoolean.d.ts +4 -12
  83. package/Hosting/Fields/FormFieldChoice.d.ts +10 -12
  84. package/Hosting/Fields/FormFieldDate.d.ts +2 -9
  85. package/Hosting/Fields/FormFieldNumeric.d.ts +2 -9
  86. package/Hosting/Fields/FormFieldSignature.d.ts +2 -2
  87. package/Hosting/Fields/FormFieldText.d.ts +2 -9
  88. package/Hosting/Fields/FormFieldTime.d.ts +12 -9
  89. package/Hosting/Fields/FormFieldTimezone.d.ts +2 -2
  90. package/Hosting/FormResult.d.ts +4 -4
  91. package/Hosting/FormTemplate.d.ts +3 -3
  92. package/Images/Dashcam.d.ts +3 -3
  93. package/Images/DashcamBase.d.ts +2 -2
  94. package/Images/DashcamLive.d.ts +3 -3
  95. package/Images/Icon.d.ts +7 -27
  96. package/Images/IconGlyph.d.ts +5 -12
  97. package/Images/IconLabel.d.ts +5 -8
  98. package/Images/Picture.d.ts +3 -3
  99. package/Maintenance/MaintenanceInterval.d.ts +2 -2
  100. package/Maintenance/MaintenanceJob.d.ts +3 -3
  101. package/Maintenance/MaintenanceSchedule.d.ts +4 -4
  102. package/Messaging/AssetAlert.d.ts +2 -1
  103. package/Messaging/AssetMessage.d.ts +2 -2
  104. package/Messaging/MessageBase.d.ts +3 -3
  105. package/Places/Place.d.ts +4 -4
  106. package/Providers/Config/ProviderConfig.d.ts +4 -4
  107. package/Providers/Config/ProviderRegistration.d.ts +2 -2
  108. package/Providers/Config/ProviderScript.d.ts +4 -4
  109. package/Providers/Config/ProviderScriptBlock.d.ts +2 -1
  110. package/Providers/Config/ProviderScriptParameter.d.ts +2 -2
  111. package/Providers/Configuration/ProviderConfiguration.d.ts +4 -4
  112. package/Providers/Configuration/ProviderConfigurationNode.d.ts +4 -3
  113. package/Providers/Configuration/ProviderConfigurationType.d.ts +4 -4
  114. package/Providers/Configuration/ProviderGeofenceBase.d.ts +6 -8
  115. package/Providers/Configuration/ProviderGeofenceBase_fromJSON.d.ts +1 -0
  116. package/Providers/Provider.d.ts +80 -14
  117. package/Providers/ProviderAdvanced.d.ts +4 -4
  118. package/Providers/ProviderCommand.d.ts +2 -2
  119. package/Providers/ProviderControl.d.ts +3 -3
  120. package/Providers/ProviderData.d.ts +2 -2
  121. package/Providers/ProviderGeneral.d.ts +18 -10
  122. package/Reports/ReportBreakdown.d.ts +9 -32
  123. package/Reports/ReportBreakdownJob.d.ts +6 -31
  124. package/Reports/ReportBreakdownMessage.d.ts +7 -32
  125. package/Reports/ReportBreakdownTask.d.ts +6 -31
  126. package/Reports/ReportBreakdown_fromJSON.d.ts +1 -0
  127. package/Reports/ReportNotifications.d.ts +3 -3
  128. package/Reports/ReportOptions.d.ts +3 -2
  129. package/Reports/ReportParameter.d.ts +2 -1
  130. package/Reports/ReportRecurrence.d.ts +2 -2
  131. package/Reports/ReportResult.d.ts +9 -9
  132. package/Reports/ReportSchedule.d.ts +3 -3
  133. package/Reports/ReportScorecard.d.ts +3 -3
  134. package/Reports/ReportScorecardParameter.d.ts +2 -2
  135. package/Reports/ReportScorecardRules.d.ts +2 -2
  136. package/Reports/ReportSummary.d.ts +5 -33
  137. package/Reports/ReportTemplate.d.ts +3 -3
  138. package/Reports/ReportTotal.d.ts +2 -2
  139. package/index.d.ts +406 -0
  140. package/package.json +31 -22
  141. package/{Storage.d.ts → storage.d.ts} +11 -1
  142. package/trakit-objects.min.js +8 -0
  143. package/API/Component.d.ts +0 -42
  144. package/API/Compound.d.ts +0 -19
  145. package/Assets/Person.d.ts +0 -25
  146. package/Assets/PersonGeneral.d.ts +0 -35
  147. package/Assets/Trailer.d.ts +0 -42
  148. package/Assets/TrailerGeneral.d.ts +0 -47
  149. package/Assets/Vehicle.d.ts +0 -73
  150. package/Assets/VehicleAdvanced.d.ts +0 -25
  151. package/Assets/VehicleGeneral.d.ts +0 -33
  152. package/README.md +0 -13
  153. package/Reports/ReportDataTotal.d.ts +0 -50
  154. package/objects.d.ts +0 -534
  155. package/objects.min.js +0 -7
@@ -1,73 +0,0 @@
1
- import { colour, double, ushort } from "../API/Types";
2
- import { Asset } from "./Asset";
3
- import { VehicleGeneral } from "./VehicleGeneral";
4
- import { VehicleAdvanced } from "./VehicleAdvanced";
5
- /**
6
- * The full details of a Vehicle, containing all the properties from the {@link VehicleGeneral} and {@link VehicleAdvanced} objects.
7
- */
8
- export declare class Vehicle extends Asset {
9
- /**
10
- * General details about this vehicle.
11
- */
12
- get general(): VehicleGeneral;
13
- /**
14
- * Advanced details about this vehicle.
15
- */
16
- get advanced(): VehicleAdvanced;
17
- /**
18
- * The license plate.
19
- */
20
- get plate(): string;
21
- /**
22
- * Manufacturer's unique identification number (Vehicle Identification Number).
23
- */
24
- get vin(): string;
25
- set vin(value: string);
26
- /**
27
- * Manufacturer's name.
28
- */
29
- get make(): string;
30
- set make(value: string);
31
- /**
32
- * Manufacturer's model name/number.
33
- */
34
- get model(): string;
35
- set model(value: string);
36
- /**
37
- * Year of manufacturing.
38
- */
39
- get year(): ushort;
40
- set year(value: ushort);
41
- /**
42
- * Primary colour of the trailer (given in 24bit hex; #RRGGBB)
43
- */
44
- get colour(): colour;
45
- set colour(value: colour);
46
- /**
47
- * The cumulative duration that the vehicle's engine has been running (in decimal hours).
48
- */
49
- get engineHours(): double;
50
- set engineHours(value: double);
51
- toJSON(): {
52
- engineHours: number;
53
- plate: string;
54
- vin: string;
55
- make: string;
56
- model: string;
57
- year: number;
58
- colour: string;
59
- id: number | null;
60
- v: number[];
61
- company: number;
62
- kind: import("./AssetType").AssetType;
63
- name: string;
64
- notes: string;
65
- icon: number;
66
- labels: string[];
67
- suspended?: boolean | undefined;
68
- since?: string | null | undefined;
69
- references?: object | undefined;
70
- messagingAddress?: string | undefined;
71
- pictures?: number[] | undefined;
72
- };
73
- }
@@ -1,25 +0,0 @@
1
- import { double } from "../API/Types";
2
- import { AssetAdvanced } from "./AssetAdvanced";
3
- /**
4
- * Often changing details about a vehicle.
5
- */
6
- export declare class VehicleAdvanced extends AssetAdvanced {
7
- /**
8
- * The cumulative duration that the vehicle's engine has been running (in decimal hours).
9
- */
10
- engineHours: double;
11
- toJSON(): {
12
- engineHours: number | null;
13
- id: number | null;
14
- v: number[];
15
- company: number;
16
- position: import("../API/Geography/Interfaces").IPosition | null;
17
- odometer: number;
18
- tags: string[];
19
- attributes: object;
20
- providers: string[];
21
- relationships: number[];
22
- places: object;
23
- };
24
- fromJSON(json: any, force?: boolean): boolean;
25
- }
@@ -1,33 +0,0 @@
1
- import { colour, ushort } from "../API/Types";
2
- import { AssetGeneral } from "./AssetGeneral";
3
- /**
4
- * Seldom changing details about a vehicle.
5
- */
6
- export declare class VehicleGeneral extends AssetGeneral {
7
- /**
8
- * Manufacturer's unique identification number (Vehicle Identification Number).
9
- */
10
- vin: string;
11
- /**
12
- * The license plate.
13
- */
14
- plate: string;
15
- /**
16
- * Manufacturer's name.
17
- */
18
- make: string;
19
- /**
20
- * Manufacturer's model name/number.
21
- */
22
- model: string;
23
- /**
24
- * Year of manufacturing.
25
- */
26
- year: ushort;
27
- /**
28
- * Primary colour of the vehicle (given in 24bit hex; #RRGGBB)
29
- */
30
- colour: colour;
31
- toJSON(): any;
32
- fromJSON(json: any, force?: boolean): boolean;
33
- }
package/README.md DELETED
@@ -1,13 +0,0 @@
1
- # Trak-iT API Object Model
2
-
3
- All of the Trak-iT APIs use the same object definitions.
4
- Other Trak-iT API libraries are available on [GitHub](https://github.com/trakitwireless) and [npm](https://www.npmjs.com/org/trakit).
5
-
6
- ### Prerequisites
7
-
8
- We do not require any other packages, however, we are targetting `ESNext`, so if your project uses CommonJS or another module manager, you will need to account for that yourself.
9
-
10
- ## Questions and Feedback
11
-
12
- If you have any questions, please start for the project on GitHub
13
- https://github.com/trakitwireless/trakit-ts-objects/issues
@@ -1,50 +0,0 @@
1
- import { ISerializable } from "../API/Interfaces/ISerializable";
2
- import { TimeSpan } from "../API/TimeSpan";
3
- import { double, timespan, uint, ulong } from "../API/Types";
4
- import { Asset } from "../Assets/Asset";
5
- /**
6
- * Totalled information from all the results of the report.
7
- * <override name="ReportTotal" />
8
- */
9
- export declare class ReportDataTotal implements ISerializable {
10
- /**
11
- *
12
- * @param json
13
- */
14
- static fromJSON(json: any): ReportDataTotal;
15
- /**
16
- * The asset to which this report total belongs.
17
- * {@link Asset.id}
18
- */
19
- assetId: ulong;
20
- /**
21
- * The asset to which this report total belongs.
22
- * {@link Asset.id}
23
- */
24
- get asset(): Asset;
25
- /**
26
- * Unique code given to the report total.
27
- * <override max-length="100" />
28
- */
29
- stateDetail: string;
30
- /**
31
- * The number of summary instances included in this total.
32
- */
33
- summaryCount: uint;
34
- /**
35
- * The total duration of all summary instances.
36
- */
37
- duration: TimeSpan;
38
- /**
39
- * The total distance travelled in kilometres of all summary instances.
40
- */
41
- distance: double;
42
- constructor(asset?: ulong, stateDetail?: string, summaryCount?: uint, duration?: TimeSpan | timespan | number, distance?: double);
43
- toJSON(): {
44
- asset: number | null;
45
- stateDetail: string;
46
- summaryCount: number | null;
47
- duration: string;
48
- distance: number | null;
49
- };
50
- }