@turndown/library 0.1.53 → 0.1.55

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.
package/dist/index.d.cts CHANGED
@@ -497,6 +497,9 @@ type TJsonObject = {
497
497
  };
498
498
  type TJsonValue = TJsonPrimitive | TJsonValue[] | TJsonObject;
499
499
  type TUnknownRecord = Record<string, unknown>;
500
+ /**
501
+ * Serialized ISO-8601 date/time value returned by API JSON contracts.
502
+ */
500
503
  type TDateTimeString = string;
501
504
  type TurndownObject<TObject extends object = TUnknownRecord> = TObject;
502
505
  type TEmptyObject = Record<string, never>;
@@ -512,9 +515,9 @@ interface ICountResponse {
512
515
  count: number;
513
516
  }
514
517
  interface IMetaData {
515
- createdAt: Date;
516
- updatedAt: Date;
517
- deletedAt?: Date;
518
+ createdAt: TDateTimeString;
519
+ updatedAt: TDateTimeString;
520
+ deletedAt: TDateTimeString | null;
518
521
  }
519
522
  type TRecordValue<TRecord extends object> = TRecord[keyof TRecord];
520
523
  type TRecordKeys<TRecord extends object> = keyof TRecord;
@@ -536,11 +539,11 @@ declare const MODE: {
536
539
  };
537
540
  type TMode = TRecordValue<typeof MODE> | null;
538
541
  declare const IMAGE_ENTITY: {
539
- readonly UserProfile: "UserProfile";
540
- readonly Property: "Property";
541
- readonly PropertyRoom: "PropertyRoom";
542
- readonly MaintenanceTicket: "MaintenanceTicket";
543
- readonly WorkReport: "WorkReport";
542
+ readonly USER_PROFILE: "USER_PROFILE";
543
+ readonly PROPERTY: "PROPERTY";
544
+ readonly PROPERTY_ROOM: "PROPERTY_ROOM";
545
+ readonly MAINTENANCE_TICKET: "MAINTENANCE_TICKET";
546
+ readonly WORK_REPORT: "WORK_REPORT";
544
547
  };
545
548
  type TImageEntityType = TRecordValue<typeof IMAGE_ENTITY>;
546
549
  type TUSStateCode = TRecordKeys<typeof US_JURISDICTIONS>;
@@ -604,26 +607,26 @@ declare const US_JURISDICTIONS: {
604
607
  };
605
608
  type TUSJurisdiction = TRecordValue<typeof US_JURISDICTIONS>;
606
609
  declare const STATUS: {
607
- readonly Pending: "Pending";
608
- readonly InProgress: "InProgress";
609
- readonly Completed: "Completed";
610
- readonly Overdue: "Overdue";
611
- readonly Active: "Active";
612
- readonly Inactive: "Inactive";
610
+ readonly PENDING: "PENDING";
611
+ readonly IN_PROGRESS: "IN_PROGRESS";
612
+ readonly COMPLETED: "COMPLETED";
613
+ readonly OVERDUE: "OVERDUE";
614
+ readonly ACTIVE: "ACTIVE";
615
+ readonly INACTIVE: "INACTIVE";
613
616
  };
614
617
  type TStatus = TRecordValue<typeof STATUS>;
615
618
  declare const SEVERITY: {
616
- readonly Low: "Low";
617
- readonly Medium: "Medium";
618
- readonly High: "High";
619
+ readonly LOW: "LOW";
620
+ readonly MEDIUM: "MEDIUM";
621
+ readonly HIGH: "HIGH";
619
622
  };
620
623
  type TSeverity = TRecordValue<typeof SEVERITY>;
621
624
  declare const SERVICE_TYPES: {
622
- readonly Property: "Property";
623
- readonly Cleaning: "Cleaning";
624
- readonly Maintenance: "Maintenance";
625
- readonly Inspection: "Inspections";
626
- readonly Other: "Other";
625
+ readonly PROPERTY: "PROPERTY";
626
+ readonly CLEANING: "CLEANING";
627
+ readonly MAINTENANCE: "MAINTENANCE";
628
+ readonly INSPECTION: "INSPECTION";
629
+ readonly OTHER: "OTHER";
627
630
  };
628
631
  type TServiceType = TRecordValue<typeof SERVICE_TYPES>;
629
632
  declare const MONTHS: readonly ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"];
@@ -693,26 +696,9 @@ declare const UnitedStatesJurisdictionOptions: ISelectOption<TRecordValue<{
693
696
  readonly AS: "American Samoa";
694
697
  readonly MP: "Northern Mariana Islands";
695
698
  }>>[];
696
- declare const StatusOptions: ISelectOption<TRecordValue<{
697
- readonly Pending: "Pending";
698
- readonly InProgress: "InProgress";
699
- readonly Completed: "Completed";
700
- readonly Overdue: "Overdue";
701
- readonly Active: "Active";
702
- readonly Inactive: "Inactive";
703
- }>>[];
704
- declare const SeverityOptions: ISelectOption<TRecordValue<{
705
- readonly Low: "Low";
706
- readonly Medium: "Medium";
707
- readonly High: "High";
708
- }>>[];
709
- declare const ServiceTypeOptions: ISelectOption<TRecordValue<{
710
- readonly Property: "Property";
711
- readonly Cleaning: "Cleaning";
712
- readonly Maintenance: "Maintenance";
713
- readonly Inspection: "Inspections";
714
- readonly Other: "Other";
715
- }>>[];
699
+ declare const StatusOptions: ISelectOption<TStatus>[];
700
+ declare const SeverityOptions: ISelectOption<TSeverity>[];
701
+ declare const ServiceTypeOptions: ISelectOption<TServiceType>[];
716
702
 
717
703
  /**
718
704
  * API Response Types
@@ -725,11 +711,6 @@ declare const HTTP_METHOD: {
725
711
  readonly PUT: "PUT";
726
712
  readonly PATCH: "PATCH";
727
713
  readonly DELETE: "DELETE";
728
- readonly Get: "GET";
729
- readonly Post: "POST";
730
- readonly Put: "PUT";
731
- readonly Patch: "PATCH";
732
- readonly Delete: "DELETE";
733
714
  };
734
715
  type THttpMethod = (typeof HTTP_METHOD)[keyof typeof HTTP_METHOD];
735
716
  /**
@@ -751,20 +732,6 @@ declare const ERROR_CODES: {
751
732
  readonly INTERNAL_ERROR: "INTERNAL_ERROR";
752
733
  readonly DATABASE_ERROR: "DATABASE_ERROR";
753
734
  readonly NOT_IMPLEMENTED: "NOT_IMPLEMENTED";
754
- readonly BadRequest: "BAD_REQUEST";
755
- readonly ValidationError: "VALIDATION_ERROR";
756
- readonly MissingFields: "MISSING_FIELDS";
757
- readonly Unauthorized: "UNAUTHORIZED";
758
- readonly InvalidToken: "INVALID_TOKEN";
759
- readonly InvalidCredentials: "INVALID_CREDENTIALS";
760
- readonly Forbidden: "FORBIDDEN";
761
- readonly NotFound: "NOT_FOUND";
762
- readonly Conflict: "CONFLICT";
763
- readonly AlreadyExists: "ALREADY_EXISTS";
764
- readonly RateLimit: "RATE_LIMIT_EXCEEDED";
765
- readonly InternalError: "INTERNAL_ERROR";
766
- readonly DatabaseError: "DATABASE_ERROR";
767
- readonly NotImplemented: "NOT_IMPLEMENTED";
768
735
  };
769
736
  type TErrorCode = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];
770
737
  /**
@@ -792,7 +759,7 @@ interface IApiError<TDetails = TApiErrorDetails> {
792
759
  details?: TDetails;
793
760
  }
794
761
  interface IApiMeta {
795
- timestamp: string;
762
+ timestamp: TDateTimeString;
796
763
  version: string;
797
764
  environment: string;
798
765
  requestId?: string;
@@ -826,14 +793,21 @@ type IGetStaffRequest = IEmptyRouteRequest;
826
793
  interface IGetStaffResponse {
827
794
  staff: IUserSafe[];
828
795
  }
829
- interface IUpdateUserRequest extends Partial<Pick<IUserSafe, "firstName" | "lastName" | "mi" | "username" | "email" | "phoneNumber" | "phoneFormat" | "preferredLanguage">> {
796
+ interface IUpdateUserRequest {
797
+ firstName?: string;
798
+ lastName?: string | null;
799
+ mi?: string | null;
800
+ username?: string | null;
801
+ email?: string;
802
+ phoneNumber?: string | null;
803
+ phoneFormat?: string | null;
804
+ preferredLanguage?: IUserSafe["preferredLanguage"];
830
805
  }
831
806
  interface IUpdateUserResponse {
832
807
  user: IUserSafe;
833
808
  }
834
809
  type IDeleteUserRequest = IEmptyRouteRequest;
835
- interface IDeleteUserResponse {
836
- message: string;
810
+ interface IDeleteUserResponse extends IMessageResponse {
837
811
  }
838
812
  interface IGetUsersByAccountTypeRequest {
839
813
  accountType: TAccountType;
@@ -843,46 +817,46 @@ interface IGetUsersByAccountTypeResponse {
843
817
  }
844
818
 
845
819
  declare const ACCOUNT_TYPE: {
846
- readonly TurndownAdmin: "TurndownAdmin";
847
- readonly AccountAdmin: "AccountAdmin";
848
- readonly Manager: "Manager";
849
- readonly Staff: "Staff";
850
- readonly Guest: "Guest";
820
+ readonly TURNDOWN_ADMIN: "TURNDOWN_ADMIN";
821
+ readonly ACCOUNT_ADMIN: "ACCOUNT_ADMIN";
822
+ readonly MANAGER: "MANAGER";
823
+ readonly STAFF: "STAFF";
824
+ readonly GUEST: "GUEST";
851
825
  };
852
826
  type TAccountType = TRecordValue<typeof ACCOUNT_TYPE>;
853
827
  declare const ACCOUNT_STATUS: {
854
- readonly Active: "Active";
855
- readonly Inactive: "Inactive";
856
- readonly Suspended: "Suspended";
857
- readonly Pending: "Pending";
828
+ readonly ACTIVE: "ACTIVE";
829
+ readonly INACTIVE: "INACTIVE";
830
+ readonly SUSPENDED: "SUSPENDED";
831
+ readonly PENDING: "PENDING";
858
832
  };
859
833
  type TAccountStatus = TRecordValue<typeof ACCOUNT_STATUS>;
860
834
  declare const LANGUAGE: {
861
- readonly English: "English";
862
- readonly French: "French";
863
- readonly Spanish: "Spanish";
864
- readonly German: "German";
835
+ readonly ENGLISH: "ENGLISH";
836
+ readonly FRENCH: "FRENCH";
837
+ readonly SPANISH: "SPANISH";
838
+ readonly GERMAN: "GERMAN";
865
839
  };
866
840
  type TLanguage = TRecordValue<typeof LANGUAGE>;
867
841
  interface IUser extends IMetaData {
868
842
  readonly id: string;
869
843
  firstName: string;
870
- lastName?: string;
871
- mi?: string;
872
- username?: string;
844
+ lastName: string | null;
845
+ mi: string | null;
846
+ username: string | null;
873
847
  email: string;
874
- profilePhoto?: string;
848
+ profilePhoto: string | null;
875
849
  passwordHash?: string;
876
850
  loginAttempts?: number;
877
851
  locked?: boolean;
878
- passwordLastReset?: Date;
852
+ passwordLastReset: TDateTimeString | null;
879
853
  passwordResetRequired?: boolean;
880
- lastLogin?: Date;
854
+ lastLogin: TDateTimeString | null;
881
855
  accountType: TAccountType;
882
856
  status: TAccountStatus;
883
- phoneNumber?: string;
884
- phoneFormat?: string;
885
- preferredLanguage?: TLanguage;
857
+ phoneNumber: string | null;
858
+ phoneFormat: string | null;
859
+ preferredLanguage: TLanguage | null;
886
860
  biometrics?: string;
887
861
  }
888
862
  type IUserSafe = Omit<IUser, "passwordLastReset" | "lastLogin" | "passwordHash" | "loginAttempts" | "biometrics">;
@@ -893,9 +867,9 @@ interface IDeviceInfo {
893
867
  }
894
868
  interface IUserSession {
895
869
  id: number;
896
- deviceInfo?: IDeviceInfo | null;
897
- createdAt: Date;
898
- lastUsedAt: Date;
870
+ deviceInfo: IDeviceInfo | null;
871
+ createdAt: TDateTimeString;
872
+ lastUsedAt: TDateTimeString;
899
873
  }
900
874
 
901
875
  interface IAuthSessionIdParams {
@@ -919,7 +893,7 @@ interface IAuthInvitationBaseResponse {
919
893
  role: TAccountType;
920
894
  invitedBy: string;
921
895
  invitedByName: string;
922
- expiresAt: Date;
896
+ expiresAt: TDateTimeString;
923
897
  }
924
898
  interface IRegisterRequest {
925
899
  email: string;
@@ -964,8 +938,8 @@ type IGetSessionsRequest = IEmptyRouteRequest;
964
938
  interface IGetSessionsResponse {
965
939
  id: string;
966
940
  deviceInfo: string;
967
- createdAt: Date;
968
- lastUsedAt: Date;
941
+ createdAt: TDateTimeString;
942
+ lastUsedAt: TDateTimeString;
969
943
  }
970
944
  interface IRevokeSessionRequest extends IAuthSessionIdParams {
971
945
  }
@@ -990,7 +964,7 @@ interface IGetLoginHistoryResponse {
990
964
  userAgent: string;
991
965
  success: boolean;
992
966
  failureReason?: string;
993
- createdAt: Date;
967
+ createdAt: TDateTimeString;
994
968
  }
995
969
  interface IGetLoginHistoryListResponse {
996
970
  history: IGetLoginHistoryResponse[];
@@ -1027,7 +1001,7 @@ interface IAcceptInvitationRouteResponse {
1027
1001
  type IGetPendingInvitationsRequest = IEmptyRouteRequest;
1028
1002
  interface IGetPendingInvitationsResponse extends IAuthInvitationBaseResponse {
1029
1003
  token: string;
1030
- createdAt: Date;
1004
+ createdAt: TDateTimeString;
1031
1005
  }
1032
1006
  interface IGetPendingInvitationsListResponse {
1033
1007
  invitations: IGetPendingInvitationsResponse[];
@@ -1038,10 +1012,6 @@ interface IRevokeInvitationRequest extends IAuthInvitationIdParams {
1038
1012
  }
1039
1013
  interface IRevokeInvitationResponse extends IAuthMessageResponse {
1040
1014
  }
1041
- interface IRefreshRequest extends IRefreshSessionRequest {
1042
- }
1043
- interface IRefreshResponse extends IRefreshSessionResponse {
1044
- }
1045
1015
 
1046
1016
  declare const AUTH_STATUS: {
1047
1017
  readonly Initializing: "Initializing";
@@ -1060,17 +1030,17 @@ interface IRefreshTokenData {
1060
1030
  token: string;
1061
1031
  tokenHash: string;
1062
1032
  tokenFamily: string;
1063
- expiresAt: Date;
1033
+ expiresAt: TDateTimeString;
1064
1034
  }
1065
1035
  interface IAuthTokenBundle {
1066
1036
  accessToken: string;
1067
1037
  refreshToken: string;
1068
- expiresAt: Date | null;
1038
+ expiresAt: TDateTimeString | null;
1069
1039
  }
1070
1040
  interface IStoredAuthSession {
1071
1041
  accessToken: string | null;
1072
1042
  refreshToken: string | null;
1073
- expiresAt: Date | null;
1043
+ expiresAt: TDateTimeString | null;
1074
1044
  }
1075
1045
  interface IAuthTokenResponse extends IAuthTokenBundle {
1076
1046
  user: IUserSafe | null;
@@ -1079,7 +1049,7 @@ interface IAuthTokenResponse extends IAuthTokenBundle {
1079
1049
  interface IAuthSession {
1080
1050
  user: IUserSafe | null;
1081
1051
  accessToken: string | null;
1082
- expiresAt: Date | null;
1052
+ expiresAt: TDateTimeString | null;
1083
1053
  }
1084
1054
  interface ISetAuthSessionParams extends IAuthTokenBundle {
1085
1055
  user: IUserSafe | null;
@@ -1115,7 +1085,7 @@ interface IRateLimitStatus {
1115
1085
  isLimited: boolean;
1116
1086
  attempts: number;
1117
1087
  maxAttempts: number;
1118
- resetTime?: string;
1088
+ resetTime?: TDateTimeString;
1119
1089
  }
1120
1090
 
1121
1091
  interface IChecklistTemplateCompanyRouteParams {
@@ -1139,7 +1109,7 @@ interface ICreateTemplateRequest extends Partial<Omit<ICreateTemplateInput, "com
1139
1109
  }
1140
1110
  interface ICreateTemplateResponse extends IChecklistTemplate {
1141
1111
  }
1142
- interface ICreateTemplateWithItemsRequest extends ICreateTemplateInput {
1112
+ interface ICreateTemplateWithItemsRequest extends ICreateTemplateRequest {
1143
1113
  items: ICreateTemplateItemInput[];
1144
1114
  }
1145
1115
  interface ICreateTemplateWithItemsResponse extends IChecklistTemplateWithItems {
@@ -1205,7 +1175,7 @@ interface IReorderTemplateItemsResponse extends IMessageResponse {
1205
1175
  interface IChecklistTemplate extends IMetaData {
1206
1176
  id: string;
1207
1177
  name: string;
1208
- description?: string;
1178
+ description: string | null;
1209
1179
  companyId: string;
1210
1180
  createdBy: string;
1211
1181
  isActive: boolean;
@@ -1222,31 +1192,31 @@ interface IChecklistTemplateItem extends IMetaData {
1222
1192
  estimatedTimeMinutes: number | null;
1223
1193
  }
1224
1194
  /**
1225
- * Template with items
1195
+ * Template with items.
1226
1196
  */
