telnyx 7.19.0 → 7.20.0

package/resources/sip-registration-status.d.ts

@@ -1,142 +0,0 @@
-import { APIResource } from "../core/resource.js";
-import { APIPromise } from "../core/api-promise.js";
-import { RequestOptions } from "../internal/request-options.js";
-/**
- * UAC connection operations
- */
-export declare class SipRegistrationStatus extends APIResource {
-    /**
-     * Returns the live SIP registration status for a Telnyx endpoint: whether it is
-     * currently registered, when the current registration expires, and the last
-     * response Telnyx received from the registrar.
-     *
-     * The endpoint supports three credential types, selected with the
-     * `credential_type` query parameter. Each type is keyed by a different identifier:
-     *
-     * | `credential_type`           | Keyed by        | Use case                                                                   |
-     * | --------------------------- | --------------- | -------------------------------------------------------------------------- |
-     * | `uac_external_credential`   | `connection_id` | A UAC (SIP attach) connection that registers to an external PBX.           |
-     * | `telephony_credential`      | `username`      | An ephemeral, one-time-use telephony credential.                           |
-     * | `sip_credential_connection` | `username`      | A traditional SIP credential connection that registers directly to Telnyx. |
-     *
-     * The authenticated account is taken from your API key; you can only read the
-     * registration status of connections and credentials your account owns.
-     */
-    retrieve(query: SipRegistrationStatusRetrieveParams, options?: RequestOptions): APIPromise<SipRegistrationStatusRetrieveResponse>;
-}
-export interface SipRegistrationStatusRetrieveResponse {
-    /**
-     * Identifier of the connection associated with the credential.
-     */
-    connection_id?: string;
-    /**
-     * Human-readable connection name.
-     */
-    connection_name?: string;
-    /**
-     * The credential type that was looked up.
-     */
-    credential_type?: 'uac_external_credential' | 'telephony_credential' | 'sip_credential_connection';
-    /**
-     * SIP username used for the registration.
-     */
-    credential_username?: string;
-    /**
-     * SIP response from the last registration attempt.
-     */
-    last_registration_response?: string | null;
-    /**
-     * True if the endpoint is currently registered.
-     */
-    registered?: boolean;
-    /**
-     * Detailed registration information reported by the registrar. The populated
-     * fields depend on `credential_type`: UAC external credentials report
-     * `auth_retries`, `uptime`, `next_action_at`, `failures`, and `sip_uri_user_host`;
-     * telephony credentials and SIP credential connections report `ua_ip`, `ua_port`,
-     * `transport`, and `last_modified`. All types report `expires`.
-     */
-    sip_registration_details?: SipRegistrationStatusRetrieveResponse.SipRegistrationDetails;
-    /**
-     * Human-readable registration status derived from the registrar state.
-     */
-    sip_registration_status?: 'unregistering' | 'connection_disabled' | 'standby' | 'failed' | 'trying' | 'registered' | 'unknown';
-}
-export declare namespace SipRegistrationStatusRetrieveResponse {
-    /**
-     * Detailed registration information reported by the registrar. The populated
-     * fields depend on `credential_type`: UAC external credentials report
-     * `auth_retries`, `uptime`, `next_action_at`, `failures`, and `sip_uri_user_host`;
-     * telephony credentials and SIP credential connections report `ua_ip`, `ua_port`,
-     * `transport`, and `last_modified`. All types report `expires`.
-     */
-    interface SipRegistrationDetails {
-        /**
-         * Number of authentication retries on the last attempt (uac_external_credential).
-         */
-        auth_retries?: number;
-        /**
-         * Unix timestamp when the current registration expires.
-         */
-        expires?: number;
-        /**
-         * Count of consecutive registration failures (uac_external_credential).
-         */
-        failures?: number;
-        /**
-         * Timestamp when the registration was last modified (telephony_credential and
-         * sip_credential_connection).
-         */
-        last_modified?: string;
-        /**
-         * Unix timestamp of the next scheduled registration action
-         * (uac_external_credential).
-         */
-        next_action_at?: number;
-        /**
-         * SIP URI user@host of the registered contact (uac_external_credential).
-         */
-        sip_uri_user_host?: string;
-        /**
-         * Transport used for the registration, e.g. UDP/TCP/TLS (telephony_credential and
-         * sip_credential_connection).
-         */
-        transport?: string;
-        /**
-         * IP address of the registered user agent (telephony_credential and
-         * sip_credential_connection).
-         */
-        ua_ip?: string;
-        /**
-         * Port of the registered user agent (telephony_credential and
-         * sip_credential_connection).
-         */
-        ua_port?: number;
-        /**
-         * Registration uptime reported by the registrar (uac_external_credential).
-         */
-        uptime?: number;
-    }
-}
-export interface SipRegistrationStatusRetrieveParams {
-    /**
-     * The kind of credential to look up. `uac_external_credential` is keyed by
-     * `connection_id`; `telephony_credential` and `sip_credential_connection` are
-     * keyed by `username`.
-     */
-    credential_type: 'uac_external_credential' | 'telephony_credential' | 'sip_credential_connection';
-    /**
-     * Identifier of the UAC connection to look up. Required when `credential_type` is
-     * `uac_external_credential`.
-     */
-    connection_id?: string;
-    /**
-     * SIP username to look up. Required when `credential_type` is
-     * `telephony_credential` or `sip_credential_connection`.
-     */
-    username?: string;
-}
-export declare namespace SipRegistrationStatus {
-    export { type SipRegistrationStatusRetrieveResponse as SipRegistrationStatusRetrieveResponse, type SipRegistrationStatusRetrieveParams as SipRegistrationStatusRetrieveParams, };
-}
-//# sourceMappingURL=sip-registration-status.d.ts.map

