servicem8 0.9.28 → 0.9.30

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 (86) hide show
  1. package/api.json +381 -346
  2. package/bin/mcp-server.js +70 -30
  3. package/bin/mcp-server.js.map +9 -9
  4. package/dist/commonjs/lib/config.d.ts +2 -2
  5. package/dist/commonjs/lib/config.js +2 -2
  6. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  7. package/dist/commonjs/mcp-server/server.js +1 -1
  8. package/dist/commonjs/models/components/company.d.ts +6 -0
  9. package/dist/commonjs/models/components/company.d.ts.map +1 -1
  10. package/dist/commonjs/models/components/company.js.map +1 -1
  11. package/dist/commonjs/models/components/job.d.ts +222 -50
  12. package/dist/commonjs/models/components/job.d.ts.map +1 -1
  13. package/dist/commonjs/models/components/job.js +107 -17
  14. package/dist/commonjs/models/components/job.js.map +1 -1
  15. package/dist/commonjs/models/components/jobactivity.d.ts +50 -8
  16. package/dist/commonjs/models/components/jobactivity.d.ts.map +1 -1
  17. package/dist/commonjs/models/components/jobactivity.js +8 -8
  18. package/dist/commonjs/models/components/jobactivity.js.map +1 -1
  19. package/dist/commonjs/models/components/jobmaterial.d.ts +12 -0
  20. package/dist/commonjs/models/components/jobmaterial.d.ts.map +1 -1
  21. package/dist/commonjs/models/components/jobmaterial.js.map +1 -1
  22. package/dist/esm/lib/config.d.ts +2 -2
  23. package/dist/esm/lib/config.js +2 -2
  24. package/dist/esm/mcp-server/mcp-server.js +1 -1
  25. package/dist/esm/mcp-server/server.js +1 -1
  26. package/dist/esm/models/components/company.d.ts +6 -0
  27. package/dist/esm/models/components/company.d.ts.map +1 -1
  28. package/dist/esm/models/components/company.js.map +1 -1
  29. package/dist/esm/models/components/job.d.ts +222 -50
  30. package/dist/esm/models/components/job.d.ts.map +1 -1
  31. package/dist/esm/models/components/job.js +106 -16
  32. package/dist/esm/models/components/job.js.map +1 -1
  33. package/dist/esm/models/components/jobactivity.d.ts +50 -8
  34. package/dist/esm/models/components/jobactivity.d.ts.map +1 -1
  35. package/dist/esm/models/components/jobactivity.js +8 -8
  36. package/dist/esm/models/components/jobactivity.js.map +1 -1
  37. package/dist/esm/models/components/jobmaterial.d.ts +12 -0
  38. package/dist/esm/models/components/jobmaterial.d.ts.map +1 -1
  39. package/dist/esm/models/components/jobmaterial.js.map +1 -1
  40. package/docs/sdks/allocationwindows/README.md +4 -4
  41. package/docs/sdks/assets/README.md +6 -6
  42. package/docs/sdks/assettypefields/README.md +8 -8
  43. package/docs/sdks/assettypes/README.md +4 -4
  44. package/docs/sdks/attachments/README.md +12 -12
  45. package/docs/sdks/badges/README.md +12 -12
  46. package/docs/sdks/bundles/README.md +4 -4
  47. package/docs/sdks/categories/README.md +4 -4
  48. package/docs/sdks/clients/README.md +8 -8
  49. package/docs/sdks/companycontacts/README.md +8 -8
  50. package/docs/sdks/documenttemplates/README.md +4 -4
  51. package/docs/sdks/emailtemplates/README.md +4 -4
  52. package/docs/sdks/feedback/README.md +8 -8
  53. package/docs/sdks/formfields/README.md +8 -8
  54. package/docs/sdks/formresponses/README.md +28 -28
  55. package/docs/sdks/forms/README.md +8 -8
  56. package/docs/sdks/jobactivities/README.md +20 -20
  57. package/docs/sdks/joballocations/README.md +24 -24
  58. package/docs/sdks/jobchecklists/README.md +32 -32
  59. package/docs/sdks/jobcontacts/README.md +8 -8
  60. package/docs/sdks/jobmaterialbundles/README.md +12 -12
  61. package/docs/sdks/jobmaterials/README.md +20 -20
  62. package/docs/sdks/jobpayments/README.md +20 -16
  63. package/docs/sdks/jobqueues/README.md +4 -4
  64. package/docs/sdks/jobs/README.md +32 -32
  65. package/docs/sdks/jobtemplates/README.md +4 -4
  66. package/docs/sdks/knowledgearticles/README.md +4 -4
  67. package/docs/sdks/locations/README.md +4 -4
  68. package/docs/sdks/materials/README.md +8 -8
  69. package/docs/sdks/notes/README.md +12 -12
  70. package/docs/sdks/securityroles/README.md +4 -4
  71. package/docs/sdks/smstemplates/README.md +4 -4
  72. package/docs/sdks/staffmembers/README.md +12 -12
  73. package/docs/sdks/staffmessages/README.md +16 -16
  74. package/docs/sdks/tasks/README.md +20 -20
  75. package/docs/sdks/taxrates/README.md +4 -4
  76. package/docs/sdks/vendors/README.md +2 -2
  77. package/examples/package-lock.json +1 -1
  78. package/jsr.json +1 -1
  79. package/package.json +1 -1
  80. package/src/lib/config.ts +2 -2
  81. package/src/mcp-server/mcp-server.ts +1 -1
  82. package/src/mcp-server/server.ts +1 -1
  83. package/src/models/components/company.ts +6 -0
  84. package/src/models/components/job.ts +242 -66
  85. package/src/models/components/jobactivity.ts +58 -16
  86. package/src/models/components/jobmaterial.ts +12 -0
