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

package/README.md

@@ -22,60 +22,94 @@ All types are exported from the package root. Hover over any property in your ed
 ## API Reference
 
 - **Owner API docs:** [https://ukapi.staging.payprop.com/api/docs/owner](https://ukapi.staging.payprop.com/api/docs/owner)
-- **Owner API user docs:** [http://one-portal-schema-ppza-128675916895.s3-website.eu-west-1.amazonaws.com/](http://one-portal-schema-ppza-128675916895.s3-website.eu-west-1.amazonaws.com/)
+- **One Portal API docs:** [http://one-portal-schema-ppza-128675916895.s3-website.eu-west-1.amazonaws.com/](http://one-portal-schema-ppza-128675916895.s3-website.eu-west-1.amazonaws.com/)
 
 ## Available Types
 
-| Type                          | Description                                           |
-| ----------------------------- | ----------------------------------------------------- |
-| `AgencyModel`                 | Full agency entity                                    |
-| `AgenciesPagedResult`         | Paginated response from `GET /agencies`               |
-| `AgenciesInvoicesModel`       | Agency invoice item                                   |
-| `AgenciesInvoicesPagedResult` | Paginated response from `GET /agencies/invoices`      |
-| `AttachmentModel`             | File attachment                                       |
-| `AttachmentsPagedResult`      | Paginated response from `GET /attachments/{source}`   |
-| `BeneficiaryModel`            | Full beneficiary entity                               |
-| `BeneficiariesPagedResult`    | Paginated response from `GET /beneficiaries`          |
-| `PropertyModel`               | Full property entity                                  |
-| `PropertiesPagedResult`       | Paginated response from `GET /properties`             |
-| `PaymentsIncomingModel`       | Incoming payment item                                 |
-| `PaymentsIncomingPagedResult` | Paginated response from `GET /payments/incoming`      |
-| `PaymentsOutgoingModel`       | Outgoing payment item                                 |
-| `PaymentsOutgoingPagedResult` | Paginated response from `GET /payments/outgoing`      |
-| `PaymentsCombinedModel`       | Combined incoming/outgoing payment item               |
-| `PaymentsCombinedPagedResult` | Paginated response from `GET /payments/combined`      |
-| `PaymentsSummaryModel`        | Payment summary response from `GET /payments/summary` |
-| `PaymentBatchModel`           | Outgoing batch payment information                    |
-| `PaymentsOutgoingOriginModel` | Individual payment origin entry                       |
-| `OwnershipModel`              | Ownership record                                      |
-| `OwnershipsPagedResult`       | Paginated response from `GET /ownerships`             |
-| `TenantModel`                 | Full tenant entity                                    |
-| `TenantsPagedResult`          | Paginated response from `GET /tenants`                |
-| `TenantsBalancesModel`        | Tenant balance item                                   |
-| `TenantsBalancesPagedResult`  | Paginated response from `GET /tenants/balances`       |
-| `TenantsTenanciesModel`       | Tenancy record                                        |
-| `TenantsTenanciesPagedResult` | Paginated response from `GET /tenants/tenancies`      |
-| `PaginationModel`             | Pagination metadata                                   |
-| `AddressModel`                | Address entity                                        |
-| `ErrorResponseModel`          | Standard API error response                           |
-| `ErrorItemModel`              | Individual error item                                 |
+### Owner API
 
-### User API
+| Type                                      | Description                                                 |
+| ----------------------------------------- | ----------------------------------------------------------- |
+| `AgencyModel`                             | Full agency entity                                          |
+| `AgenciesPagedResult`                     | Paginated response from `GET /agencies`                     |
+| `AgenciesQueryParams`                     | Query parameters for `GET /agencies`                        |
+| `AgenciesInvoicesModel`                   | Agency invoice item                                         |
+| `AgenciesInvoicesPagedResult`             | Paginated response from `GET /agencies/invoices`            |
+| `AgenciesInvoicesQueryParams`             | Query parameters for `GET /agencies/invoices`               |
+| `AgencyBasicModel`                        | Minimal agency summary used in related resources            |
+| `AttachmentModel`                         | File attachment                                             |
+| `AttachmentsPagedResult`                  | Paginated response from `GET /attachments/{source}`         |
+| `AttachmentsQueryParams`                  | Query parameters for `GET /attachments/{source}`            |
+| `BeneficiaryModel`                        | Full beneficiary entity                                     |
+| `BeneficiariesPagedResult`                | Paginated response from `GET /beneficiaries`                |
+| `BeneficiariesQueryParams`                | Query parameters for `GET /beneficiaries`                   |
+| `BeneficiaryBasicModel`                   | Minimal beneficiary summary used in related resources       |
+| `PropertyModel`                           | Full property entity                                        |
+| `PropertiesPagedResult`                   | Paginated response from `GET /properties`                   |
+| `PropertiesQueryParams`                   | Query parameters for `GET /properties`                      |
+| `PropertyBasicModel`                      | Minimal property summary used in related resources          |
+| `PaymentsIncomingModel`                   | Incoming payment item                                       |
+| `PaymentsIncomingPagedResult`             | Paginated response from `GET /payments/incoming`            |
+| `PaymentsIncomingQueryParams`             | Query parameters for `GET /payments/incoming`               |
+| `PaymentsOutgoingModel`                   | Outgoing payment item                                       |
+| `PaymentsOutgoingPagedResult`             | Paginated response from `GET /payments/outgoing`            |
+| `PaymentsOutgoingQueryParams`             | Query parameters for `GET /payments/outgoing`               |
+| `PaymentsCombinedModel`                   | Combined incoming/outgoing payment item                     |
+| `PaymentsCombinedPagedResult`             | Paginated response from `GET /payments/combined`            |
+| `PaymentsCombinedQueryParams`             | Query parameters for `GET /payments/combined`               |
+| `PaymentsSummaryModel`                    | Payment summary response from `GET /payments/summary`       |
+| `PaymentsSummaryQueryParams`              | Query parameters for `GET /payments/summary`                |
+| `PaymentBatchModel`                       | Outgoing batch payment information                          |
+| `PaymentsOutgoingOriginModel`             | Individual payment origin entry                             |
+| `OwnershipModel`                          | Ownership record                                            |
+| `OwnershipsPagedResult`                   | Paginated response from `GET /ownerships`                   |
+| `OwnershipsQueryParams`                   | Query parameters for `GET /ownerships`                      |
+| `TenantModel`                             | Full tenant entity                                          |
+| `TenantsPagedResult`                      | Paginated response from `GET /tenants`                      |
+| `TenantsQueryParams`                      | Query parameters for `GET /tenants`                         |
+| `TenantsBalancesModel`                    | Tenant balance item                                         |
+| `TenantsBalancesPagedResult`              | Paginated response from `GET /tenants/balances`             |
+| `TenantsBalancesQueryParams`              | Query parameters for `GET /tenants/balances`                |
+| `TenantsTenanciesModel`                   | Tenancy record                                              |
+| `TenantsTenanciesPagedResult`             | Paginated response from `GET /tenants/tenancies`            |
+| `TenantsTenanciesQueryParams`             | Query parameters for `GET /tenants/tenancies`               |
+| `TenantBasicModel`                        | Minimal tenant summary used in related resources            |
+| `PaginationModel`                         | Pagination metadata                                         |
+| `AddressModel`                            | Address entity                                              |
+| `ExternalID`                              | PayProp external ID (alphanumeric string)                   |
+| `AmountBase`                              | Decimal monetary amount                                     |
+| `AmountNullable`                          | Nullable decimal monetary amount                            |
+| `DateString`                              | ISO date string (`YYYY-MM-DD`)                              |
+| `DateStringNullable`                      | Nullable ISO date string (`YYYY-MM-DD`)                     |
+| `ErrorResponseModel`                      | Standard API error response                                 |
+| `ErrorItemModel`                          | Individual error item                                       |
+| `DocumentsCsvPaymentsIncomingQueryParams` | Query parameters for `GET /documents/csv/payments/incoming` |
+| `DocumentsCsvPaymentsOutgoingQueryParams` | Query parameters for `GET /documents/csv/payments/outgoing` |
+| `DocumentsCsvPaymentsCombinedQueryParams` | Query parameters for `GET /documents/csv/payments/combined` |
 
-| Type                              | Description                                                                |
-| --------------------------------- | -------------------------------------------------------------------------- |
-| `UserModel`                       | Full user response (Cognito user + metadata)                               |
-| `UserCognitoModel`                | Cognito user object from `AdminCreateUserCommand`                          |
-| `UserCognitoAttributeModel`       | Individual Cognito user attribute (name/value pair)                        |
-| `UserRoleModel`                   | User role enum (`owner` \| `tenant`)                                       |
-| `PublicMetadataModel`             | Metadata payload for `GET`/`PUT /public/metadata` (owner, tenant, or both) |
-| `OwnerMetadataModel`              | Owner-specific metadata                                                    |
-| `TenantMetadataModel`             | Tenant-specific metadata                                                   |
-| `UserAddressModel`                | Address associated with a user                                             |
-| `UserUpdateRequestModel`          | Request body for `PUT /private/users`                                      |
-| `UserCreateRequestModel`          | Request body for `POST /private/users` (owner or tenant union)             |
-| `UserCreateOwnerRequestModel`     | Request body for `POST /private/users` when creating an owner              |
-| `UserCreateTenantRequestModel`    | Request body for `POST /private/users` when creating a tenant              |
-| `SendOwnerInvitationRequestModel` | Request body for `POST /private/send-owner-invitation`                     |
-| `SendOwnerInvitationItemModel`    | Single invitation entry (requires `id` or `email`)                         |
-| `SendOwnerInvitationModel`        | Response from `POST /private/send-owner-invitation`                        |
+### One Portal API
+
+| Type                                     | Description                                                                  |
+| ---------------------------------------- | ---------------------------------------------------------------------------- |
+| `UserModel`                              | Full user response (Cognito user + metadata)                                 |
+| `PrivateUsersQueryParams`                | Query parameters for `GET /private/users`                                    |
+| `UserCognitoModel`                       | Cognito user object from `AdminCreateUserCommand`                            |
+| `UserCognitoAttributeModel`              | Individual Cognito user attribute (name/value pair)                          |
+| `UserRoleModel`                          | User role enum (`owner` \| `tenant`)                                         |
+| `PublicMetadataModel`                    | Metadata returned by `GET /public/metadata` and in user responses            |
+| `PublicMetadataQueryParams`              | Query parameters for `GET /public/metadata`                                  |
+| `MetadataPayloadModel`                   | Partial metadata payload for `PUT /public/metadata` and `PUT /private/users` |
+| `PublicMetadataUpdateQueryParams`        | Query parameters for `PUT /public/metadata`                                  |
+| `OwnerMetadataModel`                     | Owner-specific metadata                                                      |
+| `OwnerMetadataPayloadModel`              | Partial owner metadata for write operations (all fields optional)            |
+| `TenantMetadataModel`                    | Tenant-specific metadata                                                     |
+| `TenantMetadataPayloadModel`             | Partial tenant metadata for write operations (all fields optional)           |
+| `UserAddressModel`                       | Address associated with a user                                               |
+| `PrivateUserUpdateRequestModel`          | Request body for `PUT /private/users`                                        |
+| `PrivateUsersUpdateQueryParams`          | Query parameters for `PUT /private/users`                                    |
+| `PrivateUserCreateRequestModel`          | Request body for `POST /private/users` (owner or tenant union)               |
+| `PrivateUserCreateOwnerRequestModel`     | Request body for `POST /private/users` when creating an owner                |
+| `PrivateUserCreateTenantRequestModel`    | Request body for `POST /private/users` when creating a tenant                |
+| `PrivateSendOwnerInvitationRequestModel` | Request body for `POST /private/send-owner-invitation`                       |
+| `PrivateSendOwnerInvitationItemModel`    | Single invitation entry (requires `id` or `email`)                           |
+| `PrivateSendOwnerInvitationModel`        | Response from `POST /private/send-owner-invitation`                          |

package/dist/index.d.ts

@@ -1,10 +1,3 @@
-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";
+export * from "./owner-api";
+export * from "./one-portal-api";
+export * from "./error";

package/dist/index.js

@@ -14,13 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types/shared"), exports);
-__exportStar(require("./types/agency"), exports);
-__exportStar(require("./types/attachment"), exports);
-__exportStar(require("./types/beneficiaries"), exports);
-__exportStar(require("./types/properties"), exports);
-__exportStar(require("./types/payment"), exports);
-__exportStar(require("./types/ownership"), exports);
-__exportStar(require("./types/tenant"), exports);
-__exportStar(require("./types/user"), exports);
-__exportStar(require("./types/error"), exports);
+__exportStar(require("./owner-api"), exports);
+__exportStar(require("./one-portal-api"), exports);
+__exportStar(require("./error"), exports);

package/dist/one-portal-api/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./private";
+export * from "./public";

package/dist/one-portal-api/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./private"), exports);
+__exportStar(require("./public"), exports);

package/dist/{types/user.d.ts → one-portal-api/private.d.ts}

@@ -1,87 +1,4 @@
-/**
- * Address associated with a user.
- */
-export interface UserAddressModel {
-    /** Address line 1. */
-    line_1: string;
-    /** Address line 2. */
-    line_2: string;
-    /** Address line 3. */
-    line_3: string;
-    /** City. */
-    city: string;
-    /** Postal code. */
-    postal_code: string;
-}
-/**
- * Tenant-specific metadata as returned in API responses.
- */
-export interface TenantMetadataModel {
-    /** Tenant first name. */
-    first_name?: string;
-    /** Tenant last name. */
-    last_name?: string;
-}
-/**
- * Partial tenant metadata for write operations (`PUT /private/users`, `PUT /public/metadata`).
- * All fields are optional — only the fields provided will be updated.
- */
-export type TenantMetadataPayloadModel = Partial<TenantMetadataModel>;
-/**
- * Owner-specific metadata as returned in API responses.
- */
-export interface OwnerMetadataModel {
-    /** Owner first name. */
-    first_name: string;
-    /** Owner last name. */
-    last_name: string;
-    /** Business name. */
-    business_name: string;
-    /** Tax code. */
-    tax_code: string;
-    /** Indicates whether the owner has reviewed their information. */
-    is_info_reviewed: boolean;
-    /** Owner address. */
-    address: UserAddressModel;
-    /** Annual statement generation schedule. */
-    annual_statement: {
-        /**
-         * Day of the month for the annual statement.
-         * Must be between 1 and 31.
-         */
-        day: number;
-        /**
-         * Month of the year for the annual statement.
-         * Must be between 1 and 12.
-         */
-        month: number;
-    };
-}
-/**
- * Partial owner metadata for write operations (`PUT /private/users`, `PUT /public/metadata`).
- * All fields are optional — only the fields provided will be updated.
- */
-export type OwnerMetadataPayloadModel = Partial<OwnerMetadataModel>;
-/**
- * Metadata as returned by `GET /public/metadata` and in user responses.
- * Either `owner`, `tenant`, or both may be present depending on the user's role(s).
- */
-export interface PublicMetadataModel {
-    /** Owner metadata. Only present when the user has the `owner` role. */
-    owner: OwnerMetadataModel;
-    /** Tenant metadata. Only present when the user has the `tenant` role. */
-    tenant: TenantMetadataModel;
-}
-/**
- * Partial metadata payload for write operations (`PUT /public/metadata`, `PUT /private/users`).
- * Pass `owner`, `tenant`, or both — only the provided fields will be updated.
- */
-export interface PublicMetadataPayloadModel {
-    /** Partial owner metadata to update. */
-    owner?: OwnerMetadataPayloadModel;
-    /** Partial tenant metadata to update. */
-    tenant?: TenantMetadataPayloadModel;
-}
+import { OwnerMetadataPayloadModel, PublicMetadataModel, TenantMetadataPayloadModel } from "./public";
 /**
  * User role.
  *
@@ -89,6 +6,19 @@ export interface PublicMetadataPayloadModel {
  * - `tenant` – Tenant
  */
 export type UserRoleModel = "owner" | "tenant";
+/**
+ * Query parameters for `GET /private/users`.
+ */
+export interface PrivateUsersQueryParams {
+    /**
+     * User email address (alternative to `id`).
+     */
+    email?: string;
+    /**
+     * User ID (alternative to `email`).
+     */
+    id?: string;
+}
 /**
  * An individual Cognito user attribute name/value pair.
  */
@@ -138,11 +68,31 @@ export interface UserModel {
     /** User metadata payload containing owner and/or tenant metadata. */
     metadata?: PublicMetadataModel;
 }
+/**
+ * Query parameters for `PUT /private/users`.
+ */
+export interface PrivateUsersUpdateQueryParams {
+    /**
+     * User email address (alternative to `id`).
+     */
+    email?: string;
+    /**
+     * User ID (alternative to `email`).
+     */
+    id?: string;
+    /**
+     * Specifies how to apply the metadata update.
+     * - `merge` – Combines the provided metadata with the existing metadata (default).
+     * - `overwrite` – Replaces the existing metadata with the provided metadata.
+     * @default 'merge'
+     */
+    strategy?: "merge" | "overwrite";
+}
 /**
  * Request body for `PUT /private/users`.
  * Updates user metadata using the specified merge strategy.
  */
-export interface UserUpdateRequestModel {
+export interface PrivateUserUpdateRequestModel {
     /** Metadata to apply to the user. Pass `owner`, `tenant`, or both. */
     metadata?: PublicMetadataModel;
 }
@@ -150,7 +100,7 @@ export interface UserUpdateRequestModel {
  * A single entry in the owner invitation request.
  * Must include either `id` or `email`.
  */
-export interface SendOwnerInvitationItemModel {
+export interface PrivateSendOwnerInvitationItemModel {
     /** User ID (alternative to `email`). */
     id: string;
     /** User email address (alternative to `id`). */
@@ -160,23 +110,23 @@ export interface SendOwnerInvitationItemModel {
  * Request body for `POST /private/send-owner-invitation`.
  * Array of 1–50 owner invitation entries, each requiring either an `id` or `email`.
  */
-export type SendOwnerInvitationRequestModel = SendOwnerInvitationItemModel[];
+export type PrivateSendOwnerInvitationRequestModel = PrivateSendOwnerInvitationItemModel[];
 /**
  * Response from `POST /private/send-owner-invitation`.
  */
-export interface SendOwnerInvitationModel {
+export interface PrivateSendOwnerInvitationModel {
     /** Invitation enqueue result. */
     invitations: {
         /** Number of invitations received. */
-        received?: number;
+        received: number;
         /** Number of invitations successfully enqueued. */
-        enqueued?: number;
+        enqueued: number;
     };
 }
 /**
  * Request body for `POST /private/users` when creating an owner.
  */
-export interface UserCreateOwnerRequestModel {
+export interface PrivateUserCreateOwnerRequestModel {
     /** User email address. */
     email: string;
     /** Must be `"owner"`. */
@@ -187,7 +137,7 @@ export interface UserCreateOwnerRequestModel {
 /**
  * Request body for `POST /private/users` when creating a tenant.
  */
-export interface UserCreateTenantRequestModel {
+export interface PrivateUserCreateTenantRequestModel {
     /** User email address. */
     email: string;
     /** Must be `"tenant"`. */
@@ -197,6 +147,6 @@ export interface UserCreateTenantRequestModel {
 }
 /**
  * Request body for `POST /private/users`.
- * Use `UserCreateOwnerRequestModel` or `UserCreateTenantRequestModel` depending on the role.
+ * Use `PrivateUserCreateOwnerRequestModel` or `PrivateUserCreateTenantRequestModel` depending on the role.
  */
-export type UserCreateRequestModel = UserCreateOwnerRequestModel | UserCreateTenantRequestModel;
+export type PrivateUserCreateRequestModel = PrivateUserCreateOwnerRequestModel | PrivateUserCreateTenantRequestModel;

package/dist/one-portal-api/public.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Address associated with a user.
+ */
+export interface UserAddressModel {
+    /** Address line 1. */
+    line_1: string;
+    /** Address line 2. */
+    line_2: string;
+    /** Address line 3. */
+    line_3: string;
+    /** City. */
+    city: string;
+    /** Postal code. */
+    postal_code: string;
+}
+/**
+ * Tenant-specific metadata as returned in API responses.
+ */
+export interface TenantMetadataModel {
+    /** Tenant first name. */
+    first_name?: string;
+    /** Tenant last name. */
+    last_name?: string;
+}
+/**
+ * Partial tenant metadata for write operations (`PUT /private/users`, `PUT /public/metadata`).
+ * All fields are optional — only the fields provided will be updated.
+ */
+export type TenantMetadataPayloadModel = Partial<TenantMetadataModel>;
+/**
+ * Owner-specific metadata as returned in API responses.
+ */
+export interface OwnerMetadataModel {
+    /** Owner first name. */
+    first_name: string;
+    /** Owner last name. */
+    last_name: string;
+    /** Business name. */
+    business_name: string;
+    /** Tax code. */
+    tax_code: string;
+    /** Indicates whether the owner has reviewed their information. */
+    is_info_reviewed: boolean;
+    /** Owner address. */
+    address: UserAddressModel;
+    /** Annual statement generation schedule. */
+    annual_statement: {
+        /**
+         * Day of the month for the annual statement.
+         * Must be between 1 and 31.
+         */
+        day: number;
+        /**
+         * Month of the year for the annual statement.
+         * Must be between 1 and 12.
+         */
+        month: number;
+    };
+}
+/**
+ * Partial owner metadata for write operations (`PUT /private/users`, `PUT /public/metadata`).
+ * All fields are optional — only the fields provided will be updated.
+ */
+export type OwnerMetadataPayloadModel = Partial<OwnerMetadataModel>;
+/**
+ * Query parameters for `GET /public/metadata`.
+ */
+export interface PublicMetadataQueryParams {
+    /**
+     * Return metadata based on the given role.
+     */
+    role?: "tenant" | "owner";
+}
+/**
+ * Metadata as returned by `GET /public/metadata` and in user responses.
+ * Either `owner`, `tenant`, or both may be present depending on the user's role(s).
+ */
+export interface PublicMetadataModel {
+    /** Owner metadata. Only present when the user has the `owner` role. */
+    owner: OwnerMetadataModel;
+    /** Tenant metadata. Only present when the user has the `tenant` role. */
+    tenant: TenantMetadataModel;
+}
+/**
+ * Query parameters for `PUT /public/metadata`.
+ */
+export interface PublicMetadataUpdateQueryParams {
+    /**
+     * Specifies how to apply the metadata update.
+     * - `merge` – Combines the provided metadata with the existing metadata (default).
+     * - `overwrite` – Replaces the existing metadata with the provided metadata.
+     * @default 'merge'
+     */
+    strategy?: "merge" | "overwrite";
+}
+/**
+ * Partial metadata payload for write operations (`PUT /public/metadata`, `PUT /private/users`).
+ * Pass `owner`, `tenant`, or both — only the provided fields will be updated.
+ */
+export interface MetadataPayloadModel {
+    /** Partial owner metadata to update. */
+    owner?: OwnerMetadataPayloadModel;
+    /** Partial tenant metadata to update. */
+    tenant?: TenantMetadataPayloadModel;
+}

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

@@ -1,4 +1,26 @@
-import type { AddressModel, AgencyBasicModel, AmountBase, DateStringNullable, ExternalID, PaginationModel, PropertyBasicModel } from "./shared";
+import type { AddressModel, AgencyBasicModel, AmountBase, DateString, DateStringNullable, ExternalID, PaginationModel, PropertyBasicModel } from "./shared";
+/**
+ * Query parameters for `GET /agencies`.
+ */
+export interface AgenciesQueryParams {
+    /**
+     * 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;
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+}
 /**
  * Full agency entity. Contains all agency details including contact information.
  */
@@ -45,6 +67,48 @@ export interface AgenciesPagedResult {
     /** Pagination metadata. */
     pagination: PaginationModel;
 }
+/**
+ * Query parameters for `GET /agencies/invoices`.
+ */
+export interface AgenciesInvoicesQueryParams {
+    /**
+     * 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;
+    /**
+     * Filter report from date (inclusive).
+     * @example '2025-10-21'
+     */
+    from_date: DateString;
+    /**
+     * Filter report to date (inclusive).
+     * @example '2025-10-21'
+     */
+    to_date: DateString;
+    /**
+     * Filter by one or more agency IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    agency_id?: ExternalID[];
+    /**
+     * Filter by one or more property IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    property_id?: ExternalID[];
+    /**
+     * Filter by one or more beneficiary IDs.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    beneficiary_id?: ExternalID[];
+}
 /**
  * Agency invoice item. Represents an outgoing payment made by the agency
  * and the associated property and payment record.

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

@@ -27,3 +27,25 @@ export interface AttachmentsPagedResult {
     /** Pagination metadata. */
     pagination: PaginationModel;
 }
+/**
+ * Query parameters for `GET /attachments/{source}`.
+ */
+export interface AttachmentsQueryParams {
+    /**
+     * 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;
+    /**
+     * One or more attachment source IDs to filter by.
+     * @example ['zJBv2E5aJQ', 'aZfv225aJX']
+     */
+    id: ExternalID[];
+}