@justins-home/api-services 1.2.1 → 1.2.3

package/dist/index.d.ts

@@ -67,12 +67,22 @@ declare const admin: {
     new: (payload: ApiRequest<"newAdmin">) => Promise<{
         data?: {
             uid?: string | null;
-            name?: string | null;
+            username?: string | null;
+            first_name?: string | null;
+            last_name?: string | null;
             email?: string | null;
             phone?: string | null;
             status?: string | null;
             user_mode?: string | null;
-            created_at?: string;
+            last_login_at?: string | null;
+            last_login_ip?: string | null;
+            two_factor_enabled?: string | null;
+            avatar_path?: string | null;
+            language?: string | null;
+            timezone?: string | null;
+            user_type?: string;
+            created?: string;
+            email_verified_at?: string | null;
             role?: string | null;
         };
     }>;
@@ -372,7 +382,6 @@ declare const admin: {
     getListingComplianceSubmissions: () => Promise<{
         data?: {
             id?: number;
-            listing_id?: number;
             compliance?: {
                 id?: number;
                 key?: string;
@@ -411,7 +420,6 @@ declare const admin: {
     getTenancyComplianceSubmissions: () => Promise<{
         data?: {
             id?: number;
-            tenancy_id?: number;
             compliance?: {
                 id?: number;
                 key?: string;
@@ -419,7 +427,7 @@ declare const admin: {
             };
             verification_layer_key?: string;
             status?: string;
-            submitted_data?: string | null;
+            submitted_data?: unknown[];
             rejection_reason?: string | null;
             reviewed_by?: number;
             reviewed_at?: string;
@@ -524,8 +532,9 @@ declare const admin: {
         };
     }>;
     getComplianceDefinitions: () => Promise<{
+        message?: string;
+        event?: string | null;
         data?: {
-            id?: string | null;
             compliance_key?: string;
             name?: string;
             description?: string;
@@ -537,7 +546,7 @@ declare const admin: {
     }>;
     createComplianceDefinition: (payload: ApiRequest<"createComplianceDefinition">) => Promise<{
         data?: {
-            id?: number;
+            id?: string | null;
             compliance_key?: string;
             name?: string;
             description?: string;
@@ -564,6 +573,8 @@ declare const admin: {
     assignComplianceToCategory: (params: ApiPathParams<"assignComplianceToCategory">) => Promise<unknown>;
     assignComplianceToListing: (params: ApiPathParams<"assignComplianceToListing">) => Promise<unknown>;
     assignComplianceToTenancy: (params: ApiPathParams<"assignComplianceToTenancy">) => Promise<unknown>;
+    assignComplianceToListingVertical: (params: ApiPathParams<"assignComplianceToListingVertical">, payload: ApiRequest<"assignComplianceToListingVertical">) => Promise<unknown>;
+    assignComplianceToListingType: (params: ApiPathParams<"assignComplianceToListingType">, payload: ApiRequest<"assignComplianceToListingType">) => Promise<unknown>;
     listingHistoryInspection: (params: ApiPathParams<"listingHistoryInspectionAdmin">) => Promise<{
         data?: {
             uid?: string;
@@ -715,8 +726,6 @@ declare const admin: {
             updated_at?: string;
         };
     }>;
-    assignComplianceToListingVertical: (params: ApiPathParams<"assignComplianceToListingVertical">, payload: ApiRequest<"assignComplianceToListingVertical">) => Promise<unknown>;
-    assignComplianceToListingType: (params: ApiPathParams<"assignComplianceToListingType">, payload: ApiRequest<"assignComplianceToListingType">) => Promise<unknown>;
 };
 
 declare const appointment: {
@@ -830,6 +839,23 @@ declare const auth: {
         event?: string | null;
         data?: string | null;
     }>;
+    sendResetPasswordOTP: (payload: ApiRequest<"sendResetPasswordOTP">) => Promise<{
+        message?: string;
+        event?: string | null;
+        data?: string | null;
+    }>;
+    verifyPasswordResetOTP: (payload: ApiRequest<"verifyPasswordResetOTP">) => Promise<{
+        message?: string;
+        event?: string | null;
+        data?: {
+            reset_token?: string;
+        };
+    }>;
+    resetPassword: (payload: ApiRequest<"resetPassword">) => Promise<{
+        message?: string;
+        event?: string | null;
+        data?: string | null;
+    }>;
     generateOTP: (payload: ApiRequest<"generateOTP">) => Promise<{
         message?: string;
         event?: string | null;
@@ -840,6 +866,13 @@ declare const auth: {
         event?: string | null;
         data?: string | null;
     }>;
+    checkEmailStatus: () => Promise<{
+        message?: string;
+        event?: string | null;
+        data?: {
+            is_verified?: number;
+        };
+    }>;
 };
 
 declare const booking: {
@@ -995,13 +1028,40 @@ declare const landlord: {
     new: (payload: ApiRequest<"newLandlord">) => Promise<{
         data?: {
             uid?: string | null;
-            name?: string | null;
+            username?: string | null;
+            first_name?: string | null;
+            last_name?: string | null;
             email?: string | null;
             phone?: string | null;
             status?: string | null;
             user_mode?: string | null;
-            created_at?: string;
-            address?: string;
+            last_login_at?: string | null;
+            last_login_ip?: string | null;
+            two_factor_enabled?: string | null;
+            avatar_path?: string | null;
+            language?: string | null;
+            timezone?: string | null;
+            user_type?: string;
+            created?: string;
+            email_verified_at?: string | null;
+            address?: string | null;
+            address_line_2?: string | null;
+            legal_full_name?: string | null;
+            date_of_birth?: string | null;
+            nationality?: string | null;
+            landlord_type?: string | null;
+            company_name?: string | null;
+            company_registration_number?: string | null;
+            city?: string | null;
+            postcode?: string | null;
+            country?: string | null;
+            accepts_supported_housing?: string | null;
+            accepts_company_lets?: string | null;
+            accepts_pets?: string | null;
+            accepts_dss?: string | null;
+            maintenance_contact_type?: string | null;
+            prefers_email_contact?: string | null;
+            prefers_sms_contact?: string | null;
         };
     }>;
     basicLogin: (payload: ApiRequest<"basicLoginLandlord">) => Promise<{
@@ -1013,6 +1073,136 @@ declare const landlord: {
             expires_at?: string | null;
         };
     }>;
+    dashboardStats: () => Promise<{
+        message?: string;
+        event?: string | null;
+        data?: {
+            portfolio?: {
+                label?: string;
+                value?: number;
+                formatted_value?: string;
+                status?: string;
+                meta?: {
+                    label?: string;
+                    value?: string | null;
+                    formatted_value?: string | null;
+                };
+            };
+            maintenance?: {
+                label?: string;
+                value?: number;
+                formatted_value?: string;
+                status?: string;
+                meta?: {
+                    label?: string;
+                    value?: number;
+                    formatted_value?: string;
+                };
+            };
+            sla_performance?: {
+                label?: string;
+                value?: number;
+                formatted_value?: string;
+                status?: string;
+                meta?: {
+                    label?: string;
+                    value?: number;
+                    formatted_value?: string;
+                };
+            };
+            inspection?: {
+                label?: string;
+                value?: string;
+                formatted_value?: string;
+                status?: string;
+                meta?: {
+                    label?: string;
+                    value?: string;
+                    formatted_value?: string;
+                };
+            };
+        };
+    }>;
+    profile: () => Promise<{
+        message?: string;
+        event?: string | null;
+        data?: {
+            uid?: string | null;
+            username?: string | null;
+            first_name?: string | null;
+            last_name?: string | null;
+            email?: string | null;
+            phone?: string | null;
+            status?: string | null;
+            user_mode?: string | null;
+            last_login_at?: string | null;
+            last_login_ip?: string | null;
+            two_factor_enabled?: string | null;
+            avatar_path?: string | null;
+            language?: string | null;
+            timezone?: string | null;
+            user_type?: string;
+            created?: string | null;
+            email_verified_at?: string | null;
+            address?: string | null;
+            address_line_2?: string | null;
+            legal_full_name?: string | null;
+            date_of_birth?: string | null;
+            nationality?: string | null;
+            landlord_type?: string | null;
+            company_name?: string | null;
+            company_registration_number?: string | null;
+            city?: string | null;
+            postcode?: string | null;
+            country?: string | null;
+            accepts_supported_housing?: string | null;
+            accepts_company_lets?: string | null;
+            accepts_pets?: string | null;
+            accepts_dss?: string | null;
+            maintenance_contact_type?: string | null;
+            prefers_email_contact?: string | null;
+            prefers_sms_contact?: string | null;
+        };
+    }>;
+    updateProfile: (payload: ApiRequest<"updateProfile">) => Promise<{
+        data?: {
+            uid?: string | null;
+            username?: string | null;
+            first_name?: string | null;
+            last_name?: string | null;
+            email?: string | null;
+            phone?: string | null;
+            status?: string | null;
+            user_mode?: string | null;
+            last_login_at?: string | null;
+            last_login_ip?: string | null;
+            two_factor_enabled?: string | null;
+            avatar_path?: string | null;
+            language?: string | null;
+            timezone?: string | null;
+            user_type?: string;
+            created?: string;
+            email_verified_at?: string | null;
+            address?: string | null;
+            address_line_2?: string | null;
+            legal_full_name?: string | null;
+            date_of_birth?: string | null;
+            nationality?: string | null;
+            landlord_type?: string | null;
+            company_name?: string | null;
+            company_registration_number?: string | null;
+            city?: string | null;
+            postcode?: string | null;
+            country?: string | null;
+            accepts_supported_housing?: string | null;
+            accepts_company_lets?: string | null;
+            accepts_pets?: string | null;
+            accepts_dss?: string | null;
+            maintenance_contact_type?: string | null;
+            prefers_email_contact?: string | null;
+            prefers_sms_contact?: string | null;
+        };
+    }>;
     createListingDraft: (payload: ApiRequest<"createListingDraft">) => Promise<{
         data?: {
             uid?: string;
@@ -1258,16 +1448,49 @@ declare const landlord: {
             media?: unknown[];
         };
     }>;
+    propertyStandardsOverview: () => Promise<{
+        message?: string;
+        event?: string | null;
+        data?: {
+            listing_uid?: string;
+            property?: {
+                address_line?: string;
+                city?: string;
+                postcode?: string;
+                display_address?: string;
+            };
+            compliance?: {
+                name?: string;
+                status?: string;
+                valid_until?: string;
+                display_status?: string;
+            };
+            inspection?: {
+                last_completed_at?: string;
+                next_scheduled_at?: string;
+                display_last?: string;
+                display_next?: string;
+            };
+            maintenance?: {
+                last_activity_at?: string;
+                next_due_at?: string;
+                display_last?: string;
+                display_next?: string;
+            };
+            action?: {
+                listing_uid?: string;
+            };
+        }[];
+    }>;
     getListingCompliance: (params: ApiPathParams<"getListingCompliance">) => Promise<{
         data?: {
-            listing_uid?: string | null;
+            uid?: string;
             compliances?: string | null;
         };
     }>;
     submitListingCompliance: (params: ApiPathParams<"submitListingCompliance">, payload: ApiRequest<"submitListingCompliance">) => Promise<{
         data?: {
             id?: number;
-            listing_id?: number;
             compliance?: {
                 id?: number;
                 key?: string;
@@ -1284,7 +1507,7 @@ declare const landlord: {
     }>;
     resolveListingCompliance: (params: ApiPathParams<"resolveListingCompliance">) => Promise<{
         data?: {
-            listing_uid?: string | null;
+            uid?: string | null;
             compliances?: string | null;
         };
     }>;
@@ -1324,10 +1547,45 @@ declare const landlord: {
             total?: number;
         };
     }>;
+    getLandlordListingTenancies: (params: ApiPathParams<"getLandlordListingTenancies">) => Promise<{
+        data?: {
+            uid?: string;
+            listing_id?: number;
+            landlord_id?: number;
+            tenant_id?: number;
+            rent_amount?: string;
+            deposit_amount?: string;
+            state?: string;
+            start_date?: string;
+            end_date?: string;
+            is_periodic?: boolean;
+            created_at?: string;
+        }[];
+        links?: {
+            first?: string;
+            last?: string;
+            prev?: string | null;
+            next?: string | null;
+        };
+        meta?: {
+            current_page?: number;
+            from?: number;
+            last_page?: number;
+            links?: {
+                url?: string | null;
+                label?: string;
+                page?: string | null;
+                active?: boolean;
+            }[];
+            path?: string;
+            per_page?: number;
+            to?: number;
+            total?: number;
+        };
+    }>;
     submitTenancyCompliance: (params: ApiPathParams<"submitTenancyCompliance">, payload: ApiRequest<"submitTenancyCompliance">) => Promise<{
         data?: {
             id?: number;
-            tenancy_id?: number;
             compliance?: {
                 id?: number;
                 key?: string;
@@ -1335,7 +1593,7 @@ declare const landlord: {
             };
             verification_layer_key?: string;
             status?: string;
-            submitted_data?: string | null;
+            submitted_data?: unknown[];
             rejection_reason?: string | null;
             reviewed_by?: number;
             reviewed_at?: string;
@@ -1343,9 +1601,21 @@ declare const landlord: {
         };
     }>;
     resolveTenancyCompliance: (params: ApiPathParams<"resolveTenancyCompliance">) => Promise<{
-        message?: string;
-        event?: string;
-        data?: unknown[];
+        data?: {
+            id?: number;
+            compliance?: {
+                id?: number;
+                key?: string;
+                name?: string;
+            };
+            verification_layer_key?: string;
+            status?: string;
+            submitted_data?: string | null;
+            rejection_reason?: string | null;
+            reviewed_by?: number;
+            reviewed_at?: string;
+            created_at?: string;
+        };
     }>;
 };
 
@@ -1577,14 +1847,14 @@ declare const conversations: {
     }>;
     listConversationMessages: (params: ApiPathParams<"listConversationMessages">) => Promise<{
         data?: {
-            id?: number;
-            conversation_id?: number;
-            body?: string;
+            id?: string | null;
+            conversation_id?: string | null;
+            body?: string | null;
             attachment_url?: string | null;
-            is_system?: boolean;
+            is_system?: string | null;
             state?: string;
             read_at?: string | null;
-            created_at?: string;
+            created_at?: string | null;
         }[];
         links?: {
             first?: string;
@@ -1690,6 +1960,30 @@ declare const notification: {
         event?: string | null;
         data?: string | null;
     }>;
+    getNotificationPreference: () => Promise<{
+        message?: string;
+        event?: string | null;
+        data?: {
+            key?: string;
+            label?: string;
+            description?: string;
+            enabled_channels?: {
+                in_app?: number;
+                push?: number;
+                email?: number;
+            };
+        }[];
+    }>;
+    updateNotificationPreference: (params: ApiPathParams<"updateNotificationPreference">, payload: ApiRequest<"updateNotificationPreference">) => Promise<{
+        message?: string;
+        event?: string | null;
+        data?: unknown[];
+    }>;
+    updateBulkPreferences: (payload: ApiRequest<"updateBulkPreferences">) => Promise<{
+        message?: string;
+        event?: string | null;
+        data?: unknown[];
+    }>;
 };
 
 declare const plan: {
@@ -1896,7 +2190,7 @@ declare const tenancy: {
             to_state?: string;
             changed_by_user_id?: number;
             changed_by_name?: string;
-            comment?: string | null;
+            comment?: string;
             created_at?: string;
         }[];
     }>;
@@ -1913,6 +2207,35 @@ declare const tenancy: {
     }>;
 };
 
+declare const user: {
+    sendTwoFactorToggleOtp: () => Promise<{
+        message?: string;
+        event?: string | null;
+        data?: string | null;
+    }>;
+    toggleTwoFactor: (payload: ApiRequest<"toggleTwoFactor">) => Promise<{
+        data?: {
+            uid?: string;
+            username?: string;
+            first_name?: string | null;
+            last_name?: string | null;
+            email?: string;
+            phone?: string | null;
+            status?: string | null;
+            user_mode?: string;
+            last_login_at?: string | null;
+            last_login_ip?: string | null;
+            two_factor_enabled?: boolean;
+            avatar_path?: string | null;
+            language?: string;
+            timezone?: string;
+            user_type?: string;
+            created?: string;
+            email_verified_at?: string;
+        };
+    }>;
+};
+
 declare const userverification: {
     overview: () => Promise<{
         data?: {
@@ -1938,6 +2261,49 @@ declare const userverification: {
             last_calculated_at?: string;
         };
     }>;
+    dashboardCard: () => Promise<{
+        message?: string;
+        event?: string | null;
+        data?: {
+            user_type?: string;
+            current_level?: number;
+            completed_layers?: number;
+            pending_layers?: number;
+            total_layers?: number;
+            required_layers?: number;
+            progress_percentage?: number;
+            status?: string;
+            last_calculated_at?: string;
+            next_layer?: {
+                key?: string;
+                name?: string;
+                description?: string;
+                order?: number;
+                is_required?: boolean;
+                requires_review?: boolean;
+                current_status?: string;
+                rejection_reason?: string;
+            };
+            action_required_layer?: {
+                key?: string;
+                name?: string;
+                description?: string;
+                order?: number;
+                is_required?: boolean;
+                requires_review?: boolean;
+                current_status?: string;
+                rejection_reason?: string;
+            };
+        };
+    }>;
+    checkLayerStatus: (params: ApiPathParams<"checkLayerStatus">) => Promise<{
+        message?: string;
+        event?: string | null;
+        data?: {
+            layer_key?: string;
+            status?: number;
+        };
+    }>;
     resubmit: (params: ApiPathParams<"resubmitUserVerification">, payload: ApiRequest<"resubmitUserVerification">) => Promise<{
         data?: {
             current_level?: number;
@@ -2004,4 +2370,4 @@ declare const wishlist: {
     }>;
 };
 
-export { ApiError, type ApiPathParams, type ApiRequest, type ApiResponse, type Expand, type OperationId, admin, api, appointment, auth, booking, conversations, customer, feature, github, google, inspection, landlord, listings, maintenance, notification, plan, review, tenancy, tenant, userverification, wishlist };
+export { ApiError, type ApiPathParams, type ApiRequest, type ApiResponse, type Expand, type OperationId, admin, api, appointment, auth, booking, conversations, customer, feature, github, google, inspection, landlord, listings, maintenance, notification, plan, review, tenancy, tenant, user, userverification, wishlist };