@turndown/library 0.1.20 → 0.1.22

package/dist/types/image/routes.d.ts

@@ -0,0 +1,32 @@
+import type { IImageWithUrl } from ".";
+import type { ISuccessResponse } from "../base";
+export interface IImageUserRouteParams {
+    userId: string;
+}
+export interface IImagePropertyRouteParams {
+    propertyId: string;
+}
+export interface IImageRoomRouteParams {
+    roomId: string;
+}
+export interface IImageCompanyRouteParams {
+    companyId: string;
+}
+export interface IImageRouteParams {
+    imageId: string;
+}
+export interface IUploadProfileImageRequest {
+}
+export interface IUploadProfileImageResponse {
+    image: IImageWithUrl;
+}
+export interface IUploadImagesResponse {
+    images: IImageWithUrl[];
+}
+export interface IGetImagesForEntityResponse {
+    images: IImageWithUrl[];
+}
+export interface IDeleteImageRequest extends IImageRouteParams {
+}
+export interface IDeleteImageResponse extends ISuccessResponse {
+}

package/dist/types/image/routes.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -10,6 +10,8 @@ export * from "./checklist-template";
 export * from "./company";
 export * from "./damage-report";
 export * from "./errors";
+export * from "./health";
+export * from "./image";
 export * from "./inventory";
 export * from "./job";
 export * from "./property";

package/dist/types/index.js

@@ -10,6 +10,8 @@ export * from "./checklist-template";
 export * from "./company";
 export * from "./damage-report";
 export * from "./errors";
+export * from "./health";
+export * from "./image";
 export * from "./inventory";
 export * from "./job";
 export * from "./property";

package/dist/types/inventory/index.d.ts

@@ -122,77 +122,3 @@ export interface IInventoryRestockOrderItem {
     totalCost?: number;
     createdAt: Date;
 }
-export interface IRoomInventory extends IMetaData {
-    id: string;
-    roomId: string;
-    inventoryItemId: string;
-    currentLevel: number;
-    minimumLevel: number;
-    maximumLevel?: number;
-    parLevel?: number;
-    lastRestockedAt?: Date;
-    lastRestockedBy?: string;
-    lastCheckedAt?: Date;
-    lastCheckedBy?: string;
-    autoReorder: boolean;
-    locationNotes?: string;
-}
-export interface IPropertyInventory extends IMetaData {
-    id: string;
-    propertyId: string;
-    inventoryItemId: string;
-    currentLevel: number;
-    minimumLevel: number;
-    maximumLevel?: number;
-    parLevel?: number;
-    lastRestockedAt?: Date;
-    lastRestockedBy?: string;
-    lastCheckedAt?: Date;
-    lastCheckedBy?: string;
-    autoReorder: boolean;
-    locationNotes?: string;
-}
-export interface IInventoryCount {
-    id: string;
-    checklistExecutionId: string;
-    roomInventoryId: string;
-    previousLevel: number;
-    countedLevel: number;
-    consumedAmount: number;
-    restockedAmount: number;
-    finalLevel: number;
-    countedBy: string;
-    countedAt: Date;
-    needsRestock: boolean;
-    notes?: string;
-    createdAt: Date;
-}
-export interface IInventoryRestockOrder {
-    id: string;
-    companyId: string;
-    orderNumber?: string;
-    status: TInventoryRestockOrderStatus;
-    totalItems?: number;
-    totalCost?: number;
-    orderedBy?: string;
-    orderedAt?: Date;
-    expectedDelivery?: Date;
-    receivedBy?: string;
-    receivedAt?: Date;
-    supplierInfo?: string;
-    notes?: string;
-    createdAt: Date;
-    updatedAt: Date;
-}
-export interface IInventoryRestockOrderItem {
-    id: string;
-    orderId: string;
-    inventoryItemId: string;
-    roomInventoryId?: string;
-    propertyInventoryId?: string;
-    quantityOrdered: number;
-    quantityReceived: number;
-    unitCost?: number;
-    totalCost?: number;
-    createdAt: Date;
-}

package/dist/types/inventory/routes.d.ts

