telnyx 6.72.0 → 6.73.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +16 -0
- package/client.d.mts +6 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts +6 -0
- package/client.d.ts.map +1 -1
- package/client.js +6 -0
- package/client.js.map +1 -1
- package/client.mjs +6 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/index.d.mts +1 -0
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +4 -2
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/sip-registration-status.d.mts +115 -0
- package/resources/sip-registration-status.d.mts.map +1 -0
- package/resources/sip-registration-status.d.ts +115 -0
- package/resources/sip-registration-status.d.ts.map +1 -0
- package/resources/sip-registration-status.js +20 -0
- package/resources/sip-registration-status.js.map +1 -0
- package/resources/sip-registration-status.mjs +16 -0
- package/resources/sip-registration-status.mjs.map +1 -0
- package/src/client.ts +16 -0
- package/src/resources/index.ts +5 -0
- package/src/resources/sip-registration-status.ts +147 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* Look up the live SIP registration status of a UAC connection.
|
|
6
|
+
*/
|
|
7
|
+
export declare class SipRegistrationStatus extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Returns the live SIP registration state of a UAC connection: whether it is
|
|
10
|
+
* currently registered, when it last registered, and the last response Telnyx
|
|
11
|
+
* received from the registrar. Only `uac_external_credential` is supported today.
|
|
12
|
+
*/
|
|
13
|
+
retrieve(query: SipRegistrationStatusRetrieveParams, options?: RequestOptions): APIPromise<SipRegistrationStatusRetrieveResponse>;
|
|
14
|
+
}
|
|
15
|
+
export interface SipRegistrationStatusRetrieveResponse {
|
|
16
|
+
/**
|
|
17
|
+
* Raw external-side registration block reported by the registrar.
|
|
18
|
+
*/
|
|
19
|
+
b2bua_external?: {
|
|
20
|
+
[key: string]: unknown;
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Raw internal-side block reported by the registrar.
|
|
24
|
+
*/
|
|
25
|
+
b2bua_internal?: {
|
|
26
|
+
[key: string]: unknown;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Identifier of the UAC connection.
|
|
30
|
+
*/
|
|
31
|
+
connection_id?: string;
|
|
32
|
+
/**
|
|
33
|
+
* Human-readable connection name.
|
|
34
|
+
*/
|
|
35
|
+
connection_name?: string;
|
|
36
|
+
/**
|
|
37
|
+
* The credential type that was looked up.
|
|
38
|
+
*/
|
|
39
|
+
credential_type?: 'uac_external_credential';
|
|
40
|
+
/**
|
|
41
|
+
* Registration state on the external (UAC / PBX) side, e.g. REGED.
|
|
42
|
+
*/
|
|
43
|
+
external_state?: string;
|
|
44
|
+
/**
|
|
45
|
+
* Outward-facing SIP settings used for registration. Password is redacted.
|
|
46
|
+
*/
|
|
47
|
+
external_uac_settings?: SipRegistrationStatusRetrieveResponse.ExternalUacSettings;
|
|
48
|
+
/**
|
|
49
|
+
* Internal routing target the connection delivers calls to.
|
|
50
|
+
*/
|
|
51
|
+
internal_uac_settings?: SipRegistrationStatusRetrieveResponse.InternalUacSettings;
|
|
52
|
+
/**
|
|
53
|
+
* SIP response from the last registration attempt.
|
|
54
|
+
*/
|
|
55
|
+
last_registration_response?: string;
|
|
56
|
+
/**
|
|
57
|
+
* Internal pairing state, e.g. ACTIVE or INACTIVE.
|
|
58
|
+
*/
|
|
59
|
+
pair_state?: string;
|
|
60
|
+
/**
|
|
61
|
+
* True if the endpoint is currently registered.
|
|
62
|
+
*/
|
|
63
|
+
registered?: boolean;
|
|
64
|
+
/**
|
|
65
|
+
* Owner of the connection.
|
|
66
|
+
*/
|
|
67
|
+
user_id?: string;
|
|
68
|
+
/**
|
|
69
|
+
* SIP username used for the registration.
|
|
70
|
+
*/
|
|
71
|
+
username?: string;
|
|
72
|
+
}
|
|
73
|
+
export declare namespace SipRegistrationStatusRetrieveResponse {
|
|
74
|
+
/**
|
|
75
|
+
* Outward-facing SIP settings used for registration. Password is redacted.
|
|
76
|
+
*/
|
|
77
|
+
interface ExternalUacSettings {
|
|
78
|
+
auth_username?: string;
|
|
79
|
+
expiration_sec?: number;
|
|
80
|
+
from_user?: string;
|
|
81
|
+
outbound_proxy?: string;
|
|
82
|
+
/**
|
|
83
|
+
* Always redacted.
|
|
84
|
+
*/
|
|
85
|
+
password?: string;
|
|
86
|
+
proxy?: string;
|
|
87
|
+
transport?: 'TCP' | 'UDP' | 'TLS';
|
|
88
|
+
username?: string;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Internal routing target the connection delivers calls to.
|
|
92
|
+
*/
|
|
93
|
+
interface InternalUacSettings {
|
|
94
|
+
destination_uri?: string;
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
export interface SipRegistrationStatusRetrieveParams {
|
|
98
|
+
/**
|
|
99
|
+
* Identifier of the UAC connection to look up.
|
|
100
|
+
*/
|
|
101
|
+
connection_id: string;
|
|
102
|
+
/**
|
|
103
|
+
* The kind of credential to look up. Only `uac_external_credential` is supported
|
|
104
|
+
* today.
|
|
105
|
+
*/
|
|
106
|
+
credential_type: 'uac_external_credential';
|
|
107
|
+
/**
|
|
108
|
+
* Owner of the connection. Used to authorize the lookup.
|
|
109
|
+
*/
|
|
110
|
+
user_id: string;
|
|
111
|
+
}
|
|
112
|
+
export declare namespace SipRegistrationStatus {
|
|
113
|
+
export { type SipRegistrationStatusRetrieveResponse as SipRegistrationStatusRetrieveResponse, type SipRegistrationStatusRetrieveParams as SipRegistrationStatusRetrieveParams, };
|
|
114
|
+
}
|
|
115
|
+
//# sourceMappingURL=sip-registration-status.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
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,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,yBAAyB,CAAC;IAE5C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;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;;WAEG;QACH,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;;;OAGG;IACH,eAAe,EAAE,yBAAyB,CAAC;IAE3C;;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"}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
4
|
+
/**
|
|
5
|
+
* Look up the live SIP registration status of a UAC connection.
|
|
6
|
+
*/
|
|
7
|
+
export declare class SipRegistrationStatus extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Returns the live SIP registration state of a UAC connection: whether it is
|
|
10
|
+
* currently registered, when it last registered, and the last response Telnyx
|
|
11
|
+
* received from the registrar. Only `uac_external_credential` is supported today.
|
|
12
|
+
*/
|
|
13
|
+
retrieve(query: SipRegistrationStatusRetrieveParams, options?: RequestOptions): APIPromise<SipRegistrationStatusRetrieveResponse>;
|
|
14
|
+
}
|
|
15
|
+
export interface SipRegistrationStatusRetrieveResponse {
|
|
16
|
+
/**
|
|
17
|
+
* Raw external-side registration block reported by the registrar.
|
|
18
|
+
*/
|
|
19
|
+
b2bua_external?: {
|
|
20
|
+
[key: string]: unknown;
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Raw internal-side block reported by the registrar.
|
|
24
|
+
*/
|
|
25
|
+
b2bua_internal?: {
|
|
26
|
+
[key: string]: unknown;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Identifier of the UAC connection.
|
|
30
|
+
*/
|
|
31
|
+
connection_id?: string;
|
|
32
|
+
/**
|
|
33
|
+
* Human-readable connection name.
|
|
34
|
+
*/
|
|
35
|
+
connection_name?: string;
|
|
36
|
+
/**
|
|
37
|
+
* The credential type that was looked up.
|
|
38
|
+
*/
|
|
39
|
+
credential_type?: 'uac_external_credential';
|
|
40
|
+
/**
|
|
41
|
+
* Registration state on the external (UAC / PBX) side, e.g. REGED.
|
|
42
|
+
*/
|
|
43
|
+
external_state?: string;
|
|
44
|
+
/**
|
|
45
|
+
* Outward-facing SIP settings used for registration. Password is redacted.
|
|
46
|
+
*/
|
|
47
|
+
external_uac_settings?: SipRegistrationStatusRetrieveResponse.ExternalUacSettings;
|
|
48
|
+
/**
|
|
49
|
+
* Internal routing target the connection delivers calls to.
|
|
50
|
+
*/
|
|
51
|
+
internal_uac_settings?: SipRegistrationStatusRetrieveResponse.InternalUacSettings;
|
|
52
|
+
/**
|
|
53
|
+
* SIP response from the last registration attempt.
|
|
54
|
+
*/
|
|
55
|
+
last_registration_response?: string;
|
|
56
|
+
/**
|
|
57
|
+
* Internal pairing state, e.g. ACTIVE or INACTIVE.
|
|
58
|
+
*/
|
|
59
|
+
pair_state?: string;
|
|
60
|
+
/**
|
|
61
|
+
* True if the endpoint is currently registered.
|
|
62
|
+
*/
|
|
63
|
+
registered?: boolean;
|
|
64
|
+
/**
|
|
65
|
+
* Owner of the connection.
|
|
66
|
+
*/
|
|
67
|
+
user_id?: string;
|
|
68
|
+
/**
|
|
69
|
+
* SIP username used for the registration.
|
|
70
|
+
*/
|
|
71
|
+
username?: string;
|
|
72
|
+
}
|
|
73
|
+
export declare namespace SipRegistrationStatusRetrieveResponse {
|
|
74
|
+
/**
|
|
75
|
+
* Outward-facing SIP settings used for registration. Password is redacted.
|
|
76
|
+
*/
|
|
77
|
+
interface ExternalUacSettings {
|
|
78
|
+
auth_username?: string;
|
|
79
|
+
expiration_sec?: number;
|
|
80
|
+
from_user?: string;
|
|
81
|
+
outbound_proxy?: string;
|
|
82
|
+
/**
|
|
83
|
+
* Always redacted.
|
|
84
|
+
*/
|
|
85
|
+
password?: string;
|
|
86
|
+
proxy?: string;
|
|
87
|
+
transport?: 'TCP' | 'UDP' | 'TLS';
|
|
88
|
+
username?: string;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Internal routing target the connection delivers calls to.
|
|
92
|
+
*/
|
|
93
|
+
interface InternalUacSettings {
|
|
94
|
+
destination_uri?: string;
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
export interface SipRegistrationStatusRetrieveParams {
|
|
98
|
+
/**
|
|
99
|
+
* Identifier of the UAC connection to look up.
|
|
100
|
+
*/
|
|
101
|
+
connection_id: string;
|
|
102
|
+
/**
|
|
103
|
+
* The kind of credential to look up. Only `uac_external_credential` is supported
|
|
104
|
+
* today.
|
|
105
|
+
*/
|
|
106
|
+
credential_type: 'uac_external_credential';
|
|
107
|
+
/**
|
|
108
|
+
* Owner of the connection. Used to authorize the lookup.
|
|
109
|
+
*/
|
|
110
|
+
user_id: string;
|
|
111
|
+
}
|
|
112
|
+
export declare namespace SipRegistrationStatus {
|
|
113
|
+
export { type SipRegistrationStatusRetrieveResponse as SipRegistrationStatusRetrieveResponse, type SipRegistrationStatusRetrieveParams as SipRegistrationStatusRetrieveParams, };
|
|
114
|
+
}
|
|
115
|
+
//# sourceMappingURL=sip-registration-status.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
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,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,yBAAyB,CAAC;IAE5C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;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;;WAEG;QACH,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;;;OAGG;IACH,eAAe,EAAE,yBAAyB,CAAC;IAE3C;;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"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.SipRegistrationStatus = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
/**
|
|
7
|
+
* Look up the live SIP registration status of a UAC connection.
|
|
8
|
+
*/
|
|
9
|
+
class SipRegistrationStatus extends resource_1.APIResource {
|
|
10
|
+
/**
|
|
11
|
+
* Returns the live SIP registration state of a UAC connection: whether it is
|
|
12
|
+
* currently registered, when it last registered, and the last response Telnyx
|
|
13
|
+
* received from the registrar. Only `uac_external_credential` is supported today.
|
|
14
|
+
*/
|
|
15
|
+
retrieve(query, options) {
|
|
16
|
+
return this._client.get('/sip_registration_status', { query, ...options });
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
exports.SipRegistrationStatus = SipRegistrationStatus;
|
|
20
|
+
//# sourceMappingURL=sip-registration-status.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
/**
|
|
4
|
+
* Look up the live SIP registration status of a UAC connection.
|
|
5
|
+
*/
|
|
6
|
+
export class SipRegistrationStatus extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Returns the live SIP registration state of a UAC connection: whether it is
|
|
9
|
+
* currently registered, when it last registered, and the last response Telnyx
|
|
10
|
+
* received from the registrar. Only `uac_external_credential` is supported today.
|
|
11
|
+
*/
|
|
12
|
+
retrieve(query, options) {
|
|
13
|
+
return this._client.get('/sip_registration_status', { query, ...options });
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=sip-registration-status.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
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
CHANGED
|
@@ -811,6 +811,11 @@ import {
|
|
|
811
811
|
SimCardOrders,
|
|
812
812
|
SimCardOrdersDefaultFlatPagination,
|
|
813
813
|
} from './resources/sim-card-orders';
|
|
814
|
+
import {
|
|
815
|
+
SipRegistrationStatus,
|
|
816
|
+
SipRegistrationStatusRetrieveParams,
|
|
817
|
+
SipRegistrationStatusRetrieveResponse,
|
|
818
|
+
} from './resources/sip-registration-status';
|
|
814
819
|
import {
|
|
815
820
|
SiprecConnectorCreateParams,
|
|
816
821
|
SiprecConnectorCreateResponse,
|
|
@@ -2995,6 +3000,10 @@ export class Telnyx {
|
|
|
2995
3000
|
* Retrieve raw Voice SDK call report stats payloads for WebRTC call troubleshooting.
|
|
2996
3001
|
*/
|
|
2997
3002
|
voiceSDKCallReports: API.VoiceSDKCallReports = new API.VoiceSDKCallReports(this);
|
|
3003
|
+
/**
|
|
3004
|
+
* Look up the live SIP registration status of a UAC connection.
|
|
3005
|
+
*/
|
|
3006
|
+
sipRegistrationStatus: API.SipRegistrationStatus = new API.SipRegistrationStatus(this);
|
|
2998
3007
|
}
|
|
2999
3008
|
|
|
3000
3009
|
Telnyx.Legacy = Legacy;
|
|
@@ -3163,6 +3172,7 @@ Telnyx.TermsOfService = TermsOfService;
|
|
|
3163
3172
|
Telnyx.PronunciationDicts = PronunciationDicts;
|
|
3164
3173
|
Telnyx.UacConnections = UacConnections;
|
|
3165
3174
|
Telnyx.VoiceSDKCallReports = VoiceSDKCallReports;
|
|
3175
|
+
Telnyx.SipRegistrationStatus = SipRegistrationStatus;
|
|
3166
3176
|
|
|
3167
3177
|
export declare namespace Telnyx {
|
|
3168
3178
|
export type RequestOptions = Opts.RequestOptions;
|
|
@@ -4963,6 +4973,12 @@ export declare namespace Telnyx {
|
|
|
4963
4973
|
type VoiceSDKCallReportListParams as VoiceSDKCallReportListParams,
|
|
4964
4974
|
};
|
|
4965
4975
|
|
|
4976
|
+
export {
|
|
4977
|
+
SipRegistrationStatus as SipRegistrationStatus,
|
|
4978
|
+
type SipRegistrationStatusRetrieveResponse as SipRegistrationStatusRetrieveResponse,
|
|
4979
|
+
type SipRegistrationStatusRetrieveParams as SipRegistrationStatusRetrieveParams,
|
|
4980
|
+
};
|
|
4981
|
+
|
|
4966
4982
|
export type APIError = API.APIError;
|
|
4967
4983
|
export type AvailablePhoneNumbersMetadata = API.AvailablePhoneNumbersMetadata;
|
|
4968
4984
|
export type AzureVoiceSettings = API.AzureVoiceSettings;
|
package/src/resources/index.ts
CHANGED
|
@@ -1163,6 +1163,11 @@ export {
|
|
|
1163
1163
|
type SimCardListWirelessConnectivityLogsParams,
|
|
1164
1164
|
type SimCardListWirelessConnectivityLogsResponsesDefaultFlatPagination,
|
|
1165
1165
|
} from './sim-cards/sim-cards';
|
|
1166
|
+
export {
|
|
1167
|
+
SipRegistrationStatus,
|
|
1168
|
+
type SipRegistrationStatusRetrieveResponse,
|
|
1169
|
+
type SipRegistrationStatusRetrieveParams,
|
|
1170
|
+
} from './sip-registration-status';
|
|
1166
1171
|
export {
|
|
1167
1172
|
SiprecConnectors,
|
|
1168
1173
|
type SiprecConnectorCreateResponse,
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../core/resource';
|
|
4
|
+
import { APIPromise } from '../core/api-promise';
|
|
5
|
+
import { RequestOptions } from '../internal/request-options';
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Look up the live SIP registration status of a UAC connection.
|
|
9
|
+
*/
|
|
10
|
+
export class SipRegistrationStatus extends APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* Returns the live SIP registration state of a UAC connection: whether it is
|
|
13
|
+
* currently registered, when it last registered, and the last response Telnyx
|
|
14
|
+
* received from the registrar. Only `uac_external_credential` is supported today.
|
|
15
|
+
*/
|
|
16
|
+
retrieve(
|
|
17
|
+
query: SipRegistrationStatusRetrieveParams,
|
|
18
|
+
options?: RequestOptions,
|
|
19
|
+
): APIPromise<SipRegistrationStatusRetrieveResponse> {
|
|
20
|
+
return this._client.get('/sip_registration_status', { query, ...options });
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export interface SipRegistrationStatusRetrieveResponse {
|
|
25
|
+
/**
|
|
26
|
+
* Raw external-side registration block reported by the registrar.
|
|
27
|
+
*/
|
|
28
|
+
b2bua_external?: { [key: string]: unknown };
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Raw internal-side block reported by the registrar.
|
|
32
|
+
*/
|
|
33
|
+
b2bua_internal?: { [key: string]: unknown };
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* Identifier of the UAC connection.
|
|
37
|
+
*/
|
|
38
|
+
connection_id?: string;
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Human-readable connection name.
|
|
42
|
+
*/
|
|
43
|
+
connection_name?: string;
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* The credential type that was looked up.
|
|
47
|
+
*/
|
|
48
|
+
credential_type?: 'uac_external_credential';
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Registration state on the external (UAC / PBX) side, e.g. REGED.
|
|
52
|
+
*/
|
|
53
|
+
external_state?: string;
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Outward-facing SIP settings used for registration. Password is redacted.
|
|
57
|
+
*/
|
|
58
|
+
external_uac_settings?: SipRegistrationStatusRetrieveResponse.ExternalUacSettings;
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Internal routing target the connection delivers calls to.
|
|
62
|
+
*/
|
|
63
|
+
internal_uac_settings?: SipRegistrationStatusRetrieveResponse.InternalUacSettings;
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* SIP response from the last registration attempt.
|
|
67
|
+
*/
|
|
68
|
+
last_registration_response?: string;
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Internal pairing state, e.g. ACTIVE or INACTIVE.
|
|
72
|
+
*/
|
|
73
|
+
pair_state?: string;
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* True if the endpoint is currently registered.
|
|
77
|
+
*/
|
|
78
|
+
registered?: boolean;
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Owner of the connection.
|
|
82
|
+
*/
|
|
83
|
+
user_id?: string;
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* SIP username used for the registration.
|
|
87
|
+
*/
|
|
88
|
+
username?: string;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export namespace SipRegistrationStatusRetrieveResponse {
|
|
92
|
+
/**
|
|
93
|
+
* Outward-facing SIP settings used for registration. Password is redacted.
|
|
94
|
+
*/
|
|
95
|
+
export interface ExternalUacSettings {
|
|
96
|
+
auth_username?: string;
|
|
97
|
+
|
|
98
|
+
expiration_sec?: number;
|
|
99
|
+
|
|
100
|
+
from_user?: string;
|
|
101
|
+
|
|
102
|
+
outbound_proxy?: string;
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* Always redacted.
|
|
106
|
+
*/
|
|
107
|
+
password?: string;
|
|
108
|
+
|
|
109
|
+
proxy?: string;
|
|
110
|
+
|
|
111
|
+
transport?: 'TCP' | 'UDP' | 'TLS';
|
|
112
|
+
|
|
113
|
+
username?: string;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* Internal routing target the connection delivers calls to.
|
|
118
|
+
*/
|
|
119
|
+
export interface InternalUacSettings {
|
|
120
|
+
destination_uri?: string;
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
export interface SipRegistrationStatusRetrieveParams {
|
|
125
|
+
/**
|
|
126
|
+
* Identifier of the UAC connection to look up.
|
|
127
|
+
*/
|
|
128
|
+
connection_id: string;
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* The kind of credential to look up. Only `uac_external_credential` is supported
|
|
132
|
+
* today.
|
|
133
|
+
*/
|
|
134
|
+
credential_type: 'uac_external_credential';
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Owner of the connection. Used to authorize the lookup.
|
|
138
|
+
*/
|
|
139
|
+
user_id: string;
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
export declare namespace SipRegistrationStatus {
|
|
143
|
+
export {
|
|
144
|
+
type SipRegistrationStatusRetrieveResponse as SipRegistrationStatusRetrieveResponse,
|
|
145
|
+
type SipRegistrationStatusRetrieveParams as SipRegistrationStatusRetrieveParams,
|
|
146
|
+
};
|
|
147
|
+
}
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '6.
|
|
1
|
+
export const VERSION = '6.73.1'; // x-release-please-version
|
package/version.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "6.
|
|
1
|
+
export declare const VERSION = "6.73.1";
|
|
2
2
|
//# sourceMappingURL=version.d.mts.map
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "6.
|
|
1
|
+
export declare const VERSION = "6.73.1";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '6.
|
|
1
|
+
export const VERSION = '6.73.1'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|