npm - @turndown/library - Versions diffs - 0.1.55 → 0.1.57 - Mend

@turndown/library 0.1.55 → 0.1.57

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 (7) hide show

package/dist/index.d.cts CHANGED Viewed

@@ -505,6 +505,13 @@ type TurndownObject<TObject extends object = TUnknownRecord> = TObject;
 type TEmptyObject = Record<string, never>;
 type IEmptyRouteRequest = TEmptyObject;
 type IEmptyRouteParams = TEmptyObject;
+declare const ENVIRONMENT: {
+    readonly Prod: "Prod";
+    readonly Dev: "Dev";
+    readonly Local: "Local";
+    readonly Test: "Test";
+};
+type TEnvironment = (typeof ENVIRONMENT)[keyof typeof ENVIRONMENT];
 interface IMessageResponse {
     message: string;
 }
@@ -728,6 +735,7 @@ declare const ERROR_CODES: {
     readonly NOT_FOUND: "NOT_FOUND";
     readonly CONFLICT: "CONFLICT";
     readonly ALREADY_EXISTS: "ALREADY_EXISTS";
+    readonly RATE_LIMIT: "RATE_LIMIT";
     readonly RATE_LIMIT_EXCEEDED: "RATE_LIMIT_EXCEEDED";
     readonly INTERNAL_ERROR: "INTERNAL_ERROR";
     readonly DATABASE_ERROR: "DATABASE_ERROR";
@@ -761,7 +769,7 @@ interface IApiError<TDetails = TApiErrorDetails> {
 interface IApiMeta {
     timestamp: TDateTimeString;
     version: string;
-    environment: string;
+    environment: TEnvironment;
     requestId?: string;
 }
 interface IApiResponse<TData = null, TErrorDetails = TApiErrorDetails> {
@@ -1238,6 +1246,7 @@ declare const CompanyFilter: {
 };
 type TCompanyFilter = (typeof CompanyFilter)[keyof typeof CompanyFilter];
 interface IGetCompaniesQuery {
+    companyId?: string;
     search?: string;
     filter?: TCompanyFilter;
 }
@@ -1250,13 +1259,13 @@ interface ICreateCompanyRequest {
     postalCode: string;
     companyType: ICompany["companyType"];
 }
-interface ICreateCompanyResponse extends ICompany {
+interface ICreateCompanyResponse extends ICompanyWithRelationshipStatus {
 }
 type IGetCompaniesRequest = IEmptyRouteRequest;
-type IGetCompaniesResponse = ICompany[];
+type IGetCompaniesResponse = ICompanyWithRelationshipStatus[];
 interface IGetCompanyByIdRequest extends ICompanyRouteParams {
 }
-interface IGetCompanyByIdResponse extends ICompany {
+interface IGetCompanyByIdResponse extends ICompanyWithRelationshipStatus {
 }
 interface IUpdateCompanyRequest {
     displayName?: string;
@@ -1270,7 +1279,7 @@ interface IUpdateCompanyRequest {
     timezone?: string | null;
     imageUrl?: string | null;
 }
-interface IUpdateCompanyResponse extends ICompany {
+interface IUpdateCompanyResponse extends ICompanyWithRelationshipStatus {
 }
 interface IInviteUserToCompanyRequest {
     email: string;
@@ -1287,11 +1296,16 @@ interface ICompanyUserSummary {
     lastName: string | null;
     role: TAccountType;
 }
-type IGetCompanyUsersResponse = ICompanyUserSummary[];
+interface ICompanyWithUsers extends ICompanyWithRelationshipStatus {
+    users: ICompanyUserSummary[];
+}
+interface IGetCompanyUsersResponse extends ICompanyWithUsers {
+}
 interface IGetUserCompaniesRequest extends ICompanyUserRouteParams {
 }
-type IGetUserCompaniesResponse = ICompany[];
+type IGetUserCompaniesResponse = ICompanyWithRelationshipStatus[];
 interface IInviteCompanyToCompanyRequest {
+    providerCompanyId: string;
     message?: string;
 }
 interface IInviteCompanyToCompanyResponse {
@@ -1326,7 +1340,11 @@ interface IDeclineCompanyInvitationResponse extends IMessageResponse {
 }
 interface IGetPendingCompanyInvitationsRequest extends ICompanyRouteParams {
 }
-type IGetPendingCompanyInvitationsResponse = IValidateCompanyInvitationResponse[];
+interface ICompanyInvitationSummary extends IValidateCompanyInvitationResponse {
+    token: string;
+    createdAt: TDateTimeString;
+}
+type IGetPendingCompanyInvitationsResponse = ICompanyInvitationSummary[];
 interface IRevokeCompanyInvitationRequest extends ICompanyInvitationIdParams {
 }
 interface IRevokeCompanyInvitationResponse extends IMessageResponse {
@@ -1345,6 +1363,14 @@ interface ICompany extends IMetaData {
     timezone: string | null;
     imageUrl: string | null;
 }
+declare const COMPANY_RELATIONSHIP_STATUS: {
+    Active: string;
+    Pending: string;
+};
+type TCompanyRelationshipStatus = (typeof COMPANY_RELATIONSHIP_STATUS)[keyof typeof COMPANY_RELATIONSHIP_STATUS] | null;
+interface ICompanyWithRelationshipStatus extends ICompany {
+    relationshipStatus: TCompanyRelationshipStatus;
+}
 declare const COMPANY_TYPES: {
     readonly PROPERTY_MANAGEMENT: "PROPERTY_MANAGEMENT";
     readonly MAINTENANCE: "MAINTENANCE";
@@ -1672,14 +1698,25 @@ interface IGetDetailedHealthResponse {
     checks: IHealthChecks;
 }
+declare const SERVER_STATUS: {
+    readonly Healthy: "Healthy";
+    readonly Unhealthy: "UnHealthy";
+};
+type TServerStatus = (typeof SERVER_STATUS)[keyof typeof SERVER_STATUS];
+declare const DATABASE_STATUS: {
+    readonly Unknown: "Unknown";
+    readonly Connected: "Connected";
+    readonly Disconnected: "Disconnected";
+};
+type TDatabaseStatus = (typeof DATABASE_STATUS)[keyof typeof DATABASE_STATUS];
 interface IHealthCheckResponse {
-    status: "healthy";
-    database: "connected";
+    status: TServerStatus;
+    database: TDatabaseStatus;
     timestamp: TDateTimeString;
-    environment?: string;
+    environment: TEnvironment;
 }
 interface IHealthChecks {
-    database: "unknown" | "connected" | "disconnected";
+    database: TDatabaseStatus;
     uptime: number;
     memory: {
         rss: number;
@@ -2180,6 +2217,9 @@ interface ICreateRoomRequest {
 }
 interface ICreateRoomResponse extends IRoom {
 }
+interface IGetRoomsRequest {
+    propertyId?: string;
+}
 interface IGetRoomsByPropertyIdRequest extends IRoomPropertyRouteParams {
 }
 type IGetRoomsByPropertyIdResponse = IRoom[];
@@ -2821,4 +2861,4 @@ type Failure<E> = {
 type Result<T, E = unknown> = Success<T> | Failure<E>;
 declare const tryCatch: <T, E = unknown>(callback: () => T | Promise<T>) => Promise<Result<T, E>>;
-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 };
+export { ACCOUNT_STATUS, ACCOUNT_TYPE, AUTH_STATUS, BILLING_PERIOD, CHECKLIST_EXECUTION_STATUS, COMPANY_RELATIONSHIP_STATUS, COMPANY_TYPES, CompanyFilter, DAMAGE_SEVERITY, DAMAGE_STATUS, DATABASE_STATUS, ENVIRONMENT, 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 ICompanyInvitationSummary, type ICompanyInvitationTokenParams, type ICompanyRouteParams, type ICompanyUserRouteParams, type ICompanyUserSummary, type ICompanyWithRelationshipStatus, type ICompanyWithUsers, 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 IGetRoomsRequest, 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, SERVER_STATUS, 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 TCompanyRelationshipStatus, type TCompanyType, type TDamageSeverity, type TDamageStatus, type TDatabaseStatus, type TDateFormat, type TDateInput, type TDateTimeString, type TEmptyObject, type TEnvironment, 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 TServerStatus, 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 };

package/dist/index.d.ts CHANGED Viewed

@@ -505,6 +505,13 @@ type TurndownObject<TObject extends object = TUnknownRecord> = TObject;
 type TEmptyObject = Record<string, never>;
 type IEmptyRouteRequest = TEmptyObject;
 type IEmptyRouteParams = TEmptyObject;
+declare const ENVIRONMENT: {
+    readonly Prod: "Prod";
+    readonly Dev: "Dev";
+    readonly Local: "Local";
+    readonly Test: "Test";
+};
+type TEnvironment = (typeof ENVIRONMENT)[keyof typeof ENVIRONMENT];
 interface IMessageResponse {
     message: string;
 }
@@ -728,6 +735,7 @@ declare const ERROR_CODES: {
     readonly NOT_FOUND: "NOT_FOUND";
     readonly CONFLICT: "CONFLICT";
     readonly ALREADY_EXISTS: "ALREADY_EXISTS";
+    readonly RATE_LIMIT: "RATE_LIMIT";
     readonly RATE_LIMIT_EXCEEDED: "RATE_LIMIT_EXCEEDED";
     readonly INTERNAL_ERROR: "INTERNAL_ERROR";
     readonly DATABASE_ERROR: "DATABASE_ERROR";
@@ -761,7 +769,7 @@ interface IApiError<TDetails = TApiErrorDetails> {
 interface IApiMeta {
     timestamp: TDateTimeString;
     version: string;
-    environment: string;
+    environment: TEnvironment;
     requestId?: string;
 }
 interface IApiResponse<TData = null, TErrorDetails = TApiErrorDetails> {
@@ -1238,6 +1246,7 @@ declare const CompanyFilter: {
 };
 type TCompanyFilter = (typeof CompanyFilter)[keyof typeof CompanyFilter];
 interface IGetCompaniesQuery {
+    companyId?: string;
     search?: string;
     filter?: TCompanyFilter;
 }
@@ -1250,13 +1259,13 @@ interface ICreateCompanyRequest {
     postalCode: string;
     companyType: ICompany["companyType"];
 }
-interface ICreateCompanyResponse extends ICompany {
+interface ICreateCompanyResponse extends ICompanyWithRelationshipStatus {
 }
 type IGetCompaniesRequest = IEmptyRouteRequest;
-type IGetCompaniesResponse = ICompany[];
+type IGetCompaniesResponse = ICompanyWithRelationshipStatus[];
 interface IGetCompanyByIdRequest extends ICompanyRouteParams {
 }
-interface IGetCompanyByIdResponse extends ICompany {
+interface IGetCompanyByIdResponse extends ICompanyWithRelationshipStatus {
 }
 interface IUpdateCompanyRequest {
     displayName?: string;
@@ -1270,7 +1279,7 @@ interface IUpdateCompanyRequest {
     timezone?: string | null;
     imageUrl?: string | null;
 }
-interface IUpdateCompanyResponse extends ICompany {
+interface IUpdateCompanyResponse extends ICompanyWithRelationshipStatus {
 }
 interface IInviteUserToCompanyRequest {
     email: string;
@@ -1287,11 +1296,16 @@ interface ICompanyUserSummary {
     lastName: string | null;
     role: TAccountType;
 }
-type IGetCompanyUsersResponse = ICompanyUserSummary[];
+interface ICompanyWithUsers extends ICompanyWithRelationshipStatus {
+    users: ICompanyUserSummary[];
+}
+interface IGetCompanyUsersResponse extends ICompanyWithUsers {
+}
 interface IGetUserCompaniesRequest extends ICompanyUserRouteParams {
 }
-type IGetUserCompaniesResponse = ICompany[];
+type IGetUserCompaniesResponse = ICompanyWithRelationshipStatus[];
 interface IInviteCompanyToCompanyRequest {
+    providerCompanyId: string;
     message?: string;
 }
 interface IInviteCompanyToCompanyResponse {
@@ -1326,7 +1340,11 @@ interface IDeclineCompanyInvitationResponse extends IMessageResponse {
 }
 interface IGetPendingCompanyInvitationsRequest extends ICompanyRouteParams {
 }
-type IGetPendingCompanyInvitationsResponse = IValidateCompanyInvitationResponse[];
+interface ICompanyInvitationSummary extends IValidateCompanyInvitationResponse {
+    token: string;
+    createdAt: TDateTimeString;
+}
+type IGetPendingCompanyInvitationsResponse = ICompanyInvitationSummary[];
 interface IRevokeCompanyInvitationRequest extends ICompanyInvitationIdParams {
 }
 interface IRevokeCompanyInvitationResponse extends IMessageResponse {
@@ -1345,6 +1363,14 @@ interface ICompany extends IMetaData {
     timezone: string | null;
     imageUrl: string | null;
 }
+declare const COMPANY_RELATIONSHIP_STATUS: {
+    Active: string;
+    Pending: string;
+};
+type TCompanyRelationshipStatus = (typeof COMPANY_RELATIONSHIP_STATUS)[keyof typeof COMPANY_RELATIONSHIP_STATUS] | null;
+interface ICompanyWithRelationshipStatus extends ICompany {
+    relationshipStatus: TCompanyRelationshipStatus;
+}
 declare const COMPANY_TYPES: {
     readonly PROPERTY_MANAGEMENT: "PROPERTY_MANAGEMENT";
     readonly MAINTENANCE: "MAINTENANCE";
@@ -1672,14 +1698,25 @@ interface IGetDetailedHealthResponse {
     checks: IHealthChecks;
 }
+declare const SERVER_STATUS: {
+    readonly Healthy: "Healthy";
+    readonly Unhealthy: "UnHealthy";
+};
+type TServerStatus = (typeof SERVER_STATUS)[keyof typeof SERVER_STATUS];
+declare const DATABASE_STATUS: {
+    readonly Unknown: "Unknown";
+    readonly Connected: "Connected";
+    readonly Disconnected: "Disconnected";
+};
+type TDatabaseStatus = (typeof DATABASE_STATUS)[keyof typeof DATABASE_STATUS];
 interface IHealthCheckResponse {
-    status: "healthy";
-    database: "connected";
+    status: TServerStatus;
+    database: TDatabaseStatus;
     timestamp: TDateTimeString;
-    environment?: string;
+    environment: TEnvironment;
 }
 interface IHealthChecks {
-    database: "unknown" | "connected" | "disconnected";
+    database: TDatabaseStatus;
     uptime: number;
     memory: {
         rss: number;
@@ -2180,6 +2217,9 @@ interface ICreateRoomRequest {
 }
 interface ICreateRoomResponse extends IRoom {
 }
+interface IGetRoomsRequest {
+    propertyId?: string;
+}
 interface IGetRoomsByPropertyIdRequest extends IRoomPropertyRouteParams {
 }
 type IGetRoomsByPropertyIdResponse = IRoom[];
@@ -2821,4 +2861,4 @@ type Failure<E> = {
 type Result<T, E = unknown> = Success<T> | Failure<E>;
 declare const tryCatch: <T, E = unknown>(callback: () => T | Promise<T>) => Promise<Result<T, E>>;
-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 };
+export { ACCOUNT_STATUS, ACCOUNT_TYPE, AUTH_STATUS, BILLING_PERIOD, CHECKLIST_EXECUTION_STATUS, COMPANY_RELATIONSHIP_STATUS, COMPANY_TYPES, CompanyFilter, DAMAGE_SEVERITY, DAMAGE_STATUS, DATABASE_STATUS, ENVIRONMENT, 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 ICompanyInvitationSummary, type ICompanyInvitationTokenParams, type ICompanyRouteParams, type ICompanyUserRouteParams, type ICompanyUserSummary, type ICompanyWithRelationshipStatus, type ICompanyWithUsers, 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 IGetRoomsRequest, 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, SERVER_STATUS, 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 TCompanyRelationshipStatus, type TCompanyType, type TDamageSeverity, type TDamageStatus, type TDatabaseStatus, type TDateFormat, type TDateInput, type TDateTimeString, type TEmptyObject, type TEnvironment, 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 TServerStatus, 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 };

package/dist/index.mjs CHANGED Viewed

@@ -1073,6 +1073,7 @@ var ERROR_CODES = {
   NOT_FOUND: "NOT_FOUND",
   CONFLICT: "CONFLICT",
   ALREADY_EXISTS: "ALREADY_EXISTS",
+  RATE_LIMIT: "RATE_LIMIT",
   RATE_LIMIT_EXCEEDED: "RATE_LIMIT_EXCEEDED",
   INTERNAL_ERROR: "INTERNAL_ERROR",
   DATABASE_ERROR: "DATABASE_ERROR",
@@ -1126,6 +1127,12 @@ var createPagingObject = (page, size, sort, filters) => ({
 });
 // src/types/base/index.ts
+var ENVIRONMENT = {
+  Prod: "Prod",
+  Dev: "Dev",
+  Local: "Local",
+  Test: "Test"
+};
 var MODE = {
   Create: "Create",
   Edit: "Edit",
@@ -1270,6 +1277,10 @@ var CompanyFilter = {
 };
 // src/types/company/index.ts
+var COMPANY_RELATIONSHIP_STATUS = {
+  Active: "Active",
+  Pending: "Pending"
+};
 var COMPANY_TYPES = {
   PROPERTY_MANAGEMENT: "PROPERTY_MANAGEMENT",
   MAINTENANCE: "MAINTENANCE",
@@ -1324,6 +1335,17 @@ function isAuthError(error) {
   return isErrorLike(error) && (error.code === ERROR_CODES.UNAUTHORIZED || error.code === ERROR_CODES.INVALID_TOKEN || error.code === ERROR_CODES.INVALID_CREDENTIALS);
 }
+// src/types/health/index.ts
+var SERVER_STATUS = {
+  Healthy: "Healthy",
+  Unhealthy: "UnHealthy"
+};
+var DATABASE_STATUS = {
+  Unknown: "Unknown",
+  Connected: "Connected",
+  Disconnected: "Disconnected"
+};
 // src/types/image/index.ts
 var IMAGE_ENTITY_TYPE = {
   USER_PROFILE: "USER_PROFILE",
@@ -1518,10 +1540,13 @@ export {
   AUTH_STATUS,
   BILLING_PERIOD,
   CHECKLIST_EXECUTION_STATUS,
+  COMPANY_RELATIONSHIP_STATUS,
   COMPANY_TYPES,
   CompanyFilter,
   DAMAGE_SEVERITY,
   DAMAGE_STATUS,
+  DATABASE_STATUS,
+  ENVIRONMENT,
   ERROR_CODES,
   FilterCondition,
   HTTP_METHOD,
@@ -1540,6 +1565,7 @@ export {
   PropertyStatusOptions,
   PropertyTypeOptions,
   ROOM_TYPE,
+  SERVER_STATUS,
   SERVICE_TYPES,
   SEVERITY,
   STATUS,