@@ -34,19 +34,40 @@ export type JobActivity = {
34
34
  * Timestamp at which record was last modified
35
35
  */
36
36
  editDate?: any | undefined;
37
+ /**
38
+ * The UUID of the job this activity belongs to
39
+ */
37
40
  jobUuid?: string | undefined;
41
+ /**
42
+ * The UUID of the staff member assigned to this activity
43
+ */
38
44
  staffUuid?: string | undefined;
45
+ /**
46
+ * The scheduled start date and time of the activity
47
+ */
39
48
  startDate?: string | undefined;
49
+ /**
50
+ * The scheduled end date and time of the activity
51
+ */
40
52
  endDate?: string | undefined;
41
53
  activityWasScheduled?: string | undefined;
42
54
  activityWasRecorded?: string | undefined;
43
55
  activityWasAutomated?: string | undefined;
44
56
  hasBeenOpened?: string | undefined;
45
57
  hasBeenOpenedTimestamp?: string | undefined;
46
- travelTimeInSeconds?: string | undefined;
47
- travelDistanceInMeters?: string | undefined;
58
+ /**
59
+ * The estimated travel time to reach this activity location in seconds
60
+ */
61
+ travelTimeInSeconds?: number | undefined;
62
+ /**
63
+ * The estimated travel distance to reach this activity location in meters
64
+ */
65
+ travelDistanceInMeters?: number | undefined;
48
66
  allocatedByStaffUuid?: string | undefined;
49
67
  allocatedTimestamp?: string | undefined;
68
+ /**
69
+ * The UUID of the material associated with this activity. Used to determine the cost of the activity.
70
+ */
50
71
  materialUuid?: string | undefined;
51
72
  /**
52
73
  * UUID of Staff Member who last modified record
@@ -63,19 +84,40 @@ export type JobActivityInput = {
63
84
  * Record active/deleted flag. Valid values are [0,1]. Valid values are [0,1]
64
85
  */
65
86
  active?: JobActivityActive | undefined;
87
+ /**
88
+ * The UUID of the job this activity belongs to
89
+ */
66
90
  jobUuid?: string | undefined;
91
+ /**
92
+ * The UUID of the staff member assigned to this activity
93
+ */
67
94
  staffUuid?: string | undefined;
95
+ /**
96
+ * The scheduled start date and time of the activity
97
+ */
68
98
  startDate?: string | undefined;
99
+ /**
100
+ * The scheduled end date and time of the activity
101
+ */
69
102
  endDate?: string | undefined;
70
103
  activityWasScheduled?: string | undefined;
71
104
  activityWasRecorded?: string | undefined;
72
105
  activityWasAutomated?: string | undefined;
73
106
  hasBeenOpened?: string | undefined;
74
107
  hasBeenOpenedTimestamp?: string | undefined;
75
- travelTimeInSeconds?: string | undefined;
76
- travelDistanceInMeters?: string | undefined;
108
+ /**
109
+ * The estimated travel time to reach this activity location in seconds
110
+ */
111
+ travelTimeInSeconds?: number | undefined;
112
+ /**
113
+ * The estimated travel distance to reach this activity location in meters
114
+ */
115
+ travelDistanceInMeters?: number | undefined;
77
116
  allocatedByStaffUuid?: string | undefined;
78
117
  allocatedTimestamp?: string | undefined;
118
+ /**
119
+ * The UUID of the material associated with this activity. Used to determine the cost of the activity.
120
+ */
79
121
  materialUuid?: string | undefined;
80
122
  };
81
123
 
@@ -118,8 +160,8 @@ export const JobActivity$inboundSchema: z.ZodType<
118
160
  activity_was_automated: z.string().optional(),
119
161
  has_been_opened: z.string().optional(),
120
162
  has_been_opened_timestamp: z.string().optional(),
121
- travel_time_in_seconds: z.string().optional(),
122
- travel_distance_in_meters: z.string().optional(),
163
+ travel_time_in_seconds: z.number().int().optional(),
164
+ travel_distance_in_meters: z.number().int().optional(),
123
165
  allocated_by_staff_uuid: z.string().optional(),
124
166
  allocated_timestamp: z.string().optional(),
125
167
  material_uuid: z.string().optional(),