package/resources/sip-registration-status.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sip-registration-status.d.ts","sourceRoot":"","sources":["../src/resources/sip-registration-status.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,WAAW;IACpD;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CACN,KAAK,EAAE,mCAAmC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAGrD;AAED,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,yBAAyB,GAAG,sBAAsB,GAAG,2BAA2B,CAAC;IAEnG;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,qCAAqC,CAAC,sBAAsB,CAAC;IAExF;;OAEG;IACH,uBAAuB,CAAC,EACpB,eAAe,GACf,qBAAqB,GACrB,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,YAAY,GACZ,SAAS,CAAC;CACf;AAED,yBAAiB,qCAAqC,CAAC;IACrD;;;;;;OAMG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,mCAAmC;IAClD;;;;OAIG;IACH,eAAe,EAAE,yBAAyB,GAAG,sBAAsB,GAAG,2BAA2B,CAAC;IAElG;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,qBAAqB,CAAC;IAC7C,OAAO,EACL,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}

package/resources/sip-registration-status.js

@@ -1,32 +0,0 @@
-"use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SipRegistrationStatus = void 0;
-const resource_1 = require("../core/resource.js");
-/**
- * UAC connection operations
- */
-class SipRegistrationStatus extends resource_1.APIResource {
-    /**
-     * Returns the live SIP registration status for a Telnyx endpoint: whether it is
-     * currently registered, when the current registration expires, and the last
-     * response Telnyx received from the registrar.
-     *
-     * The endpoint supports three credential types, selected with the
-     * `credential_type` query parameter. Each type is keyed by a different identifier:
-     *
-     * | `credential_type`           | Keyed by        | Use case                                                                   |
-     * | --------------------------- | --------------- | -------------------------------------------------------------------------- |
-     * | `uac_external_credential`   | `connection_id` | A UAC (SIP attach) connection that registers to an external PBX.           |
-     * | `telephony_credential`      | `username`      | An ephemeral, one-time-use telephony credential.                           |
-     * | `sip_credential_connection` | `username`      | A traditional SIP credential connection that registers directly to Telnyx. |
-     *
-     * The authenticated account is taken from your API key; you can only read the
-     * registration status of connections and credentials your account owns.
-     */
-    retrieve(query, options) {
-        return this._client.get('/sip_registration_status', { query, ...options });
-    }
-}
-exports.SipRegistrationStatus = SipRegistrationStatus;
-//# sourceMappingURL=sip-registration-status.js.map

