@axivoy/api 1.49.0 → 1.55.0

package/dist/generated/schema.d.ts

@@ -17812,7 +17812,7 @@ export interface paths {
         put?: never;
         /**
          * Turn on calls for a phone number
-         * @description Sends calls for one of the company's phone numbers to Axivoy. A number at another provider is marked as needing manual setup.
+         * @description Sends calls for one of the company's phone numbers to Axivoy. A number at another provider is marked as needing manual setup. A number whose calls go somewhere else today needs replace_elsewhere.
          *
          *     Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
          */
@@ -17834,7 +17834,7 @@ export interface paths {
         put?: never;
         /**
          * Phone numbers
-         * @description The company's phone numbers for calls, with where each came from (texting number, rented, transferred in, added manually), its status and whether it is the main number callers see.
+         * @description The company's phone numbers, with where each came from (texting number, rented, transferred in, added manually), its status, what happens to calls and texts to it, and whether it is the main number callers see.
          *
          *     Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
          */
@@ -17878,7 +17878,7 @@ export interface paths {
         put?: never;
         /**
          * Set the main phone number
-         * @description Makes an active phone number the main number, the one people see when the company calls them from Axivoy.
+         * @description Makes an active phone number the main number, the one people see when the company calls them from Axivoy. When its texts are on, new texts go from it too.
          *
          *     Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
          */
@@ -17889,6 +17889,50 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/ops/voice.numbers.texting.disable": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Turn off texting for a phone number
+         * @description Stops texts going out from one of the company's phone numbers. Texts to it still reach the Inbox, and replies go from the main texting number. Refused for the main texting number; make another texting number main first.
+         *
+         *     Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.voice.numbers.texting.disable"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/ops/voice.numbers.texting.enable": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Turn on texting for a phone number
+         * @description Lets one of the company's phone numbers send and receive texts under the company's approved texting registration. Refused while the registration is not active, when the number is in another calling account, or when the registration is at its number limit.
+         *
+         *     Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.voice.numbers.texting.enable"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/ops/voice.port_in.cancel": {
         parameters: {
             query?: never;
@@ -53199,9 +53243,25 @@ export interface operations {
                                     eta_at?: string | null;
                                     /** @description Road time to the stop. */
                                     road_seconds?: number | null;
-                                    /** @description Hours left at arrival; negative when he runs out first. */
+                                    /**
+                                     * Format: date-time
+                                     * @description The arrival the margin is judged from. When drive, shift and week left at departure each cover road_seconds: the Live ETA while live, else departure (now, or ready_at while he rests) plus road time. Otherwise the earliest legal arrival with every reset, 34-hour restart and 30-minute break the road needs (an estimate, never his hours). Null without road time, while Stale or Off route, on site, or with no plan (unknown ruleset, or the week runs out with no restart).
+                                     */
+                                    projected_at?: string | null;
+                                    /** @description The rests in projected_at, set only when it plans a reset or restart. Conservative: no split sleeper, no hours back after midnight, no exemptions. */
+                                    rests_on_the_way?: {
+                                        /** @description Full resets (10-hour property, 8-hour passenger) planned before the stop. */
+                                        resets: number;
+                                        /** @description 30-minute breaks planned before the stop. */
+                                        breaks: number;
+                                        /** @description A 34-hour restart is planned before the stop. */
+                                        restart: boolean;
+                                        /** @description The smallest of drive, shift and week left at arrival after those rests. */
+                                        clock_left_after_rests_seconds: number;
+                                    } | null;
+                                    /** @description Hours left at arrival without a reset; negative when he runs out first. */
                                     clock_left_seconds?: number | null;
-                                    /** @description Stopped while his limiting clock still runs. */
+                                    /** @description Stopped while his limiting clock still runs and he is not resting toward a ready time (clock_left_seconds then counts from after that rest and holds still). */
                                     clock_dropping: boolean;
                                     /** @description appointment, window or none. */
                                     appointment_kind: string;
@@ -53210,9 +53270,9 @@ export interface operations {
                                      * @description The instant the on-time rule judges against.
                                      */
                                     expected_at?: string | null;
-                                    /** @description Projected arrival minus expected_at in minutes; negative is early. */
+                                    /** @description projected_at minus expected_at in minutes; negative is early. */
                                     minutes_vs_appointment?: number | null;
-                                    /** @description early, on_time or late; null without an appointment or a trustworthy arrival. */
+                                    /** @description early, on_time or late, judged from projected_at; null without an appointment or a projected_at. */
                                     on_time?: string | null;
                                     /** @description Split sleeper suggestion, set only when the tenant setting is on and he is at risk of being late. A suggestion to talk through with the driver; he decides when he rests. */
                                     split_plan?: {
@@ -53243,7 +53303,7 @@ export interface operations {
                                         rest_after_stop_minutes?: number | null;
                                         /**
                                          * Format: date-time
-                                         * @description Arrival without a split (with a full reset where his clock ends).
+                                         * @description Arrival without a split: projected_at, with every rest the road needs.
                                          */
                                         full_reset_arrives_at?: string | null;
                                         /** @description no_plan (no split arrives on time) or hours_not_confirmed (Axivoy's replay of his hours does not match the ELD's, or has not checked the latest snapshot). */
@@ -53253,6 +53313,13 @@ export interface operations {
                                         /** @description Axivoy minus the ELD for that figure. */
                                         unconfirmed_difference_seconds?: number | null;
                                     } | null;
+                                    /**
+                                     * Format: date-time
+                                     * @description On site: when he arrived at the stop. Null otherwise, or before the stop records an arrival.
+                                     */
+                                    arrived_at?: string | null;
+                                    /** @description On site: arrived_at minus expected_at in minutes, judged by the on-time rule with the tenant grace; negative is early. Null without an appointment or arrived_at. */
+                                    arrived_minutes_vs_appointment?: number | null;
                                 } | null;
                                 /** @description True on a tombstone (the row was deleted or recycled); other fields are absent. */
                                 deleted?: boolean | null;
@@ -151939,6 +152006,8 @@ export interface operations {
                 "application/json": {
                     /** @description The phone number (from voice.numbers.list) */
                     number_id: number;
+                    /** @description True replaces call handling set up outside Axivoy (the number's calls go to another host today); default false */
+                    replace_elsewhere?: boolean | null;
                 };
             };
         };
@@ -152077,11 +152146,17 @@ export interface operations {
                      *         "items": [
                      *           {
                      *             "id": 1,
-                     *             "number": "+13125551505",
+                     *             "number": "+13125558041",
                      *             "source": "sms_registration",
                      *             "status": "calls_off",
                      *             "status_label": "Calls not turned on",
                      *             "is_main": false,
+                     *             "calls": "off",
+                     *             "calls_elsewhere_host": null,
+                     *             "texts": "needs_registration",
+                     *             "texting_error": null,
+                     *             "is_main_texting_number": false,
+                     *             "texting_registration": "none",
                      *             "deleted": null
                      *           }
                      *         ],
@@ -152105,6 +152180,18 @@ export interface operations {
                                 status_label: string;
                                 /** @description Whether calls from Axivoy show this number */
                                 is_main: boolean;
+                                /** @description What Axivoy does with calls to it: on, off, needs_setup or elsewhere */
+                                calls: string;
+                                /** @description Where its calls go today when calls is elsewhere (host only) */
+                                calls_elsewhere_host?: string | null;
+                                /** @description What Axivoy does with texts: on, failed, needs_registration, receive_only (texts reach the Inbox, replies go from the main number) or not_connected */
+                                texts: string;
+                                /** @description Why turning on texting failed, when texts is failed */
+                                texting_error?: string | null;
+                                /** @description Whether new texts go from this number */
+                                is_main_texting_number: boolean;
+                                /** @description The company's texting registration: none, in_progress or active (the same on every number) */
+                                texting_registration: string;
                                 /** @description True on a tombstone (the row was deleted or recycled); other fields are absent. */
                                 deleted?: boolean | null;
                             }[];
@@ -152325,7 +152412,7 @@ export interface operations {
             content: {
                 /**
                  * @example {
-                 *       "number_id": 1
+                 *       "number_id": 2
                  *     }
                  */
                 "application/json": {
@@ -152344,9 +152431,10 @@ export interface operations {
                     /**
                      * @example {
                      *       "result": {
-                     *         "number_id": 1,
+                     *         "number_id": 2,
                      *         "is_main": true,
-                     *         "message": "(312) 555-1505 is now the main number."
+                     *         "texts_from_this_number": true,
+                     *         "message": "(312) 555-0141 is now the main number. New texts go from this number."
                      *       }
                      *     }
                      */
@@ -152356,6 +152444,246 @@ export interface operations {
                             number_id: number;
                             /** @description Always true on success */
                             is_main: boolean;
+                            /** @description Whether new texts now go from this number (true only when its texts are on) */
+                            texts_from_this_number: boolean;
+                            /** @description What happened, in the operator's words */
+                            message: string;
+                        };
+                    };
+                };
+            };
+            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.voice.numbers.texting.disable": {
+        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 {
+                 *       "number_id": 2
+                 *     }
+                 */
+                "application/json": {
+                    /** @description The phone number (from voice.numbers.list) */
+                    number_id: number;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "number_id": 2,
+                     *         "texts": "receive_only",
+                     *         "message": "Texts from (312) 555-0141 stopped. Texts to it still reach your Inbox; replies go from your main number."
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description The phone number */
+                            number_id: number;
+                            /** @description The number's texts state after the change: on, failed, needs_registration, receive_only or not_connected */
+                            texts: string;
+                            /** @description What happened, in the operator's words */
+                            message: string;
+                        };
+                    };
+                };
+            };
+            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.voice.numbers.texting.enable": {
+        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 {
+                 *       "number_id": 2
+                 *     }
+                 */
+                "application/json": {
+                    /** @description The phone number (from voice.numbers.list) */
+                    number_id: number;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "number_id": 2,
+                     *         "texts": "on",
+                     *         "message": "Texts on for (312) 555-0141."
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description The phone number */
+                            number_id: number;
+                            /** @description The number's texts state after the change: on, failed, needs_registration, receive_only or not_connected */
+                            texts: string;
                             /** @description What happened, in the operator's words */
                             message: string;
                         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axivoy/api",
-  "version": "1.49.0",
+  "version": "1.55.0",
   "description": "Typed client for the Axivoy API: operations, webhooks and errors.",
   "license": "MIT",
   "homepage": "https://app.axivoy.ai/developers",