@codeforamerica/safety-net-openapi-california 1.0.0

package/dist/incomes/types.gen.d.ts

@@ -0,0 +1,1425 @@
+export type ClientOptions = {
+    baseURL: 'https://api.example.com' | 'http://localhost:8080' | (string & {});
+};
+/**
+ * A single item of income, which may be earned or unearned.
+ */
+export type Income = {
+    /**
+     * Unique identifier for the income.
+     */
+    readonly id?: string;
+    /**
+     * Foreign key reference to the person who has this income.
+     */
+    personId: string;
+    /**
+     * Optional foreign key reference to the employer, third-party or self related to this income.
+     */
+    employerId?: string;
+    /**
+     * The type of income this item represents.
+     */
+    type: 'employed' | 'self_employed' | 'unearned';
+    /**
+     * Types of unearned income.
+     */
+    unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+    /**
+     * Whether the income is net or gross.
+     */
+    incomeBasis?: 'net' | 'gross';
+    /**
+     * The amount of income this item represents.
+     */
+    amount: number;
+    /**
+     * The frequency with which the income is received.
+     */
+    frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+    /**
+     * The date the income was reported on.
+     */
+    reportedOn: string;
+    /**
+     * The source of the income.
+     */
+    source: 'client' | 'authorized_assister' | 'county_worker';
+    /**
+     * When did the applicant first receive this income?
+     */
+    startDate: string;
+    /**
+     * Does applicant expect this income to end soon or has it already ended?
+     */
+    endDate?: string;
+    /**
+     * Whether the income has been verified.
+     */
+    isVerified?: boolean;
+    /**
+     * The date the income was verified.
+     */
+    verifiedDate?: string;
+    /**
+     * The county worker who verified the income.
+     */
+    verifiedBy?: string;
+    /**
+     * Array of verification sources related to this income.
+     */
+    verificationSourceIds?: Array<string>;
+};
+/**
+ * A single item of income, which may be earned or unearned.
+ */
+export type IncomeCreate = {
+    /**
+     * Unique identifier for the income.
+     */
+    readonly id?: string;
+    /**
+     * Foreign key reference to the person who has this income.
+     */
+    personId: string;
+    /**
+     * Optional foreign key reference to the employer, third-party or self related to this income.
+     */
+    employerId?: string;
+    /**
+     * The type of income this item represents.
+     */
+    type: 'employed' | 'self_employed' | 'unearned';
+    /**
+     * Types of unearned income.
+     */
+    unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+    /**
+     * Whether the income is net or gross.
+     */
+    incomeBasis?: 'net' | 'gross';
+    /**
+     * The amount of income this item represents.
+     */
+    amount: number;
+    /**
+     * The frequency with which the income is received.
+     */
+    frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+    /**
+     * The date the income was reported on.
+     */
+    reportedOn: string;
+    /**
+     * The source of the income.
+     */
+    source: 'client' | 'authorized_assister' | 'county_worker';
+    /**
+     * When did the applicant first receive this income?
+     */
+    startDate: string;
+    /**
+     * Does applicant expect this income to end soon or has it already ended?
+     */
+    endDate?: string;
+    /**
+     * Whether the income has been verified.
+     */
+    isVerified?: boolean;
+    /**
+     * The date the income was verified.
+     */
+    verifiedDate?: string;
+    /**
+     * The county worker who verified the income.
+     */
+    verifiedBy?: string;
+    /**
+     * Array of verification sources related to this income.
+     */
+    verificationSourceIds?: Array<string>;
+};
+/**
+ * A single item of income, which may be earned or unearned.
+ */
+export type IncomeUpdate = {
+    /**
+     * Unique identifier for the income.
+     */
+    readonly id?: string;
+    /**
+     * Foreign key reference to the person who has this income.
+     */
+    personId: string;
+    /**
+     * Optional foreign key reference to the employer, third-party or self related to this income.
+     */
+    employerId?: string;
+    /**
+     * The type of income this item represents.
+     */
+    type: 'employed' | 'self_employed' | 'unearned';
+    /**
+     * Types of unearned income.
+     */
+    unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+    /**
+     * Whether the income is net or gross.
+     */
+    incomeBasis?: 'net' | 'gross';
+    /**
+     * The amount of income this item represents.
+     */
+    amount: number;
+    /**
+     * The frequency with which the income is received.
+     */
+    frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+    /**
+     * The date the income was reported on.
+     */
+    reportedOn: string;
+    /**
+     * The source of the income.
+     */
+    source: 'client' | 'authorized_assister' | 'county_worker';
+    /**
+     * When did the applicant first receive this income?
+     */
+    startDate: string;
+    /**
+     * Does applicant expect this income to end soon or has it already ended?
+     */
+    endDate?: string;
+    /**
+     * Whether the income has been verified.
+     */
+    isVerified?: boolean;
+    /**
+     * The date the income was verified.
+     */
+    verifiedDate?: string;
+    /**
+     * The county worker who verified the income.
+     */
+    verifiedBy?: string;
+    /**
+     * Array of verification sources related to this income.
+     */
+    verificationSourceIds?: Array<string>;
+};
+export type IncomeList = {
+    items: Array<{
+        /**
+         * Unique identifier for the income.
+         */
+        readonly id?: string;
+        /**
+         * Foreign key reference to the person who has this income.
+         */
+        personId: string;
+        /**
+         * Optional foreign key reference to the employer, third-party or self related to this income.
+         */
+        employerId?: string;
+        /**
+         * The type of income this item represents.
+         */
+        type: 'employed' | 'self_employed' | 'unearned';
+        /**
+         * Types of unearned income.
+         */
+        unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+        /**
+         * Whether the income is net or gross.
+         */
+        incomeBasis?: 'net' | 'gross';
+        /**
+         * The amount of income this item represents.
+         */
+        amount: number;
+        /**
+         * The frequency with which the income is received.
+         */
+        frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+        /**
+         * The date the income was reported on.
+         */
+        reportedOn: string;
+        /**
+         * The source of the income.
+         */
+        source: 'client' | 'authorized_assister' | 'county_worker';
+        /**
+         * When did the applicant first receive this income?
+         */
+        startDate: string;
+        /**
+         * Does applicant expect this income to end soon or has it already ended?
+         */
+        endDate?: string;
+        /**
+         * Whether the income has been verified.
+         */
+        isVerified?: boolean;
+        /**
+         * The date the income was verified.
+         */
+        verifiedDate?: string;
+        /**
+         * The county worker who verified the income.
+         */
+        verifiedBy?: string;
+        /**
+         * Array of verification sources related to this income.
+         */
+        verificationSourceIds?: Array<string>;
+    }>;
+    /**
+     * Total number of income available.
+     */
+    total: number;
+    /**
+     * Maximum number of income requested.
+     */
+    limit: number;
+    /**
+     * Number of items skipped before the current page.
+     */
+    offset: number;
+};
+/**
+ * A single item of income, which may be earned or unearned.
+ */
+export type IncomeWritable = {
+    /**
+     * Foreign key reference to the person who has this income.
+     */
+    personId: string;
+    /**
+     * Optional foreign key reference to the employer, third-party or self related to this income.
+     */
+    employerId?: string;
+    /**
+     * The type of income this item represents.
+     */
+    type: 'employed' | 'self_employed' | 'unearned';
+    /**
+     * Types of unearned income.
+     */
+    unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+    /**
+     * Whether the income is net or gross.
+     */
+    incomeBasis?: 'net' | 'gross';
+    /**
+     * The amount of income this item represents.
+     */
+    amount: number;
+    /**
+     * The frequency with which the income is received.
+     */
+    frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+    /**
+     * The date the income was reported on.
+     */
+    reportedOn: string;
+    /**
+     * The source of the income.
+     */
+    source: 'client' | 'authorized_assister' | 'county_worker';
+    /**
+     * When did the applicant first receive this income?
+     */
+    startDate: string;
+    /**
+     * Does applicant expect this income to end soon or has it already ended?
+     */
+    endDate?: string;
+    /**
+     * Whether the income has been verified.
+     */
+    isVerified?: boolean;
+    /**
+     * The date the income was verified.
+     */
+    verifiedDate?: string;
+    /**
+     * The county worker who verified the income.
+     */
+    verifiedBy?: string;
+    /**
+     * Array of verification sources related to this income.
+     */
+    verificationSourceIds?: Array<string>;
+};
+/**
+ * A single item of income, which may be earned or unearned.
+ */
+export type IncomeCreateWritable = {
+    /**
+     * Foreign key reference to the person who has this income.
+     */
+    personId: string;
+    /**
+     * Optional foreign key reference to the employer, third-party or self related to this income.
+     */
+    employerId?: string;
+    /**
+     * The type of income this item represents.
+     */
+    type: 'employed' | 'self_employed' | 'unearned';
+    /**
+     * Types of unearned income.
+     */
+    unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+    /**
+     * Whether the income is net or gross.
+     */
+    incomeBasis?: 'net' | 'gross';
+    /**
+     * The amount of income this item represents.
+     */
+    amount: number;
+    /**
+     * The frequency with which the income is received.
+     */
+    frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+    /**
+     * The date the income was reported on.
+     */
+    reportedOn: string;
+    /**
+     * The source of the income.
+     */
+    source: 'client' | 'authorized_assister' | 'county_worker';
+    /**
+     * When did the applicant first receive this income?
+     */
+    startDate: string;
+    /**
+     * Does applicant expect this income to end soon or has it already ended?
+     */
+    endDate?: string;
+    /**
+     * Whether the income has been verified.
+     */
+    isVerified?: boolean;
+    /**
+     * The date the income was verified.
+     */
+    verifiedDate?: string;
+    /**
+     * The county worker who verified the income.
+     */
+    verifiedBy?: string;
+    /**
+     * Array of verification sources related to this income.
+     */
+    verificationSourceIds?: Array<string>;
+};
+/**
+ * A single item of income, which may be earned or unearned.
+ */
+export type IncomeUpdateWritable = {
+    /**
+     * Foreign key reference to the person who has this income.
+     */
+    personId: string;
+    /**
+     * Optional foreign key reference to the employer, third-party or self related to this income.
+     */
+    employerId?: string;
+    /**
+     * The type of income this item represents.
+     */
+    type: 'employed' | 'self_employed' | 'unearned';
+    /**
+     * Types of unearned income.
+     */
+    unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+    /**
+     * Whether the income is net or gross.
+     */
+    incomeBasis?: 'net' | 'gross';
+    /**
+     * The amount of income this item represents.
+     */
+    amount: number;
+    /**
+     * The frequency with which the income is received.
+     */
+    frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+    /**
+     * The date the income was reported on.
+     */
+    reportedOn: string;
+    /**
+     * The source of the income.
+     */
+    source: 'client' | 'authorized_assister' | 'county_worker';
+    /**
+     * When did the applicant first receive this income?
+     */
+    startDate: string;
+    /**
+     * Does applicant expect this income to end soon or has it already ended?
+     */
+    endDate?: string;
+    /**
+     * Whether the income has been verified.
+     */
+    isVerified?: boolean;
+    /**
+     * The date the income was verified.
+     */
+    verifiedDate?: string;
+    /**
+     * The county worker who verified the income.
+     */
+    verifiedBy?: string;
+    /**
+     * Array of verification sources related to this income.
+     */
+    verificationSourceIds?: Array<string>;
+};
+export type IncomeListWritable = {
+    items: Array<{
+        /**
+         * Foreign key reference to the person who has this income.
+         */
+        personId: string;
+        /**
+         * Optional foreign key reference to the employer, third-party or self related to this income.
+         */
+        employerId?: string;
+        /**
+         * The type of income this item represents.
+         */
+        type: 'employed' | 'self_employed' | 'unearned';
+        /**
+         * Types of unearned income.
+         */
+        unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+        /**
+         * Whether the income is net or gross.
+         */
+        incomeBasis?: 'net' | 'gross';
+        /**
+         * The amount of income this item represents.
+         */
+        amount: number;
+        /**
+         * The frequency with which the income is received.
+         */
+        frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+        /**
+         * The date the income was reported on.
+         */
+        reportedOn: string;
+        /**
+         * The source of the income.
+         */
+        source: 'client' | 'authorized_assister' | 'county_worker';
+        /**
+         * When did the applicant first receive this income?
+         */
+        startDate: string;
+        /**
+         * Does applicant expect this income to end soon or has it already ended?
+         */
+        endDate?: string;
+        /**
+         * Whether the income has been verified.
+         */
+        isVerified?: boolean;
+        /**
+         * The date the income was verified.
+         */
+        verifiedDate?: string;
+        /**
+         * The county worker who verified the income.
+         */
+        verifiedBy?: string;
+        /**
+         * Array of verification sources related to this income.
+         */
+        verificationSourceIds?: Array<string>;
+    }>;
+    /**
+     * Total number of income available.
+     */
+    total: number;
+    /**
+     * Maximum number of income requested.
+     */
+    limit: number;
+    /**
+     * Number of items skipped before the current page.
+     */
+    offset: number;
+};
+export type ListIncomeData = {
+    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: '/incomes';
+};
+export type ListIncomeErrors = {
+    /**
+     * 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 ListIncomeError = ListIncomeErrors[keyof ListIncomeErrors];
+export type ListIncomeResponses = {
+    /**
+     * A paginated collection of income.
+     */
+    200: {
+        items: Array<{
+            /**
+             * Unique identifier for the income.
+             */
+            readonly id?: string;
+            /**
+             * Foreign key reference to the person who has this income.
+             */
+            personId: string;
+            /**
+             * Optional foreign key reference to the employer, third-party or self related to this income.
+             */
+            employerId?: string;
+            /**
+             * The type of income this item represents.
+             */
+            type: 'employed' | 'self_employed' | 'unearned';
+            /**
+             * Types of unearned income.
+             */
+            unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+            /**
+             * Whether the income is net or gross.
+             */
+            incomeBasis?: 'net' | 'gross';
+            /**
+             * The amount of income this item represents.
+             */
+            amount: number;
+            /**
+             * The frequency with which the income is received.
+             */
+            frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+            /**
+             * The date the income was reported on.
+             */
+            reportedOn: string;
+            /**
+             * The source of the income.
+             */
+            source: 'client' | 'authorized_assister' | 'county_worker';
+            /**
+             * When did the applicant first receive this income?
+             */
+            startDate: string;
+            /**
+             * Does applicant expect this income to end soon or has it already ended?
+             */
+            endDate?: string;
+            /**
+             * Whether the income has been verified.
+             */
+            isVerified?: boolean;
+            /**
+             * The date the income was verified.
+             */
+            verifiedDate?: string;
+            /**
+             * The county worker who verified the income.
+             */
+            verifiedBy?: string;
+            /**
+             * Array of verification sources related to this income.
+             */
+            verificationSourceIds?: Array<string>;
+        }>;
+        /**
+         * Total number of income available.
+         */
+        total: number;
+        /**
+         * Maximum number of income requested.
+         */
+        limit: number;
+        /**
+         * Number of items skipped before the current page.
+         */
+        offset: number;
+    };
+};
+export type ListIncomeResponse = ListIncomeResponses[keyof ListIncomeResponses];
+export type CreateIncomeData = {
+    body: {
+        /**
+         * Unique identifier for the income.
+         */
+        readonly id?: string;
+        /**
+         * Foreign key reference to the person who has this income.
+         */
+        personId: string;
+        /**
+         * Optional foreign key reference to the employer, third-party or self related to this income.
+         */
+        employerId?: string;
+        /**
+         * The type of income this item represents.
+         */
+        type: 'employed' | 'self_employed' | 'unearned';
+        /**
+         * Types of unearned income.
+         */
+        unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+        /**
+         * Whether the income is net or gross.
+         */
+        incomeBasis?: 'net' | 'gross';
+        /**
+         * The amount of income this item represents.
+         */
+        amount: number;
+        /**
+         * The frequency with which the income is received.
+         */
+        frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+        /**
+         * The date the income was reported on.
+         */
+        reportedOn: string;
+        /**
+         * The source of the income.
+         */
+        source: 'client' | 'authorized_assister' | 'county_worker';
+        /**
+         * When did the applicant first receive this income?
+         */
+        startDate: string;
+        /**
+         * Does applicant expect this income to end soon or has it already ended?
+         */
+        endDate?: string;
+        /**
+         * Whether the income has been verified.
+         */
+        isVerified?: boolean;
+        /**
+         * The date the income was verified.
+         */
+        verifiedDate?: string;
+        /**
+         * The county worker who verified the income.
+         */
+        verifiedBy?: string;
+        /**
+         * Array of verification sources related to this income.
+         */
+        verificationSourceIds?: Array<string>;
+    } & {
+        [key: string]: unknown;
+    };
+    path?: never;
+    query?: never;
+    url: '/incomes';
+};
+export type CreateIncomeErrors = {
+    /**
+     * 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;
+        }>;
+    };
+    /**
+     * A conflict occurred with the current state of the resource.
+     */
+    409: {
+        /**
+         * 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 CreateIncomeError = CreateIncomeErrors[keyof CreateIncomeErrors];
+export type CreateIncomeResponses = {
+    /**
+     * A single item of income, which may be earned or unearned.
+     */
+    201: {
+        /**
+         * Unique identifier for the income.
+         */
+        readonly id?: string;
+        /**
+         * Foreign key reference to the person who has this income.
+         */
+        personId: string;
+        /**
+         * Optional foreign key reference to the employer, third-party or self related to this income.
+         */
+        employerId?: string;
+        /**
+         * The type of income this item represents.
+         */
+        type: 'employed' | 'self_employed' | 'unearned';
+        /**
+         * Types of unearned income.
+         */
+        unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+        /**
+         * Whether the income is net or gross.
+         */
+        incomeBasis?: 'net' | 'gross';
+        /**
+         * The amount of income this item represents.
+         */
+        amount: number;
+        /**
+         * The frequency with which the income is received.
+         */
+        frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+        /**
+         * The date the income was reported on.
+         */
+        reportedOn: string;
+        /**
+         * The source of the income.
+         */
+        source: 'client' | 'authorized_assister' | 'county_worker';
+        /**
+         * When did the applicant first receive this income?
+         */
+        startDate: string;
+        /**
+         * Does applicant expect this income to end soon or has it already ended?
+         */
+        endDate?: string;
+        /**
+         * Whether the income has been verified.
+         */
+        isVerified?: boolean;
+        /**
+         * The date the income was verified.
+         */
+        verifiedDate?: string;
+        /**
+         * The county worker who verified the income.
+         */
+        verifiedBy?: string;
+        /**
+         * Array of verification sources related to this income.
+         */
+        verificationSourceIds?: Array<string>;
+    };
+};
+export type CreateIncomeResponse = CreateIncomeResponses[keyof CreateIncomeResponses];
+export type DeleteIncomeData = {
+    body?: never;
+    path: {
+        /**
+         * Unique identifier of the income.
+         */
+        incomeId: string;
+    };
+    query?: never;
+    url: '/incomes/{incomeId}';
+};
+export type DeleteIncomeErrors = {
+    /**
+     * 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 DeleteIncomeError = DeleteIncomeErrors[keyof DeleteIncomeErrors];
+export type DeleteIncomeResponses = {
+    /**
+     * Income deleted successfully.
+     */
+    204: void;
+};
+export type DeleteIncomeResponse = DeleteIncomeResponses[keyof DeleteIncomeResponses];
+export type GetIncomeData = {
+    body?: never;
+    path: {
+        /**
+         * Unique identifier of the income.
+         */
+        incomeId: string;
+    };
+    query?: never;
+    url: '/incomes/{incomeId}';
+};
+export type GetIncomeErrors = {
+    /**
+     * 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 GetIncomeError = GetIncomeErrors[keyof GetIncomeErrors];
+export type GetIncomeResponses = {
+    /**
+     * A single item of income, which may be earned or unearned.
+     */
+    200: {
+        /**
+         * Unique identifier for the income.
+         */
+        readonly id?: string;
+        /**
+         * Foreign key reference to the person who has this income.
+         */
+        personId: string;
+        /**
+         * Optional foreign key reference to the employer, third-party or self related to this income.
+         */
+        employerId?: string;
+        /**
+         * The type of income this item represents.
+         */
+        type: 'employed' | 'self_employed' | 'unearned';
+        /**
+         * Types of unearned income.
+         */
+        unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+        /**
+         * Whether the income is net or gross.
+         */
+        incomeBasis?: 'net' | 'gross';
+        /**
+         * The amount of income this item represents.
+         */
+        amount: number;
+        /**
+         * The frequency with which the income is received.
+         */
+        frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+        /**
+         * The date the income was reported on.
+         */
+        reportedOn: string;
+        /**
+         * The source of the income.
+         */
+        source: 'client' | 'authorized_assister' | 'county_worker';
+        /**
+         * When did the applicant first receive this income?
+         */
+        startDate: string;
+        /**
+         * Does applicant expect this income to end soon or has it already ended?
+         */
+        endDate?: string;
+        /**
+         * Whether the income has been verified.
+         */
+        isVerified?: boolean;
+        /**
+         * The date the income was verified.
+         */
+        verifiedDate?: string;
+        /**
+         * The county worker who verified the income.
+         */
+        verifiedBy?: string;
+        /**
+         * Array of verification sources related to this income.
+         */
+        verificationSourceIds?: Array<string>;
+    };
+};
+export type GetIncomeResponse = GetIncomeResponses[keyof GetIncomeResponses];
+export type UpdateIncomeData = {
+    body: {
+        /**
+         * Unique identifier for the income.
+         */
+        readonly id?: string;
+        /**
+         * Foreign key reference to the person who has this income.
+         */
+        personId: string;
+        /**
+         * Optional foreign key reference to the employer, third-party or self related to this income.
+         */
+        employerId?: string;
+        /**
+         * The type of income this item represents.
+         */
+        type: 'employed' | 'self_employed' | 'unearned';
+        /**
+         * Types of unearned income.
+         */
+        unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+        /**
+         * Whether the income is net or gross.
+         */
+        incomeBasis?: 'net' | 'gross';
+        /**
+         * The amount of income this item represents.
+         */
+        amount: number;
+        /**
+         * The frequency with which the income is received.
+         */
+        frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+        /**
+         * The date the income was reported on.
+         */
+        reportedOn: string;
+        /**
+         * The source of the income.
+         */
+        source: 'client' | 'authorized_assister' | 'county_worker';
+        /**
+         * When did the applicant first receive this income?
+         */
+        startDate: string;
+        /**
+         * Does applicant expect this income to end soon or has it already ended?
+         */
+        endDate?: string;
+        /**
+         * Whether the income has been verified.
+         */
+        isVerified?: boolean;
+        /**
+         * The date the income was verified.
+         */
+        verifiedDate?: string;
+        /**
+         * The county worker who verified the income.
+         */
+        verifiedBy?: string;
+        /**
+         * Array of verification sources related to this income.
+         */
+        verificationSourceIds?: Array<string>;
+    } & {
+        [key: string]: unknown;
+    };
+    path: {
+        /**
+         * Unique identifier of the income.
+         */
+        incomeId: string;
+    };
+    query?: never;
+    url: '/incomes/{incomeId}';
+};
+export type UpdateIncomeErrors = {
+    /**
+     * 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;
+        }>;
+    };
+    /**
+     * A conflict occurred with the current state of the resource.
+     */
+    409: {
+        /**
+         * 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 UpdateIncomeError = UpdateIncomeErrors[keyof UpdateIncomeErrors];
+export type UpdateIncomeResponses = {
+    /**
+     * A single item of income, which may be earned or unearned.
+     */
+    200: {
+        /**
+         * Unique identifier for the income.
+         */
+        readonly id?: string;
+        /**
+         * Foreign key reference to the person who has this income.
+         */
+        personId: string;
+        /**
+         * Optional foreign key reference to the employer, third-party or self related to this income.
+         */
+        employerId?: string;
+        /**
+         * The type of income this item represents.
+         */
+        type: 'employed' | 'self_employed' | 'unearned';
+        /**
+         * Types of unearned income.
+         */
+        unearnedType?: 'unemployment' | 'kinship_payment' | 'veterans_programs' | 'adoption_and_refugee_services' | 'ssi_or_ssdi' | 'private_disability' | 'workers_compensation' | 'disability_from_veterans_programs' | 'legal_form_or_settlement' | 'scholarship' | 'educational_grant' | 'work_study' | 'spousal_support' | 'child_support' | 'retirement_or_pension_plan' | 'investment_interest_and_dividends' | 'social_security_retirement' | 'renting_home' | 'renting_room' | 'renting_equipment' | 'gambling_lottery_or_other_winnings' | 'donations_or_gifts' | 'income_from_loan_or_mortgage' | 'payment_for_participating_in_research' | 'other_money_not_reported';
+        /**
+         * Whether the income is net or gross.
+         */
+        incomeBasis?: 'net' | 'gross';
+        /**
+         * The amount of income this item represents.
+         */
+        amount: number;
+        /**
+         * The frequency with which the income is received.
+         */
+        frequency: 'hourly' | 'daily' | 'weekly' | 'every_2_weeks' | 'twice_a_month' | 'monthly' | 'yearly';
+        /**
+         * The date the income was reported on.
+         */
+        reportedOn: string;
+        /**
+         * The source of the income.
+         */
+        source: 'client' | 'authorized_assister' | 'county_worker';
+        /**
+         * When did the applicant first receive this income?
+         */
+        startDate: string;
+        /**
+         * Does applicant expect this income to end soon or has it already ended?
+         */
+        endDate?: string;
+        /**
+         * Whether the income has been verified.
+         */
+        isVerified?: boolean;
+        /**
+         * The date the income was verified.
+         */
+        verifiedDate?: string;
+        /**
+         * The county worker who verified the income.
+         */
+        verifiedBy?: string;
+        /**
+         * Array of verification sources related to this income.
+         */
+        verificationSourceIds?: Array<string>;
+    };
+};
+export type UpdateIncomeResponse = UpdateIncomeResponses[keyof UpdateIncomeResponses];