package/resources/sip-registration-status.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sip-registration-status.js","sourceRoot":"","sources":["../src/resources/sip-registration-status.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,qBAAsB,SAAQ,sBAAW;IACpD;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CACN,KAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AAxBD,sDAwBC"}

package/resources/sip-registration-status.mjs

@@ -1,28 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../core/resource.mjs";
-/**
- * UAC connection operations
- */
-export class SipRegistrationStatus extends APIResource {
-    /**
-     * Returns the live SIP registration status for a Telnyx endpoint: whether it is
-     * currently registered, when the current registration expires, and the last
-     * response Telnyx received from the registrar.
-     *
-     * The endpoint supports three credential types, selected with the
-     * `credential_type` query parameter. Each type is keyed by a different identifier:
-     *
-     * | `credential_type`           | Keyed by        | Use case                                                                   |
-     * | --------------------------- | --------------- | -------------------------------------------------------------------------- |
-     * | `uac_external_credential`   | `connection_id` | A UAC (SIP attach) connection that registers to an external PBX.           |
-     * | `telephony_credential`      | `username`      | An ephemeral, one-time-use telephony credential.                           |
-     * | `sip_credential_connection` | `username`      | A traditional SIP credential connection that registers directly to Telnyx. |
-     *
-     * The authenticated account is taken from your API key; you can only read the
-     * registration status of connections and credentials your account owns.
-     */
-    retrieve(query, options) {
-        return this._client.get('/sip_registration_status', { query, ...options });
-    }
-}
-//# sourceMappingURL=sip-registration-status.mjs.map

package/resources/sip-registration-status.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"sip-registration-status.mjs","sourceRoot":"","sources":["../src/resources/sip-registration-status.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IACpD;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CACN,KAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF"}

package/src/resources/sip-registration-status.ts

