@axivoy/api 1.62.0 → 1.65.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;
@@ -17988,7 +18010,7 @@ export interface paths {
         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.
+         * @description Lets one of the company's phone numbers send and receive texts under the company's approved texting registration. When carriers have approved the company and Axivoy is waiting for a number, this number becomes the texting number. 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}}`.
          */
@@ -136906,6 +136928,8 @@ export interface operations {
                             contact_name?: string | null;
                             /** @description Authorized contact title */
                             contact_title?: string | null;
+                            /** @description Authorized contact position: Director, GM, VP, CEO, CFO, General Counsel or Other */
+                            contact_job_position?: string | null;
                             /** @description Authorized contact email */
                             contact_email?: string | null;
                             /** @description Authorized contact phone (E.164) */
@@ -140676,7 +140700,9 @@ export interface operations {
                      *         "status": "brand_pending",
                      *         "status_label": "Brand review pending",
                      *         "sending_number": null,
-                     *         "submitted_at": "2026-10-24T07:05:06Z",
+                     *         "requested_number": null,
+                     *         "number_needed": false,
+                     *         "submitted_at": "2026-10-25T01:30:45Z",
                      *         "approved_at": null,
                      *         "rejection_reason": null,
                      *         "steps": [
@@ -140736,6 +140762,10 @@ export interface operations {
                             status_label?: string | null;
                             /** @description The number texts are sent from (E.164) */
                             sending_number?: string | null;
+                            /** @description The company number texting will use once carriers approve (E.164) */
+                            requested_number?: string | null;
+                            /** @description Whether carriers approved the company and Axivoy is waiting for it to choose a number to text from */
+                            number_needed: boolean;
                             /**
                              * Format: date-time
                              * @description When it was sent to carriers
@@ -152850,17 +152880,25 @@ 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",
+                     *             "texting_requested": false,
+                     *             "handed_over_until": null,
                      *             "deleted": null
                      *           }
                      *         ],
@@ -152894,8 +152932,22 @@ export interface operations {
                                 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) */
+                                /** @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, needs_changes (carriers refused a step), number_needed (approved, waiting for the company to choose a number) or active (the same on every number) */
                                 texting_registration: string;
+                                /** @description Whether this is the number the texting registration will text from once carriers approve */
+                                texting_requested: boolean;
                                 /**
                                  * Format: date-time
                                  * @description Set when the number moved to Axivoy: it is read-only and texts to it reach the company until then
@@ -153105,6 +153157,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.62.0",
+  "version": "1.65.0",
   "description": "Typed client for the Axivoy API: operations, webhooks and errors.",
   "license": "MIT",
   "homepage": "https://app.axivoy.ai/developers",