@@ -1,72 +1,109 @@
-export interface ICreateInventoryItemRequest {
+import type { IInventoryCount, IInventoryItem, IInventoryRestockOrder, IInventoryRestockOrderItem, IPropertyInventory, IRoomInventory, TInventoryRestockOrderStatus } from ".";
+import type { IMessageResponse } from "../base";
+export interface IInventoryCompanyRouteParams {
+    companyId: string;
 }
-export interface ICreateInventoryItemResponse {
+export interface IInventoryItemRouteParams {
+    itemId: string;
 }
-export interface IGetInventoryItemByIdRequest {
+export interface IInventoryRoomRouteParams {
+    roomId: string;
 }
-export interface IGetInventoryItemByIdResponse {
+export interface IInventoryPropertyRouteParams {
+    propertyId: string;
 }
-export interface IUpdateInventoryItemRequest {
+export interface IInventoryExecutionRouteParams {
+    executionId: string;
 }
-export interface IUpdateInventoryItemResponse {
+export interface IRoomInventoryIdParams {
+    roomInventoryId: string;
 }
-export interface IDeleteInventoryItemRequest {
+export interface IInventoryOrderRouteParams {
+    orderId: string;
 }
-export interface IDeleteInventoryItemResponse {
+export interface ICreateInventoryItemRequest extends Partial<IInventoryItem> {
+    companyId: string;
+    name: string;
 }
-export interface IGetInventoryByCompanyIdRequest {
+export interface ICreateInventoryItemResponse extends IInventoryItem {
 }
-export interface IGetInventoryByCompanyIdResponse {
+export interface IGetInventoryItemByIdRequest extends IInventoryItemRouteParams {
 }
-export interface IAddInventoryToPropertyRequest {
+export interface IGetInventoryItemByIdResponse extends IInventoryItem {
 }
-export interface IAddInventoryToPropertyResponse {
+export interface IUpdateInventoryItemRequest extends Partial<IInventoryItem> {
 }
-export interface IGetPropertyInventoryRequest {
+export interface IUpdateInventoryItemResponse extends IInventoryItem {
 }
-export interface IGetPropertyInventoryResponse {
+export interface IDeleteInventoryItemRequest extends IInventoryItemRouteParams {
 }
-export interface IGetPropertyInventoryNeedingRestockRequest {
+export interface IDeleteInventoryItemResponse extends IMessageResponse {
 }
-export interface IGetPropertyInventoryNeedingRestockResponse {
+export interface IGetInventoryByCompanyIdRequest extends IInventoryCompanyRouteParams {
 }
-export interface IAddInventoryToRoomRequest {
+export type IGetInventoryByCompanyIdResponse = IInventoryItem[];
+export interface IAddInventoryToPropertyRequest extends Partial<IPropertyInventory> {
+    propertyId: string;
+    inventoryItemId: string;
 }
-export interface IAddInventoryToRoomResponse {
+export interface IAddInventoryToPropertyResponse extends IPropertyInventory {
 }
-export interface IGetRoomInventoryRequest {
+export interface IGetPropertyInventoryRequest extends IInventoryPropertyRouteParams {
 }
-export interface IGetRoomInventoryResponse {
+export type IGetPropertyInventoryResponse = IPropertyInventory[];
+export interface IGetPropertyInventoryNeedingRestockRequest extends IInventoryPropertyRouteParams {
 }
-export interface IUpdateRoomInventoryRequest {
+export type IGetPropertyInventoryNeedingRestockResponse = IPropertyInventory[];
+export interface IAddInventoryToRoomRequest extends Partial<IRoomInventory> {
+    roomId: string;
+    inventoryItemId: string;
 }
-export interface IUpdateRoomInventoryResponse {
+export interface IAddInventoryToRoomResponse extends IRoomInventory {
 }
-export interface IGetRoomInventoryNeedingRestockRequest {
+export interface IGetRoomInventoryRequest extends IInventoryRoomRouteParams {
 }
-export interface IGetRoomInventoryNeedingRestockResponse {
+export type IGetRoomInventoryResponse = IRoomInventory[];
+export interface IUpdateRoomInventoryRequest extends Partial<IRoomInventory> {
 }
-export interface IRecordInventoryCountRequest {
+export interface IUpdateRoomInventoryResponse extends IRoomInventory {
 }
-export interface IRecordInventoryCountResponse {
+export interface IGetRoomInventoryNeedingRestockRequest extends IInventoryRoomRouteParams {
 }
-export interface IGetInventoryCountsByExecutionIdRequest {
+export type IGetRoomInventoryNeedingRestockResponse = IRoomInventory[];
+export interface IRecordInventoryCountRequest extends Partial<IInventoryCount> {
+    checklistExecutionId: string;
+    roomInventoryId: string;
+    countedLevel: number;
+    countedBy: string;
 }
-export interface IGetInventoryCountsByExecutionIdResponse {
+export interface IRecordInventoryCountResponse extends IInventoryCount {
 }
-export interface ICreateRestockOrderRequest {
+export interface IGetInventoryCountsByExecutionIdRequest extends IInventoryExecutionRouteParams {
 }
-export interface ICreateRestockOrderResponse {
+export type IGetInventoryCountsByExecutionIdResponse = IInventoryCount[];
+export interface IRestockOrderItemInput {
+    inventoryItemId: string;
+    roomInventoryId?: string;
+    propertyInventoryId?: string;
+    quantityOrdered: number;
+    unitCost?: number;
 }
-export interface IGetRestockOrdersByCompanyIdRequest {
+export interface ICreateRestockOrderRequest extends Partial<IInventoryRestockOrder> {
+    companyId: string;
+    orderedBy: string;
+    items: IRestockOrderItemInput[];
 }
-export interface IGetRestockOrdersByCompanyIdResponse {
+export interface ICreateRestockOrderResponse extends IInventoryRestockOrder {
 }
-export interface IGetRestockOrderItemsRequest {
+export interface IGetRestockOrdersByCompanyIdRequest extends IInventoryCompanyRouteParams {
 }
-export interface IGetRestockOrderItemsResponse {
+export type IGetRestockOrdersByCompanyIdResponse = IInventoryRestockOrder[];
+export interface IGetRestockOrderItemsRequest extends IInventoryOrderRouteParams {
 }
+export type IGetRestockOrderItemsResponse = IInventoryRestockOrderItem[];
 export interface IUpdateRestockOrderStatusRequest {
+    status: TInventoryRestockOrderStatus;
+    receivedBy?: string;
 }
-export interface IUpdateRestockOrderStatusResponse {
+export interface IUpdateRestockOrderStatusResponse extends IInventoryRestockOrder {
 }

package/dist/types/inventory/routes.js

@@ -1,2 +1 @@
-// inventory.interfaces.ts
 export {};

package/dist/types/property/routes.d.ts

@@ -1,12 +1,25 @@
-import type { IPropertyAccessInformation, IPropertyDetail, IPropertySummary } from ".";
+import type { IProperty, IPropertyAccessInformation, IPropertyDetail, IPropertySummary } from ".";
+import type { IMessageResponse } from "../base";
+export interface IPropertyIdParams {
+    propertyId: string;
+}
+export interface ICompanyIdParams {
+    companyId: string;
+}
 export interface ICreatePropertyRequest {
+    companyId: string;
     displayName: string;
     propertyType: string;
-    status: string;
+    status?: string;
     addressLine1: string;
+    addressLine2?: string;
     city: string;
     stateCode: string;
     postalCode: string;
+    country?: string;
+    sqft?: number;
+    timezone?: string;
+    photoUrl?: string;
     specialNotes?: string;
 }
 export interface IUpdatePropertyRequest extends Partial<ICreatePropertyRequest> {
@@ -14,42 +27,28 @@ export interface IUpdatePropertyRequest extends Partial<ICreatePropertyRequest>
 export interface IGetPropertiesRequest {
     companyId?: string;
 }
-export interface IGetPropertyByIdRequest {
-    id: string;
-}
-export interface IDeletePropertyRequest {
-    id: string;
+export interface IGetPropertyByIdRequest extends IPropertyIdParams {
 }
-export interface IGetPropertiesResponse {
-    properties: IPropertySummary[];
+export interface IDeletePropertyRequest extends IPropertyIdParams {
 }
-export interface IGetPropertyResponse {
-    property: IPropertyDetail;
+export type IGetPropertiesResponse = IPropertySummary[];
+export interface IGetPropertyResponse extends IPropertyDetail {
 }
-export interface ICreatePropertyResponse {
-    property: IPropertyDetail;
+export interface ICreatePropertyResponse extends IPropertyDetail {
 }
-export interface IUpdatePropertyResponse {
-    property: IPropertyDetail;
+export interface IUpdatePropertyResponse extends IPropertyDetail {
 }
-export interface IDeletePropertyResponse {
-    message?: string;
+export interface IDeletePropertyResponse extends IMessageResponse {
 }
 export interface IUpdatePropertyAccessInformationRequest extends Partial<IPropertyAccessInformation> {
-    propertyId: string;
-}
-export interface IUpdatePropertyAccessInformationResponse {
-    propertyAccessInformation: IPropertyAccessInformation;
 }
-export interface IGetPropertyAccessInformationRequest {
-    propertyId: string;
+export interface IUpdatePropertyAccessInformationResponse extends IPropertyAccessInformation {
 }
-export interface IGetPropertyAccessInformationResponse {
-    propertyAccessInformation: IPropertyAccessInformation | null;
+export interface IGetPropertyAccessInformationRequest extends IPropertyIdParams {
 }
+export type IGetPropertyAccessInformationResponse = IPropertyAccessInformation | null;
 export interface IGetPropertyByIdResponse extends IGetPropertyResponse {
 }
-export interface IGetPropertiesByCompanyIdRequest extends IGetPropertiesRequest {
-}
-export interface IGetPropertiesByCompanyIdResponse extends IGetPropertiesResponse {
+export interface IGetPropertiesByCompanyIdRequest extends ICompanyIdParams {
 }
+export type IGetPropertiesByCompanyIdResponse = IProperty[];

package/dist/types/room/routes.d.ts

@@ -1,16 +1,35 @@
+import type { IRoom } from ".";
+import type { IMessageResponse } from "../base";
+export interface IRoomPropertyRouteParams {
+    propertyId: string;
+}
+export interface IRoomRouteParams {
+    roomId: string;
+}
 export interface ICreateRoomRequest {
+    propertyId: string;
+    displayName: string;
+    description?: string;
+    checklistTemplateId?: string;
+}
+export interface ICreateRoomResponse extends IRoom {
+}
+export interface IGetRoomsByPropertyIdRequest extends IRoomPropertyRouteParams {
 }
-export interface ICreateRoomResponse {
+export type IGetRoomsByPropertyIdResponse = IRoom[];
+export interface IGetDetailedRoomsByPropertyIdRequest extends IRoomPropertyRouteParams {
 }
-export interface IGetRoomsByPropertyIdRequest {
+export type IGetDetailedRoomsByPropertyIdResponse = IRoom[];
+export interface IGetRoomByIdRequest extends IRoomRouteParams {
 }
-export interface IGetRoomsByPropertyIdResponse {
+export interface IGetRoomByIdResponse extends IRoom {
 }
-export interface IUpdateRoomRequest {
+export interface IUpdateRoomRequest extends Partial<ICreateRoomRequest> {
+    displayName?: string;
 }
-export interface IUpdateRoomResponse {
+export interface IUpdateRoomResponse extends IRoom {
 }
-export interface IDeleteRoomRequest {
+export interface IDeleteRoomRequest extends IRoomRouteParams {
 }
-export interface IDeleteRoomResponse {
+export interface IDeleteRoomResponse extends IMessageResponse {
 }

package/dist/types/room/routes.js

@@ -1,2 +1 @@
-// room.interfaces.ts
 export {};

package/dist/types/room-checklist/routes.d.ts

@@ -1,56 +1,78 @@
-export interface ICreateChecklistRequest {
+import type { ICreateRoomChecklistInput, ICreateRoomChecklistItemInput, IRoomChecklist, IRoomChecklistItem, IRoomChecklistWithItems } from ".";
+import type { IMessageResponse } from "../base";
+export interface IRoomChecklistRoomRouteParams {
+    roomId: string;
 }
-export interface ICreateChecklistResponse {
+export interface IChecklistIdParams {
+    checklistId: string;
+}
+export interface IChecklistAndItemIdParams {
+    checklistId: string;
+    itemId: string;
+}
+export interface ICreateChecklistRequest extends Omit<ICreateRoomChecklistInput, "roomId"> {
+    name: string;
+}
+export interface ICreateChecklistResponse extends IRoomChecklist {
 }
 export interface ICreateCustomChecklistRequest {
+    roomId: string;
+    name: string;
+    items: ICreateRoomChecklistItemInput[];
 }
-export interface ICreateCustomChecklistResponse {
+export interface ICreateCustomChecklistResponse extends IRoomChecklistWithItems {
 }
-export interface IGetChecklistByRoomIdRequest {
+export interface IGetChecklistByRoomIdRequest extends IRoomChecklistRoomRouteParams {
 }
-export interface IGetChecklistByRoomIdResponse {
+export interface IGetChecklistByRoomIdResponse extends IRoomChecklist {
 }
-export interface IGetChecklistByIdRequest {
+export interface IGetChecklistByIdRequest extends IChecklistIdParams {
 }
-export interface IGetChecklistByIdResponse {
+export interface IGetChecklistByIdResponse extends IRoomChecklist {
 }
-export interface IGetChecklistWithItemsRequest {
+export interface IGetChecklistWithItemsRequest extends IChecklistIdParams {
 }
-export interface IGetChecklistWithItemsResponse {
+export interface IGetChecklistWithItemsResponse extends IRoomChecklistWithItems {
 }
-export interface IUpdateChecklistRequest {
+export interface IUpdateChecklistRequest extends Partial<ICreateRoomChecklistInput> {
 }
-export interface IUpdateChecklistResponse {
+export interface IUpdateChecklistResponse extends IRoomChecklist {
 }
-export interface IDeleteChecklistRequest {
+export interface IDeleteChecklistRequest extends IChecklistIdParams {
 }
-export interface IDeleteChecklistResponse {
+export interface IDeleteChecklistResponse extends IMessageResponse {
 }
 export interface ICloneChecklistRequest {
+    targetRoomId: string;
 }
-export interface ICloneChecklistResponse {
-}
-export interface IGetChecklistItemsRequest {
+export interface ICloneChecklistResponse extends IRoomChecklistWithItems {
 }
-export interface IGetChecklistItemsResponse {
+export interface IGetChecklistItemsRequest extends IChecklistIdParams {
 }
-export interface IGetCustomChecklistItemsRequest {
+export type IGetChecklistItemsResponse = IRoomChecklistItem[];
+export interface IGetCustomChecklistItemsRequest extends IChecklistIdParams {
 }
-export interface IGetCustomChecklistItemsResponse {
+export type IGetCustomChecklistItemsResponse = IRoomChecklistItem[];
+export interface IAddChecklistItemRequest extends ICreateRoomChecklistItemInput {
+    title: string;
+    displayOrder: number;
 }
-export interface IAddChecklistItemRequest {
+export interface IAddChecklistItemResponse extends IRoomChecklistItem {
 }
-export interface IAddChecklistItemResponse {
+export interface IUpdateChecklistItemRequest extends Partial<ICreateRoomChecklistItemInput> {
 }
-export interface IUpdateChecklistItemRequest {
+export interface IUpdateChecklistItemResponse extends IRoomChecklistItem {
 }
-export interface IUpdateChecklistItemResponse {
+export interface IDeleteChecklistItemRequest extends IChecklistAndItemIdParams {
 }
-export interface IDeleteChecklistItemRequest {
+export interface IDeleteChecklistItemResponse extends IMessageResponse {
 }
-export interface IDeleteChecklistItemResponse {
+export interface IChecklistItemOrder {
+    itemId: string;
+    displayOrder: number;
 }
 export interface IReorderChecklistItemsRequest {
+    itemOrders: IChecklistItemOrder[];
 }
-export interface IReorderChecklistItemsResponse {
+export interface IReorderChecklistItemsResponse extends IMessageResponse {
 }

package/dist/types/room-checklist/routes.js

@@ -1,2 +1 @@
-// room-checklist.interfaces.ts
 export {};

package/dist/types/user/routes.d.ts

@@ -1,4 +1,7 @@
-import { TLanguage, IUserSafe } from "..";
+import type { TAccountType, TLanguage, IUserSafe } from ".";
+export interface IUserIdParams {
+    id: string;
+}
 export interface IGetUserResponse {
     user: IUserSafe | null;
 }
@@ -6,8 +9,7 @@ export interface IGetCurrentUserRequest {
 }
 export interface IGetCurrentUserResponse extends IGetUserResponse {
 }
-export interface IGetUserByIdRequest {
-    userId: string;
+export interface IGetUserByIdRequest extends IUserIdParams {
 }
 export interface IGetUserByIdResponse extends IGetUserResponse {
 }
@@ -16,6 +18,11 @@ export interface IGetUserByEmailRequest {
 }
 export interface IGetUserByEmailResponse extends IGetUserResponse {
 }
+export interface IGetCleanersRequest {
+}
+export interface IGetCleanersResponse {
+    cleaners: IUserSafe[];
+}
 export interface IUpdateUserRequest {
     firstName?: string;
     lastName?: string;
@@ -34,3 +41,6 @@ export interface IDeleteUserRequest {
 export interface IDeleteUserResponse {
     message: string;
 }
+export interface IGetUsersByAccountTypeRequest {
+    accountType: TAccountType;
+}

package/dist/types/user/routes.js

@@ -1,2 +1 @@
-// user.interfaces.ts
 export {};