@@ -1,181 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-import { APIResource } from '../core/resource';
-import { APIPromise } from '../core/api-promise';
-import { RequestOptions } from '../internal/request-options';
-
-/**
- * UAC connection operations
- */
-export class SipRegistrationStatus extends APIResource {
-  /**
-   * Returns the live SIP registration status for a Telnyx endpoint: whether it is
-   * currently registered, when the current registration expires, and the last
-   * response Telnyx received from the registrar.
-   *
-   * The endpoint supports three credential types, selected with the
-   * `credential_type` query parameter. Each type is keyed by a different identifier:
-   *
-   * | `credential_type`           | Keyed by        | Use case                                                                   |
-   * | --------------------------- | --------------- | -------------------------------------------------------------------------- |
-   * | `uac_external_credential`   | `connection_id` | A UAC (SIP attach) connection that registers to an external PBX.           |
-   * | `telephony_credential`      | `username`      | An ephemeral, one-time-use telephony credential.                           |
-   * | `sip_credential_connection` | `username`      | A traditional SIP credential connection that registers directly to Telnyx. |
-   *
-   * The authenticated account is taken from your API key; you can only read the
-   * registration status of connections and credentials your account owns.
-   */
-  retrieve(
-    query: SipRegistrationStatusRetrieveParams,
-    options?: RequestOptions,
-  ): APIPromise<SipRegistrationStatusRetrieveResponse> {
-    return this._client.get('/sip_registration_status', { query, ...options });
-  }
-}
-
-export interface SipRegistrationStatusRetrieveResponse {
-  /**
-   * Identifier of the connection associated with the credential.
-   */
-  connection_id?: string;
-
-  /**
-   * Human-readable connection name.
-   */
-  connection_name?: string;
-
-  /**
-   * The credential type that was looked up.
-   */
-  credential_type?: 'uac_external_credential' | 'telephony_credential' | 'sip_credential_connection';
-
-  /**
-   * SIP username used for the registration.
-   */
-  credential_username?: string;
-
-  /**
-   * SIP response from the last registration attempt.
-   */
-  last_registration_response?: string | null;
-
-  /**
-   * True if the endpoint is currently registered.
-   */
-  registered?: boolean;
-
-  /**
-   * Detailed registration information reported by the registrar. The populated
-   * fields depend on `credential_type`: UAC external credentials report
-   * `auth_retries`, `uptime`, `next_action_at`, `failures`, and `sip_uri_user_host`;
-   * telephony credentials and SIP credential connections report `ua_ip`, `ua_port`,
-   * `transport`, and `last_modified`. All types report `expires`.
-   */
-  sip_registration_details?: SipRegistrationStatusRetrieveResponse.SipRegistrationDetails;
-
-  /**
-   * Human-readable registration status derived from the registrar state.
-   */
-  sip_registration_status?:
-    | 'unregistering'
-    | 'connection_disabled'
-    | 'standby'
-    | 'failed'
-    | 'trying'
-    | 'registered'
-    | 'unknown';
-}
-
-export namespace SipRegistrationStatusRetrieveResponse {
-  /**
-   * Detailed registration information reported by the registrar. The populated
-   * fields depend on `credential_type`: UAC external credentials report
-   * `auth_retries`, `uptime`, `next_action_at`, `failures`, and `sip_uri_user_host`;
-   * telephony credentials and SIP credential connections report `ua_ip`, `ua_port`,
-   * `transport`, and `last_modified`. All types report `expires`.
-   */
-  export interface SipRegistrationDetails {
-    /**
-     * Number of authentication retries on the last attempt (uac_external_credential).
-     */
-    auth_retries?: number;
-
-    /**
-     * Unix timestamp when the current registration expires.
-     */
-    expires?: number;
-
-    /**
-     * Count of consecutive registration failures (uac_external_credential).
-     */
-    failures?: number;
-
-    /**
-     * Timestamp when the registration was last modified (telephony_credential and
-     * sip_credential_connection).
-     */
-    last_modified?: string;
-
-    /**
-     * Unix timestamp of the next scheduled registration action
-     * (uac_external_credential).
-     */
-    next_action_at?: number;
-
-    /**
-     * SIP URI user@host of the registered contact (uac_external_credential).
-     */
-    sip_uri_user_host?: string;
-
-    /**
-     * Transport used for the registration, e.g. UDP/TCP/TLS (telephony_credential and
-     * sip_credential_connection).
-     */
-    transport?: string;
-
-    /**
-     * IP address of the registered user agent (telephony_credential and
-     * sip_credential_connection).
-     */
-    ua_ip?: string;
-
-    /**
-     * Port of the registered user agent (telephony_credential and
-     * sip_credential_connection).
-     */
-    ua_port?: number;
-
-    /**
-     * Registration uptime reported by the registrar (uac_external_credential).
-     */
-    uptime?: number;
-  }
-}
-
-export interface SipRegistrationStatusRetrieveParams {
-  /**
-   * The kind of credential to look up. `uac_external_credential` is keyed by
-   * `connection_id`; `telephony_credential` and `sip_credential_connection` are
-   * keyed by `username`.
-   */
-  credential_type: 'uac_external_credential' | 'telephony_credential' | 'sip_credential_connection';
-
-  /**
-   * Identifier of the UAC connection to look up. Required when `credential_type` is
-   * `uac_external_credential`.
-   */
-  connection_id?: string;
-
-  /**
-   * SIP username to look up. Required when `credential_type` is
-   * `telephony_credential` or `sip_credential_connection`.
-   */
-  username?: string;
-}
-
-export declare namespace SipRegistrationStatus {
-  export {
-    type SipRegistrationStatusRetrieveResponse as SipRegistrationStatusRetrieveResponse,
-    type SipRegistrationStatusRetrieveParams as SipRegistrationStatusRetrieveParams,
-  };
-}