1227
1197
  interface IChecklistTemplateWithItems extends IChecklistTemplate {
1228
1198
  items: IChecklistTemplateItem[];
1229
1199
  }
1230
1200
  /**
1231
- * Input for creating a template
1201
+ * Input for creating a template.
1232
1202
  */
1233
1203
  interface ICreateTemplateInput {
1234
1204
  name: string;
1235
- description?: string;
1205
+ description?: string | null;
1236
1206
  companyId: string;
1237
1207
  createdBy: string;
1238
1208
  isActive?: boolean;
1239
1209
  }
1240
1210
  /**
1241
- * Input for creating template items
1211
+ * Input for creating template items.
1242
1212
  */
1243
1213
  interface ICreateTemplateItemInput {
1244
1214
  title: string;
1245
- description?: string;
1215
+ description?: string | null;
1246
1216
  displayOrder: number;
1247
1217
  requiresPhoto?: boolean;
1248
1218
  isRequired?: boolean;
1249
- estimatedTimeMinutes?: number;
1219
+ estimatedTimeMinutes?: number | null;
1250
1220
  }
1251
1221
 
1252
1222
  interface ICompanyRouteParams {
@@ -1271,7 +1241,14 @@ interface IGetCompaniesQuery {
1271
1241
  search?: string;
1272
1242
  filter?: TCompanyFilter;
1273
1243
  }
1274
- interface ICreateCompanyRequest extends Pick<ICompany, "displayName" | "addressLine1" | "addressLine2" | "city" | "stateCode" | "postalCode" | "companyType"> {
1244
+ interface ICreateCompanyRequest {
1245
+ displayName: string;
1246
+ addressLine1: string;
1247
+ addressLine2?: string | null;
1248
+ city: string;
1249
+ stateCode: TUSStateCode;
1250
+ postalCode: string;
1251
+ companyType: ICompany["companyType"];
1275
1252
  }
1276
1253
  interface ICreateCompanyResponse extends ICompany {
1277
1254
  }
@@ -1281,7 +1258,17 @@ interface IGetCompanyByIdRequest extends ICompanyRouteParams {
1281
1258
  }
1282
1259
  interface IGetCompanyByIdResponse extends ICompany {
1283
1260
  }
1284
- interface IUpdateCompanyRequest extends Partial<Pick<ICompany, "displayName" | "addressLine1" | "addressLine2" | "city" | "stateCode" | "postalCode" | "companyType" | "country" | "timezone" | "imageUrl">> {
1261
+ interface IUpdateCompanyRequest {
1262
+ displayName?: string;
1263
+ addressLine1?: string;
1264
+ addressLine2?: string | null;
1265
+ city?: string;
1266
+ stateCode?: TUSStateCode;
1267
+ postalCode?: string;
1268
+ companyType?: ICompany["companyType"];
1269
+ country?: string | null;
1270
+ timezone?: string | null;
1271
+ imageUrl?: string | null;
1285
1272
  }
1286
1273
  interface IUpdateCompanyResponse extends ICompany {
1287
1274
  }
@@ -1297,7 +1284,7 @@ interface ICompanyUserSummary {
1297
1284
  id: string;
1298
1285
  email: string;
1299
1286
  firstName: string;
1300
- lastName?: string;
1287
+ lastName: string | null;
1301
1288
  role: TAccountType;
1302
1289
  }
1303
1290
  type IGetCompanyUsersResponse = ICompanyUserSummary[];
@@ -1310,7 +1297,7 @@ interface IInviteCompanyToCompanyRequest {
1310
1297
  interface IInviteCompanyToCompanyResponse {
1311
1298
  id: string;
1312
1299
  token: string;
1313
- expiresAt: Date;
1300
+ expiresAt: TDateTimeString;
1314
1301
  }
1315
1302
  interface IValidateCompanyInvitationRequest extends ICompanyInvitationTokenParams {
1316
1303
  }
@@ -1319,8 +1306,8 @@ interface IValidateCompanyInvitationResponse {
1319
1306
  requesterCompanyId: string;
1320
1307
  providerCompanyId: string;
1321
1308
  invitedBy: string;
1322
- message?: string | null;
1323
- expiresAt: Date;
1309
+ message: string | null;
1310
+ expiresAt: TDateTimeString;
1324
1311
  requesterCompanyName: string;
1325
1312
  providerCompanyName: string;
1326
1313
  invitedByName: string;
@@ -1349,20 +1336,20 @@ interface ICompany extends IMetaData {
1349
1336
  id: string;
1350
1337
  displayName: string;
1351
1338
  addressLine1: string;
1352
- addressLine2?: string;
1339
+ addressLine2: string | null;
1353
1340
  city: string;
1354
1341
  stateCode: TUSStateCode;
1355
1342
  companyType: TCompanyType;
1356
1343
  postalCode: string;
1357
- country?: string;
1358
- timezone?: string;
1359
- imageUrl?: string;
1344
+ country: string | null;
1345
+ timezone: string | null;
1346
+ imageUrl: string | null;
1360
1347
  }
1361
1348
  declare const COMPANY_TYPES: {
1362
- readonly PropertyManagement: "PropertyManagement";
1363
- readonly Maintenance: "Maintenance";
1364
- readonly Cleaner: "Cleaner";
1365
- readonly Other: "Other";
1349
+ readonly PROPERTY_MANAGEMENT: "PROPERTY_MANAGEMENT";
1350
+ readonly MAINTENANCE: "MAINTENANCE";
1351
+ readonly CLEANER: "CLEANER";
1352
+ readonly OTHER: "OTHER";
1366
1353
  };
1367
1354
  type TCompanyType = TRecordValue<typeof COMPANY_TYPES>;
1368
1355
 
@@ -1479,35 +1466,35 @@ interface IUpdateWorkOrderStatusResponse extends IWorkOrder {
1479
1466
  }
1480
1467
 
1481
1468
  declare const DAMAGE_SEVERITY: {
1482
- readonly Low: "Low";
1483
- readonly Medium: "Medium";
1484
- readonly High: "High";
1485
- readonly Critical: "Critical";
1469
+ readonly LOW: "LOW";
1470
+ readonly MEDIUM: "MEDIUM";
1471
+ readonly HIGH: "HIGH";
1472
+ readonly CRITICAL: "CRITICAL";
1486
1473
  };
1487
1474
  type TDamageSeverity = TRecordValue<typeof DAMAGE_SEVERITY>;
1488
1475
  declare const DAMAGE_STATUS: {
1489
- readonly Open: "Open";
1490
- readonly InReview: "InReview";
1491
- readonly Assigned: "Assigned";
1492
- readonly InProgress: "InProgress";
1493
- readonly Resolved: "Resolved";
1494
- readonly Closed: "Closed";
1495
- readonly Escalated: "Escalated";
1476
+ readonly OPEN: "OPEN";
1477
+ readonly IN_REVIEW: "IN_REVIEW";
1478
+ readonly ASSIGNED: "ASSIGNED";
1479
+ readonly IN_PROGRESS: "IN_PROGRESS";
1480
+ readonly RESOLVED: "RESOLVED";
1481
+ readonly CLOSED: "CLOSED";
1482
+ readonly ESCALATED: "ESCALATED";
1496
1483
  };
1497
1484
  type TDamageStatus = TRecordValue<typeof DAMAGE_STATUS>;
1498
1485
  declare const WORK_ORDER_PRIORITY: {
1499
- readonly Low: "Low";
1500
- readonly Normal: "Normal";
1501
- readonly High: "High";
1502
- readonly Urgent: "Urgent";
1486
+ readonly LOW: "LOW";
1487
+ readonly NORMAL: "NORMAL";
1488
+ readonly HIGH: "HIGH";
1489
+ readonly URGENT: "URGENT";
1503
1490
  };
1504
1491
  type TWorkOrderPriority = TRecordValue<typeof WORK_ORDER_PRIORITY>;
1505
1492
  declare const WORK_ORDER_STATUS: {
1506
- readonly Pending: "Pending";
1507
- readonly Scheduled: "Scheduled";
1508
- readonly InProgress: "InProgress";
1509
- readonly Completed: "Completed";
1510
- readonly Cancelled: "Cancelled";
1493
+ readonly PENDING: "PENDING";
1494
+ readonly SCHEDULED: "SCHEDULED";
1495
+ readonly IN_PROGRESS: "IN_PROGRESS";
1496
+ readonly COMPLETED: "COMPLETED";
1497
+ readonly CANCELLED: "CANCELLED";
1511
1498
  };
1512
1499
  type TWorkOrderStatus = TRecordValue<typeof WORK_ORDER_STATUS>;
1513
1500
  interface IDamageReport {
@@ -1515,9 +1502,9 @@ interface IDamageReport {
1515
1502
  propertyId: string;
1516
1503
  roomId: string;
1517
1504
  workSessionId: string | null;
1518
- cleaningSessionId?: string;
1505
+ cleaningSessionId: string | null;
1519
1506
  reportedBy: string;
1520
- reportedAt: Date;
1507
+ reportedAt: TDateTimeString;
1521
1508
  severity: TDamageSeverity;
1522
1509
  status: TDamageStatus;
1523
1510
  title: string;
@@ -1526,8 +1513,8 @@ interface IDamageReport {
1526
1513
  estimatedCost: number | null;
1527
1514
  actualCost: number | null;
1528
1515
  assignedTo: string | null;
1529
- assignedAt: Date | null;
1530
- resolvedAt: Date | null;
1516
+ assignedAt: TDateTimeString | null;
1517
+ resolvedAt: TDateTimeString | null;
1531
1518
  resolvedBy: string | null;
1532
1519
  resolutionNotes: string | null;
1533
1520
  requiresProfessional: boolean;
@@ -1535,8 +1522,8 @@ interface IDamageReport {
1535
1522
  insuranceClaimNumber: string | null;
1536
1523
  isTenantResponsible: boolean;
1537
1524
  tenantChargeAmount: number | null;
1538
- createdAt: Date;
1539
- updatedAt: Date;
1525
+ createdAt: TDateTimeString;
1526
+ updatedAt: TDateTimeString;
1540
1527
  photos?: IDamagePhoto[];
1541
1528
  comments?: IDamageComment[];
1542
1529
  }
@@ -1544,12 +1531,12 @@ interface IDamageReportPhoto {
1544
1531
  id: string;
1545
1532
  damageReportId: string;
1546
1533
  photoId: string;
1547
- imageUrl?: string;
1534
+ imageUrl: string | null;
1548
1535
  caption: string | null;
1549
1536
  isBeforePhoto: boolean;
1550
1537
  displayOrder: number;
1551
1538
  uploadedBy: string | null;
1552
- createdAt: Date;
1539
+ createdAt: TDateTimeString;
1553
1540
  }
1554
1541
  interface IDamagePhoto extends IDamageReportPhoto {
1555
1542
  }
@@ -1557,11 +1544,11 @@ interface IDamageComment {
1557
1544
  id: string;
1558
1545
  damageReportId: string;
1559
1546
  userId: string;
1560
- userName?: string;
1547
+ userName: string | null;
1561
1548
  comment: string;
1562
1549
  isInternal: boolean;
1563
- createdAt: Date;
1564
- updatedAt: Date;
1550
+ createdAt: TDateTimeString;
1551
+ updatedAt: TDateTimeString;
1565
1552
  }
1566
1553
  interface IDamageReportStatusHistory {
1567
1554
  id: string;
@@ -1570,7 +1557,7 @@ interface IDamageReportStatusHistory {
1570
1557
  newStatus: TDamageStatus;
1571
1558
  changedBy: string;
1572
1559
  reason: string | null;
1573
- createdAt: Date;
1560
+ createdAt: TDateTimeString;
1574
1561
  }
1575
1562
  interface IWorkOrder {
1576
1563
  id: string;
@@ -1581,12 +1568,12 @@ interface IWorkOrder {
1581
1568
  priority: TWorkOrderPriority;
1582
1569
  category: string | null;
1583
1570
  assignedTo: string | null;
1584
- assignedAt: Date | null;
1585
- scheduledDate: Date | null;
1571
+ assignedAt: TDateTimeString | null;
1572
+ scheduledDate: TDateTimeString | null;
1586
1573
  scheduledTimeStart: string | null;
1587
1574
  scheduledTimeEnd: string | null;
1588
- startedAt: Date | null;
1589
- completedAt: Date | null;
1575
+ startedAt: TDateTimeString | null;
1576
+ completedAt: TDateTimeString | null;
1590
1577
  completedBy: string | null;
1591
1578
  description: string;
1592
1579
  workPerformed: string | null;
@@ -1596,8 +1583,8 @@ interface IWorkOrder {
1596
1583
  materialsCost: number | null;
1597
1584
  totalCost: number | null;
1598
1585
  status: TWorkOrderStatus;
1599
- createdAt: Date;
1600
- updatedAt: Date;
1586
+ createdAt: TDateTimeString;
1587
+ updatedAt: TDateTimeString;
1601
1588
  }
1602
1589
  interface ICreateDamageReportInput {
1603
1590
  propertyId: string;
@@ -1620,7 +1607,7 @@ interface ICreateWorkOrderInput {
1620
1607
  priority?: TWorkOrderPriority;
1621
1608
  category?: string;
1622
1609
  description: string;
1623
- scheduledDate?: Date;
1610
+ scheduledDate?: TDateTimeString;
1624
1611
  scheduledTimeStart?: string;
1625
1612
  scheduledTimeEnd?: string;
1626
1613
  }
@@ -1688,7 +1675,7 @@ interface IGetDetailedHealthResponse {
1688
1675
  interface IHealthCheckResponse {
1689
1676
  status: "healthy";
1690
1677
  database: "connected";
1691
- timestamp: string;
1678
+ timestamp: TDateTimeString;
1692
1679
  environment?: string;
1693
1680
  }
1694
1681
  interface IHealthChecks {
@@ -1701,7 +1688,7 @@ interface IHealthChecks {
1701
1688
  external: number;
1702
1689
  arrayBuffers: number;
1703
1690
  };
1704
- timestamp: string;
1691
+ timestamp: TDateTimeString;
1705
1692
  databaseError?: string;
1706
1693
  }
1707
1694
 
@@ -1736,15 +1723,15 @@ interface IDeleteImageResponse extends ISuccessResponse {
1736
1723
  }
1737
1724
 
1738
1725
  declare const IMAGE_ENTITY_TYPE: {
1739
- readonly UserProfile: "UserProfile";
1740
- readonly Property: "Property";
1741
- readonly Company: "Company";
1742
- readonly ChecklistItem: "ChecklistItem";
1743
- readonly PropertyRoom: "PropertyRoom";
1744
- readonly MaintenanceTicket: "MaintenanceTicket";
1745
- readonly WorkReport: "WorkReport";
1746
- readonly CleaningReport: "CleaningReport";
1747
- readonly TurndownDefault: "TurndownDefault";
1726
+ readonly USER_PROFILE: "USER_PROFILE";
1727
+ readonly PROPERTY: "PROPERTY";
1728
+ readonly COMPANY: "COMPANY";
1729
+ readonly CHECKLIST_ITEM: "CHECKLIST_ITEM";
1730
+ readonly PROPERTY_ROOM: "PROPERTY_ROOM";
1731
+ readonly MAINTENANCE_TICKET: "MAINTENANCE_TICKET";
1732
+ readonly WORK_REPORT: "WORK_REPORT";
1733
+ readonly CLEANING_REPORT: "CLEANING_REPORT";
1734
+ readonly TURNDOWN_DEFAULT: "TURNDOWN_DEFAULT";
1748
1735
  };
1749
1736
  type TStoredImageEntityType = (typeof IMAGE_ENTITY_TYPE)[keyof typeof IMAGE_ENTITY_TYPE];
1750
1737
  interface IImage {
@@ -1755,16 +1742,16 @@ interface IImage {
1755
1742
  entityId: string;
1756
1743
  fileName: string;
1757
1744
  mimeType: string;
1758
- fileSizeBytes?: number;
1759
- width?: number;
1760
- height?: number;
1745
+ fileSizeBytes: number | null;
1746
+ width: number | null;
1747
+ height: number | null;
1761
1748
  isPublic: boolean;
1762
- category?: string;
1749
+ category: string | null;
1763
1750
  displayOrder: number;
1764
- uploadedBy?: string;
1765
- createdAt: Date;
1766
- updatedAt: Date;
1767
- deletedAt?: Date;
1751
+ uploadedBy: string | null;
1752
+ createdAt: TDateTimeString;
1753
+ updatedAt: TDateTimeString;
1754
+ deletedAt: TDateTimeString | null;
1768
1755
  }
1769
1756
  interface IImageWithUrl extends IImage {
1770
1757
  url: string;
@@ -1848,7 +1835,13 @@ interface IRestockOrderItemInput {
1848
1835
  quantityOrdered: number;
1849
1836
  unitCost?: number;
1850
1837
  }
1851
- interface ICreateRestockOrderRequest extends Pick<IInventoryRestockOrder, "companyId" | "orderedBy">, Partial<Pick<IInventoryRestockOrder, "orderNumber" | "expectedDelivery" | "supplierInfo" | "notes">> {
1838
+ interface ICreateRestockOrderRequest {
1839
+ companyId: string;
1840
+ orderedBy?: string | null;
1841
+ orderNumber?: string | null;
1842
+ expectedDelivery?: IInventoryRestockOrder["expectedDelivery"];
1843
+ supplierInfo?: string | null;
1844
+ notes?: string | null;
1852
1845
  items: IRestockOrderItemInput[];
1853
1846
  }
1854
1847
  interface ICreateRestockOrderResponse extends IInventoryRestockOrder {
@@ -1861,58 +1854,58 @@ interface IGetRestockOrderItemsRequest extends IInventoryOrderRouteParams {
1861
1854
  type IGetRestockOrderItemsResponse = IInventoryRestockOrderItem[];
1862
1855
  interface IUpdateRestockOrderStatusRequest {
1863
1856
  status: TInventoryRestockOrderStatus;
1864
- receivedBy?: string;
1857
+ receivedBy?: string | null;
1865
1858
  }
1866
1859
  interface IUpdateRestockOrderStatusResponse extends IInventoryRestockOrder {
1867
1860
  }
1868
1861
 
1869
1862
  declare const INVENTORY_RESTOCK_ORDER_STATUS: {
1870
- readonly Pending: "Pending";
1871
- readonly Ordered: "Ordered";
1872
- readonly Shipped: "Shipped";
1873
- readonly Received: "Received";
1863
+ readonly PENDING: "PENDING";
1864
+ readonly ORDERED: "ORDERED";
1865
+ readonly SHIPPED: "SHIPPED";
1866
+ readonly RECEIVED: "RECEIVED";
1874
1867
  };
1875
1868
  type TInventoryRestockOrderStatus = TRecordValue<typeof INVENTORY_RESTOCK_ORDER_STATUS>;
1876
1869
  declare const INVENTORY_UNITS: {
1877
- readonly Count: "Count";
1878
- readonly Rolls: "Rolls";
1879
- readonly Pods: "Pods";
1880
- readonly Boxes: "Boxes";
1881
- readonly Bottles: "Bottles";
1882
- readonly Packs: "Packs";
1883
- readonly Bags: "Bags";
1884
- readonly Gallons: "Gallons";
1885
- readonly Liters: "Liters";
1886
- readonly Kilograms: "Kilograms";
1887
- readonly Pounds: "Pounds";
1888
- readonly Ounces: "Ounces";
1889
- readonly Grams: "Grams";
1890
- readonly Sheets: "Sheets";
1891
- readonly Cases: "Cases";
1892
- readonly Cartons: "Cartons";
1893
- readonly Other: "Other";
1870
+ readonly COUNT: "COUNT";
1871
+ readonly ROLLS: "ROLLS";
1872
+ readonly PODS: "PODS";
1873
+ readonly BOXES: "BOXES";
1874
+ readonly BOTTLES: "BOTTLES";
1875
+ readonly PACKS: "PACKS";
1876
+ readonly BAGS: "BAGS";
1877
+ readonly GALLONS: "GALLONS";
1878
+ readonly LITERS: "LITERS";
1879
+ readonly KILOGRAMS: "KILOGRAMS";
1880
+ readonly POUNDS: "POUNDS";
1881
+ readonly OUNCES: "OUNCES";
1882
+ readonly GRAMS: "GRAMS";
1883
+ readonly SHEETS: "SHEETS";
1884
+ readonly CASES: "CASES";
1885
+ readonly CARTONS: "CARTONS";
1886
+ readonly OTHER: "OTHER";
1894
1887
  };
1895
1888
  type TInventoryUnitType = TRecordValue<typeof INVENTORY_UNITS>;
1896
1889
  declare const INVENTORY_ITEM_TYPE: {
1897
- readonly Consumable: "Consumable";
1898
- readonly Fixed: "Fixed";
1890
+ readonly CONSUMABLE: "CONSUMABLE";
1891
+ readonly FIXED: "FIXED";
1899
1892
  };
1900
1893
  type TInventoryItemType = TRecordValue<typeof INVENTORY_ITEM_TYPE>;
1901
1894
  interface IInventoryItem extends IMetaData {
1902
1895
  id: string;
1903
1896
  companyId: string;
1904
1897
  name: string;
1905
- description?: string;
1898
+ description: string | null;
1906
1899
  itemType: TInventoryItemType;
1907
1900
  unit: TInventoryUnitType;
1908
- unitCustom?: string;
1901
+ unitCustom: string | null;
1909
1902
  minimumLevel: number;
1910
1903
  reorderLevel: number;
1911
- maximumLevel?: number;
1912
- costPerUnit?: number;
1913
- supplierInfo?: string;
1914
- sku?: string;
1915
- barcode?: string;
1904
+ maximumLevel: number | null;
1905
+ costPerUnit: number | null;
1906
+ supplierInfo: string | null;
1907
+ sku: string | null;
1908
+ barcode: string | null;
1916
1909
  }
1917
1910
  interface IRoomInventory extends IMetaData {
1918
1911
  id: string;
@@ -1920,14 +1913,14 @@ interface IRoomInventory extends IMetaData {
1920
1913
  inventoryItemId: string;
1921
1914
  currentLevel: number;
1922
1915
  minimumLevel: number;
1923
- maximumLevel?: number;
1924
- parLevel?: number;
1925
- lastRestockedAt?: Date;
1926
- lastRestockedBy?: string;
1927
- lastCheckedAt?: Date;
1928
- lastCheckedBy?: string;
1916
+ maximumLevel: number | null;
1917
+ parLevel: number | null;
1918
+ lastRestockedAt: TDateTimeString | null;
1919
+ lastRestockedBy: string | null;
1920
+ lastCheckedAt: TDateTimeString | null;
1921
+ lastCheckedBy: string | null;
1929
1922
  autoReorder: boolean;
1930
- locationNotes?: string;
1923
+ locationNotes: string | null;
1931
1924
  }
1932
1925
  interface IPropertyInventory extends IMetaData {
1933
1926
  id: string;
@@ -1935,14 +1928,14 @@ interface IPropertyInventory extends IMetaData {
1935
1928
  inventoryItemId: string;
1936
1929
  currentLevel: number;
1937
1930
  minimumLevel: number;
1938
- maximumLevel?: number;
1939
- parLevel?: number;
1940
- lastRestockedAt?: Date;
1941
- lastRestockedBy?: string;
1942
- lastCheckedAt?: Date;
1943
- lastCheckedBy?: string;
1931
+ maximumLevel: number | null;
1932
+ parLevel: number | null;
1933
+ lastRestockedAt: TDateTimeString | null;
1934
+ lastRestockedBy: string | null;
1935
+ lastCheckedAt: TDateTimeString | null;
1936
+ lastCheckedBy: string | null;
1944
1937
  autoReorder: boolean;
1945
- locationNotes?: string;
1938
+ locationNotes: string | null;
1946
1939
  }
1947
1940
  interface IInventoryCount {
1948
1941
  id: string;
@@ -1954,39 +1947,39 @@ interface IInventoryCount {
1954
1947
  restockedAmount: number;
1955
1948
  finalLevel: number;
1956
1949
  countedBy: string;
1957
- countedAt: Date;
1950
+ countedAt: TDateTimeString;
1958
1951
  needsRestock: boolean;
1959
- notes?: string;
1960
- createdAt: Date;
1952
+ notes: string | null;
1953
+ createdAt: TDateTimeString;
1961
1954
  }
1962
1955
  interface IInventoryRestockOrder {
1963
1956
  id: string;
1964
1957
  companyId: string;
1965
- orderNumber?: string;
1958
+ orderNumber: string | null;
1966
1959
  status: TInventoryRestockOrderStatus;
1967
- totalItems?: number;
1968
- totalCost?: number;
1969
- orderedBy?: string;
1970
- orderedAt?: Date;
1971
- expectedDelivery?: Date;
1972
- receivedBy?: string;
1973
- receivedAt?: Date;
1974
- supplierInfo?: string;
1975
- notes?: string;
1976
- createdAt: Date;
1977
- updatedAt: Date;
1960
+ totalItems: number | null;
1961
+ totalCost: number | null;
1962
+ orderedBy: string | null;
1963
+ orderedAt: TDateTimeString | null;
1964
+ expectedDelivery: TDateTimeString | null;
1965
+ receivedBy: string | null;
1966
+ receivedAt: TDateTimeString | null;
1967
+ supplierInfo: string | null;
1968
+ notes: string | null;
1969
+ createdAt: TDateTimeString;
1970
+ updatedAt: TDateTimeString;
1978
1971
  }
1979
1972
  interface IInventoryRestockOrderItem {
1980
1973
  id: string;
1981
1974
  orderId: string;
1982
1975
  inventoryItemId: string;
1983
- roomInventoryId?: string;
1984
- propertyInventoryId?: string;
1976
+ roomInventoryId: string | null;
1977
+ propertyInventoryId: string | null;
1985
1978
  quantityOrdered: number;
1986
1979
  quantityReceived: number;
1987
- unitCost?: number;
1988
- totalCost?: number;
1989
- createdAt: Date;
1980
+ unitCost: number | null;
1981
+ totalCost: number | null;
1982
+ createdAt: TDateTimeString;
1990
1983
  }
1991
1984
 
1992
1985
  interface IPropertyIdParams {
@@ -2001,15 +1994,15 @@ interface ICreatePropertyRequest {
2001
1994
  propertyType: TPropertyType;
2002
1995
  status?: TPropertyStatus;
2003
1996
  addressLine1: string;
2004
- addressLine2?: string;
1997
+ addressLine2?: string | null;
2005
1998
  city: string;
2006
1999
  stateCode: TUSStateCode;
2007
2000
  postalCode: string;
2008
- country?: string;
2009
- sqft?: number;
2010
- timezone?: string;
2011
- imageUrl?: string;
2012
- specialNotes?: string;
2001
+ country?: string | null;
2002
+ sqft?: number | null;
2003
+ timezone?: string | null;
2004
+ imageUrl?: string | null;
2005
+ specialNotes?: string | null;
2013
2006
  }
2014
2007
  interface IUpdatePropertyRequest extends Partial<Omit<ICreatePropertyRequest, "companyId">> {
2015
2008
  }
@@ -2043,23 +2036,23 @@ interface IGetPropertiesByCompanyIdRequest extends ICompanyIdParams {
2043
2036
  type IGetPropertiesByCompanyIdResponse = IProperty[];
2044
2037
 
2045
2038
  declare const PROPERTY_STATUS: {
2046
- readonly Active: "Active";
2047
- readonly Inactive: "Inactive";
2039
+ readonly ACTIVE: "ACTIVE";
2040
+ readonly INACTIVE: "INACTIVE";
2048
2041
  };
2049
2042
  type TPropertyStatus = TRecordValue<typeof PROPERTY_STATUS>;
2050
2043
  declare const PropertyStatusOptions: ISelectOption<TPropertyStatus>[];
2051
2044
  declare const PROPERTY_TYPES: {
2052
- readonly Apartment: "Apartment";
2053
- readonly Commercial: "Commercial";
2054
- readonly Condo: "Condo";
2055
- readonly Duplex: "Duplex";
2056
- readonly House: "House";
2057
- readonly MultiFamily: "Multi-Family";
2058
- readonly Office: "Office";
2059
- readonly Retail: "Retail";
2060
- readonly Townhouse: "Townhouse";
2061
- readonly Vacation: "Vacation Rental";
2062
- readonly Warehouse: "Warehouse";
2045
+ readonly APARTMENT: "APARTMENT";
2046
+ readonly COMMERCIAL: "COMMERCIAL";
2047
+ readonly CONDO: "CONDO";
2048
+ readonly DUPLEX: "DUPLEX";
2049
+ readonly HOUSE: "HOUSE";
2050
+ readonly MULTI_FAMILY: "MULTI_FAMILY";
2051
+ readonly OFFICE: "OFFICE";
2052
+ readonly RETAIL: "RETAIL";
2053
+ readonly TOWNHOUSE: "TOWNHOUSE";
2054
+ readonly VACATION_RENTAL: "VACATION_RENTAL";
2055
+ readonly WAREHOUSE: "WAREHOUSE";
2063
2056
  };
2064
2057
  type TPropertyType = TRecordValue<typeof PROPERTY_TYPES>;
2065
2058
  declare const PropertyTypeOptions: ISelectOption<TPropertyType>[];
@@ -2067,28 +2060,28 @@ interface IProperty extends IMetaData {
2067
2060
  id: string;
2068
2061
  displayName: string;
2069
2062
  addressLine1: string;
2070
- addressLine2?: string;
2063
+ addressLine2: string | null;
2071
2064
  city: string;
2072
2065
  stateCode: TUSStateCode;
2073
- propertyType?: TPropertyType;
2074
- status?: TPropertyStatus;
2075
- sqft?: number;
2066
+ propertyType: TPropertyType | null;
2067
+ status: TPropertyStatus | null;
2068
+ sqft: number | null;
2076
2069
  postalCode: string;
2077
- country?: string;
2078
- timezone?: string;
2079
- imageUrl?: string;
2070
+ country: string | null;
2071
+ timezone: string | null;
2072
+ imageUrl: string | null;
2080
2073
  companyId: string;
2081
- specialNotes?: string;
2074
+ specialNotes: string | null;
2082
2075
  }
2083
2076
  interface IPropertyAccessInformation {
2084
2077
  propertyId: string;
2085
- entryInstructions?: string;
2086
- accessCode?: string;
2087
- wifiName?: string;
2088
- wifiPassword?: string;
2089
- alarmCode?: string;
2090
- parkingInfo?: string;
2091
- specialNotes?: string;
2078
+ entryInstructions: string | null;
2079
+ accessCode: string | null;
2080
+ wifiName: string | null;
2081
+ wifiPassword: string | null;
2082
+ alarmCode: string | null;
2083
+ parkingInfo: string | null;
2084
+ specialNotes: string | null;
2092
2085
  }
2093
2086
  interface IPropertyBase {
2094
2087
  id: string;
@@ -2149,20 +2142,20 @@ interface IPropertyFilterValues {
2149
2142
  interface IPropertySummary {
2150
2143
  id: string;
2151
2144
  displayName: string;
2152
- propertyType: TPropertyType;
2145
+ propertyType: TPropertyType | null;
2153
2146
  addressLine1: string;
2154
- addressLine2?: string;
2147
+ addressLine2: string | null;
2155
2148
  city: string;
2156
2149
  stateCode: TUSStateCode;
2157
2150
  postalCode: string;
2158
- imageUrl?: string;
2159
- status?: TPropertyStatus;
2151
+ imageUrl: string | null;
2152
+ status: TPropertyStatus | null;
2160
2153
  }
2161
2154
  interface IPropertyDetail extends IPropertySummary {
2162
- specialNotes?: string;
2155
+ specialNotes: string | null;
2163
2156
  roomCount?: number;
2164
- createdAt?: Date;
2165
- updatedAt?: Date;
2157
+ createdAt: TDateTimeString;
2158
+ updatedAt: TDateTimeString;
2166
2159
  }
2167
2160
 
2168
2161
  interface IJobFilterValues {
@@ -2177,7 +2170,13 @@ interface IRoomPropertyRouteParams {
2177
2170
  interface IRoomRouteParams {
2178
2171
  roomId: string;
2179
2172
  }
2180
- interface ICreateRoomRequest extends Pick<IRoom, "propertyId" | "displayName">, Partial<Pick<IRoom, "description" | "checklistTemplateId" | "roomType" | "heroPhoto">> {
2173
+ interface ICreateRoomRequest {
2174
+ propertyId: string;
2175
+ displayName: string;
2176
+ description?: string | null;
2177
+ checklistTemplateId?: string | null;
2178
+ roomType?: IRoom["roomType"];
2179
+ heroPhoto?: string | null;
2181
2180
  }
2182
2181
  interface ICreateRoomResponse extends IRoom {
2183
2182
  }
@@ -2220,11 +2219,11 @@ type TRoomType = TRecordValue<typeof ROOM_TYPE>;
2220
2219
  interface IRoom extends IMetaData {
2221
2220
  id: string;
2222
2221
  displayName: string;
2223
- checklistTemplateId?: string;
2224
- roomType?: TRoomType;
2225
- heroPhoto?: string;
2222
+ checklistTemplateId: string | null;
2223
+ roomType: TRoomType | null;
2224
+ heroPhoto: string | null;
2226
2225
  propertyId: string;
2227
- description?: string;
2226
+ description: string | null;
2228
2227
  }
2229
2228
 
2230
2229
  interface IRoomChecklistRoomRouteParams {
@@ -2261,7 +2260,7 @@ interface IGetChecklistWithItemsRequest extends IChecklistIdParams {
2261
2260
  }
2262
2261
  interface IGetChecklistWithItemsResponse extends IRoomChecklistWithItems {
2263
2262
  }
2264
- interface IUpdateChecklistRequest extends Partial<ICreateRoomChecklistInput> {
2263
+ interface IUpdateChecklistRequest extends Partial<Omit<ICreateRoomChecklistInput, "roomId">> {
2265
2264
  }
2266
2265
  interface IUpdateChecklistResponse extends IRoomChecklist {
2267
2266
  }
@@ -2307,61 +2306,61 @@ interface IReorderChecklistItemsResponse extends IMessageResponse {
2307
2306
  interface IRoomChecklist extends IMetaData {
2308
2307
  id: string;
2309
2308
  roomId: string;
2310
- templateId?: string;
2309
+ templateId: string | null;
2311
2310
  name: string;
2312
2311
  isActive: boolean;
2313
2312
  items: IRoomChecklistItem[];
2314
2313
  }
2315
2314
  interface IRoomChecklistItem extends IChecklistTemplateItem {
2316
2315
  roomChecklistId: string;
2317
- templateItemId?: string;
2316
+ templateItemId: string | null;
2318
2317
  isCustom: boolean;
2319
2318
  }
2320
2319
  /**
2321
- * Room checklist with items
2320
+ * Room checklist with items.
2322
2321
  */
2323
2322
  interface IRoomChecklistWithItems extends IRoomChecklist {
2324
2323
  items: IRoomChecklistItem[];
2325
2324
  }
2326
2325
  /**
2327
- * Input for creating a room checklist
2326
+ * Input for creating a room checklist.
2328
2327
  */
2329
2328
  interface ICreateRoomChecklistInput {
2330
2329
  roomId: string;
2331
- templateId?: string;
2330
+ templateId?: string | null;
2332
2331
  name: string;
2333
2332
  isActive?: boolean;
2334
2333
  }
2335
2334
  /**
2336
- * Input for creating room checklist items
2335
+ * Input for creating room checklist items.
2337
2336
  */
2338
2337
  interface ICreateRoomChecklistItemInput {
2339
2338
  title: string;
2340
- description?: string;
2339
+ description?: string | null;
2341
2340
  displayOrder: number;
2342
2341
  requiresPhoto?: boolean;
2343
2342
  isRequired?: boolean;
2344
- estimatedTimeMinutes?: number;
2343
+ estimatedTimeMinutes?: number | null;
2345
2344
  isCustom?: boolean;
2346
2345
  }
2347
2346
 
2348
2347
  declare const SUBSCRIPTION_STATUS: {
2349
- readonly Active: "Active";
2350
- readonly Canceled: "Canceled";
2351
- readonly Expired: "Expired";
2352
- readonly PastDue: "PastDue";
2353
- readonly Trialing: "Trialing";
2348
+ readonly ACTIVE: "ACTIVE";
2349
+ readonly CANCELED: "CANCELED";
2350
+ readonly EXPIRED: "EXPIRED";
2351
+ readonly PAST_DUE: "PAST_DUE";
2352
+ readonly TRIALING: "TRIALING";
2354
2353
  };
2355
2354
  type TSubscriptionStatus = TRecordValue<typeof SUBSCRIPTION_STATUS>;
2356
2355
  declare const SUBSCRIPTION_PROVIDER: {
2357
- readonly Stripe: "Stripe";
2358
- readonly Apple: "Apple";
2359
- readonly Google: "Google";
2356
+ readonly STRIPE: "STRIPE";
2357
+ readonly APPLE: "APPLE";
2358
+ readonly GOOGLE: "GOOGLE";
2360
2359
  };
2361
2360
  type TSubscriptionProvider = TRecordValue<typeof SUBSCRIPTION_PROVIDER>;
2362
2361
  declare const BILLING_PERIOD: {
2363
- readonly Monthly: "Monthly";
2364
- readonly Yearly: "Yearly";
2362
+ readonly MONTHLY: "MONTHLY";
2363
+ readonly YEARLY: "YEARLY";
2365
2364
  };
2366
2365
  type TBillingPeriod = TRecordValue<typeof BILLING_PERIOD>;
2367
2366
  interface IUserSubscription {
@@ -2370,8 +2369,8 @@ interface IUserSubscription {
2370
2369
  planId: string;
2371
2370
  status: TSubscriptionStatus;
2372
2371
  billingPeriod: TBillingPeriod;
2373
- currentPeriodStart: Date;
2374
- currentPeriodEnd: Date;
2372
+ currentPeriodStart: TDateTimeString;
2373
+ currentPeriodEnd: TDateTimeString;
2375
2374
  provider: TSubscriptionProvider;
2376
2375
  providerSubscriptionId: string;
2377
2376
  cancelAtPeriodEnd: boolean;
@@ -2465,7 +2464,7 @@ interface ICompleteExecutionItemResponse extends IChecklistItemCompletion {
2465
2464
  }
2466
2465
 
2467
2466
  /**
2468
- * Work session status enum
2467
+ * Work session status enum.
2469
2468
  */
2470
2469
  declare const WORK_SESSION_STATUS: {
2471
2470
  readonly IN_PROGRESS: "IN_PROGRESS";
@@ -2474,7 +2473,7 @@ declare const WORK_SESSION_STATUS: {
2474
2473
  };
2475
2474
  type TWorkSessionStatus = TRecordValue<typeof WORK_SESSION_STATUS>;
2476
2475
  /**
2477
- * Checklist execution status enum
2476
+ * Checklist execution status enum.
2478
2477
  */
2479
2478
  declare const CHECKLIST_EXECUTION_STATUS: {
2480
2479
  readonly PENDING: "PENDING";
@@ -2484,7 +2483,7 @@ declare const CHECKLIST_EXECUTION_STATUS: {
2484
2483
  };
2485
2484
  type TChecklistExecutionStatus = TRecordValue<typeof CHECKLIST_EXECUTION_STATUS>;
2486
2485
  /**
2487
- * Work session
2486
+ * Work session.
2488
2487
  */
2489
2488
  interface IWorkSession {
2490
2489
  id: string;
@@ -2492,16 +2491,16 @@ interface IWorkSession {
2492
2491
  serviceProviderCompanyId: string;
2493
2492
  performedBy: string;
2494
2493
  status: TWorkSessionStatus;
2495
- scheduledDate: Date | null;
2496
- startedAt: Date;
2497
- completedAt: Date | null;
2494
+ scheduledDate: TDateTimeString | null;
2495
+ startedAt: TDateTimeString;
2496
+ completedAt: TDateTimeString | null;
2498
2497
  totalTimeMinutes: number | null;
2499
2498
  notes: string | null;
2500
- createdAt: Date;
2501
- updatedAt: Date;
2499
+ createdAt: TDateTimeString;
2500
+ updatedAt: TDateTimeString;
2502
2501
  }
2503
2502
  /**
2504
- * Checklist execution
2503
+ * Checklist execution.
2505
2504
  */
2506
2505
  interface IChecklistExecution {
2507
2506
  id: string;
@@ -2510,46 +2509,46 @@ interface IChecklistExecution {
2510
2509
  roomId: string;
2511
2510
  workerId: string;
2512
2511
  status: TChecklistExecutionStatus;
2513
- startedAt: Date | null;
2514
- completedAt: Date | null;
2512
+ startedAt: TDateTimeString | null;
2513
+ completedAt: TDateTimeString | null;
2515
2514
  timeSpentMinutes: number | null;
2516
2515
  notes: string | null;
2517
- createdAt: Date;
2518
- updatedAt: Date;
2516
+ createdAt: TDateTimeString;
2517
+ updatedAt: TDateTimeString;
2519
2518
  }
2520
2519
  /**
2521
- * Checklist item completion
2520
+ * Checklist item completion.
2522
2521
  */
2523
2522
  interface IChecklistItemCompletion {
2524
2523
  id: string;
2525
2524
  checklistExecutionId: string;
2526
2525
  roomChecklistItemId: string;
2527
2526
  completedBy: string;
2528
- completedAt: Date;
2527
+ completedAt: TDateTimeString;
2529
2528
  photoId: string | null;
2530
2529
  notes: string | null;
2531
2530
  skipped: boolean;
2532
2531
  skipReason: string | null;
2533
- createdAt: Date;
2532
+ createdAt: TDateTimeString;
2534
2533
  }
2535
2534
  /**
2536
- * Work session with executions
2535
+ * Work session with executions.
2537
2536
  */
2538
2537
  interface IWorkSessionWithExecutions extends IWorkSession {
2539
2538
  executions: IChecklistExecution[];
2540
2539
  }
2541
2540
  /**
2542
- * Input for creating a work session
2541
+ * Input for creating a work session.
2543
2542
  */
2544
2543
  interface ICreateWorkSessionInput {
2545
2544
  propertyId: string;
2546
2545
  serviceProviderCompanyId: string;
2547
2546
  performedBy: string;
2548
- scheduledDate?: Date;
2547
+ scheduledDate?: TDateTimeString;
2549
2548
  notes?: string;
2550
2549
  }
2551
2550
  /**
2552
- * Input for completing a checklist item
2551
+ * Input for completing a checklist item.
2553
2552
  */
2554
2553
  interface ICompleteChecklistItemInput {
2555
2554
  roomChecklistItemId: string;
@@ -2811,4 +2810,15 @@ interface IAddress {
2811
2810
  }
2812
2811
  declare const formatAddress: (address: IAddress) => string;
2813
2812
 
2814
- export { ACCOUNT_STATUS, ACCOUNT_TYPE, AUTH_STATUS, BILLING_PERIOD, CHECKLIST_EXECUTION_STATUS, COMPANY_TYPES, CompanyFilter, DAMAGE_SEVERITY, DAMAGE_STATUS, ERROR_CODES, FilterCondition, HTTP_METHOD, HTTP_STATUS, type IAcceptCompanyInvitationRequest, type IAcceptCompanyInvitationResponse, type IAcceptInvitationRequest, type IAcceptInvitationResponse, type IAcceptInvitationRouteResponse, type IAddChecklistItemRequest, type IAddChecklistItemResponse, type IAddDamageReportCommentRequest, type IAddDamageReportCommentResponse, type IAddDamageReportPhotoRequest, type IAddDamageReportPhotoResponse, type IAddInventoryToPropertyRequest, type IAddInventoryToPropertyResponse, type IAddInventoryToRoomRequest, type IAddInventoryToRoomResponse, type IAddTemplateItemRequest, type IAddTemplateItemResponse, type IAddress, type IApiError, type IApiMeta, type IApiResponse, type IAssignDamageReportRequest, type IAssignDamageReportResponse, type IAssignWorkOrderRequest, type IAssignWorkOrderResponse, type IAuthInvitationBaseResponse, type IAuthInvitationIdParams, type IAuthInvitationTokenParams, type IAuthMessageResponse, type IAuthRefreshTokenResponse, type IAuthSession, type IAuthSessionIdParams, type IAuthTokenBundle, type IAuthTokenResponse, type IBooleanFilterCondition, type ICancelWorkSessionRequest, type ICancelWorkSessionResponse, type IChangePasswordRequest, type IChangePasswordResponse, type IChecklistAndItemIdParams, type IChecklistExecution, type IChecklistIdParams, type IChecklistItemCompletion, type IChecklistItemOrder, type IChecklistTemplate, type IChecklistTemplateCompanyRouteParams, type IChecklistTemplateItem, type IChecklistTemplateWithItems, type ICloneChecklistRequest, type ICloneChecklistResponse, type ICompany, type ICompanyIdParams, type ICompanyInvitationIdParams, type ICompanyInvitationTokenParams, type ICompanyRouteParams, type ICompanyUserRouteParams, type ICompanyUserSummary, type ICompleteChecklistExecutionRequest, type ICompleteChecklistExecutionResponse, type ICompleteChecklistItemInput, type ICompleteExecutionItemRequest, type ICompleteExecutionItemResponse, type ICompleteWorkOrderRequest, type ICompleteWorkOrderResponse, type ICompleteWorkSessionRequest, type ICompleteWorkSessionResponse, type ICountResponse, type ICreateChecklistRequest, type ICreateChecklistResponse, type ICreateCompanyRequest, type ICreateCompanyResponse, type ICreateCustomChecklistRequest, type ICreateCustomChecklistResponse, type ICreateDamageReportInput, type ICreateDamageReportRequest, type ICreateDamageReportResponse, type ICreateInventoryItemRequest, type ICreateInventoryItemResponse, type ICreatePropertyRequest, type ICreatePropertyResponse, type ICreateRestockOrderRequest, type ICreateRestockOrderResponse, type ICreateRoomChecklistInput, type ICreateRoomChecklistItemInput, type ICreateRoomRequest, type ICreateRoomResponse, type ICreateTemplateInput, type ICreateTemplateItemInput, type ICreateTemplateRequest, type ICreateTemplateResponse, type ICreateTemplateWithItemsRequest, type ICreateTemplateWithItemsResponse, type ICreateWorkOrderInput, type ICreateWorkOrderRequest, type ICreateWorkOrderResponse, type ICreateWorkSessionInput, type ICreateWorkSessionRequest, type ICreateWorkSessionResponse, type IDamageComment, type IDamagePhoto, type IDamageReport, type IDamageReportPhoto, type IDamageReportPropertyRouteParams, type IDamageReportRoomRouteParams, type IDamageReportRouteParams, type IDamageReportStatusHistory, type IDamageReportWorkOrderRouteParams, type IDataWithPagingResult, type IDeclineCompanyInvitationRequest, type IDeclineCompanyInvitationResponse, type IDeleteChecklistItemRequest, type IDeleteChecklistItemResponse, type IDeleteChecklistRequest, type IDeleteChecklistResponse, type IDeleteImageRequest, type IDeleteImageResponse, type IDeleteInventoryItemRequest, type IDeleteInventoryItemResponse, type IDeletePropertyRequest, type IDeletePropertyResponse, type IDeleteRoomRequest, type IDeleteRoomResponse, type IDeleteTemplateItemRequest, type IDeleteTemplateItemResponse, type IDeleteTemplateRequest, type IDeleteTemplateResponse, type IDeleteUserRequest, type IDeleteUserResponse, type IDeviceInfo, type IDuplicateTemplateItemRequest, type IDuplicateTemplateItemResponse, type IEmailValidationResult, type IEmptyRouteParams, type IEmptyRouteRequest, type IFilterCondition, type IFilterConditionBase, type IForgotPasswordRequest, type IForgotPasswordResponse, type IGetActiveWorkSessionRequest, type IGetActiveWorkSessionResponse, type IGetChecklistByIdRequest, type IGetChecklistByIdResponse, type IGetChecklistByRoomIdRequest, type IGetChecklistByRoomIdResponse, type IGetChecklistExecutionByIdRequest, type IGetChecklistExecutionByIdResponse, type IGetChecklistExecutionsRequest, type IGetChecklistExecutionsResponse, type IGetChecklistItemsRequest, type IGetChecklistItemsResponse, type IGetChecklistWithItemsRequest, type IGetChecklistWithItemsResponse, type IGetCompaniesQuery, type IGetCompaniesRequest, type IGetCompaniesResponse, type IGetCompanyByIdRequest, type IGetCompanyByIdResponse, type IGetCompanyUsersRequest, type IGetCompanyUsersResponse, type IGetCurrentUserRequest, type IGetCurrentUserResponse, type IGetCustomChecklistItemsRequest, type IGetCustomChecklistItemsResponse, type IGetDamageReportByIdRequest, type IGetDamageReportByIdResponse, type IGetDamageReportCommentsRequest, type IGetDamageReportCommentsResponse, type IGetDamageReportHistoryRequest, type IGetDamageReportHistoryResponse, type IGetDamageReportPhotosRequest, type IGetDamageReportPhotosResponse, type IGetDamageReportsByPropertyIdRequest, type IGetDamageReportsByPropertyIdResponse, type IGetDamageReportsByRoomIdRequest, type IGetDamageReportsByRoomIdResponse, type IGetDetailedHealthRequest, type IGetDetailedHealthResponse, type IGetDetailedRoomsByPropertyIdRequest, type IGetDetailedRoomsByPropertyIdResponse, type IGetExecutionItemsRequest, type IGetExecutionItemsResponse, type IGetExecutionProgressRequest, type IGetExecutionProgressResponse, type IGetHealthRequest, type IGetHealthResponse, type IGetImagesForEntityResponse, type IGetInventoryByCompanyIdRequest, type IGetInventoryByCompanyIdResponse, type IGetInventoryCountsByExecutionIdRequest, type IGetInventoryCountsByExecutionIdResponse, type IGetInventoryItemByIdRequest, type IGetInventoryItemByIdResponse, type IGetLoginHistoryListResponse, type IGetLoginHistoryRequest, type IGetLoginHistoryResponse, type IGetMeRequest, type IGetMeResponse, type IGetPendingCompanyInvitationsRequest, type IGetPendingCompanyInvitationsResponse, type IGetPendingInvitationsListResponse, type IGetPendingInvitationsRequest, type IGetPendingInvitationsResponse, type IGetPropertiesByCompanyIdRequest, type IGetPropertiesByCompanyIdResponse, type IGetPropertiesRequest, type IGetPropertiesResponse, type IGetPropertyAccessInformationRequest, type IGetPropertyAccessInformationResponse, type IGetPropertyByIdRequest, type IGetPropertyByIdResponse, type IGetPropertyInventoryNeedingRestockRequest, type IGetPropertyInventoryNeedingRestockResponse, type IGetPropertyInventoryRequest, type IGetPropertyInventoryResponse, type IGetPropertyResponse, type IGetRestockOrderItemsRequest, type IGetRestockOrderItemsResponse, type IGetRestockOrdersByCompanyIdRequest, type IGetRestockOrdersByCompanyIdResponse, type IGetRoomByIdRequest, type IGetRoomByIdResponse, type IGetRoomInventoryNeedingRestockRequest, type IGetRoomInventoryNeedingRestockResponse, type IGetRoomInventoryRequest, type IGetRoomInventoryResponse, type IGetRoomsByPropertyIdRequest, type IGetRoomsByPropertyIdResponse, type IGetSessionsRequest, type IGetSessionsResponse, type IGetStaffRequest, type IGetStaffResponse, type IGetTemplateByIdRequest, type IGetTemplateByIdResponse, type IGetTemplateItemsRequest, type IGetTemplateItemsResponse, type IGetTemplateUsageRequest, type IGetTemplateUsageResponse, type IGetTemplateWithItemsRequest, type IGetTemplateWithItemsResponse, type IGetTemplatesByCompanyIdRequest, type IGetTemplatesByCompanyIdResponse, type IGetUserByEmailRequest, type IGetUserByEmailResponse, type IGetUserByIdRequest, type IGetUserByIdResponse, type IGetUserCompaniesRequest, type IGetUserCompaniesResponse, type IGetUserResponse, type IGetUsersByAccountTypeRequest, type IGetUsersByAccountTypeResponse, type IGetWorkOrderByIdRequest, type IGetWorkOrderByIdResponse, type IGetWorkOrdersByPropertyIdRequest, type IGetWorkOrdersByPropertyIdResponse, type IGetWorkSessionByIdRequest, type IGetWorkSessionByIdResponse, type IGetWorkSessionWithExecutionsRequest, type IGetWorkSessionWithExecutionsResponse, type IGetWorkSessionsByPropertyIdRequest, type IGetWorkSessionsByPropertyIdResponse, type IGetWorkSessionsByUserIdRequest, type IGetWorkSessionsByUserIdResponse, type IHealthCheckResponse, type IHealthChecks, type IImage, type IImageCompanyRouteParams, type IImagePropertyRouteParams, type IImageRoomRouteParams, type IImageRouteParams, type IImageUserRouteParams, type IImageWithUrl, type IIncludeInactiveQuery, type IIncludeResolvedQuery, type IInventoryCompanyRouteParams, type IInventoryCount, type IInventoryExecutionRouteParams, type IInventoryItem, type IInventoryItemRouteParams, type IInventoryOrderRouteParams, type IInventoryPropertyRouteParams, type IInventoryRestockOrder, type IInventoryRestockOrderItem, type IInventoryRoomRouteParams, type IInviteCompanyToCompanyRequest, type IInviteCompanyToCompanyResponse, type IInviteUserToCompanyRequest, type IInviteUserToCompanyResponse, type IJobFilterValues, type ILimitQuery, type ILoginCredentials, type ILoginRequest, type ILoginResponse, type ILogoutAllRequest, type ILogoutAllResponse, type ILogoutRequest, type ILogoutResponse, IMAGE_ENTITY, IMAGE_ENTITY_TYPE, type IMessageResponse, type IMetaData, type IMissingFieldsErrorDetail, INVENTORY_ITEM_TYPE, INVENTORY_RESTOCK_ORDER_STATUS, INVENTORY_UNITS, type INumberFilterCondition, type IPaginationRequest, type IPagingObject, type IPagingResult, type IPasswordValidationResult, type IPasswordValidationRules, type IProperty, type IPropertyAccessFormValues, type IPropertyAccessInformation, type IPropertyAccessItem, type IPropertyBase, type IPropertyDetail, type IPropertyFilterValues, type IPropertyFormValues, type IPropertyIdParams, type IPropertyInventory, type IPropertyJobSummaryItem, type IPropertyMetric, type IPropertyRoomSummaryItem, type IPropertySummary, type IRateLimitErrorDetail, type IRateLimitStatus, type IRecordInventoryCountRequest, type IRecordInventoryCountResponse, type IRefreshRequest, type IRefreshResponse, type IRefreshSessionRequest, type IRefreshSessionResponse, type IRefreshTokenData, type IRegisterCredentials, type IRegisterRequest, type IRegisterResponse, type IRegisterWithInvitationRequest, type IRegisterWithInvitationResponse, type IReorderChecklistItemsRequest, type IReorderChecklistItemsResponse, type IReorderTemplateItemsRequest, type IReorderTemplateItemsResponse, type IResolveDamageReportRequest, type IResolveDamageReportResponse, type IRestockOrderItemInput, type IRevokeCompanyInvitationRequest, type IRevokeCompanyInvitationResponse, type IRevokeInvitationRequest, type IRevokeInvitationResponse, type IRevokeSessionRequest, type IRevokeSessionResponse, type IRoom, type IRoomChecklist, type IRoomChecklistItem, type IRoomChecklistRoomRouteParams, type IRoomChecklistWithItems, type IRoomInventory, type IRoomInventoryIdParams, type IRoomPropertyRouteParams, type IRoomRouteParams, type ISelectOption, type ISetAuthSessionParams, type ISkipChecklistExecutionRequest, type ISkipChecklistExecutionResponse, type ISortCondition, type IStartChecklistExecutionRequest, type IStartChecklistExecutionResponse, type IStoredAuthSession, type IStringFilterCondition, type ISuccessResponse, type ITemplateAndItemIdParams, type ITemplateIdParams, type ITemplateItemIdParams, type ITemplateItemOrder, type IToggleTemplateActiveRequest, type IToggleTemplateActiveResponse, type ITokenPayload, type ITypedApiError, type IUpdateChecklistItemRequest, type IUpdateChecklistItemResponse, type IUpdateChecklistRequest, type IUpdateChecklistResponse, type IUpdateCompanyRequest, type IUpdateCompanyResponse, type IUpdateDamageReportRequest, type IUpdateDamageReportResponse, type IUpdateDamageReportStatusRequest, type IUpdateDamageReportStatusResponse, type IUpdateInventoryItemRequest, type IUpdateInventoryItemResponse, type IUpdatePropertyAccessInformationRequest, type IUpdatePropertyAccessInformationResponse, type IUpdatePropertyRequest, type IUpdatePropertyResponse, type IUpdateRestockOrderStatusRequest, type IUpdateRestockOrderStatusResponse, type IUpdateRoomInventoryRequest, type IUpdateRoomInventoryResponse, type IUpdateRoomRequest, type IUpdateRoomResponse, type IUpdateTemplateItemRequest, type IUpdateTemplateItemResponse, type IUpdateTemplateRequest, type IUpdateTemplateResponse, type IUpdateUserRequest, type IUpdateUserResponse, type IUpdateWorkOrderRequest, type IUpdateWorkOrderResponse, type IUpdateWorkOrderStatusRequest, type IUpdateWorkOrderStatusResponse, type IUpdateWorkSessionRequest, type IUpdateWorkSessionResponse, type IUploadImagesResponse, type IUploadProfileImageRequest, type IUploadProfileImageResponse, type IUser, type IUserIdParams, type IUserSafe, type IUserSession, type IUserSubscription, type IValidateCompanyInvitationRequest, type IValidateCompanyInvitationResponse, type IValidateInvitationRequest, type IValidateInvitationResponse, type IValidationErrorDetail, type IVersion, type IWeekDay, type IWorkOrder, type IWorkSession, type IWorkSessionExecutionRouteParams, type IWorkSessionPropertyRouteParams, type IWorkSessionRouteParams, type IWorkSessionUserRouteParams, type IWorkSessionWithExecutions, JSONStringify, LANGUAGE, MODE, MONTHS, PROPERTY_STATUS, PROPERTY_TYPES, PropertyStatusOptions, PropertyTypeOptions, ROOM_TYPE, SERVICE_TYPES, SEVERITY, STATUS, SUBSCRIPTION_PROVIDER, SUBSCRIPTION_STATUS, ServiceTypeOptions, SeverityOptions, SortDirection, StatusOptions, type TAccountStatus, type TAccountType, type TApiErrorDetails, type TAuthStatus, type TBillingPeriod, type TChecklistExecutionStatus, type TCompanyFilter, type TCompanyType, type TDamageSeverity, type TDamageStatus, type TDateFormat, type TDateInput, type TDateTimeString, type TEmptyObject, type TErrorCode, type TErrorResponseDetail, type TFilterCondition, type TFilterConditionValue, type THttpMethod, type THttpStatusCode, type TImageEntityType, type TInventoryItemType, type TInventoryRestockOrderStatus, type TInventoryUnitType, type TJsonObject, type TJsonPrimitive, type TJsonValue, type TLanguage, type TMissingFieldsError, type TMode, type TMonth, type TPropertyStatus, type TPropertyType, type TRateLimitError, type TRecordKeys, type TRecordValue, type TRoomType, type TServiceType, type TSeverity, type TSortDirection, type TStatus, type TStoredImageEntityType, type TSubscriptionProvider, type TSubscriptionStatus, type TUSJurisdiction, type TUSStateCode, type TUnknownRecord, type TValidationError, type TVersionInput, type TWorkOrderPriority, type TWorkOrderStatus, type TWorkSessionStatus, type TurndownObject, US_JURISDICTIONS, UnitedStatesJurisdictionOptions, WORK_ORDER_PRIORITY, WORK_ORDER_STATUS, WORK_SESSION_STATUS, addDays, addWeeks, camelCase, capitalize, charCount, chunkArray, cleanFormData, containsAll, containsAny, convertStringBooleans, createPagingObject, daysBetween, deepClone, deletePropertyIfExists, endOfDay, endOfWeek, escapeRegex, extractNumbers, filterArrayById, flatten, formatAddress, formatDate, formatNumber, formatPhoneNumber, fromBase64, getFirstPropertyValue, getNestedValue, getWeekDays, hasOwnProp, hasProperties, hasProperty, highlight, isAuthError, isEmail, isEmpty, isFuture, isMissingFieldsError, isNumeric, isPalindrome, isPast, isRateLimitError, isToday, isUrl, isValidationError, kebabCase, kebabToSpaces, longestWord, lowerCase, normalCase, normalizeSpaces, omitProperties, padEnd, padStart, parseJSON, parseNumber, pascalCase, pluralize, removeDuplicates, removeFormProperties, removeSpecialChars, removeUndefined, removeWhitespace, repeat, repeatChar, replaceNulls, resetPagination, returnObject, reverse, sentenceCase, setNestedValue, slug, snakeCase, snakeCaseToSpaces, sortArrayByProperty, splitMultiple, startOfDay, startOfWeek, stringSimilarity, stripHtml, subtractDays, subtractWeeks, timeAgo, titleCase, toBase64, toCamelCase, toKebabCase, toNumber, toPascalCase, toSnakeCase, truncate, unflatten, upperCase, validPath, wordCount };
2813
+ type Success<T> = {
2814
+ data: T;
2815
+ error: null;
2816
+ };
2817
+ type Failure<E> = {
2818
+ data: null;
2819
+ error: E;
2820
+ };
2821
+ type Result<T, E = unknown> = Success<T> | Failure<E>;
2822
+ declare const tryCatch: <T, E = unknown>(callback: () => T | Promise<T>) => Promise<Result<T, E>>;
2823
+
2824
+ export { ACCOUNT_STATUS, ACCOUNT_TYPE, AUTH_STATUS, BILLING_PERIOD, CHECKLIST_EXECUTION_STATUS, COMPANY_TYPES, CompanyFilter, DAMAGE_SEVERITY, DAMAGE_STATUS, ERROR_CODES, FilterCondition, HTTP_METHOD, HTTP_STATUS, type IAcceptCompanyInvitationRequest, type IAcceptCompanyInvitationResponse, type IAcceptInvitationRequest, type IAcceptInvitationResponse, type IAcceptInvitationRouteResponse, type IAddChecklistItemRequest, type IAddChecklistItemResponse, type IAddDamageReportCommentRequest, type IAddDamageReportCommentResponse, type IAddDamageReportPhotoRequest, type IAddDamageReportPhotoResponse, type IAddInventoryToPropertyRequest, type IAddInventoryToPropertyResponse, type IAddInventoryToRoomRequest, type IAddInventoryToRoomResponse, type IAddTemplateItemRequest, type IAddTemplateItemResponse, type IAddress, type IApiError, type IApiMeta, type IApiResponse, type IAssignDamageReportRequest, type IAssignDamageReportResponse, type IAssignWorkOrderRequest, type IAssignWorkOrderResponse, type IAuthInvitationBaseResponse, type IAuthInvitationIdParams, type IAuthInvitationTokenParams, type IAuthMessageResponse, type IAuthRefreshTokenResponse, type IAuthSession, type IAuthSessionIdParams, type IAuthTokenBundle, type IAuthTokenResponse, type IBooleanFilterCondition, type ICancelWorkSessionRequest, type ICancelWorkSessionResponse, type IChangePasswordRequest, type IChangePasswordResponse, type IChecklistAndItemIdParams, type IChecklistExecution, type IChecklistIdParams, type IChecklistItemCompletion, type IChecklistItemOrder, type IChecklistTemplate, type IChecklistTemplateCompanyRouteParams, type IChecklistTemplateItem, type IChecklistTemplateWithItems, type ICloneChecklistRequest, type ICloneChecklistResponse, type ICompany, type ICompanyIdParams, type ICompanyInvitationIdParams, type ICompanyInvitationTokenParams, type ICompanyRouteParams, type ICompanyUserRouteParams, type ICompanyUserSummary, type ICompleteChecklistExecutionRequest, type ICompleteChecklistExecutionResponse, type ICompleteChecklistItemInput, type ICompleteExecutionItemRequest, type ICompleteExecutionItemResponse, type ICompleteWorkOrderRequest, type ICompleteWorkOrderResponse, type ICompleteWorkSessionRequest, type ICompleteWorkSessionResponse, type ICountResponse, type ICreateChecklistRequest, type ICreateChecklistResponse, type ICreateCompanyRequest, type ICreateCompanyResponse, type ICreateCustomChecklistRequest, type ICreateCustomChecklistResponse, type ICreateDamageReportInput, type ICreateDamageReportRequest, type ICreateDamageReportResponse, type ICreateInventoryItemRequest, type ICreateInventoryItemResponse, type ICreatePropertyRequest, type ICreatePropertyResponse, type ICreateRestockOrderRequest, type ICreateRestockOrderResponse, type ICreateRoomChecklistInput, type ICreateRoomChecklistItemInput, type ICreateRoomRequest, type ICreateRoomResponse, type ICreateTemplateInput, type ICreateTemplateItemInput, type ICreateTemplateRequest, type ICreateTemplateResponse, type ICreateTemplateWithItemsRequest, type ICreateTemplateWithItemsResponse, type ICreateWorkOrderInput, type ICreateWorkOrderRequest, type ICreateWorkOrderResponse, type ICreateWorkSessionInput, type ICreateWorkSessionRequest, type ICreateWorkSessionResponse, type IDamageComment, type IDamagePhoto, type IDamageReport, type IDamageReportPhoto, type IDamageReportPropertyRouteParams, type IDamageReportRoomRouteParams, type IDamageReportRouteParams, type IDamageReportStatusHistory, type IDamageReportWorkOrderRouteParams, type IDataWithPagingResult, type IDeclineCompanyInvitationRequest, type IDeclineCompanyInvitationResponse, type IDeleteChecklistItemRequest, type IDeleteChecklistItemResponse, type IDeleteChecklistRequest, type IDeleteChecklistResponse, type IDeleteImageRequest, type IDeleteImageResponse, type IDeleteInventoryItemRequest, type IDeleteInventoryItemResponse, type IDeletePropertyRequest, type IDeletePropertyResponse, type IDeleteRoomRequest, type IDeleteRoomResponse, type IDeleteTemplateItemRequest, type IDeleteTemplateItemResponse, type IDeleteTemplateRequest, type IDeleteTemplateResponse, type IDeleteUserRequest, type IDeleteUserResponse, type IDeviceInfo, type IDuplicateTemplateItemRequest, type IDuplicateTemplateItemResponse, type IEmailValidationResult, type IEmptyRouteParams, type IEmptyRouteRequest, type IFilterCondition, type IFilterConditionBase, type IForgotPasswordRequest, type IForgotPasswordResponse, type IGetActiveWorkSessionRequest, type IGetActiveWorkSessionResponse, type IGetChecklistByIdRequest, type IGetChecklistByIdResponse, type IGetChecklistByRoomIdRequest, type IGetChecklistByRoomIdResponse, type IGetChecklistExecutionByIdRequest, type IGetChecklistExecutionByIdResponse, type IGetChecklistExecutionsRequest, type IGetChecklistExecutionsResponse, type IGetChecklistItemsRequest, type IGetChecklistItemsResponse, type IGetChecklistWithItemsRequest, type IGetChecklistWithItemsResponse, type IGetCompaniesQuery, type IGetCompaniesRequest, type IGetCompaniesResponse, type IGetCompanyByIdRequest, type IGetCompanyByIdResponse, type IGetCompanyUsersRequest, type IGetCompanyUsersResponse, type IGetCurrentUserRequest, type IGetCurrentUserResponse, type IGetCustomChecklistItemsRequest, type IGetCustomChecklistItemsResponse, type IGetDamageReportByIdRequest, type IGetDamageReportByIdResponse, type IGetDamageReportCommentsRequest, type IGetDamageReportCommentsResponse, type IGetDamageReportHistoryRequest, type IGetDamageReportHistoryResponse, type IGetDamageReportPhotosRequest, type IGetDamageReportPhotosResponse, type IGetDamageReportsByPropertyIdRequest, type IGetDamageReportsByPropertyIdResponse, type IGetDamageReportsByRoomIdRequest, type IGetDamageReportsByRoomIdResponse, type IGetDetailedHealthRequest, type IGetDetailedHealthResponse, type IGetDetailedRoomsByPropertyIdRequest, type IGetDetailedRoomsByPropertyIdResponse, type IGetExecutionItemsRequest, type IGetExecutionItemsResponse, type IGetExecutionProgressRequest, type IGetExecutionProgressResponse, type IGetHealthRequest, type IGetHealthResponse, type IGetImagesForEntityResponse, type IGetInventoryByCompanyIdRequest, type IGetInventoryByCompanyIdResponse, type IGetInventoryCountsByExecutionIdRequest, type IGetInventoryCountsByExecutionIdResponse, type IGetInventoryItemByIdRequest, type IGetInventoryItemByIdResponse, type IGetLoginHistoryListResponse, type IGetLoginHistoryRequest, type IGetLoginHistoryResponse, type IGetMeRequest, type IGetMeResponse, type IGetPendingCompanyInvitationsRequest, type IGetPendingCompanyInvitationsResponse, type IGetPendingInvitationsListResponse, type IGetPendingInvitationsRequest, type IGetPendingInvitationsResponse, type IGetPropertiesByCompanyIdRequest, type IGetPropertiesByCompanyIdResponse, type IGetPropertiesRequest, type IGetPropertiesResponse, type IGetPropertyAccessInformationRequest, type IGetPropertyAccessInformationResponse, type IGetPropertyByIdRequest, type IGetPropertyByIdResponse, type IGetPropertyInventoryNeedingRestockRequest, type IGetPropertyInventoryNeedingRestockResponse, type IGetPropertyInventoryRequest, type IGetPropertyInventoryResponse, type IGetPropertyResponse, type IGetRestockOrderItemsRequest, type IGetRestockOrderItemsResponse, type IGetRestockOrdersByCompanyIdRequest, type IGetRestockOrdersByCompanyIdResponse, type IGetRoomByIdRequest, type IGetRoomByIdResponse, type IGetRoomInventoryNeedingRestockRequest, type IGetRoomInventoryNeedingRestockResponse, type IGetRoomInventoryRequest, type IGetRoomInventoryResponse, type IGetRoomsByPropertyIdRequest, type IGetRoomsByPropertyIdResponse, type IGetSessionsRequest, type IGetSessionsResponse, type IGetStaffRequest, type IGetStaffResponse, type IGetTemplateByIdRequest, type IGetTemplateByIdResponse, type IGetTemplateItemsRequest, type IGetTemplateItemsResponse, type IGetTemplateUsageRequest, type IGetTemplateUsageResponse, type IGetTemplateWithItemsRequest, type IGetTemplateWithItemsResponse, type IGetTemplatesByCompanyIdRequest, type IGetTemplatesByCompanyIdResponse, type IGetUserByEmailRequest, type IGetUserByEmailResponse, type IGetUserByIdRequest, type IGetUserByIdResponse, type IGetUserCompaniesRequest, type IGetUserCompaniesResponse, type IGetUserResponse, type IGetUsersByAccountTypeRequest, type IGetUsersByAccountTypeResponse, type IGetWorkOrderByIdRequest, type IGetWorkOrderByIdResponse, type IGetWorkOrdersByPropertyIdRequest, type IGetWorkOrdersByPropertyIdResponse, type IGetWorkSessionByIdRequest, type IGetWorkSessionByIdResponse, type IGetWorkSessionWithExecutionsRequest, type IGetWorkSessionWithExecutionsResponse, type IGetWorkSessionsByPropertyIdRequest, type IGetWorkSessionsByPropertyIdResponse, type IGetWorkSessionsByUserIdRequest, type IGetWorkSessionsByUserIdResponse, type IHealthCheckResponse, type IHealthChecks, type IImage, type IImageCompanyRouteParams, type IImagePropertyRouteParams, type IImageRoomRouteParams, type IImageRouteParams, type IImageUserRouteParams, type IImageWithUrl, type IIncludeInactiveQuery, type IIncludeResolvedQuery, type IInventoryCompanyRouteParams, type IInventoryCount, type IInventoryExecutionRouteParams, type IInventoryItem, type IInventoryItemRouteParams, type IInventoryOrderRouteParams, type IInventoryPropertyRouteParams, type IInventoryRestockOrder, type IInventoryRestockOrderItem, type IInventoryRoomRouteParams, type IInviteCompanyToCompanyRequest, type IInviteCompanyToCompanyResponse, type IInviteUserToCompanyRequest, type IInviteUserToCompanyResponse, type IJobFilterValues, type ILimitQuery, type ILoginCredentials, type ILoginRequest, type ILoginResponse, type ILogoutAllRequest, type ILogoutAllResponse, type ILogoutRequest, type ILogoutResponse, IMAGE_ENTITY, IMAGE_ENTITY_TYPE, type IMessageResponse, type IMetaData, type IMissingFieldsErrorDetail, INVENTORY_ITEM_TYPE, INVENTORY_RESTOCK_ORDER_STATUS, INVENTORY_UNITS, type INumberFilterCondition, type IPaginationRequest, type IPagingObject, type IPagingResult, type IPasswordValidationResult, type IPasswordValidationRules, type IProperty, type IPropertyAccessFormValues, type IPropertyAccessInformation, type IPropertyAccessItem, type IPropertyBase, type IPropertyDetail, type IPropertyFilterValues, type IPropertyFormValues, type IPropertyIdParams, type IPropertyInventory, type IPropertyJobSummaryItem, type IPropertyMetric, type IPropertyRoomSummaryItem, type IPropertySummary, type IRateLimitErrorDetail, type IRateLimitStatus, type IRecordInventoryCountRequest, type IRecordInventoryCountResponse, type IRefreshSessionRequest, type IRefreshSessionResponse, type IRefreshTokenData, type IRegisterCredentials, type IRegisterRequest, type IRegisterResponse, type IRegisterWithInvitationRequest, type IRegisterWithInvitationResponse, type IReorderChecklistItemsRequest, type IReorderChecklistItemsResponse, type IReorderTemplateItemsRequest, type IReorderTemplateItemsResponse, type IResolveDamageReportRequest, type IResolveDamageReportResponse, type IRestockOrderItemInput, type IRevokeCompanyInvitationRequest, type IRevokeCompanyInvitationResponse, type IRevokeInvitationRequest, type IRevokeInvitationResponse, type IRevokeSessionRequest, type IRevokeSessionResponse, type IRoom, type IRoomChecklist, type IRoomChecklistItem, type IRoomChecklistRoomRouteParams, type IRoomChecklistWithItems, type IRoomInventory, type IRoomInventoryIdParams, type IRoomPropertyRouteParams, type IRoomRouteParams, type ISelectOption, type ISetAuthSessionParams, type ISkipChecklistExecutionRequest, type ISkipChecklistExecutionResponse, type ISortCondition, type IStartChecklistExecutionRequest, type IStartChecklistExecutionResponse, type IStoredAuthSession, type IStringFilterCondition, type ISuccessResponse, type ITemplateAndItemIdParams, type ITemplateIdParams, type ITemplateItemIdParams, type ITemplateItemOrder, type IToggleTemplateActiveRequest, type IToggleTemplateActiveResponse, type ITokenPayload, type ITypedApiError, type IUpdateChecklistItemRequest, type IUpdateChecklistItemResponse, type IUpdateChecklistRequest, type IUpdateChecklistResponse, type IUpdateCompanyRequest, type IUpdateCompanyResponse, type IUpdateDamageReportRequest, type IUpdateDamageReportResponse, type IUpdateDamageReportStatusRequest, type IUpdateDamageReportStatusResponse, type IUpdateInventoryItemRequest, type IUpdateInventoryItemResponse, type IUpdatePropertyAccessInformationRequest, type IUpdatePropertyAccessInformationResponse, type IUpdatePropertyRequest, type IUpdatePropertyResponse, type IUpdateRestockOrderStatusRequest, type IUpdateRestockOrderStatusResponse, type IUpdateRoomInventoryRequest, type IUpdateRoomInventoryResponse, type IUpdateRoomRequest, type IUpdateRoomResponse, type IUpdateTemplateItemRequest, type IUpdateTemplateItemResponse, type IUpdateTemplateRequest, type IUpdateTemplateResponse, type IUpdateUserRequest, type IUpdateUserResponse, type IUpdateWorkOrderRequest, type IUpdateWorkOrderResponse, type IUpdateWorkOrderStatusRequest, type IUpdateWorkOrderStatusResponse, type IUpdateWorkSessionRequest, type IUpdateWorkSessionResponse, type IUploadImagesResponse, type IUploadProfileImageRequest, type IUploadProfileImageResponse, type IUser, type IUserIdParams, type IUserSafe, type IUserSession, type IUserSubscription, type IValidateCompanyInvitationRequest, type IValidateCompanyInvitationResponse, type IValidateInvitationRequest, type IValidateInvitationResponse, type IValidationErrorDetail, type IVersion, type IWeekDay, type IWorkOrder, type IWorkSession, type IWorkSessionExecutionRouteParams, type IWorkSessionPropertyRouteParams, type IWorkSessionRouteParams, type IWorkSessionUserRouteParams, type IWorkSessionWithExecutions, JSONStringify, LANGUAGE, MODE, MONTHS, PROPERTY_STATUS, PROPERTY_TYPES, PropertyStatusOptions, PropertyTypeOptions, ROOM_TYPE, SERVICE_TYPES, SEVERITY, STATUS, SUBSCRIPTION_PROVIDER, SUBSCRIPTION_STATUS, ServiceTypeOptions, SeverityOptions, SortDirection, StatusOptions, type TAccountStatus, type TAccountType, type TApiErrorDetails, type TAuthStatus, type TBillingPeriod, type TChecklistExecutionStatus, type TCompanyFilter, type TCompanyType, type TDamageSeverity, type TDamageStatus, type TDateFormat, type TDateInput, type TDateTimeString, type TEmptyObject, type TErrorCode, type TErrorResponseDetail, type TFilterCondition, type TFilterConditionValue, type THttpMethod, type THttpStatusCode, type TImageEntityType, type TInventoryItemType, type TInventoryRestockOrderStatus, type TInventoryUnitType, type TJsonObject, type TJsonPrimitive, type TJsonValue, type TLanguage, type TMissingFieldsError, type TMode, type TMonth, type TPropertyStatus, type TPropertyType, type TRateLimitError, type TRecordKeys, type TRecordValue, type TRoomType, type TServiceType, type TSeverity, type TSortDirection, type TStatus, type TStoredImageEntityType, type TSubscriptionProvider, type TSubscriptionStatus, type TUSJurisdiction, type TUSStateCode, type TUnknownRecord, type TValidationError, type TVersionInput, type TWorkOrderPriority, type TWorkOrderStatus, type TWorkSessionStatus, type TurndownObject, US_JURISDICTIONS, UnitedStatesJurisdictionOptions, WORK_ORDER_PRIORITY, WORK_ORDER_STATUS, WORK_SESSION_STATUS, addDays, addWeeks, camelCase, capitalize, charCount, chunkArray, cleanFormData, containsAll, containsAny, convertStringBooleans, createPagingObject, daysBetween, deepClone, deletePropertyIfExists, endOfDay, endOfWeek, escapeRegex, extractNumbers, filterArrayById, flatten, formatAddress, formatDate, formatNumber, formatPhoneNumber, fromBase64, getFirstPropertyValue, getNestedValue, getWeekDays, hasOwnProp, hasProperties, hasProperty, highlight, isAuthError, isEmail, isEmpty, isFuture, isMissingFieldsError, isNumeric, isPalindrome, isPast, isRateLimitError, isToday, isUrl, isValidationError, kebabCase, kebabToSpaces, longestWord, lowerCase, normalCase, normalizeSpaces, omitProperties, padEnd, padStart, parseJSON, parseNumber, pascalCase, pluralize, removeDuplicates, removeFormProperties, removeSpecialChars, removeUndefined, removeWhitespace, repeat, repeatChar, replaceNulls, resetPagination, returnObject, reverse, sentenceCase, setNestedValue, slug, snakeCase, snakeCaseToSpaces, sortArrayByProperty, splitMultiple, startOfDay, startOfWeek, stringSimilarity, stripHtml, subtractDays, subtractWeeks, timeAgo, titleCase, toBase64, toCamelCase, toKebabCase, toNumber, toPascalCase, toSnakeCase, truncate, tryCatch, unflatten, upperCase, validPath, wordCount };