telnyx 6.72.0 → 6.73.0

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

@@ -0,0 +1,91 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Look up SIP registration status across credential types
+ */
+export declare class SipRegistrationStatus extends APIResource {
+    /**
+     * Returns the live SIP registration state of a connection or credential. Supports
+     * UAC third-party credentials, telephony credentials, and SIP credential
+     * connections.
+     */
+    retrieve(query: SipRegistrationStatusRetrieveParams, options?: RequestOptions): APIPromise<SipRegistrationStatusRetrieveResponse>;
+}
+export interface SipRegistrationStatusRetrieveResponse {
+    /**
+     * Identifier of the resource.
+     */
+    connection_id?: string;
+    /**
+     * Human-readable connection name.
+     */
+    connection_name?: string;
+    /**
+     * Outward-facing SIP settings used for registration. Password is redacted.
+     */
+    external_uac_settings?: SipRegistrationStatusRetrieveResponse.ExternalUacSettings;
+    /**
+     * Internal routing target the connection delivers calls to.
+     */
+    internal_uac_settings?: SipRegistrationStatusRetrieveResponse.InternalUacSettings;
+    /**
+     * SIP response from the last registration attempt.
+     */
+    last_registration_response?: string;
+    /**
+     * Internal pairing state, e.g. ACTIVE or INACTIVE.
+     */
+    pair_state?: string;
+    /**
+     * True if the endpoint is currently registered.
+     */
+    registered?: boolean;
+    /**
+     * Owner of the resource.
+     */
+    user_id?: string;
+    /**
+     * SIP username used for the registration.
+     */
+    username?: string;
+}
+export declare namespace SipRegistrationStatusRetrieveResponse {
+    /**
+     * Outward-facing SIP settings used for registration. Password is redacted.
+     */
+    interface ExternalUacSettings {
+        auth_username?: string;
+        expiration_sec?: number;
+        from_user?: string;
+        outbound_proxy?: string;
+        password?: string;
+        proxy?: string;
+        transport?: 'TCP' | 'UDP' | 'TLS';
+        username?: string;
+    }
+    /**
+     * Internal routing target the connection delivers calls to.
+     */
+    interface InternalUacSettings {
+        destination_uri?: string;
+    }
+}
+export interface SipRegistrationStatusRetrieveParams {
+    /**
+     * Identifier of the connection or credential to look up.
+     */
+    connection_id: string;
+    /**
+     * The kind of credential to look up.
+     */
+    credential_type: 'uac_external_credential' | 'telephony_credential' | 'sip_credential_connection';
+    /**
+     * Owner of the connection. Used to authorize the lookup.
+     */
+    user_id: string;
+}
+export declare namespace SipRegistrationStatus {
+    export { type SipRegistrationStatusRetrieveResponse as SipRegistrationStatusRetrieveResponse, type SipRegistrationStatusRetrieveParams as SipRegistrationStatusRetrieveParams, };
+}
+//# sourceMappingURL=sip-registration-status.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sip-registration-status.d.mts","sourceRoot":"","sources":["../src/resources/sip-registration-status.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,WAAW;IACpD;;;;OAIG;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,qBAAqB,CAAC,EAAE,qCAAqC,CAAC,mBAAmB,CAAC;IAElF;;OAEG;IACH,qBAAqB,CAAC,EAAE,qCAAqC,CAAC,mBAAmB,CAAC;IAElF;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,qCAAqC,CAAC;IACrD;;OAEG;IACH,UAAiB,mBAAmB;QAClC,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;QAElC,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,yBAAyB,GAAG,sBAAsB,GAAG,2BAA2B,CAAC;IAElG;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;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.d.ts

