@axivoy/api 1.65.0 → 1.71.0

package/dist/generated/schema.d.ts

@@ -1301,6 +1301,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/ops/compensation_plans.pay_outlook": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * My pay steps and next raise
+         * @description A driver's current pay plan and its rates, the next pay step payroll will apply automatically (new rates, start date, time served toward it and, for a per-mile raise, about how much more a week at the driver's usual miles), up to three later steps, and recent raises. Default you.
+         *
+         *     Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.compensation_plans.pay_outlook"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/ops/compensation_plans.progression_events.approve": {
         parameters: {
             query?: never;
@@ -1510,7 +1532,7 @@ export interface paths {
         put?: never;
         /**
          * Get a pay statement
-         * @description One finalized compensation statement: period, settlement detail, pay stub and net pay. Set include_pdf for a download link.
+         * @description One finalized compensation statement: period, settlement detail, pay stub, net pay and a breakdown of where the gross pay went. Set include_pdf for a download link.
          *
          *     Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
          */
@@ -15623,6 +15645,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/ops/scorecards.bonus_history": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Bonus history
+         * @description The scorecard bonuses a driver or dispatcher earned in recent final weeks: each week's total and, per bonus, the amount and whether it is waiting for payroll, on a pay statement, not paid, or paid outside Axivoy payroll (dispatcher bonuses). Default you, your portal's scorecard and the 8 most recent weeks with bonus results.
+         *
+         *     Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.scorecards.bonus_history"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/ops/scorecards.bonus_previews": {
         parameters: {
             query?: never;
@@ -15634,7 +15678,7 @@ export interface paths {
         put?: never;
         /**
          * Preview scorecard bonuses
-         * @description What each bonus scheme would pay a driver for the week as it stands, with the reason. A preview, not pay.
+         * @description What each bonus scheme would pay a driver or dispatcher for the week as it stands: its standing, the targets it checks, how it pays, and the week's total. A preview, not pay; "earned" only for a final week's persisted payout.
          *
          *     Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
          */
@@ -15645,6 +15689,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/ops/scorecards.focus.set": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Set my scorecard focus
+         * @description Pick one score on your own scorecard to focus on for the current open week, or clear it. The picked score shows first in What to work on, and the week reports how it went. Self only; only the current open week.
+         *
+         *     Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.scorecards.focus.set"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/ops/scorecards.get": {
         parameters: {
             query?: never;
@@ -15655,8 +15721,8 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Get a driver scorecard
-         * @description A driver weekly scorecard: each metric with its value, band and prior week value. Default you and the current week.
+         * Get a scorecard
+         * @description A driver's or dispatcher's weekly scorecard: each metric with its value, score level, change, tip, bonus targets and next step, plus the week's state, what to work on, wins and the person's weekly focus pick. Never amounts. Default you, your portal's scorecard and the most recent week with scores.
          *
          *     Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
          */
@@ -15678,7 +15744,7 @@ export interface paths {
         put?: never;
         /**
          * Get scorecard trends
-         * @description Weekly trend series behind a driver scorecard, for one metric slug or all of them.
+         * @description Weekly trend series behind a driver or dispatcher scorecard, for one metric slug or all of them, with each week's value in words, bonus target lines and the best week in the last 8.
          *
          *     Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
          */
@@ -28673,6 +28739,335 @@ export interface operations {
             };
         };
     };
+    "ops.compensation_plans.pay_outlook": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
+                "Idempotency-Key"?: string;
+                /** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
+                "Axivoy-Dry-Run"?: "true" | "false";
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                /** @example {} */
+                "application/json": {
+                    /** @description Another driver; default you. */
+                    user_id?: number | null;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "current_plan": {
+                     *           "name": "Solo Driver II",
+                     *           "since": "2026-05-19",
+                     *           "since_label": "May 19",
+                     *           "rates": [
+                     *             {
+                     *               "label": "Miles",
+                     *               "text": "55¢ a mile"
+                     *             },
+                     *             {
+                     *               "label": "Stops",
+                     *               "text": "$25 a stop after the first"
+                     *             },
+                     *             {
+                     *               "label": "Detention",
+                     *               "text": "$20 an hour after 2 hours"
+                     *             },
+                     *             {
+                     *               "label": "Layover",
+                     *               "text": "$100 a day"
+                     *             }
+                     *           ]
+                     *         },
+                     *         "next_step": {
+                     *           "kind": "raise",
+                     *           "plan_name": "Solo Driver III",
+                     *           "starts_on": "2026-11-03",
+                     *           "starts_on_label": "Nov 3",
+                     *           "days_until": 13,
+                     *           "headline": "Your raise to 60¢ a mile starts Nov 3",
+                     *           "figure_text": "60¢ a mile",
+                     *           "tile_text": "Raise to 60¢ a mile Nov 3",
+                     *           "effective_note": "Loads you deliver on or after Nov 3 pay the new rates.",
+                     *           "progress": {
+                     *             "elapsed": 22,
+                     *             "total": 24,
+                     *             "unit": "weeks",
+                     *             "text": "22 of 24 weeks",
+                     *             "anchor_text": "Counted from May 19, the day you started on Solo Driver II. After 24 weeks on that plan, you move to Solo Driver III."
+                     *           },
+                     *           "changes": [
+                     *             {
+                     *               "label": "Miles",
+                     *               "direction": "up",
+                     *               "from_text": "55¢ a mile",
+                     *               "to_text": "60¢ a mile",
+                     *               "delta_text": "5¢ more a mile"
+                     *             },
+                     *             {
+                     *               "label": "Layover",
+                     *               "direction": "up",
+                     *               "from_text": "$100 a day",
+                     *               "to_text": "$125 a day",
+                     *               "delta_text": "$25 more a day"
+                     *             }
+                     *           ],
+                     *           "estimate": {
+                     *             "amount": 121,
+                     *             "text": "About $120 more a week at your usual miles",
+                     *             "calculation_text": "2,410 paid miles a week × 5¢ more a mile ≈ $121",
+                     *             "basis_text": "Based on your paid miles over the last 9 weeks"
+                     *           }
+                     *         },
+                     *         "later_steps": [
+                     *           {
+                     *             "kind": "raise",
+                     *             "plan_name": "Solo Driver IV",
+                     *             "starts_on": "2027-05-04",
+                     *             "starts_on_label": "May 4, 2027",
+                     *             "headline": "Raise to 63¢ a mile on May 4, 2027",
+                     *             "figure_text": "63¢ a mile"
+                     *           }
+                     *         ],
+                     *         "recent_raise": null,
+                     *         "history": [
+                     *           {
+                     *             "event_id": 1,
+                     *             "kind": "raise",
+                     *             "plan_name": "Solo Driver II",
+                     *             "started_on": "2026-05-19",
+                     *             "started_on_label": "May 19",
+                     *             "summary_text": "Raise to 55¢ a mile, up from 50¢ a mile"
+                     *           }
+                     *         ],
+                     *         "team_note": null
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description The pay plan the driver is on today; null when the driver has no pay plan. */
+                            current_plan?: {
+                                /** @description Name of the pay plan the driver is on today. */
+                                name: string;
+                                /**
+                                 * Format: date
+                                 * @description Date the driver started on this plan.
+                                 */
+                                since?: string | null;
+                                /** @description That date as people read it, such as "May 19". */
+                                since_label?: string | null;
+                                /** @description The plan's rates, base pay first; empty when the plan cannot be resolved today. */
+                                rates: {
+                                    /** @description What the rate pays for, such as "Miles" or "Stops". */
+                                    label: string;
+                                    /** @description The rate in plain words, such as "55¢ a mile" or "$25 a stop after the first". */
+                                    text: string;
+                                }[];
+                            } | null;
+                            /** @description The next pay step payroll will apply automatically; null when none is coming. */
+                            next_step?: {
+                                /** @description raise when at least one rate goes up or is added and none goes down, ends or changes; otherwise change. */
+                                kind: string;
+                                /** @description Name of the plan the driver moves to. */
+                                plan_name: string;
+                                /**
+                                 * Format: date
+                                 * @description Date the new plan starts; loads delivered on or after it pay the new rates.
+                                 */
+                                starts_on: string;
+                                /** @description That date as people read it, such as "Nov 3". */
+                                starts_on_label: string;
+                                /** @description Days from the driver's today to the start date; 0 when it starts today. */
+                                days_until: number;
+                                /** @description One sentence for the step, such as "Your raise to 60¢ a mile starts Nov 3" or "Your pay plan changes to Regional Dedicated on Nov 3". */
+                                headline: string;
+                                /** @description The new rate that stands for the step, base pay first, such as "60¢ a mile"; null when no rate is known. */
+                                figure_text?: string | null;
+                                /** @description Short form for a dashboard tile, such as "Raise to 60¢ a mile Nov 3" or "Plan changes Nov 3". */
+                                tile_text: string;
+                                /** @description When the new rates apply, or "Your rates stay the same." when nothing changes. */
+                                effective_note: string;
+                                /** @description Time served toward the step; null when the count has no start date. */
+                                progress?: {
+                                    /** @description Whole periods served so far, capped at total. */
+                                    elapsed: number;
+                                    /** @description Periods the rule requires. */
+                                    total: number;
+                                    /** @description Period unit: days, weeks or months. */
+                                    unit: string;
+                                    /** @description Progress in words, such as "18 of 24 weeks". */
+                                    text: string;
+                                    /** @description What the time is counted from and what happens at the end. */
+                                    anchor_text?: string | null;
+                                } | null;
+                                /** @description Rates that differ between today and the new plan; a change lists rates that go down or end first. Empty when the rates are the same or cannot be resolved. */
+                                changes: {
+                                    /** @description What the rate pays for, such as "Miles". */
+                                    label: string;
+                                    /** @description up, down, new (added), ends (removed) or changed (paid a different way). */
+                                    direction: string;
+                                    /** @description The rate today; null for a new rate. */
+                                    from_text?: string | null;
+                                    /** @description The rate on the new plan; null for a rate that ends. */
+                                    to_text?: string | null;
+                                    /** @description The difference, such as "5¢ more a mile", "New" or "Ends"; null when several parts of the rate change. */
+                                    delta_text?: string | null;
+                                }[];
+                                /** @description About how much more a week a per-mile raise pays at the driver's usual paid miles; null for other steps or with under four weeks of finalized pay. */
+                                estimate?: {
+                                    /** @description Estimated extra pay a week, in whole dollars. */
+                                    amount: number;
+                                    /** @description The estimate in words, rounded, such as "About $120 more a week at your usual miles". */
+                                    text: string;
+                                    /** @description How it was worked out, such as "2,410 paid miles a week × 5¢ more a mile ≈ $121". */
+                                    calculation_text: string;
+                                    /** @description Which pay it is based on, such as "Based on your paid miles over the last 12 weeks". */
+                                    basis_text: string;
+                                } | null;
+                            } | null;
+                            /** @description Up to three automatic steps after the next one, in order; stops at a step that needs office approval. */
+                            later_steps: {
+                                /** @description raise or change, as for next_step. */
+                                kind: string;
+                                /** @description Name of the plan the driver moves to. */
+                                plan_name: string;
+                                /**
+                                 * Format: date
+                                 * @description Projected start date.
+                                 */
+                                starts_on: string;
+                                /** @description That date as people read it, such as "May 4, 2027". */
+                                starts_on_label: string;
+                                /** @description One sentence for the step, such as "Raise to 63¢ a mile on May 4, 2027". */
+                                headline: string;
+                                /** @description The new rate that stands for the step; null when no rate is known. */
+                                figure_text?: string | null;
+                            }[];
+                            /** @description The newest pay step, when it was a raise that started in the last 30 days; else null. */
+                            recent_raise?: {
+                                /** @description Pay progression event id. */
+                                event_id: number;
+                                /** @description Name of the plan the raise moved the driver to. */
+                                plan_name: string;
+                                /**
+                                 * Format: date
+                                 * @description Date the raise started.
+                                 */
+                                started_on: string;
+                                /** @description That date as people read it, such as "Oct 20". */
+                                started_on_label: string;
+                                /** @description Such as "Your raise started Oct 20". */
+                                headline: string;
+                                /** @description The new rate, such as "60¢ a mile". */
+                                figure_text?: string | null;
+                                /** @description The old rate, such as "Up from 55¢ a mile"; null for a rate that is new. */
+                                from_figure_text?: string | null;
+                            } | null;
+                            /** @description Up to five pay steps already applied, newest first. */
+                            history: {
+                                /** @description Pay progression event id. */
+                                event_id: number;
+                                /** @description raise or change. */
+                                kind: string;
+                                /** @description Name of the plan the step moved the driver to. */
+                                plan_name: string;
+                                /**
+                                 * Format: date
+                                 * @description Date the step started.
+                                 */
+                                started_on: string;
+                                /** @description That date as people read it. */
+                                started_on_label: string;
+                                /** @description Such as "Raise to 55¢ a mile, up from 50¢ a mile" or "Pay plan changed to Regional Dedicated". */
+                                summary_text: string;
+                            }[];
+                            /** @description A note when the driver's plans pay team loads differently; null otherwise. */
+                            team_note?: string | null;
+                        };
+                    };
+                };
+            };
+            202: components["responses"]["Proposal"];
+            /** @description Refused: credits_exhausted. */
+            402: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: idempotency_conflict, stale_state. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: operation_retired. */
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: invalid_input, domain_rule. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: rate_limited. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+        };
+    };
     "ops.compensation_plans.progression_events.approve": {
         parameters: {
             query?: never;
@@ -30147,7 +30542,7 @@ export interface operations {
                      *           "period_end": "2026-06-30",
                      *           "pay_date": null
                      *         },
-                     *         "finalized_at": "2026-10-19T02:34:32+00:00",
+                     *         "finalized_at": "2026-10-25T21:01:10+00:00",
                      *         "section_order": [
                      *           "letterhead",
                      *           "meta",
@@ -30432,6 +30827,12 @@ export interface operations {
                      *           ]
                      *         },
                      *         "has_net_pay_detail": true,
+                     *         "breakdown": {
+                     *           "gross_pay": "500.00",
+                     *           "taxes": "50.00",
+                     *           "deductions": "10.00",
+                     *           "net_pay": "440.00"
+                     *         },
                      *         "pdf_url": null,
                      *         "pdf_expires_at": null
                      *       }
@@ -30463,6 +30864,17 @@ export interface operations {
                             pay_stub: Record<string, never>;
                             net_pay_footer: Record<string, never>;
                             has_net_pay_detail: boolean;
+                            /** @description Where the gross pay went, as numbers for a graphic; each amount matches its driver summary row. */
+                            breakdown: {
+                                /** @description Gross pay, the same amount as the Gross Pay summary row. */
+                                gross_pay?: string | null;
+                                /** @description Total taxes taken out; null without net pay detail. */
+                                taxes?: string | null;
+                                /** @description Total deductions taken out; null without net pay detail. */
+                                deductions?: string | null;
+                                /** @description Net pay; null without net pay detail. */
+                                net_pay?: string | null;
+                            };
                             pdf_url?: string | null;
                             /** Format: date-time */
                             pdf_expires_at?: string | null;
@@ -134894,7 +135306,7 @@ export interface operations {
             };
         };
     };
-    "ops.scorecards.bonus_previews": {
+    "ops.scorecards.bonus_history": {
         parameters: {
             query?: never;
             header?: {
@@ -134908,19 +135320,22 @@ export interface operations {
         };
         requestBody?: {
             content: {
-                /**
-                 * @example {
-                 *       "week_start": "2026-04-12"
-                 *     }
-                 */
+                /** @example {} */
                 "application/json": {
-                    /** @description Another driver to preview; default you. */
+                    /** @description Another driver or dispatcher to preview; default you. */
                     user_id?: number | null;
+                    /**
+                     * @description Whose scorecard: driver or dispatcher; default the person's portal, driver first.
+                     * @enum {string|null}
+                     */
+                    audience?: "driver" | "dispatcher" | null;
+                    /** @description How many weeks with bonus results, newest first; 1 to 26, default 8. */
+                    week_count?: number | null;
                     /**
                      * Format: date
-                     * @description Operational Sunday of the week (Y-m-d); default the current week.
+                     * @description Only weeks before this operational Sunday (Y-m-d), for the next page.
                      */
-                    week_start?: string | null;
+                    before_week_start?: string | null;
                 };
             };
         };
@@ -134934,35 +135349,483 @@ export interface operations {
                     /**
                      * @example {
                      *       "result": {
-                     *         "week_start": "2026-04-12",
-                     *         "iso_year": 2026,
-                     *         "iso_week": 16,
-                     *         "context_line": "Aligned to week starting 2026-04-12 (week ending 2026-04-18).",
-                     *         "has_weekly_snapshot": false,
-                     *         "previews": []
+                     *         "audience": "driver",
+                     *         "weeks": [
+                     *           {
+                     *             "week_start": "2026-10-11",
+                     *             "iso_year": 2026,
+                     *             "iso_week": 42,
+                     *             "week_label": "Oct 11 to 17, 2026",
+                     *             "total_amount": "40.85",
+                     *             "bonuses": [
+                     *               {
+                     *                 "scheme_id": 1,
+                     *                 "scheme_name": "Scorecard bonus",
+                     *                 "amount": "20.85",
+                     *                 "earned": true,
+                     *                 "pay_state": "on_statement",
+                     *                 "payroll_run_id": 1
+                     *               },
+                     *               {
+                     *                 "scheme_id": 2,
+                     *                 "scheme_name": "On-time arrival bonus",
+                     *                 "amount": "20.00",
+                     *                 "earned": true,
+                     *                 "pay_state": "pending",
+                     *                 "payroll_run_id": null
+                     *               }
+                     *             ]
+                     *           },
+                     *           {
+                     *             "week_start": "2026-10-04",
+                     *             "iso_year": 2026,
+                     *             "iso_week": 41,
+                     *             "week_label": "Oct 4 to 10, 2026",
+                     *             "total_amount": "0.00",
+                     *             "bonuses": [
+                     *               {
+                     *                 "scheme_id": 1,
+                     *                 "scheme_name": "Scorecard bonus",
+                     *                 "amount": "0.00",
+                     *                 "earned": false,
+                     *                 "pay_state": "none",
+                     *                 "payroll_run_id": null
+                     *               }
+                     *             ]
+                     *           },
+                     *           {
+                     *             "week_start": "2026-09-27",
+                     *             "iso_year": 2026,
+                     *             "iso_week": 40,
+                     *             "week_label": "Sep 27 to Oct 3, 2026",
+                     *             "total_amount": "35.00",
+                     *             "bonuses": [
+                     *               {
+                     *                 "scheme_id": 2,
+                     *                 "scheme_name": "On-time arrival bonus",
+                     *                 "amount": "20.00",
+                     *                 "earned": true,
+                     *                 "pay_state": "pending",
+                     *                 "payroll_run_id": null
+                     *               },
+                     *               {
+                     *                 "scheme_id": 1,
+                     *                 "scheme_name": "Scorecard bonus",
+                     *                 "amount": "15.00",
+                     *                 "earned": true,
+                     *                 "pay_state": "not_paid",
+                     *                 "payroll_run_id": null
+                     *               }
+                     *             ]
+                     *           }
+                     *         ],
+                     *         "total_amount": "75.85",
+                     *         "weeks_earned": 2,
+                     *         "next_before_week_start": null,
+                     *         "streak_weeks": 1,
+                     *         "streak_text": null,
+                     *         "year_label": "This year",
+                     *         "year_total_amount": "75.85"
                      *       }
                      *     }
                      */
                     "application/json": {
                         result: {
-                            /** Format: date */
-                            week_start?: string | null;
-                            iso_year?: number | null;
-                            iso_week?: number | null;
-                            context_line?: string | null;
-                            has_weekly_snapshot: boolean;
-                            previews: {
-                                scheme_id: number;
-                                scheme_name: string;
-                                scheme_slug?: string | null;
-                                mode: string;
-                                eligible: boolean;
-                                amount?: string | null;
-                                reason?: string | null;
-                                reason_display?: string | null;
-                                /** Format: date */
-                                week_end_date?: string | null;
+                            /** @description Whose scorecard the history is for: driver or dispatcher; null when the person holds neither portal. */
+                            audience?: string | null;
+                            /** @description Weeks with persisted bonus results, newest first. */
+                            weeks: {
+                                /**
+                                 * Format: date
+                                 * @description Operational Sunday that starts the week.
+                                 */
+                                week_start: string;
+                                /** @description ISO year of the week. */
+                                iso_year: number;
+                                /** @description ISO week number. */
+                                iso_week: number;
+                                /** @description The week as people read it, such as "Oct 11 to 17, 2026". */
+                                week_label: string;
+                                /** @description Bonus earned that week, in dollars. */
+                                total_amount: string;
+                                /** @description Bonus results this week, earned first. */
+                                bonuses: {
+                                    /** @description Bonus scheme id. */
+                                    scheme_id: number;
+                                    /** @description Bonus scheme name. */
+                                    scheme_name: string;
+                                    /** @description Amount earned, in dollars; 0.00 when not earned. */
+                                    amount: string;
+                                    /** @description True when the bonus paid more than $0. */
+                                    earned: boolean;
+                                    /** @description pending (waiting for payroll), on_statement (on a pay statement), not_paid (voided), outside_payroll (dispatcher bonuses, paid outside Axivoy payroll) or none (not earned). */
+                                    pay_state: string;
+                                    /** @description Payroll run whose compensation statement carries it, when on_statement. */
+                                    payroll_run_id?: number | null;
+                                }[];
                             }[];
+                            /** @description Bonus earned across the weeks on this page, in dollars. */
+                            total_amount: string;
+                            /** @description Weeks on this page with at least one earned bonus. */
+                            weeks_earned: number;
+                            /**
+                             * Format: date
+                             * @description Pass as before_week_start for the next page; null at the end.
+                             */
+                            next_before_week_start?: string | null;
+                            /** @description Final weeks in a row with an earned bonus, newest first, up to 26; null after the first page. */
+                            streak_weeks?: number | null;
+                            /** @description "4 weeks in a row" from two weeks up, "Start a new streak this week" when the latest week broke a streak of two or more, else null. */
+                            streak_text?: string | null;
+                            /** @description Label for the year total, such as "This year"; null after the first page. */
+                            year_label?: string | null;
+                            /** @description Bonus earned this ISO year, in dollars; null after the first page. */
+                            year_total_amount?: string | null;
+                        };
+                    };
+                };
+            };
+            202: components["responses"]["Proposal"];
+            /** @description Refused: credits_exhausted. */
+            402: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: idempotency_conflict, stale_state. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: operation_retired. */
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: invalid_input, domain_rule. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: rate_limited. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+        };
+    };
+    "ops.scorecards.bonus_previews": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
+                "Idempotency-Key"?: string;
+                /** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
+                "Axivoy-Dry-Run"?: "true" | "false";
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                /**
+                 * @example {
+                 *       "week_start": "2026-04-12"
+                 *     }
+                 */
+                "application/json": {
+                    /** @description Another driver or dispatcher to preview; default you. */
+                    user_id?: number | null;
+                    /**
+                     * @description Whose scorecard: driver or dispatcher; default the person's portal, driver first.
+                     * @enum {string|null}
+                     */
+                    audience?: "driver" | "dispatcher" | null;
+                    /**
+                     * Format: date
+                     * @description Operational Sunday of the week (Y-m-d); default the most recent week with scores.
+                     */
+                    week_start?: string | null;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "audience": "driver",
+                     *         "week_start": "2026-04-12",
+                     *         "iso_year": 2026,
+                     *         "iso_week": 16,
+                     *         "context_line": "Aligned to week starting 2026-04-12 (week ending 2026-04-18).",
+                     *         "has_weekly_snapshot": false,
+                     *         "week_state": "ended",
+                     *         "week_state_label": "Not final yet",
+                     *         "week_state_tone": "info",
+                     *         "week_label": "Apr 12 to 18, 2026",
+                     *         "total_amount": "0.00",
+                     *         "total_label": "$0 expected",
+                     *         "available_amount": "0.00",
+                     *         "summary": "No bonus this week",
+                     *         "previews": []
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            audience?: string | null;
+                            /** Format: date */
+                            week_start?: string | null;
+                            iso_year?: number | null;
+                            iso_week?: number | null;
+                            context_line?: string | null;
+                            has_weekly_snapshot: boolean;
+                            /** @description in_progress while the week is open, ended until it is final, final once frozen or locked. */
+                            week_state: string;
+                            week_state_label: string;
+                            week_state_tone: string;
+                            week_label?: string | null;
+                            /** @description Earned (final), expected (ended) or on track (open) this week, in dollars. */
+                            total_amount: string;
+                            /** @description The total in words, for example "$20 on track" or "New week". */
+                            total_label: string;
+                            /** @description Still open this week: the potential of bonuses not yet met and not out of reach. 0.00 once the week ends. */
+                            available_amount: string;
+                            /** @description One sentence under the total; names amounts. */
+                            summary: string;
+                            previews: {
+                                scheme_id: number;
+                                scheme_name: string;
+                                scheme_slug?: string | null;
+                                mode: string;
+                                eligible: boolean;
+                                amount?: string | null;
+                                reason?: string | null;
+                                /** @description Why, in words. */
+                                reason_display?: string | null;
+                                /** Format: date */
+                                week_end_date?: string | null;
+                                /** @description earned, on_track, expected, not_yet, not_earned, out_of_reach, waiting or unavailable. */
+                                standing?: string | null;
+                                standing_label?: string | null;
+                                standing_tone?: string | null;
+                                /** @description The scheme's portal description. */
+                                about?: string | null;
+                                headline?: string | null;
+                                /** @description What the bonus is worth this week; conditional, never pay. */
+                                potential_amount?: string | null;
+                                /** @description Bonus detail line: "Worth $X if ..." while open, "Was worth $X with all N targets met" once ended. */
+                                worth_text?: string | null;
+                                conditions_met?: number | null;
+                                conditions_total?: number | null;
+                                conditions?: {
+                                    label: string;
+                                    metric_slug?: string | null;
+                                    actual_display?: string | null;
+                                    target_text: string;
+                                    gap_text?: string | null;
+                                    met: boolean;
+                                    reachable: boolean;
+                                    /** @description all, or any for one choice of an any-of group. */
+                                    group: string;
+                                }[] | null;
+                                payout?: {
+                                    /** @description tiered, flat, per_unit or qualifying_week_cap. */
+                                    basis: string;
+                                    text: string;
+                                    metric_slug?: string | null;
+                                    calculation_text?: string | null;
+                                    tiers: {
+                                        label: string;
+                                        range_text?: string | null;
+                                        current: boolean;
+                                        amount: string;
+                                    }[];
+                                } | null;
+                            }[];
+                        };
+                    };
+                };
+            };
+            202: components["responses"]["Proposal"];
+            /** @description Refused: credits_exhausted. */
+            402: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: idempotency_conflict, stale_state. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: operation_retired. */
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: invalid_input, domain_rule. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: rate_limited. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+        };
+    };
+    "ops.scorecards.focus.set": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
+                "Idempotency-Key"?: string;
+                /** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
+                "Axivoy-Dry-Run"?: "true" | "false";
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                /**
+                 * @example {
+                 *       "metric_slug": "safety_score",
+                 *       "week_start": "2026-10-18"
+                 *     }
+                 */
+                "application/json": {
+                    /**
+                     * @description Whose scorecard: driver or dispatcher; default the person's portal, driver first.
+                     * @enum {string|null}
+                     */
+                    audience?: "driver" | "dispatcher" | null;
+                    /** @description A score on your scorecard this open week (a headline metric or a part); null or omitted clears the focus. */
+                    metric_slug?: string | null;
+                    /**
+                     * Format: date
+                     * @description The week the screen shows (Y-m-d operational Sunday); refused once it is no longer the current open week.
+                     */
+                    week_start?: string | null;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "audience": "driver",
+                     *         "week_start": "2026-10-18",
+                     *         "week_label": "Oct 18 to 24, 2026",
+                     *         "focus_pick": {
+                     *           "slug": "safety_score",
+                     *           "name": "Safety",
+                     *           "picked_at": "2026-10-21T15:00:00Z"
+                     *         }
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            audience: string;
+                            /** Format: date */
+                            week_start: string;
+                            week_label: string;
+                            /** @description The score you picked; null once cleared. */
+                            focus_pick?: {
+                                slug: string;
+                                name: string;
+                                /** Format: date-time */
+                                picked_at: string;
+                            } | null;
                         };
                     };
                 };
