@codeforamerica/safety-net-openapi-california 1.0.0

package/src/households/types.gen.ts

@@ -0,0 +1,1729 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+    baseURL: 'https://api.example.com' | 'http://localhost:8080' | (string & {});
+};
+
+/**
+ * Represents a household unit with multiple members.
+ */
+export type Household = {
+    /**
+     * Unique identifier for the household.
+     */
+    readonly id: string;
+    /**
+     * Home address of the household.
+     */
+    homeAddress: {
+        /**
+         * Primary street address line.
+         */
+        addressLine1: string;
+        /**
+         * Secondary address line such as apartment or unit.
+         */
+        addressLine2?: string;
+        /**
+         * City or locality of residence.
+         */
+        city: string;
+        /**
+         * State, province, or region of residence.
+         */
+        stateProvince: string;
+        /**
+         * Postal or ZIP code.
+         */
+        postalCode: string;
+        /**
+         * County or equivalent administrative region.
+         */
+        county?: string;
+    };
+    /**
+     * Mailing address if different from home address.
+     */
+    mailingAddress?: {
+        /**
+         * Primary street address line.
+         */
+        addressLine1: string;
+        /**
+         * Secondary address line such as apartment or unit.
+         */
+        addressLine2?: string;
+        /**
+         * City or locality of residence.
+         */
+        city: string;
+        /**
+         * State, province, or region of residence.
+         */
+        stateProvince: string;
+        /**
+         * Postal or ZIP code.
+         */
+        postalCode: string;
+        /**
+         * County or equivalent administrative region.
+         */
+        county?: string;
+    };
+    /**
+     * Primary phone number for the household.
+     */
+    phoneNumber?: string;
+    /**
+     * List of household members with their relationship to the head of household.
+     */
+    members: Array<{
+        /**
+         * Reference to the person's unique identifier.
+         */
+        personId: string;
+        /**
+         * Relationship to the head of household.
+         */
+        relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+    }>;
+    /**
+     * Timestamp when the household record was created.
+     */
+    readonly createdAt: string;
+    /**
+     * Timestamp when the household record was last updated.
+     */
+    readonly updatedAt: string;
+};
+
+/**
+ * Represents a household unit with multiple members.
+ */
+export type HouseholdCreate = {
+    /**
+     * Unique identifier for the household.
+     */
+    readonly id: string;
+    /**
+     * Home address of the household.
+     */
+    homeAddress: {
+        /**
+         * Primary street address line.
+         */
+        addressLine1: string;
+        /**
+         * Secondary address line such as apartment or unit.
+         */
+        addressLine2?: string;
+        /**
+         * City or locality of residence.
+         */
+        city: string;
+        /**
+         * State, province, or region of residence.
+         */
+        stateProvince: string;
+        /**
+         * Postal or ZIP code.
+         */
+        postalCode: string;
+        /**
+         * County or equivalent administrative region.
+         */
+        county?: string;
+    };
+    /**
+     * Mailing address if different from home address.
+     */
+    mailingAddress?: {
+        /**
+         * Primary street address line.
+         */
+        addressLine1: string;
+        /**
+         * Secondary address line such as apartment or unit.
+         */
+        addressLine2?: string;
+        /**
+         * City or locality of residence.
+         */
+        city: string;
+        /**
+         * State, province, or region of residence.
+         */
+        stateProvince: string;
+        /**
+         * Postal or ZIP code.
+         */
+        postalCode: string;
+        /**
+         * County or equivalent administrative region.
+         */
+        county?: string;
+    };
+    /**
+     * Primary phone number for the household.
+     */
+    phoneNumber?: string;
+    /**
+     * List of household members with their relationship to the head of household.
+     */
+    members: Array<{
+        /**
+         * Reference to the person's unique identifier.
+         */
+        personId: string;
+        /**
+         * Relationship to the head of household.
+         */
+        relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+    }>;
+    /**
+     * Timestamp when the household record was created.
+     */
+    readonly createdAt: string;
+    /**
+     * Timestamp when the household record was last updated.
+     */
+    readonly updatedAt: string;
+};
+
+/**
+ * Represents a household unit with multiple members.
+ */
+export type HouseholdUpdate = {
+    /**
+     * Unique identifier for the household.
+     */
+    readonly id: string;
+    /**
+     * Home address of the household.
+     */
+    homeAddress: {
+        /**
+         * Primary street address line.
+         */
+        addressLine1: string;
+        /**
+         * Secondary address line such as apartment or unit.
+         */
+        addressLine2?: string;
+        /**
+         * City or locality of residence.
+         */
+        city: string;
+        /**
+         * State, province, or region of residence.
+         */
+        stateProvince: string;
+        /**
+         * Postal or ZIP code.
+         */
+        postalCode: string;
+        /**
+         * County or equivalent administrative region.
+         */
+        county?: string;
+    };
+    /**
+     * Mailing address if different from home address.
+     */
+    mailingAddress?: {
+        /**
+         * Primary street address line.
+         */
+        addressLine1: string;
+        /**
+         * Secondary address line such as apartment or unit.
+         */
+        addressLine2?: string;
+        /**
+         * City or locality of residence.
+         */
+        city: string;
+        /**
+         * State, province, or region of residence.
+         */
+        stateProvince: string;
+        /**
+         * Postal or ZIP code.
+         */
+        postalCode: string;
+        /**
+         * County or equivalent administrative region.
+         */
+        county?: string;
+    };
+    /**
+     * Primary phone number for the household.
+     */
+    phoneNumber?: string;
+    /**
+     * List of household members with their relationship to the head of household.
+     */
+    members: Array<{
+        /**
+         * Reference to the person's unique identifier.
+         */
+        personId: string;
+        /**
+         * Relationship to the head of household.
+         */
+        relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+    }>;
+    /**
+     * Timestamp when the household record was created.
+     */
+    readonly createdAt: string;
+    /**
+     * Timestamp when the household record was last updated.
+     */
+    readonly updatedAt: string;
+};
+
+export type HouseholdList = {
+    items: Array<{
+        /**
+         * Unique identifier for the household.
+         */
+        readonly id: string;
+        /**
+         * Home address of the household.
+         */
+        homeAddress: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Mailing address if different from home address.
+         */
+        mailingAddress?: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Primary phone number for the household.
+         */
+        phoneNumber?: string;
+        /**
+         * List of household members with their relationship to the head of household.
+         */
+        members: Array<{
+            /**
+             * Reference to the person's unique identifier.
+             */
+            personId: string;
+            /**
+             * Relationship to the head of household.
+             */
+            relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+        }>;
+        /**
+         * Timestamp when the household record was created.
+         */
+        readonly createdAt: string;
+        /**
+         * Timestamp when the household record was last updated.
+         */
+        readonly updatedAt: string;
+    }>;
+    /**
+     * Total number of households available.
+     */
+    total: number;
+    /**
+     * Maximum number of households requested.
+     */
+    limit: number;
+    /**
+     * Number of items skipped before the current page.
+     */
+    offset: number;
+    /**
+     * Indicates whether more households are available beyond the current page.
+     */
+    hasNext?: boolean;
+};
+
+/**
+ * Represents a household unit with multiple members.
+ */
+export type HouseholdWritable = {
+    /**
+     * Home address of the household.
+     */
+    homeAddress: {
+        /**
+         * Primary street address line.
+         */
+        addressLine1: string;
+        /**
+         * Secondary address line such as apartment or unit.
+         */
+        addressLine2?: string;
+        /**
+         * City or locality of residence.
+         */
+        city: string;
+        /**
+         * State, province, or region of residence.
+         */
+        stateProvince: string;
+        /**
+         * Postal or ZIP code.
+         */
+        postalCode: string;
+        /**
+         * County or equivalent administrative region.
+         */
+        county?: string;
+    };
+    /**
+     * Mailing address if different from home address.
+     */
+    mailingAddress?: {
+        /**
+         * Primary street address line.
+         */
+        addressLine1: string;
+        /**
+         * Secondary address line such as apartment or unit.
+         */
+        addressLine2?: string;
+        /**
+         * City or locality of residence.
+         */
+        city: string;
+        /**
+         * State, province, or region of residence.
+         */
+        stateProvince: string;
+        /**
+         * Postal or ZIP code.
+         */
+        postalCode: string;
+        /**
+         * County or equivalent administrative region.
+         */
+        county?: string;
+    };
+    /**
+     * Primary phone number for the household.
+     */
+    phoneNumber?: string;
+    /**
+     * List of household members with their relationship to the head of household.
+     */
+    members: Array<{
+        /**
+         * Reference to the person's unique identifier.
+         */
+        personId: string;
+        /**
+         * Relationship to the head of household.
+         */
+        relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+    }>;
+};
+
+/**
+ * Represents a household unit with multiple members.
+ */
+export type HouseholdCreateWritable = {
+    /**
+     * Home address of the household.
+     */
+    homeAddress: {
+        /**
+         * Primary street address line.
+         */
+        addressLine1: string;
+        /**
+         * Secondary address line such as apartment or unit.
+         */
+        addressLine2?: string;
+        /**
+         * City or locality of residence.
+         */
+        city: string;
+        /**
+         * State, province, or region of residence.
+         */
+        stateProvince: string;
+        /**
+         * Postal or ZIP code.
+         */
+        postalCode: string;
+        /**
+         * County or equivalent administrative region.
+         */
+        county?: string;
+    };
+    /**
+     * Mailing address if different from home address.
+     */
+    mailingAddress?: {
+        /**
+         * Primary street address line.
+         */
+        addressLine1: string;
+        /**
+         * Secondary address line such as apartment or unit.
+         */
+        addressLine2?: string;
+        /**
+         * City or locality of residence.
+         */
+        city: string;
+        /**
+         * State, province, or region of residence.
+         */
+        stateProvince: string;
+        /**
+         * Postal or ZIP code.
+         */
+        postalCode: string;
+        /**
+         * County or equivalent administrative region.
+         */
+        county?: string;
+    };
+    /**
+     * Primary phone number for the household.
+     */
+    phoneNumber?: string;
+    /**
+     * List of household members with their relationship to the head of household.
+     */
+    members: Array<{
+        /**
+         * Reference to the person's unique identifier.
+         */
+        personId: string;
+        /**
+         * Relationship to the head of household.
+         */
+        relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+    }>;
+};
+
+/**
+ * Represents a household unit with multiple members.
+ */
+export type HouseholdUpdateWritable = {
+    /**
+     * Home address of the household.
+     */
+    homeAddress: {
+        /**
+         * Primary street address line.
+         */
+        addressLine1: string;
+        /**
+         * Secondary address line such as apartment or unit.
+         */
+        addressLine2?: string;
+        /**
+         * City or locality of residence.
+         */
+        city: string;
+        /**
+         * State, province, or region of residence.
+         */
+        stateProvince: string;
+        /**
+         * Postal or ZIP code.
+         */
+        postalCode: string;
+        /**
+         * County or equivalent administrative region.
+         */
+        county?: string;
+    };
+    /**
+     * Mailing address if different from home address.
+     */
+    mailingAddress?: {
+        /**
+         * Primary street address line.
+         */
+        addressLine1: string;
+        /**
+         * Secondary address line such as apartment or unit.
+         */
+        addressLine2?: string;
+        /**
+         * City or locality of residence.
+         */
+        city: string;
+        /**
+         * State, province, or region of residence.
+         */
+        stateProvince: string;
+        /**
+         * Postal or ZIP code.
+         */
+        postalCode: string;
+        /**
+         * County or equivalent administrative region.
+         */
+        county?: string;
+    };
+    /**
+     * Primary phone number for the household.
+     */
+    phoneNumber?: string;
+    /**
+     * List of household members with their relationship to the head of household.
+     */
+    members: Array<{
+        /**
+         * Reference to the person's unique identifier.
+         */
+        personId: string;
+        /**
+         * Relationship to the head of household.
+         */
+        relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+    }>;
+};
+
+export type HouseholdListWritable = {
+    items: Array<{
+        /**
+         * Home address of the household.
+         */
+        homeAddress: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Mailing address if different from home address.
+         */
+        mailingAddress?: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Primary phone number for the household.
+         */
+        phoneNumber?: string;
+        /**
+         * List of household members with their relationship to the head of household.
+         */
+        members: Array<{
+            /**
+             * Reference to the person's unique identifier.
+             */
+            personId: string;
+            /**
+             * Relationship to the head of household.
+             */
+            relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+        }>;
+    }>;
+    /**
+     * Total number of households available.
+     */
+    total: number;
+    /**
+     * Maximum number of households requested.
+     */
+    limit: number;
+    /**
+     * Number of items skipped before the current page.
+     */
+    offset: number;
+    /**
+     * Indicates whether more households are available beyond the current page.
+     */
+    hasNext?: boolean;
+};
+
+/**
+ * Unique identifier of the household.
+ */
+export type HouseholdIdParam = string;
+
+export type ListHouseholdsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Search query using field:value syntax. Multiple conditions separated by
+         * spaces are ANDed together.
+         *
+         * **URL Encoding:** This parameter must be URL-encoded when sent over HTTP.
+         * Most HTTP clients handle this automatically. Examples in this documentation
+         * show human-readable syntax for clarity.
+         *
+         * ## Syntax
+         *
+         * | Pattern | Description | Example |
+         * |---------|-------------|---------|
+         * | `term` | Full-text exact match | `john` |
+         * | `*term*` | Full-text contains | `*john*` |
+         * | `term*` | Full-text starts with | `john*` |
+         * | `*term` | Full-text ends with | `*smith` |
+         * | `field:value` | Exact match on field | `status:approved` |
+         * | `field:*value*` | Contains (case-insensitive) | `name:*john*` |
+         * | `field:value*` | Starts with | `name:john*` |
+         * | `field:*value` | Ends with | `email:*@example.com` |
+         * | `field:"value"` | Quoted value (for spaces) | `name:"john doe"` |
+         * | `field.nested:value` | Nested field (dot notation) | `address.state:CA` |
+         * | `field:>value` | Greater than | `income:>1000` |
+         * | `field:>=value` | Greater than or equal | `income:>=1000` |
+         * | `field:<value` | Less than | `income:<5000` |
+         * | `field:<=value` | Less than or equal | `income:<=5000` |
+         * | `field:val1,val2` | Match any value (OR) | `status:approved,pending` |
+         * | `-field:value` | Exclude / negate | `-status:denied` |
+         * | `field:*` | Field exists (not null) | `email:*` |
+         * | `-field:*` | Field does not exist | `-deletedAt:*` |
+         *
+         * ## Examples
+         *
+         * - `john` — exact match for "john" in searchable fields
+         * - `*john*` — contains "john" in searchable fields
+         * - `name:*smith*` — name contains "smith" (case-insensitive)
+         * - `email:*@example.com` — email ends with "@example.com"
+         * - `status:approved` — exact match on status field
+         * - `status:approved,pending` — status is "approved" OR "pending"
+         * - `income:>=1000` — income greater than or equal to 1000
+         * - `created:>2024-01-01` — created after January 1, 2024
+         * - `status:approved income:>=1000` — approved AND income >= 1000 (multiple conditions)
+         * - `-status:denied` — exclude records with status "denied"
+         * - `-deletedAt:*` — only records where deletedAt does not exist
+         * - `applicant.state:CA` — nested field filter
+         *
+         * ## URL Encoding Reference
+         *
+         * When manually constructing URLs, encode these characters:
+         *
+         * | Character | Encoded |
+         * |-----------|---------|
+         * | (space) | `%20` or `+` |
+         * | `"` | `%22` |
+         * | `:` | `%3A` |
+         * | `>` | `%3E` |
+         * | `<` | `%3C` |
+         * | `,` | `%2C` |
+         *
+         * **Example:**
+         * ```
+         * Human-readable: q=status:approved income:>=1000
+         * URL-encoded:    q=status%3Aapproved%20income%3A%3E%3D1000
+         * ```
+         *
+         */
+        q?: string;
+        /**
+         * Maximum number of items to return (1-100).
+         */
+        limit?: number;
+        /**
+         * Number of items to skip before collecting results.
+         */
+        offset?: number;
+    };
+    url: '/households';
+};
+
+export type ListHouseholdsErrors = {
+    /**
+     * The request is malformed or contains invalid parameters.
+     */
+    400: {
+        /**
+         * Machine-readable error code.
+         */
+        code: string;
+        /**
+         * Human-readable error description.
+         */
+        message: string;
+        /**
+         * Additional error details.
+         */
+        details?: Array<{
+            [key: string]: unknown;
+        }>;
+    };
+    /**
+     * An unexpected error occurred on the server.
+     */
+    500: {
+        /**
+         * Machine-readable error code.
+         */
+        code: string;
+        /**
+         * Human-readable error description.
+         */
+        message: string;
+        /**
+         * Additional error details.
+         */
+        details?: Array<{
+            [key: string]: unknown;
+        }>;
+    };
+};
+
+export type ListHouseholdsError = ListHouseholdsErrors[keyof ListHouseholdsErrors];
+
+export type ListHouseholdsResponses = {
+    /**
+     * A paginated collection of households.
+     */
+    200: {
+        items: Array<{
+            /**
+             * Unique identifier for the household.
+             */
+            readonly id: string;
+            /**
+             * Home address of the household.
+             */
+            homeAddress: {
+                /**
+                 * Primary street address line.
+                 */
+                addressLine1: string;
+                /**
+                 * Secondary address line such as apartment or unit.
+                 */
+                addressLine2?: string;
+                /**
+                 * City or locality of residence.
+                 */
+                city: string;
+                /**
+                 * State, province, or region of residence.
+                 */
+                stateProvince: string;
+                /**
+                 * Postal or ZIP code.
+                 */
+                postalCode: string;
+                /**
+                 * County or equivalent administrative region.
+                 */
+                county?: string;
+            };
+            /**
+             * Mailing address if different from home address.
+             */
+            mailingAddress?: {
+                /**
+                 * Primary street address line.
+                 */
+                addressLine1: string;
+                /**
+                 * Secondary address line such as apartment or unit.
+                 */
+                addressLine2?: string;
+                /**
+                 * City or locality of residence.
+                 */
+                city: string;
+                /**
+                 * State, province, or region of residence.
+                 */
+                stateProvince: string;
+                /**
+                 * Postal or ZIP code.
+                 */
+                postalCode: string;
+                /**
+                 * County or equivalent administrative region.
+                 */
+                county?: string;
+            };
+            /**
+             * Primary phone number for the household.
+             */
+            phoneNumber?: string;
+            /**
+             * List of household members with their relationship to the head of household.
+             */
+            members: Array<{
+                /**
+                 * Reference to the person's unique identifier.
+                 */
+                personId: string;
+                /**
+                 * Relationship to the head of household.
+                 */
+                relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+            }>;
+            /**
+             * Timestamp when the household record was created.
+             */
+            readonly createdAt: string;
+            /**
+             * Timestamp when the household record was last updated.
+             */
+            readonly updatedAt: string;
+        }>;
+        /**
+         * Total number of households available.
+         */
+        total: number;
+        /**
+         * Maximum number of households requested.
+         */
+        limit: number;
+        /**
+         * Number of items skipped before the current page.
+         */
+        offset: number;
+        /**
+         * Indicates whether more households are available beyond the current page.
+         */
+        hasNext?: boolean;
+    };
+};
+
+export type ListHouseholdsResponse = ListHouseholdsResponses[keyof ListHouseholdsResponses];
+
+export type CreateHouseholdData = {
+    body: {
+        /**
+         * Unique identifier for the household.
+         */
+        readonly id: string;
+        /**
+         * Home address of the household.
+         */
+        homeAddress: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Mailing address if different from home address.
+         */
+        mailingAddress?: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Primary phone number for the household.
+         */
+        phoneNumber?: string;
+        /**
+         * List of household members with their relationship to the head of household.
+         */
+        members: Array<{
+            /**
+             * Reference to the person's unique identifier.
+             */
+            personId: string;
+            /**
+             * Relationship to the head of household.
+             */
+            relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+        }>;
+        /**
+         * Timestamp when the household record was created.
+         */
+        readonly createdAt: string;
+        /**
+         * Timestamp when the household record was last updated.
+         */
+        readonly updatedAt: string;
+    } & {
+        [key: string]: unknown;
+    };
+    path?: never;
+    query?: never;
+    url: '/households';
+};
+
+export type CreateHouseholdErrors = {
+    /**
+     * The request is malformed or contains invalid parameters.
+     */
+    400: {
+        /**
+         * Machine-readable error code.
+         */
+        code: string;
+        /**
+         * Human-readable error description.
+         */
+        message: string;
+        /**
+         * Additional error details.
+         */
+        details?: Array<{
+            [key: string]: unknown;
+        }>;
+    };
+    /**
+     * The request was well-formed but contained semantic errors.
+     */
+    422: {
+        /**
+         * Machine-readable error code.
+         */
+        code: string;
+        /**
+         * Human-readable error description.
+         */
+        message: string;
+        /**
+         * Additional error details.
+         */
+        details?: Array<{
+            [key: string]: unknown;
+        }>;
+    };
+    /**
+     * An unexpected error occurred on the server.
+     */
+    500: {
+        /**
+         * Machine-readable error code.
+         */
+        code: string;
+        /**
+         * Human-readable error description.
+         */
+        message: string;
+        /**
+         * Additional error details.
+         */
+        details?: Array<{
+            [key: string]: unknown;
+        }>;
+    };
+};
+
+export type CreateHouseholdError = CreateHouseholdErrors[keyof CreateHouseholdErrors];
+
+export type CreateHouseholdResponses = {
+    /**
+     * Represents a household unit with multiple members.
+     */
+    201: {
+        /**
+         * Unique identifier for the household.
+         */
+        readonly id: string;
+        /**
+         * Home address of the household.
+         */
+        homeAddress: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Mailing address if different from home address.
+         */
+        mailingAddress?: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Primary phone number for the household.
+         */
+        phoneNumber?: string;
+        /**
+         * List of household members with their relationship to the head of household.
+         */
+        members: Array<{
+            /**
+             * Reference to the person's unique identifier.
+             */
+            personId: string;
+            /**
+             * Relationship to the head of household.
+             */
+            relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+        }>;
+        /**
+         * Timestamp when the household record was created.
+         */
+        readonly createdAt: string;
+        /**
+         * Timestamp when the household record was last updated.
+         */
+        readonly updatedAt: string;
+    };
+};
+
+export type CreateHouseholdResponse = CreateHouseholdResponses[keyof CreateHouseholdResponses];
+
+export type DeleteHouseholdData = {
+    body?: never;
+    path: {
+        /**
+         * Unique identifier of the household.
+         */
+        householdId: string;
+    };
+    query?: never;
+    url: '/households/{householdId}';
+};
+
+export type DeleteHouseholdErrors = {
+    /**
+     * The requested resource was not found.
+     */
+    404: {
+        /**
+         * Machine-readable error code.
+         */
+        code: string;
+        /**
+         * Human-readable error description.
+         */
+        message: string;
+        /**
+         * Additional error details.
+         */
+        details?: Array<{
+            [key: string]: unknown;
+        }>;
+    };
+    /**
+     * An unexpected error occurred on the server.
+     */
+    500: {
+        /**
+         * Machine-readable error code.
+         */
+        code: string;
+        /**
+         * Human-readable error description.
+         */
+        message: string;
+        /**
+         * Additional error details.
+         */
+        details?: Array<{
+            [key: string]: unknown;
+        }>;
+    };
+};
+
+export type DeleteHouseholdError = DeleteHouseholdErrors[keyof DeleteHouseholdErrors];
+
+export type DeleteHouseholdResponses = {
+    /**
+     * Household deleted successfully.
+     */
+    204: void;
+};
+
+export type DeleteHouseholdResponse = DeleteHouseholdResponses[keyof DeleteHouseholdResponses];
+
+export type GetHouseholdData = {
+    body?: never;
+    path: {
+        /**
+         * Unique identifier of the household.
+         */
+        householdId: string;
+    };
+    query?: never;
+    url: '/households/{householdId}';
+};
+
+export type GetHouseholdErrors = {
+    /**
+     * The requested resource was not found.
+     */
+    404: {
+        /**
+         * Machine-readable error code.
+         */
+        code: string;
+        /**
+         * Human-readable error description.
+         */
+        message: string;
+        /**
+         * Additional error details.
+         */
+        details?: Array<{
+            [key: string]: unknown;
+        }>;
+    };
+    /**
+     * An unexpected error occurred on the server.
+     */
+    500: {
+        /**
+         * Machine-readable error code.
+         */
+        code: string;
+        /**
+         * Human-readable error description.
+         */
+        message: string;
+        /**
+         * Additional error details.
+         */
+        details?: Array<{
+            [key: string]: unknown;
+        }>;
+    };
+};
+
+export type GetHouseholdError = GetHouseholdErrors[keyof GetHouseholdErrors];
+
+export type GetHouseholdResponses = {
+    /**
+     * Represents a household unit with multiple members.
+     */
+    200: {
+        /**
+         * Unique identifier for the household.
+         */
+        readonly id: string;
+        /**
+         * Home address of the household.
+         */
+        homeAddress: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Mailing address if different from home address.
+         */
+        mailingAddress?: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Primary phone number for the household.
+         */
+        phoneNumber?: string;
+        /**
+         * List of household members with their relationship to the head of household.
+         */
+        members: Array<{
+            /**
+             * Reference to the person's unique identifier.
+             */
+            personId: string;
+            /**
+             * Relationship to the head of household.
+             */
+            relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+        }>;
+        /**
+         * Timestamp when the household record was created.
+         */
+        readonly createdAt: string;
+        /**
+         * Timestamp when the household record was last updated.
+         */
+        readonly updatedAt: string;
+    };
+};
+
+export type GetHouseholdResponse = GetHouseholdResponses[keyof GetHouseholdResponses];
+
+export type UpdateHouseholdData = {
+    body: {
+        /**
+         * Unique identifier for the household.
+         */
+        readonly id: string;
+        /**
+         * Home address of the household.
+         */
+        homeAddress: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Mailing address if different from home address.
+         */
+        mailingAddress?: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Primary phone number for the household.
+         */
+        phoneNumber?: string;
+        /**
+         * List of household members with their relationship to the head of household.
+         */
+        members: Array<{
+            /**
+             * Reference to the person's unique identifier.
+             */
+            personId: string;
+            /**
+             * Relationship to the head of household.
+             */
+            relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+        }>;
+        /**
+         * Timestamp when the household record was created.
+         */
+        readonly createdAt: string;
+        /**
+         * Timestamp when the household record was last updated.
+         */
+        readonly updatedAt: string;
+    } & {
+        [key: string]: unknown;
+    };
+    path: {
+        /**
+         * Unique identifier of the household.
+         */
+        householdId: string;
+    };
+    query?: never;
+    url: '/households/{householdId}';
+};
+
+export type UpdateHouseholdErrors = {
+    /**
+     * The request is malformed or contains invalid parameters.
+     */
+    400: {
+        /**
+         * Machine-readable error code.
+         */
+        code: string;
+        /**
+         * Human-readable error description.
+         */
+        message: string;
+        /**
+         * Additional error details.
+         */
+        details?: Array<{
+            [key: string]: unknown;
+        }>;
+    };
+    /**
+     * The requested resource was not found.
+     */
+    404: {
+        /**
+         * Machine-readable error code.
+         */
+        code: string;
+        /**
+         * Human-readable error description.
+         */
+        message: string;
+        /**
+         * Additional error details.
+         */
+        details?: Array<{
+            [key: string]: unknown;
+        }>;
+    };
+    /**
+     * The request was well-formed but contained semantic errors.
+     */
+    422: {
+        /**
+         * Machine-readable error code.
+         */
+        code: string;
+        /**
+         * Human-readable error description.
+         */
+        message: string;
+        /**
+         * Additional error details.
+         */
+        details?: Array<{
+            [key: string]: unknown;
+        }>;
+    };
+    /**
+     * An unexpected error occurred on the server.
+     */
+    500: {
+        /**
+         * Machine-readable error code.
+         */
+        code: string;
+        /**
+         * Human-readable error description.
+         */
+        message: string;
+        /**
+         * Additional error details.
+         */
+        details?: Array<{
+            [key: string]: unknown;
+        }>;
+    };
+};
+
+export type UpdateHouseholdError = UpdateHouseholdErrors[keyof UpdateHouseholdErrors];
+
+export type UpdateHouseholdResponses = {
+    /**
+     * Represents a household unit with multiple members.
+     */
+    200: {
+        /**
+         * Unique identifier for the household.
+         */
+        readonly id: string;
+        /**
+         * Home address of the household.
+         */
+        homeAddress: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Mailing address if different from home address.
+         */
+        mailingAddress?: {
+            /**
+             * Primary street address line.
+             */
+            addressLine1: string;
+            /**
+             * Secondary address line such as apartment or unit.
+             */
+            addressLine2?: string;
+            /**
+             * City or locality of residence.
+             */
+            city: string;
+            /**
+             * State, province, or region of residence.
+             */
+            stateProvince: string;
+            /**
+             * Postal or ZIP code.
+             */
+            postalCode: string;
+            /**
+             * County or equivalent administrative region.
+             */
+            county?: string;
+        };
+        /**
+         * Primary phone number for the household.
+         */
+        phoneNumber?: string;
+        /**
+         * List of household members with their relationship to the head of household.
+         */
+        members: Array<{
+            /**
+             * Reference to the person's unique identifier.
+             */
+            personId: string;
+            /**
+             * Relationship to the head of household.
+             */
+            relationship: 'head_of_household' | 'spouse' | 'husband' | 'wife' | 'partner' | 'child' | 'parent' | 'sibling' | 'grandparent' | 'grandchild' | 'other_relative' | 'non_relative';
+        }>;
+        /**
+         * Timestamp when the household record was created.
+         */
+        readonly createdAt: string;
+        /**
+         * Timestamp when the household record was last updated.
+         */
+        readonly updatedAt: string;
+    };
+};
+
+export type UpdateHouseholdResponse = UpdateHouseholdResponses[keyof UpdateHouseholdResponses];