@reapit/gbl-pp-owner-api-ts-definitions 1.0.0 → 1.0.3

package/dist/types/{tenant.d.ts → owner-api/tenant.d.ts}

@@ -1,4 +1,47 @@
 import type { AgencyBasicModel, AmountBase, DateString, DateStringNullable, ExternalID, PaginationModel, PropertyBasicModel, TenantBasicModel } from "./shared";
+/**
+ * Query parameters for `GET /tenants`.
+ */
+export interface TenantsQueryParams {
+    /**
+     * Number of rows to return.
+     * Must be between 1 and 25.
+     * @example 12
+     */
+    rows?: number;
+    /**
+     * Page number to return.
+     * Must be >= 1.
+     * @example 3
+     */
+    page?: number;
+    /**
+     * Return tenants with active tenancies only.
+     * By default, or when set to `false`, returns tenants with both active and inactive tenancies.
+     * @example true
+     */
+    active_tenancies?: boolean;
+    /**
+     * Filter by one or more tenant IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    tenant_id?: ExternalID[];
+    /**
+     * Filter by one or more beneficiary IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    beneficiary_id?: ExternalID[];
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+}
 /**
  * Full tenant entity with all tenant details.
  */
@@ -32,6 +75,56 @@ export interface TenantsPagedResult {
     /** Pagination metadata. */
     pagination: PaginationModel;
 }
+/**
+ * Query parameters for `GET /tenants/balances`.
+ */
+export interface TenantsBalancesQueryParams {
+    /**
+     * Number of rows to return.
+     * Must be between 1 and 25.
+     * @example 12
+     */
+    rows?: number;
+    /**
+     * Page number to return.
+     * Must be >= 1.
+     * @example 3
+     */
+    page?: number;
+    /**
+     * Return closing balance on the given date.
+     * This value represents the sum of all transactions up to and including the given date.
+     * @example '2025-10-21'
+     */
+    closing_balance_date: DateString;
+    /**
+     * Return opening balance on the given date.
+     * This value represents the sum of all transactions before the given date.
+     * If not provided, falls back to `closing_balance_date`.
+     * @example '2025-10-21'
+     */
+    opening_balance_date?: DateString;
+    /**
+     * Return only tenants where there is an arrears balance.
+     * @example true
+     */
+    in_arrears?: boolean;
+    /**
+     * Filter by one or more tenant IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    tenant_id?: ExternalID[];
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+}
 /**
  * Tenant balance item showing opening and closing balances for a given date range.
  */
@@ -69,6 +162,49 @@ export interface TenantsBalancesPagedResult {
     /** Pagination metadata. */
     pagination: PaginationModel;
 }
+/**
+ * Query parameters for `GET /tenants/tenancies`.
+ */
+export interface TenantsTenanciesQueryParams {
+    /**
+     * Number of rows to return.
+     * Must be between 1 and 25.
+     * @example 12
+     */
+    rows?: number;
+    /**
+     * Page number to return.
+     * Must be >= 1.
+     * @example 3
+     */
+    page?: number;
+    /**
+     * Return only active tenancies when set to `true`.
+     * By default, or when set to `false`, returns both active and inactive tenancies.
+     * @example true
+     */
+    active_tenancies?: boolean;
+    /**
+     * Filter by one or more tenant IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    tenant_id?: ExternalID[];
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+    /**
+     * Filter by one or more beneficiary IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    beneficiary_id?: ExternalID[];
+}
 /**
  * A tenancy record representing a tenant's occupancy period on a property.
  *

package/dist/types/owner-api/tenant.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reapit/gbl-pp-owner-api-ts-definitions",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "TypeScript type definitions for the PayProp Owner API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,7 +16,6 @@
     "@types/jest": "^30.0.0",
     "@types/node": "^25.5.2",
     "@types/react": "^19.2.14",
-    "typescript": "^5.6.2"
-  },
-  "packageManager": "yarn@4.13.0+sha512.5c20ba010c99815433e5c8453112165e673f1c7948d8d2b267f4b5e52097538658388ebc9f9580656d9b75c5cc996f990f611f99304a2197d4c56d21eea370e7"
+    "typescript": "^6.0.2"
+  }
 }

package/dist/index.d.ts

@@ -1,10 +0,0 @@
-export * from "./types/shared";
-export * from "./types/agency";
-export * from "./types/attachment";
-export * from "./types/beneficiaries";
-export * from "./types/properties";
-export * from "./types/payment";
-export * from "./types/ownership";
-export * from "./types/tenant";
-export * from "./types/user";
-export * from "./types/error";

package/dist/types/beneficiaries.d.ts

@@ -1,32 +0,0 @@
-import type { AddressModel, AgencyBasicModel, ExternalID, PaginationModel } from "./shared";
-/**
- * Full beneficiary entity. Contains all beneficiary details including
- * address and ownership information.
- */
-export interface BeneficiaryModel {
-    /** Address associated with the beneficiary. */
-    address: AddressModel;
-    /** Minimal information about the agency associated with this beneficiary. */
-    agency: AgencyBasicModel;
-    /** Business name. */
-    business_name: string;
-    /** Formatted beneficiary display name used on the platform. */
-    display_name: string;
-    /** Beneficiary first name. */
-    first_name: string;
-    /** PayProp external ID. */
-    id: ExternalID;
-    /** Beneficiary last name. */
-    last_name: string;
-    /** Number of unique properties the beneficiary has an ownership. */
-    number_of_properties: number;
-}
-/**
- * Paginated response from `GET /beneficiaries`.
- */
-export interface BeneficiariesPagedResult {
-    /** List of beneficiary entities. */
-    items: BeneficiaryModel[];
-    /** Pagination metadata. */
-    pagination: PaginationModel;
-}

package/dist/types/properties.d.ts

@@ -1,35 +0,0 @@
-import type { AddressModel, AgencyBasicModel, BeneficiaryBasicModel, ExternalID, PaginationModel } from "./shared";
-/**
- * Full property entity. Contains all property details including address,
- * agency association, and optional beneficiary list.
- */
-export interface PropertyModel {
-    /** Address of the property. */
-    address?: AddressModel;
-    /** Minimal information about the agency managing this property. */
-    agency?: AgencyBasicModel;
-    /**
-     * List of beneficiaries that have an ownership of the property for the specified ownership range.
-     * Only present when the `with_beneficiaries` query parameter is set to `true`.
-     */
-    beneficiaries?: BeneficiaryBasicModel[] | null;
-    /** PayProp external ID. */
-    id: ExternalID;
-    /** URL of the property image, or null if no image has been set. */
-    image?: string | null;
-    /** Indicates if the property is active on PayProp. */
-    is_active: boolean;
-    /** Property name. */
-    name: string;
-    /** Number of unique tenants that have an active tenancy on the property. */
-    number_of_tenants?: number;
-}
-/**
- * Paginated response from `GET /properties`.
- */
-export interface PropertiesPagedResult {
-    /** List of property entities. */
-    items: PropertyModel[];
-    /** Pagination metadata. */
-    pagination: PaginationModel;
-}