@@ -135053,11 +135916,16 @@ export interface operations {
                  *     }
                  */
                 "application/json": {
-                    /** @description Another driver to preview; default you. */
+                    /** @description Another driver or dispatcher to preview; default you. */
                     user_id?: number | null;
+                    /**
+                     * @description Whose scorecard: driver or dispatcher; default the person's portal, driver first.
+                     * @enum {string|null}
+                     */
+                    audience?: "driver" | "dispatcher" | null;
                     /**
                      * Format: date
-                     * @description Operational Sunday of the week (Y-m-d); default the current week.
+                     * @description Operational Sunday of the week (Y-m-d); default the most recent week with scores.
                      */
                     week_start?: string | null;
                 };
@@ -135073,6 +135941,7 @@ export interface operations {
                     /**
                      * @example {
                      *       "result": {
+                     *         "audience": "driver",
                      *         "week_start": "2026-04-12",
                      *         "iso_year": 2026,
                      *         "iso_week": 16,
@@ -135089,7 +135958,63 @@ export interface operations {
                      *             "prior_value": null,
                      *             "format": "decimal",
                      *             "decimals": 2,
-                     *             "direction": "higher_is_better"
+                     *             "direction": "higher_is_better",
+                     *             "value_display": "70.25",
+                     *             "hint": null,
+                     *             "band_palette": "blue",
+                     *             "band_position": 3,
+                     *             "band_count": 5,
+                     *             "needs_work": false,
+                     *             "tip": null,
+                     *             "change": null,
+                     *             "next_step": {
+                     *               "kind": "next_level",
+                     *               "text": "9.75 to go for Fantastic"
+                     *             },
+                     *             "bands": [
+                     *               {
+                     *                 "label": "Poor",
+                     *                 "palette": "red",
+                     *                 "range_text": "0 to 50",
+                     *                 "min": 0,
+                     *                 "max": 50,
+                     *                 "current": false
+                     *               },
+                     *               {
+                     *                 "label": "Fair",
+                     *                 "palette": "amber",
+                     *                 "range_text": "50 to 65",
+                     *                 "min": 50,
+                     *                 "max": 65,
+                     *                 "current": false
+                     *               },
+                     *               {
+                     *                 "label": "Great",
+                     *                 "palette": "blue",
+                     *                 "range_text": "65 to 80",
+                     *                 "min": 65,
+                     *                 "max": 80,
+                     *                 "current": true
+                     *               },
+                     *               {
+                     *                 "label": "Fantastic",
+                     *                 "palette": "green",
+                     *                 "range_text": "80 to 90",
+                     *                 "min": 80,
+                     *                 "max": 90,
+                     *                 "current": false
+                     *               },
+                     *               {
+                     *                 "label": "Fantastic Plus",
+                     *                 "palette": "violet",
+                     *                 "range_text": "90 or more",
+                     *                 "min": 90,
+                     *                 "max": null,
+                     *                 "current": false
+                     *               }
+                     *             ],
+                     *             "targets": [],
+                     *             "components_needing_work": null
                      *           },
                      *           {
                      *             "kind": "single",
@@ -135102,7 +136027,63 @@ export interface operations {
                      *             "prior_value": null,
                      *             "format": "decimal",
                      *             "decimals": 2,
-                     *             "direction": "higher_is_better"
+                     *             "direction": "higher_is_better",
+                     *             "value_display": "85.75",
+                     *             "hint": null,
+                     *             "band_palette": "green",
+                     *             "band_position": 4,
+                     *             "band_count": 5,
+                     *             "needs_work": false,
+                     *             "tip": null,
+                     *             "change": null,
+                     *             "next_step": {
+                     *               "kind": "next_level",
+                     *               "text": "4.25 to go for Fantastic Plus"
+                     *             },
+                     *             "bands": [
+                     *               {
+                     *                 "label": "Poor",
+                     *                 "palette": "red",
+                     *                 "range_text": "0 to 50",
+                     *                 "min": 0,
+                     *                 "max": 50,
+                     *                 "current": false
+                     *               },
+                     *               {
+                     *                 "label": "Fair",
+                     *                 "palette": "amber",
+                     *                 "range_text": "50 to 65",
+                     *                 "min": 50,
+                     *                 "max": 65,
+                     *                 "current": false
+                     *               },
+                     *               {
+                     *                 "label": "Great",
+                     *                 "palette": "blue",
+                     *                 "range_text": "65 to 80",
+                     *                 "min": 65,
+                     *                 "max": 80,
+                     *                 "current": false
+                     *               },
+                     *               {
+                     *                 "label": "Fantastic",
+                     *                 "palette": "green",
+                     *                 "range_text": "80 to 90",
+                     *                 "min": 80,
+                     *                 "max": 90,
+                     *                 "current": true
+                     *               },
+                     *               {
+                     *                 "label": "Fantastic Plus",
+                     *                 "palette": "violet",
+                     *                 "range_text": "90 or more",
+                     *                 "min": 90,
+                     *                 "max": null,
+                     *                 "current": false
+                     *               }
+                     *             ],
+                     *             "targets": [],
+                     *             "components_needing_work": null
                      *           },
                      *           {
                      *             "kind": "single",
@@ -135115,20 +136096,120 @@ export interface operations {
                      *             "prior_value": null,
                      *             "format": "decimal",
                      *             "decimals": 2,
-                     *             "direction": "higher_is_better"
+                     *             "direction": "higher_is_better",
+                     *             "value_display": "92.50",
+                     *             "hint": null,
+                     *             "band_palette": "violet",
+                     *             "band_position": 5,
+                     *             "band_count": 5,
+                     *             "needs_work": false,
+                     *             "tip": null,
+                     *             "change": null,
+                     *             "next_step": {
+                     *               "kind": "top_level",
+                     *               "text": "Top level"
+                     *             },
+                     *             "bands": [
+                     *               {
+                     *                 "label": "Poor",
+                     *                 "palette": "red",
+                     *                 "range_text": "0 to 50",
+                     *                 "min": 0,
+                     *                 "max": 50,
+                     *                 "current": false
+                     *               },
+                     *               {
+                     *                 "label": "Fair",
+                     *                 "palette": "amber",
+                     *                 "range_text": "50 to 65",
+                     *                 "min": 50,
+                     *                 "max": 65,
+                     *                 "current": false
+                     *               },
+                     *               {
+                     *                 "label": "Great",
+                     *                 "palette": "blue",
+                     *                 "range_text": "65 to 80",
+                     *                 "min": 65,
+                     *                 "max": 80,
+                     *                 "current": false
+                     *               },
+                     *               {
+                     *                 "label": "Fantastic",
+                     *                 "palette": "green",
+                     *                 "range_text": "80 to 90",
+                     *                 "min": 80,
+                     *                 "max": 90,
+                     *                 "current": false
+                     *               },
+                     *               {
+                     *                 "label": "Fantastic Plus",
+                     *                 "palette": "violet",
+                     *                 "range_text": "90 or more",
+                     *                 "min": 90,
+                     *                 "max": null,
+                     *                 "current": true
+                     *               }
+                     *             ],
+                     *             "targets": [],
+                     *             "components_needing_work": null
                      *           }
-                     *         ]
+                     *         ],
+                     *         "week_state": "ended",
+                     *         "week_state_label": "Not final yet",
+                     *         "week_state_tone": "info",
+                     *         "week_label": "Apr 12 to 18, 2026",
+                     *         "focus": [],
+                     *         "wins": []
                      *       }
                      *     }
                      */
                     "application/json": {
                         result: {
+                            audience?: string | null;
                             /** Format: date */
                             week_start?: string | null;
                             iso_year?: number | null;
                             iso_week?: number | null;
                             /** Format: date */
                             week_end?: string | null;
+                            /** @description in_progress while the week is open, ended until it is final, final once frozen or locked. */
+                            week_state: string;
+                            week_state_label: string;
+                            week_state_tone: string;
+                            /** @description The week in words, for example "Oct 11 to 17, 2026". */
+                            week_label?: string | null;
+                            /** @description What to work on: at most three items, the person's focus pick first, then the bonus closest to paying. Never names an amount. */
+                            focus: {
+                                slug: string;
+                                name: string;
+                                /** @description bonus_target or needs_work. */
+                                kind: string;
+                                text: string;
+                                gap_text?: string | null;
+                                tip?: string | null;
+                                scheme_id?: number | null;
+                                component_slugs: unknown[];
+                                /** @description The person's weekly focus pick ("Your focus"). */
+                                picked: boolean;
+                            }[];
+                            /** @description Wins this week: at most three, from this week and the week before. */
+                            wins: {
+                                slug: string;
+                                name: string;
+                                /** @description focus_improved, target_met, level_up or top_level_held. */
+                                kind: string;
+                                text: string;
+                            }[];
+                            /** @description The score the person picked to focus on this week; null when none. */
+                            focus_pick?: {
+                                slug: string;
+                                name: string;
+                                /** Format: date-time */
+                                picked_at: string;
+                                /** @description How the focus went, once the week has ended; null while it is open. */
+                                result_text?: string | null;
+                            } | null;
                             metrics: {
                                 kind: string;
                                 slug: string;
@@ -135141,7 +136222,108 @@ export interface operations {
                                 format?: string | null;
                                 decimals?: number | null;
                                 direction?: string | null;
-                                components?: unknown[] | null;
+                                /** @description The value in the metric's format, or "No score". */
+                                value_display: string;
+                                hint?: string | null;
+                                /** @description red, amber, green, blue, violet or gray. */
+                                band_palette?: string | null;
+                                /** @description Level from the worst, 1-based. */
+                                band_position?: number | null;
+                                band_count?: number | null;
+                                needs_work: boolean;
+                                tip?: string | null;
+                                change?: {
+                                    direction: string;
+                                    better?: boolean | null;
+                                    text: string;
+                                } | null;
+                                next_step?: {
+                                    /** @description bonus_target, next_level or top_level. */
+                                    kind: string;
+                                    text: string;
+                                } | null;
+                                /** @description Score levels, worst first. */
+                                bands: {
+                                    label: string;
+                                    palette: string;
+                                    range_text: string;
+                                    min?: number | null;
+                                    max?: number | null;
+                                    current: boolean;
+                                }[];
+                                /** @description Bonus targets on this score. */
+                                targets: {
+                                    scheme_id: number;
+                                    scheme_name: string;
+                                    text: string;
+                                    gap_text?: string | null;
+                                    met: boolean;
+                                    reachable: boolean;
+                                }[];
+                                /** @description On a composite: its parts in the bottom half of their ladders. */
+                                components_needing_work?: {
+                                    count: number;
+                                    total: number;
+                                    text: string;
+                                    slugs: unknown[];
+                                } | null;
+                                components?: {
+                                    slug: string;
+                                    name: string;
+                                    value?: number | null;
+                                    band_slug?: string | null;
+                                    band_label?: string | null;
+                                    band_color?: string | null;
+                                    prior_value?: number | null;
+                                    format?: string | null;
+                                    decimals?: number | null;
+                                    direction?: string | null;
+                                    /** @description The value in the metric's format, or "No score". */
+                                    value_display: string;
+                                    hint?: string | null;
+                                    /** @description red, amber, green, blue, violet or gray. */
+                                    band_palette?: string | null;
+                                    /** @description Level from the worst, 1-based. */
+                                    band_position?: number | null;
+                                    band_count?: number | null;
+                                    needs_work: boolean;
+                                    tip?: string | null;
+                                    change?: {
+                                        direction: string;
+                                        better?: boolean | null;
+                                        text: string;
+                                    } | null;
+                                    next_step?: {
+                                        /** @description bonus_target, next_level or top_level. */
+                                        kind: string;
+                                        text: string;
+                                    } | null;
+                                    /** @description Score levels, worst first. */
+                                    bands: {
+                                        label: string;
+                                        palette: string;
+                                        range_text: string;
+                                        min?: number | null;
+                                        max?: number | null;
+                                        current: boolean;
+                                    }[];
+                                    /** @description Bonus targets on this score. */
+                                    targets: {
+                                        scheme_id: number;
+                                        scheme_name: string;
+                                        text: string;
+                                        gap_text?: string | null;
+                                        met: boolean;
+                                        reachable: boolean;
+                                    }[];
+                                    /** @description On a composite: its parts in the bottom half of their ladders. */
+                                    components_needing_work?: {
+                                        count: number;
+                                        total: number;
+                                        text: string;
+                                        slugs: unknown[];
+                                    } | null;
+                                }[] | null;
                             }[];
                         };
                     };
@@ -135233,11 +136415,16 @@ export interface operations {
                  *     }
                  */
                 "application/json": {
-                    /** @description Another driver to preview; default you. */
+                    /** @description Another driver or dispatcher to preview; default you. */
                     user_id?: number | null;
+                    /**
+                     * @description Whose scorecard: driver or dispatcher; default the person's portal, driver first.
+                     * @enum {string|null}
+                     */
+                    audience?: "driver" | "dispatcher" | null;
                     /**
                      * Format: date
-                     * @description Operational Sunday of the week (Y-m-d); default the current week.
+                     * @description Operational Sunday of the week (Y-m-d); default the most recent week with scores.
                      */
                     week_start?: string | null;
                     /** @description Metric slug; default all. */
@@ -135309,6 +136496,7 @@ export interface operations {
                      */
                     "application/json": {
                         result: {
+                            audience?: string | null;
                             /** Format: date */
                             week_start?: string | null;
                             iso_year?: number | null;