@@ -159,8 +201,8 @@ export type JobActivity$Outbound = {
159
201
  activity_was_automated?: string | undefined;
160
202
  has_been_opened?: string | undefined;
161
203
  has_been_opened_timestamp?: string | undefined;
162
- travel_time_in_seconds?: string | undefined;
163
- travel_distance_in_meters?: string | undefined;
204
+ travel_time_in_seconds?: number | undefined;
205
+ travel_distance_in_meters?: number | undefined;
164
206
  allocated_by_staff_uuid?: string | undefined;
165
207
  allocated_timestamp?: string | undefined;
166
208
  material_uuid?: string | undefined;
@@ -185,8 +227,8 @@ export const JobActivity$outboundSchema: z.ZodType<
185
227
  activityWasAutomated: z.string().optional(),
186
228
  hasBeenOpened: z.string().optional(),
187
229
  hasBeenOpenedTimestamp: z.string().optional(),
188
- travelTimeInSeconds: z.string().optional(),
189
- travelDistanceInMeters: z.string().optional(),
230
+ travelTimeInSeconds: z.number().int().optional(),
231
+ travelDistanceInMeters: z.number().int().optional(),
190
232
  allocatedByStaffUuid: z.string().optional(),
191
233
  allocatedTimestamp: z.string().optional(),
192
234
  materialUuid: z.string().optional(),
@@ -256,8 +298,8 @@ export const JobActivityInput$inboundSchema: z.ZodType<
256
298
  activity_was_automated: z.string().optional(),
257
299
  has_been_opened: z.string().optional(),
258
300
  has_been_opened_timestamp: z.string().optional(),
259
- travel_time_in_seconds: z.string().optional(),
260
- travel_distance_in_meters: z.string().optional(),
301
+ travel_time_in_seconds: z.number().int().optional(),
302
+ travel_distance_in_meters: z.number().int().optional(),
261
303
  allocated_by_staff_uuid: z.string().optional(),
262
304
  allocated_timestamp: z.string().optional(),
263
305
  material_uuid: z.string().optional(),
@@ -293,8 +335,8 @@ export type JobActivityInput$Outbound = {
293
335
  activity_was_automated?: string | undefined;
294
336
  has_been_opened?: string | undefined;
295
337
  has_been_opened_timestamp?: string | undefined;
296
- travel_time_in_seconds?: string | undefined;
297
- travel_distance_in_meters?: string | undefined;
338
+ travel_time_in_seconds?: number | undefined;
339
+ travel_distance_in_meters?: number | undefined;
298
340
  allocated_by_staff_uuid?: string | undefined;
299
341
  allocated_timestamp?: string | undefined;
300
342
  material_uuid?: string | undefined;
@@ -317,8 +359,8 @@ export const JobActivityInput$outboundSchema: z.ZodType<
317
359
  activityWasAutomated: z.string().optional(),
318
360
  hasBeenOpened: z.string().optional(),
319
361
  hasBeenOpenedTimestamp: z.string().optional(),
320
- travelTimeInSeconds: z.string().optional(),
321
- travelDistanceInMeters: z.string().optional(),
362
+ travelTimeInSeconds: z.number().int().optional(),
363
+ travelDistanceInMeters: z.number().int().optional(),
322
364
  allocatedByStaffUuid: z.string().optional(),
323
365
  allocatedTimestamp: z.string().optional(),
324
366
  materialUuid: z.string().optional(),
@@ -43,7 +43,13 @@ export type JobMaterial = {
43
43
  displayedAmountIsTaxInclusive?: string | undefined;
44
44
  taxRateUuid?: string | undefined;
45
45
  sortOrder?: string | undefined;
46
+ /**
47
+ * The cost of the material for this job. This is the ex-tax amount.
48
+ */
46
49
  cost?: string | undefined;
50
+ /**
51
+ * The cost of the material for this job, displayed as inc-tax or ex-tax depending on jobMaterial.displayed_amount_is_tax_inclusive.
52
+ */
47
53
  displayedCost?: string | undefined;
48
54
  /**
49
55
  * UUID of a JobMaterialBundle which this JobMaterial belongs to. The default value is blank, which means that the JobMaterial is not part of a JobMaterialBundle.
@@ -69,7 +75,13 @@ export type JobMaterialInput = {
69
75
  displayedAmountIsTaxInclusive?: string | undefined;
70
76
  taxRateUuid?: string | undefined;
71
77
  sortOrder?: string | undefined;
78
+ /**
79
+ * The cost of the material for this job. This is the ex-tax amount.
80
+ */
72
81
  cost?: string | undefined;
82
+ /**
83
+ * The cost of the material for this job, displayed as inc-tax or ex-tax depending on jobMaterial.displayed_amount_is_tax_inclusive.
84
+ */
73
85
  displayedCost?: string | undefined;
74
86
  /**
75
87
  * UUID of a JobMaterialBundle which this JobMaterial belongs to. The default value is blank, which means that the JobMaterial is not part of a JobMaterialBundle.