@axivoy/api 1.61.0 → 1.63.0

package/dist/generated/schema.d.ts

@@ -17856,7 +17856,7 @@ export interface paths {
         put?: never;
         /**
          * Use a phone menu on a number
-         * @description Chooses the phone menu a company number answers with, the built-in Axivoy carrier main line (builtin_key), or none to ring everyone available and then take a voicemail. The menu must be published. Refused while the number is moving to another provider.
+         * @description Chooses the phone menu a company number answers with, the built-in Axivoy carrier main line (builtin_key), or none to ring everyone available and then take a voicemail. Assigning a menu or none also stops forwarding. The menu must be published. Refused while the number is moving to another provider.
          *
          *     Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
          */
@@ -17933,6 +17933,28 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/ops/voice.numbers.set_call_handling": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Choose what happens when someone calls a number
+         * @description Chooses how one of the company's phone numbers answers calls: ring the team (everyone available, then their mobiles, then voicemail), a phone menu (menu_id or builtin_key), or forward to an outside US or Canada number (forward_to, ring_seconds, show_company_number) with voicemail if nobody answers. Turns on calls for the number when they are off; a number whose calls go somewhere else today needs replace_elsewhere.
+         *
+         *     Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.voice.numbers.set_call_handling"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/ops/voice.numbers.set_default": {
         parameters: {
             query?: never;
@@ -53417,7 +53439,7 @@ export interface operations {
                                     /** @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 Does he make every stop left on this trip? Set for a driver with live clocks and a Live ETA on an in-progress load, while the outlook is for that load and next stop. An estimate from his ELD clocks and the route, not his hours: 2 hours at each stop, rests as soon as his hours run out. */
+                                /** @description Does he make every stop left on this trip? Set for a driver with live clocks and a Live ETA on an in-progress load, while the outlook is for that load and next stop. An estimate from his ELD clocks and the route, not his hours: 2 hours at each stop, rests as soon as his hours run out, and a wait for a scheduled start of a full reset or more (10 hours; 8 passenger; on site, with the rest he is already in) is that reset. */
                                 trip_outlook?: {
                                     /**
                                      * Format: date-time
@@ -53472,13 +53494,13 @@ export interface operations {
                                     }[];
                                     /** @description Set while the verdict is late: the ways to make every stop, best first (the larger smallest margin, then fewer added rest hours), at most one per kind, a split last; empty when no single change does; null until searched. A split only while the tenant has split sleeper suggestions on and Axivoy's replay of his hours matches the ELD. A suggestion to talk through with the driver; he decides when he rests. */
                                     ways?: {
-                                        /** @description longer_rest (hold one full reset or 34-hour restart until rest_until), rest_at_stop (log the wait for stop_id's scheduled start Off duty or Sleeper, a full reset) or split (a split sleeper pair across the trip, in steps). */
+                                        /** @description longer_rest (hold one full reset or 34-hour restart until rest_until) or split (a split sleeper pair across the trip, in steps). A reset during a long wait at a stop is not a way: the outlook already counts it. */
                                         kind: string;
-                                        /** @description reset or restart: the rest held longer; reset for rest_at_stop; split for split. */
+                                        /** @description reset or restart: the rest held longer; split for split. */
                                         rest_kind: string;
                                         /** @description longer_rest: the rest held is the one he is in now. split: the first period is the rest he is in now, held longer. */
                                         resting_now: boolean;
-                                        /** @description longer_rest: the first stop after the rest held. rest_at_stop: the stop he waits at. split: the stop at or before which the first period falls. */
+                                        /** @description longer_rest: the first stop after the rest held. split: the stop at or before which the first period falls. */
                                         stop_id: number;
                                         /**
                                          * Format: date-time
@@ -53487,22 +53509,22 @@ export interface operations {
                                         rest_starts_at?: string | null;
                                         /**
                                          * Format: date-time
-                                         * @description longer_rest: when the rest would end without the change. Null for rest_at_stop and split.
+                                         * @description longer_rest: when the rest would end without the change. Null for split.
                                          */
                                         rest_planned_until?: string | null;
                                         /**
                                          * Format: date-time
-                                         * @description longer_rest: the suggested end, the middle of the range that works, on 15 minutes. rest_at_stop: when the stop's work starts. split: when the second period ends.
+                                         * @description longer_rest: the suggested end, the middle of the range that works, on 15 minutes. split: when the second period ends.
                                          */
                                         rest_until: string;
                                         /**
                                          * Format: date-time
-                                         * @description longer_rest: the earliest end that makes every stop. Null for rest_at_stop and split.
+                                         * @description longer_rest: the earliest end that makes every stop. Null for split.
                                          */
                                         rest_until_earliest?: string | null;
                                         /**
                                          * Format: date-time
-                                         * @description longer_rest: the latest end that makes every stop. Null for rest_at_stop and split.
+                                         * @description longer_rest: the latest end that makes every stop. Null for split.
                                          */
                                         rest_until_latest?: string | null;
                                         /** @description The stops the change moves, in route order. */
@@ -152850,17 +152872,24 @@ export interface operations {
                      *         "items": [
                      *           {
                      *             "id": 1,
-                     *             "number": "+13125558041",
-                     *             "source": "sms_registration",
-                     *             "status": "calls_off",
-                     *             "status_label": "Calls not turned on",
+                     *             "number": "+13125550150",
+                     *             "source": "rented",
+                     *             "status": "active",
+                     *             "status_label": "Active",
                      *             "is_main": false,
-                     *             "calls": "off",
+                     *             "calls": "on",
                      *             "calls_elsewhere_host": null,
                      *             "texts": "needs_registration",
                      *             "texting_error": null,
                      *             "is_main_texting_number": false,
+                     *             "answers_with": "forward",
+                     *             "menu_id": null,
+                     *             "menu_name": null,
+                     *             "forward_to": "+18325550101",
+                     *             "forward_ring_seconds": 30,
+                     *             "forward_shows_company_number": true,
                      *             "texting_registration": "none",
+                     *             "handed_over_until": null,
                      *             "deleted": null
                      *           }
                      *         ],
@@ -152894,6 +152923,18 @@ export interface operations {
                                 texting_error?: string | null;
                                 /** @description Whether new texts go from this number */
                                 is_main_texting_number: boolean;
+                                /** @description How the number answers calls: team (rings everyone available, then voicemail), menu or forward */
+                                answers_with: string;
+                                /** @description The phone menu it answers with, when answers_with is menu */
+                                menu_id?: number | null;
+                                /** @description That phone menu's name */
+                                menu_name?: string | null;
+                                /** @description The outside number calls forward to (+1 format), when answers_with is forward */
+                                forward_to?: string | null;
+                                /** @description How long the forwarded phone rings before voicemail, when answers_with is forward */
+                                forward_ring_seconds?: number | null;
+                                /** @description Whether the forwarded phone sees the company number instead of the caller's */
+                                forward_shows_company_number: boolean;
                                 /** @description The company's texting registration: none, in_progress or active (the same on every number) */
                                 texting_registration: string;
                                 /**
@@ -153105,6 +153146,155 @@ export interface operations {
             };
         };
     };
+    "ops.voice.numbers.set_call_handling": {
+        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": 1,
+                 *       "answer_with": "forward",
+                 *       "forward_to": "(832) 555-0101",
+                 *       "ring_seconds": 30,
+                 *       "show_company_number": true
+                 *     }
+                 */
+                "application/json": {
+                    /** @description The phone number (from voice.numbers.list) */
+                    number_id: number;
+                    /**
+                     * @description How the number answers calls
+                     * @enum {string}
+                     */
+                    answer_with: "team" | "menu" | "forward";
+                    /** @description The phone menu, when answer_with is menu (or builtin_key) */
+                    menu_id?: number | null;
+                    /**
+                     * @description A built-in Axivoy menu, when answer_with is menu (or menu_id)
+                     * @enum {string|null}
+                     */
+                    builtin_key?: "carrier_main_line" | null;
+                    /** @description US or Canada number calls forward to; required when answer_with is forward */
+                    forward_to?: string | null;
+                    /** @description How long the forwarded phone rings before voicemail, 10 to 60; default 20 */
+                    ring_seconds?: number | null;
+                    /** @description True shows the company number to the forwarded phone instead of the caller's; default false */
+                    show_company_number?: boolean | null;
+                    /** @description True replaces call handling set up outside Axivoy; required when the number's calls go to another host today */
+                    replace_elsewhere?: boolean | null;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "number_id": 1,
+                     *         "answers_with": "forward",
+                     *         "calls": "on",
+                     *         "calls_turned_on": false,
+                     *         "message": "Calls to (312) 555-0150 now forward to (832) 555-0101."
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description The phone number */
+                            number_id: number;
+                            /** @description How it answers calls now: team, menu or forward */
+                            answers_with: string;
+                            /** @description What Axivoy does with calls to it now: on, or needs_setup for a number at another provider */
+                            calls: string;
+                            /** @description Whether calls were turned on for the number by this change */
+                            calls_turned_on: 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.set_default": {
         parameters: {
             query?: never;

package/package.json

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