@@ -0,0 +1,91 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Look up SIP registration status across credential types
+ */
+export declare class SipRegistrationStatus extends APIResource {
+    /**
+     * Returns the live SIP registration state of a connection or credential. Supports
+     * UAC third-party credentials, telephony credentials, and SIP credential
+     * connections.
+     */
+    retrieve(query: SipRegistrationStatusRetrieveParams, options?: RequestOptions): APIPromise<SipRegistrationStatusRetrieveResponse>;
+}
+export interface SipRegistrationStatusRetrieveResponse {
+    /**
+     * Identifier of the resource.
+     */
+    connection_id?: string;
+    /**
+     * Human-readable connection name.
+     */
+    connection_name?: string;
+    /**
+     * Outward-facing SIP settings used for registration. Password is redacted.
+     */
+    external_uac_settings?: SipRegistrationStatusRetrieveResponse.ExternalUacSettings;
+    /**
+     * Internal routing target the connection delivers calls to.
+     */
+    internal_uac_settings?: SipRegistrationStatusRetrieveResponse.InternalUacSettings;
+    /**
+     * SIP response from the last registration attempt.
+     */
+    last_registration_response?: string;
+    /**
+     * Internal pairing state, e.g. ACTIVE or INACTIVE.
+     */
+    pair_state?: string;
+    /**
+     * True if the endpoint is currently registered.
+     */
+    registered?: boolean;
+    /**
+     * Owner of the resource.
+     */
+    user_id?: string;
+    /**
+     * SIP username used for the registration.
+     */
+    username?: string;
+}
+export declare namespace SipRegistrationStatusRetrieveResponse {
+    /**
+     * Outward-facing SIP settings used for registration. Password is redacted.
+     */
+    interface ExternalUacSettings {
+        auth_username?: string;
+        expiration_sec?: number;
+        from_user?: string;
+        outbound_proxy?: string;
+        password?: string;
+        proxy?: string;
+        transport?: 'TCP' | 'UDP' | 'TLS';
+        username?: string;
+    }
+    /**
+     * Internal routing target the connection delivers calls to.
+     */
+    interface InternalUacSettings {
+        destination_uri?: string;
+    }
+}
+export interface SipRegistrationStatusRetrieveParams {
+    /**
+     * Identifier of the connection or credential to look up.
+     */
+    connection_id: string;
+    /**
+     * The kind of credential to look up.
+     */
+    credential_type: 'uac_external_credential' | 'telephony_credential' | 'sip_credential_connection';
+    /**
+     * Owner of the connection. Used to authorize the lookup.
+     */
+    user_id: 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

@@ -0,0 +1 @@
+{"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;;;;OAIG;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,qBAAqB,CAAC,EAAE,qCAAqC,CAAC,mBAAmB,CAAC;IAElF;;OAEG;IACH,qBAAqB,CAAC,EAAE,qCAAqC,CAAC,mBAAmB,CAAC;IAElF;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,qCAAqC,CAAC;IACrD;;OAEG;IACH,UAAiB,mBAAmB;QAClC,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;QAElC,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,EAAE,yBAAyB,GAAG,sBAAsB,GAAG,2BAA2B,CAAC;IAElG;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;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

@@ -0,0 +1,20 @@
+"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");
+/**
+ * Look up SIP registration status across credential types
+ */
+class SipRegistrationStatus extends resource_1.APIResource {
+    /**
+     * Returns the live SIP registration state of a connection or credential. Supports
+     * UAC third-party credentials, telephony credentials, and SIP credential
+     * connections.
+     */
+    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

@@ -0,0 +1 @@
+{"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;;;;OAIG;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;AAZD,sDAYC"}

package/resources/sip-registration-status.mjs

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+/**
+ * Look up SIP registration status across credential types
+ */
+export class SipRegistrationStatus extends APIResource {
+    /**
+     * Returns the live SIP registration state of a connection or credential. Supports
+     * UAC third-party credentials, telephony credentials, and SIP credential
+     * connections.
+     */
+    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

@@ -0,0 +1 @@
+{"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;;;;OAIG;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/client.ts

@@ -811,6 +811,11 @@ import {
   SimCardOrders,
   SimCardOrdersDefaultFlatPagination,
 } from './resources/sim-card-orders';
+import {
+  SipRegistrationStatus,
+  SipRegistrationStatusRetrieveParams,
+  SipRegistrationStatusRetrieveResponse,
+} from './resources/sip-registration-status';
 import {
   SiprecConnectorCreateParams,
   SiprecConnectorCreateResponse,
@@ -2995,6 +3000,10 @@ export class Telnyx {
    * Retrieve raw Voice SDK call report stats payloads for WebRTC call troubleshooting.
    */
   voiceSDKCallReports: API.VoiceSDKCallReports = new API.VoiceSDKCallReports(this);
+  /**
+   * Look up SIP registration status across credential types
+   */
+  sipRegistrationStatus: API.SipRegistrationStatus = new API.SipRegistrationStatus(this);
 }
 
 Telnyx.Legacy = Legacy;
@@ -3163,6 +3172,7 @@ Telnyx.TermsOfService = TermsOfService;
 Telnyx.PronunciationDicts = PronunciationDicts;
 Telnyx.UacConnections = UacConnections;
 Telnyx.VoiceSDKCallReports = VoiceSDKCallReports;
+Telnyx.SipRegistrationStatus = SipRegistrationStatus;
 
 export declare namespace Telnyx {
   export type RequestOptions = Opts.RequestOptions;
@@ -4963,6 +4973,12 @@ export declare namespace Telnyx {
     type VoiceSDKCallReportListParams as VoiceSDKCallReportListParams,
   };
 
+  export {
+    SipRegistrationStatus as SipRegistrationStatus,
+    type SipRegistrationStatusRetrieveResponse as SipRegistrationStatusRetrieveResponse,
+    type SipRegistrationStatusRetrieveParams as SipRegistrationStatusRetrieveParams,
+  };
+
   export type APIError = API.APIError;
   export type AvailablePhoneNumbersMetadata = API.AvailablePhoneNumbersMetadata;
   export type AzureVoiceSettings = API.AzureVoiceSettings;

package/src/resources/index.ts

@@ -1163,6 +1163,11 @@ export {
   type SimCardListWirelessConnectivityLogsParams,
   type SimCardListWirelessConnectivityLogsResponsesDefaultFlatPagination,
 } from './sim-cards/sim-cards';
+export {
+  SipRegistrationStatus,
+  type SipRegistrationStatusRetrieveResponse,
+  type SipRegistrationStatusRetrieveParams,
+} from './sip-registration-status';
 export {
   SiprecConnectors,
   type SiprecConnectorCreateResponse,

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

@@ -0,0 +1,123 @@
+// 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';
+
+/**
+ * Look up SIP registration status across credential types
+ */
+export class SipRegistrationStatus extends APIResource {
+  /**
+   * Returns the live SIP registration state of a connection or credential. Supports
+   * UAC third-party credentials, telephony credentials, and SIP credential
+   * connections.
+   */
+  retrieve(
+    query: SipRegistrationStatusRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<SipRegistrationStatusRetrieveResponse> {
+    return this._client.get('/sip_registration_status', { query, ...options });
+  }
+}
+
+export interface SipRegistrationStatusRetrieveResponse {
+  /**
+   * Identifier of the resource.
+   */
+  connection_id?: string;
+
+  /**
+   * Human-readable connection name.
+   */
+  connection_name?: string;
+
+  /**
+   * Outward-facing SIP settings used for registration. Password is redacted.
+   */
+  external_uac_settings?: SipRegistrationStatusRetrieveResponse.ExternalUacSettings;
+
+  /**
+   * Internal routing target the connection delivers calls to.
+   */
+  internal_uac_settings?: SipRegistrationStatusRetrieveResponse.InternalUacSettings;
+
+  /**
+   * SIP response from the last registration attempt.
+   */
+  last_registration_response?: string;
+
+  /**
+   * Internal pairing state, e.g. ACTIVE or INACTIVE.
+   */
+  pair_state?: string;
+
+  /**
+   * True if the endpoint is currently registered.
+   */
+  registered?: boolean;
+
+  /**
+   * Owner of the resource.
+   */
+  user_id?: string;
+
+  /**
+   * SIP username used for the registration.
+   */
+  username?: string;
+}
+
+export namespace SipRegistrationStatusRetrieveResponse {
+  /**
+   * Outward-facing SIP settings used for registration. Password is redacted.
+   */
+  export interface ExternalUacSettings {
+    auth_username?: string;
+
+    expiration_sec?: number;
+
+    from_user?: string;
+
+    outbound_proxy?: string;
+
+    password?: string;
+
+    proxy?: string;
+
+    transport?: 'TCP' | 'UDP' | 'TLS';
+
+    username?: string;
+  }
+
+  /**
+   * Internal routing target the connection delivers calls to.
+   */
+  export interface InternalUacSettings {
+    destination_uri?: string;
+  }
+}
+
+export interface SipRegistrationStatusRetrieveParams {
+  /**
+   * Identifier of the connection or credential to look up.
+   */
+  connection_id: string;
+
+  /**
+   * The kind of credential to look up.
+   */
+  credential_type: 'uac_external_credential' | 'telephony_credential' | 'sip_credential_connection';
+
+  /**
+   * Owner of the connection. Used to authorize the lookup.
+   */
+  user_id: string;
+}
+
+export declare namespace SipRegistrationStatus {
+  export {
+    type SipRegistrationStatusRetrieveResponse as SipRegistrationStatusRetrieveResponse,
+    type SipRegistrationStatusRetrieveParams as SipRegistrationStatusRetrieveParams,
+  };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.72.0'; // x-release-please-version
+export const VERSION = '6.73.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.72.0";
+export declare const VERSION = "6.73.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.72.0";
+export declare const VERSION = "6.73.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '6.72.0'; // x-release-please-version
+exports.VERSION = '6.73.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '6.72.0'; // x-release-please-version
+export const VERSION = '6.73.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map