telnyx 6.35.0 → 6.36.0
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 +14 -0
- package/client.d.mts +2 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +2 -2
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/enterprises/enterprises.d.mts +2 -2
- package/resources/enterprises/enterprises.d.mts.map +1 -1
- package/resources/enterprises/enterprises.d.ts +2 -2
- package/resources/enterprises/enterprises.d.ts.map +1 -1
- package/resources/enterprises/index.d.mts +1 -1
- package/resources/enterprises/index.d.mts.map +1 -1
- package/resources/enterprises/index.d.ts +1 -1
- package/resources/enterprises/index.d.ts.map +1 -1
- package/resources/enterprises/reputation/index.d.mts +2 -2
- package/resources/enterprises/reputation/index.d.mts.map +1 -1
- package/resources/enterprises/reputation/index.d.ts +2 -2
- package/resources/enterprises/reputation/index.d.ts.map +1 -1
- package/resources/enterprises/reputation/numbers.d.mts +43 -43
- package/resources/enterprises/reputation/numbers.d.mts.map +1 -1
- package/resources/enterprises/reputation/numbers.d.ts +43 -43
- package/resources/enterprises/reputation/numbers.d.ts.map +1 -1
- package/resources/enterprises/reputation/numbers.js +31 -31
- package/resources/enterprises/reputation/numbers.js.map +1 -1
- package/resources/enterprises/reputation/numbers.mjs +31 -31
- package/resources/enterprises/reputation/numbers.mjs.map +1 -1
- package/resources/enterprises/reputation/reputation.d.mts +45 -46
- package/resources/enterprises/reputation/reputation.d.mts.map +1 -1
- package/resources/enterprises/reputation/reputation.d.ts +45 -46
- package/resources/enterprises/reputation/reputation.d.ts.map +1 -1
- package/resources/enterprises/reputation/reputation.js +43 -44
- package/resources/enterprises/reputation/reputation.js.map +1 -1
- package/resources/enterprises/reputation/reputation.mjs +43 -44
- package/resources/enterprises/reputation/reputation.mjs.map +1 -1
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/texml/accounts/calls/calls.d.mts +7 -0
- package/resources/texml/accounts/calls/calls.d.mts.map +1 -1
- package/resources/texml/accounts/calls/calls.d.ts +7 -0
- package/resources/texml/accounts/calls/calls.d.ts.map +1 -1
- package/resources/texml/accounts/calls/calls.js.map +1 -1
- package/resources/texml/accounts/calls/calls.mjs.map +1 -1
- package/resources/texml/index.d.mts +1 -1
- package/resources/texml/index.d.mts.map +1 -1
- package/resources/texml/index.d.ts +1 -1
- package/resources/texml/index.d.ts.map +1 -1
- package/resources/texml/index.js.map +1 -1
- package/resources/texml/index.mjs +1 -1
- package/resources/texml/index.mjs.map +1 -1
- package/resources/texml/texml.d.mts +219 -1
- package/resources/texml/texml.d.mts.map +1 -1
- package/resources/texml/texml.d.ts +219 -1
- package/resources/texml/texml.d.ts.map +1 -1
- package/resources/texml/texml.js +26 -0
- package/resources/texml/texml.js.map +1 -1
- package/resources/texml/texml.mjs +26 -0
- package/resources/texml/texml.mjs.map +1 -1
- package/src/client.ts +9 -1
- package/src/resources/enterprises/enterprises.ts +6 -6
- package/src/resources/enterprises/index.ts +3 -3
- package/src/resources/enterprises/reputation/index.ts +6 -6
- package/src/resources/enterprises/reputation/numbers.ts +58 -54
- package/src/resources/enterprises/reputation/reputation.ts +60 -61
- package/src/resources/index.ts +7 -1
- package/src/resources/texml/accounts/calls/calls.ts +8 -0
- package/src/resources/texml/index.ts +7 -1
- package/src/resources/texml/texml.ts +279 -1
- 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
|
@@ -8,33 +8,6 @@ import { RequestOptions } from "../../../internal/request-options.js";
|
|
|
8
8
|
* Associate phone numbers with an enterprise for reputation monitoring and retrieve reputation scores
|
|
9
9
|
*/
|
|
10
10
|
export declare class Numbers extends APIResource {
|
|
11
|
-
/**
|
|
12
|
-
* Associate one or more phone numbers with an enterprise for Number Reputation
|
|
13
|
-
* monitoring.
|
|
14
|
-
*
|
|
15
|
-
* **Validations:**
|
|
16
|
-
*
|
|
17
|
-
* - Phone numbers must be in E.164 format (e.g., `+16035551234`)
|
|
18
|
-
* - Phone numbers must be in-service and belong to your account (verified via
|
|
19
|
-
* Warehouse)
|
|
20
|
-
* - Phone numbers must be US local numbers
|
|
21
|
-
* - Phone numbers cannot already be associated with any enterprise
|
|
22
|
-
*
|
|
23
|
-
* **Note:** This operation is atomic — if any number fails validation, the entire
|
|
24
|
-
* request fails.
|
|
25
|
-
*
|
|
26
|
-
* **Maximum:** 100 phone numbers per request.
|
|
27
|
-
*
|
|
28
|
-
* @example
|
|
29
|
-
* ```ts
|
|
30
|
-
* const number =
|
|
31
|
-
* await client.enterprises.reputation.numbers.create(
|
|
32
|
-
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
33
|
-
* { phone_numbers: ['+16035551234'] },
|
|
34
|
-
* );
|
|
35
|
-
* ```
|
|
36
|
-
*/
|
|
37
|
-
create(enterpriseID: string, body: NumberCreateParams, options?: RequestOptions): APIPromise<NumberCreateResponse>;
|
|
38
11
|
/**
|
|
39
12
|
* Get detailed reputation data for a specific phone number associated with an
|
|
40
13
|
* enterprise.
|
|
@@ -85,6 +58,33 @@ export declare class Numbers extends APIResource {
|
|
|
85
58
|
* ```
|
|
86
59
|
*/
|
|
87
60
|
list(enterpriseID: string, query?: NumberListParams | null | undefined, options?: RequestOptions): PagePromise<ReputationPhoneNumberWithReputationDataDefaultFlatPagination, Shared.ReputationPhoneNumberWithReputationData>;
|
|
61
|
+
/**
|
|
62
|
+
* Associate one or more phone numbers with an enterprise for Number Reputation
|
|
63
|
+
* monitoring.
|
|
64
|
+
*
|
|
65
|
+
* **Validations:**
|
|
66
|
+
*
|
|
67
|
+
* - Phone numbers must be in E.164 format (e.g., `+16035551234`)
|
|
68
|
+
* - Phone numbers must be in-service and belong to your account (verified via
|
|
69
|
+
* Warehouse)
|
|
70
|
+
* - Phone numbers must be US local numbers
|
|
71
|
+
* - Phone numbers cannot already be associated with any enterprise
|
|
72
|
+
*
|
|
73
|
+
* **Note:** This operation is atomic — if any number fails validation, the entire
|
|
74
|
+
* request fails.
|
|
75
|
+
*
|
|
76
|
+
* **Maximum:** 100 phone numbers per request.
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* ```ts
|
|
80
|
+
* const response =
|
|
81
|
+
* await client.enterprises.reputation.numbers.associate(
|
|
82
|
+
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
83
|
+
* { phone_numbers: ['+16035551234'] },
|
|
84
|
+
* );
|
|
85
|
+
* ```
|
|
86
|
+
*/
|
|
87
|
+
associate(enterpriseID: string, body: NumberAssociateParams, options?: RequestOptions): APIPromise<NumberAssociateResponse>;
|
|
88
88
|
/**
|
|
89
89
|
* Remove a phone number from Number Reputation monitoring for an enterprise.
|
|
90
90
|
*
|
|
@@ -93,19 +93,22 @@ export declare class Numbers extends APIResource {
|
|
|
93
93
|
*
|
|
94
94
|
* @example
|
|
95
95
|
* ```ts
|
|
96
|
-
* await client.enterprises.reputation.numbers.
|
|
96
|
+
* await client.enterprises.reputation.numbers.disassociate(
|
|
97
97
|
* '+16035551234',
|
|
98
98
|
* { enterprise_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58' },
|
|
99
99
|
* );
|
|
100
100
|
* ```
|
|
101
101
|
*/
|
|
102
|
-
|
|
102
|
+
disassociate(phoneNumber: string, params: NumberDisassociateParams, options?: RequestOptions): APIPromise<void>;
|
|
103
103
|
}
|
|
104
|
-
export interface
|
|
105
|
-
data?:
|
|
104
|
+
export interface NumberRetrieveResponse {
|
|
105
|
+
data?: Shared.ReputationPhoneNumberWithReputationData;
|
|
106
|
+
}
|
|
107
|
+
export interface NumberAssociateResponse {
|
|
108
|
+
data?: Array<NumberAssociateResponse.Data>;
|
|
106
109
|
meta?: Shared.MetaInfo;
|
|
107
110
|
}
|
|
108
|
-
export declare namespace
|
|
111
|
+
export declare namespace NumberAssociateResponse {
|
|
109
112
|
interface Data {
|
|
110
113
|
/**
|
|
111
114
|
* Unique identifier
|
|
@@ -129,15 +132,6 @@ export declare namespace NumberCreateResponse {
|
|
|
129
132
|
updated_at?: string;
|
|
130
133
|
}
|
|
131
134
|
}
|
|
132
|
-
export interface NumberRetrieveResponse {
|
|
133
|
-
data?: Shared.ReputationPhoneNumberWithReputationData;
|
|
134
|
-
}
|
|
135
|
-
export interface NumberCreateParams {
|
|
136
|
-
/**
|
|
137
|
-
* List of phone numbers to associate for reputation monitoring (max 100)
|
|
138
|
-
*/
|
|
139
|
-
phone_numbers: Array<string>;
|
|
140
|
-
}
|
|
141
135
|
export interface NumberRetrieveParams {
|
|
142
136
|
/**
|
|
143
137
|
* Path param: Unique identifier of the enterprise (UUID)
|
|
@@ -155,14 +149,20 @@ export interface NumberListParams extends DefaultFlatPaginationParams {
|
|
|
155
149
|
*/
|
|
156
150
|
phone_number?: string;
|
|
157
151
|
}
|
|
158
|
-
export interface
|
|
152
|
+
export interface NumberAssociateParams {
|
|
153
|
+
/**
|
|
154
|
+
* List of phone numbers to associate for reputation monitoring (max 100)
|
|
155
|
+
*/
|
|
156
|
+
phone_numbers: Array<string>;
|
|
157
|
+
}
|
|
158
|
+
export interface NumberDisassociateParams {
|
|
159
159
|
/**
|
|
160
160
|
* Unique identifier of the enterprise (UUID)
|
|
161
161
|
*/
|
|
162
162
|
enterprise_id: string;
|
|
163
163
|
}
|
|
164
164
|
export declare namespace Numbers {
|
|
165
|
-
export { type
|
|
165
|
+
export { type NumberRetrieveResponse as NumberRetrieveResponse, type NumberAssociateResponse as NumberAssociateResponse, type NumberRetrieveParams as NumberRetrieveParams, type NumberListParams as NumberListParams, type NumberAssociateParams as NumberAssociateParams, type NumberDisassociateParams as NumberDisassociateParams, };
|
|
166
166
|
}
|
|
167
167
|
export { type ReputationPhoneNumberWithReputationDataDefaultFlatPagination };
|
|
168
168
|
//# sourceMappingURL=numbers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"numbers.d.ts","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,4DAA4D,EAAE;OAChE,EAAE,UAAU,EAAE;OACd,EAEL,KAAK,2BAA2B,EAChC,WAAW,EACZ;OAEM,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"numbers.d.ts","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,4DAA4D,EAAE;OAChE,EAAE,UAAU,EAAE;OACd,EAEL,KAAK,2BAA2B,EAChC,WAAW,EACZ;OAEM,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAQrC;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CACZ,4DAA4D,EAC5D,MAAM,CAAC,uCAAuC,CAC/C;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,SAAS,CACP,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC,uCAAuC,CAAC;CACvD;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAE3C,IAAI,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC;CACxB;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,gBAAiB,SAAQ,2BAA2B;IACnE;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH;AAED,OAAO,EAAE,KAAK,4DAA4D,EAAE,CAAC"}
|
|
@@ -10,35 +10,6 @@ const path_1 = require("../../../internal/utils/path.js");
|
|
|
10
10
|
* Associate phone numbers with an enterprise for reputation monitoring and retrieve reputation scores
|
|
11
11
|
*/
|
|
12
12
|
class Numbers extends resource_1.APIResource {
|
|
13
|
-
/**
|
|
14
|
-
* Associate one or more phone numbers with an enterprise for Number Reputation
|
|
15
|
-
* monitoring.
|
|
16
|
-
*
|
|
17
|
-
* **Validations:**
|
|
18
|
-
*
|
|
19
|
-
* - Phone numbers must be in E.164 format (e.g., `+16035551234`)
|
|
20
|
-
* - Phone numbers must be in-service and belong to your account (verified via
|
|
21
|
-
* Warehouse)
|
|
22
|
-
* - Phone numbers must be US local numbers
|
|
23
|
-
* - Phone numbers cannot already be associated with any enterprise
|
|
24
|
-
*
|
|
25
|
-
* **Note:** This operation is atomic — if any number fails validation, the entire
|
|
26
|
-
* request fails.
|
|
27
|
-
*
|
|
28
|
-
* **Maximum:** 100 phone numbers per request.
|
|
29
|
-
*
|
|
30
|
-
* @example
|
|
31
|
-
* ```ts
|
|
32
|
-
* const number =
|
|
33
|
-
* await client.enterprises.reputation.numbers.create(
|
|
34
|
-
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
35
|
-
* { phone_numbers: ['+16035551234'] },
|
|
36
|
-
* );
|
|
37
|
-
* ```
|
|
38
|
-
*/
|
|
39
|
-
create(enterpriseID, body, options) {
|
|
40
|
-
return this._client.post((0, path_1.path) `/enterprises/${enterpriseID}/reputation/numbers`, { body, ...options });
|
|
41
|
-
}
|
|
42
13
|
/**
|
|
43
14
|
* Get detailed reputation data for a specific phone number associated with an
|
|
44
15
|
* enterprise.
|
|
@@ -97,6 +68,35 @@ class Numbers extends resource_1.APIResource {
|
|
|
97
68
|
list(enterpriseID, query = {}, options) {
|
|
98
69
|
return this._client.getAPIList((0, path_1.path) `/enterprises/${enterpriseID}/reputation/numbers`, (pagination_1.DefaultFlatPagination), { query, ...options });
|
|
99
70
|
}
|
|
71
|
+
/**
|
|
72
|
+
* Associate one or more phone numbers with an enterprise for Number Reputation
|
|
73
|
+
* monitoring.
|
|
74
|
+
*
|
|
75
|
+
* **Validations:**
|
|
76
|
+
*
|
|
77
|
+
* - Phone numbers must be in E.164 format (e.g., `+16035551234`)
|
|
78
|
+
* - Phone numbers must be in-service and belong to your account (verified via
|
|
79
|
+
* Warehouse)
|
|
80
|
+
* - Phone numbers must be US local numbers
|
|
81
|
+
* - Phone numbers cannot already be associated with any enterprise
|
|
82
|
+
*
|
|
83
|
+
* **Note:** This operation is atomic — if any number fails validation, the entire
|
|
84
|
+
* request fails.
|
|
85
|
+
*
|
|
86
|
+
* **Maximum:** 100 phone numbers per request.
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* ```ts
|
|
90
|
+
* const response =
|
|
91
|
+
* await client.enterprises.reputation.numbers.associate(
|
|
92
|
+
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
93
|
+
* { phone_numbers: ['+16035551234'] },
|
|
94
|
+
* );
|
|
95
|
+
* ```
|
|
96
|
+
*/
|
|
97
|
+
associate(enterpriseID, body, options) {
|
|
98
|
+
return this._client.post((0, path_1.path) `/enterprises/${enterpriseID}/reputation/numbers`, { body, ...options });
|
|
99
|
+
}
|
|
100
100
|
/**
|
|
101
101
|
* Remove a phone number from Number Reputation monitoring for an enterprise.
|
|
102
102
|
*
|
|
@@ -105,13 +105,13 @@ class Numbers extends resource_1.APIResource {
|
|
|
105
105
|
*
|
|
106
106
|
* @example
|
|
107
107
|
* ```ts
|
|
108
|
-
* await client.enterprises.reputation.numbers.
|
|
108
|
+
* await client.enterprises.reputation.numbers.disassociate(
|
|
109
109
|
* '+16035551234',
|
|
110
110
|
* { enterprise_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58' },
|
|
111
111
|
* );
|
|
112
112
|
* ```
|
|
113
113
|
*/
|
|
114
|
-
|
|
114
|
+
disassociate(phoneNumber, params, options) {
|
|
115
115
|
const { enterprise_id } = params;
|
|
116
116
|
return this._client.delete((0, path_1.path) `/enterprises/${enterprise_id}/reputation/numbers/${phoneNumber}`, {
|
|
117
117
|
...options,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"numbers.js","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,4DAIkC;AAClC,0DAAyD;AAEzD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC
|
|
1
|
+
{"version":3,"file":"numbers.js","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,4DAIkC;AAClC,0DAAyD;AAEzD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,QAAQ,CACN,WAAmB,EACnB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,aAAa,uBAAuB,WAAW,EAAE,EAAE;YAC7F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,YAAoB,EACpB,QAA6C,EAAE,EAC/C,OAAwB;QAKxB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,gBAAgB,YAAY,qBAAqB,EACrD,CAAA,kCAAqE,CAAA,EACrE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,SAAS,CACP,YAAoB,EACpB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,YAAY,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,WAAmB,EACnB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,aAAa,uBAAuB,WAAW,EAAE,EAAE;YAChG,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAvID,0BAuIC"}
|
|
@@ -7,35 +7,6 @@ import { path } from "../../../internal/utils/path.mjs";
|
|
|
7
7
|
* Associate phone numbers with an enterprise for reputation monitoring and retrieve reputation scores
|
|
8
8
|
*/
|
|
9
9
|
export class Numbers extends APIResource {
|
|
10
|
-
/**
|
|
11
|
-
* Associate one or more phone numbers with an enterprise for Number Reputation
|
|
12
|
-
* monitoring.
|
|
13
|
-
*
|
|
14
|
-
* **Validations:**
|
|
15
|
-
*
|
|
16
|
-
* - Phone numbers must be in E.164 format (e.g., `+16035551234`)
|
|
17
|
-
* - Phone numbers must be in-service and belong to your account (verified via
|
|
18
|
-
* Warehouse)
|
|
19
|
-
* - Phone numbers must be US local numbers
|
|
20
|
-
* - Phone numbers cannot already be associated with any enterprise
|
|
21
|
-
*
|
|
22
|
-
* **Note:** This operation is atomic — if any number fails validation, the entire
|
|
23
|
-
* request fails.
|
|
24
|
-
*
|
|
25
|
-
* **Maximum:** 100 phone numbers per request.
|
|
26
|
-
*
|
|
27
|
-
* @example
|
|
28
|
-
* ```ts
|
|
29
|
-
* const number =
|
|
30
|
-
* await client.enterprises.reputation.numbers.create(
|
|
31
|
-
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
32
|
-
* { phone_numbers: ['+16035551234'] },
|
|
33
|
-
* );
|
|
34
|
-
* ```
|
|
35
|
-
*/
|
|
36
|
-
create(enterpriseID, body, options) {
|
|
37
|
-
return this._client.post(path `/enterprises/${enterpriseID}/reputation/numbers`, { body, ...options });
|
|
38
|
-
}
|
|
39
10
|
/**
|
|
40
11
|
* Get detailed reputation data for a specific phone number associated with an
|
|
41
12
|
* enterprise.
|
|
@@ -94,6 +65,35 @@ export class Numbers extends APIResource {
|
|
|
94
65
|
list(enterpriseID, query = {}, options) {
|
|
95
66
|
return this._client.getAPIList(path `/enterprises/${enterpriseID}/reputation/numbers`, (DefaultFlatPagination), { query, ...options });
|
|
96
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* Associate one or more phone numbers with an enterprise for Number Reputation
|
|
70
|
+
* monitoring.
|
|
71
|
+
*
|
|
72
|
+
* **Validations:**
|
|
73
|
+
*
|
|
74
|
+
* - Phone numbers must be in E.164 format (e.g., `+16035551234`)
|
|
75
|
+
* - Phone numbers must be in-service and belong to your account (verified via
|
|
76
|
+
* Warehouse)
|
|
77
|
+
* - Phone numbers must be US local numbers
|
|
78
|
+
* - Phone numbers cannot already be associated with any enterprise
|
|
79
|
+
*
|
|
80
|
+
* **Note:** This operation is atomic — if any number fails validation, the entire
|
|
81
|
+
* request fails.
|
|
82
|
+
*
|
|
83
|
+
* **Maximum:** 100 phone numbers per request.
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* ```ts
|
|
87
|
+
* const response =
|
|
88
|
+
* await client.enterprises.reputation.numbers.associate(
|
|
89
|
+
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
90
|
+
* { phone_numbers: ['+16035551234'] },
|
|
91
|
+
* );
|
|
92
|
+
* ```
|
|
93
|
+
*/
|
|
94
|
+
associate(enterpriseID, body, options) {
|
|
95
|
+
return this._client.post(path `/enterprises/${enterpriseID}/reputation/numbers`, { body, ...options });
|
|
96
|
+
}
|
|
97
97
|
/**
|
|
98
98
|
* Remove a phone number from Number Reputation monitoring for an enterprise.
|
|
99
99
|
*
|
|
@@ -102,13 +102,13 @@ export class Numbers extends APIResource {
|
|
|
102
102
|
*
|
|
103
103
|
* @example
|
|
104
104
|
* ```ts
|
|
105
|
-
* await client.enterprises.reputation.numbers.
|
|
105
|
+
* await client.enterprises.reputation.numbers.disassociate(
|
|
106
106
|
* '+16035551234',
|
|
107
107
|
* { enterprise_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58' },
|
|
108
108
|
* );
|
|
109
109
|
* ```
|
|
110
110
|
*/
|
|
111
|
-
|
|
111
|
+
disassociate(phoneNumber, params, options) {
|
|
112
112
|
const { enterprise_id } = params;
|
|
113
113
|
return this._client.delete(path `/enterprises/${enterprise_id}/reputation/numbers/${phoneNumber}`, {
|
|
114
114
|
...options,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"numbers.mjs","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EACL,qBAAqB,GAGtB;OACM,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"numbers.mjs","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EACL,qBAAqB,GAGtB;OACM,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,QAAQ,CACN,WAAmB,EACnB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,aAAa,uBAAuB,WAAW,EAAE,EAAE;YAC7F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,YAAoB,EACpB,QAA6C,EAAE,EAC/C,OAAwB;QAKxB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,gBAAgB,YAAY,qBAAqB,EACrD,CAAA,qBAAqE,CAAA,EACrE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,SAAS,CACP,YAAoB,EACpB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,YAAY,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,WAAmB,EACnB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,aAAa,uBAAuB,WAAW,EAAE,EAAE;YAChG,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../../core/resource.mjs";
|
|
2
2
|
import * as NumbersAPI from "./numbers.mjs";
|
|
3
|
-
import {
|
|
3
|
+
import { NumberAssociateParams, NumberAssociateResponse, NumberDisassociateParams, NumberListParams, NumberRetrieveParams, NumberRetrieveResponse, Numbers } from "./numbers.mjs";
|
|
4
4
|
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
5
5
|
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
6
6
|
/**
|
|
@@ -8,6 +8,42 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
|
8
8
|
*/
|
|
9
9
|
export declare class Reputation extends APIResource {
|
|
10
10
|
numbers: NumbersAPI.Numbers;
|
|
11
|
+
/**
|
|
12
|
+
* Retrieve the current Number Reputation settings for an enterprise.
|
|
13
|
+
*
|
|
14
|
+
* Returns the enrollment status (`pending`, `approved`, `rejected`, `deleted`),
|
|
15
|
+
* check frequency, and any rejection reasons.
|
|
16
|
+
*
|
|
17
|
+
* Returns `404` if reputation has not been enabled for this enterprise.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* const reputation =
|
|
22
|
+
* await client.enterprises.reputation.retrieve(
|
|
23
|
+
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
24
|
+
* );
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
retrieve(enterpriseID: string, options?: RequestOptions): APIPromise<ReputationRetrieveResponse>;
|
|
28
|
+
/**
|
|
29
|
+
* Disable Number Reputation for an enterprise.
|
|
30
|
+
*
|
|
31
|
+
* This will:
|
|
32
|
+
*
|
|
33
|
+
* - Delete the reputation settings record
|
|
34
|
+
* - Log the deletion for audit purposes
|
|
35
|
+
* - Stop all future automated reputation checks
|
|
36
|
+
*
|
|
37
|
+
* **Note:** Can only be performed on `approved` reputation settings.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* await client.enterprises.reputation.disable(
|
|
42
|
+
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
43
|
+
* );
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
disable(enterpriseID: string, options?: RequestOptions): APIPromise<void>;
|
|
11
47
|
/**
|
|
12
48
|
* Enable Number Reputation service for an enterprise.
|
|
13
49
|
*
|
|
@@ -37,50 +73,13 @@ export declare class Reputation extends APIResource {
|
|
|
37
73
|
*
|
|
38
74
|
* @example
|
|
39
75
|
* ```ts
|
|
40
|
-
* const
|
|
41
|
-
* await client.enterprises.reputation.create(
|
|
42
|
-
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
43
|
-
* { loa_document_id: 'doc_01HXYZ1234ABCDEF' },
|
|
44
|
-
* );
|
|
45
|
-
* ```
|
|
46
|
-
*/
|
|
47
|
-
create(enterpriseID: string, body: ReputationCreateParams, options?: RequestOptions): APIPromise<ReputationCreateResponse>;
|
|
48
|
-
/**
|
|
49
|
-
* Retrieve the current Number Reputation settings for an enterprise.
|
|
50
|
-
*
|
|
51
|
-
* Returns the enrollment status (`pending`, `approved`, `rejected`, `deleted`),
|
|
52
|
-
* check frequency, and any rejection reasons.
|
|
53
|
-
*
|
|
54
|
-
* Returns `404` if reputation has not been enabled for this enterprise.
|
|
55
|
-
*
|
|
56
|
-
* @example
|
|
57
|
-
* ```ts
|
|
58
|
-
* const reputations =
|
|
59
|
-
* await client.enterprises.reputation.list(
|
|
60
|
-
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
61
|
-
* );
|
|
62
|
-
* ```
|
|
63
|
-
*/
|
|
64
|
-
list(enterpriseID: string, options?: RequestOptions): APIPromise<ReputationListResponse>;
|
|
65
|
-
/**
|
|
66
|
-
* Disable Number Reputation for an enterprise.
|
|
67
|
-
*
|
|
68
|
-
* This will:
|
|
69
|
-
*
|
|
70
|
-
* - Delete the reputation settings record
|
|
71
|
-
* - Log the deletion for audit purposes
|
|
72
|
-
* - Stop all future automated reputation checks
|
|
73
|
-
*
|
|
74
|
-
* **Note:** Can only be performed on `approved` reputation settings.
|
|
75
|
-
*
|
|
76
|
-
* @example
|
|
77
|
-
* ```ts
|
|
78
|
-
* await client.enterprises.reputation.deleteAll(
|
|
76
|
+
* const response = await client.enterprises.reputation.enable(
|
|
79
77
|
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
78
|
+
* { loa_document_id: 'doc_01HXYZ1234ABCDEF' },
|
|
80
79
|
* );
|
|
81
80
|
* ```
|
|
82
81
|
*/
|
|
83
|
-
|
|
82
|
+
enable(enterpriseID: string, body: ReputationEnableParams, options?: RequestOptions): APIPromise<ReputationEnableResponse>;
|
|
84
83
|
/**
|
|
85
84
|
* Update how often reputation data is automatically refreshed.
|
|
86
85
|
*
|
|
@@ -137,16 +136,16 @@ export interface EnterpriseReputationPublic {
|
|
|
137
136
|
*/
|
|
138
137
|
updated_at?: string;
|
|
139
138
|
}
|
|
140
|
-
export interface
|
|
139
|
+
export interface ReputationRetrieveResponse {
|
|
141
140
|
data?: EnterpriseReputationPublic;
|
|
142
141
|
}
|
|
143
|
-
export interface
|
|
142
|
+
export interface ReputationEnableResponse {
|
|
144
143
|
data?: EnterpriseReputationPublic;
|
|
145
144
|
}
|
|
146
145
|
export interface ReputationUpdateFrequencyResponse {
|
|
147
146
|
data?: EnterpriseReputationPublic;
|
|
148
147
|
}
|
|
149
|
-
export interface
|
|
148
|
+
export interface ReputationEnableParams {
|
|
150
149
|
/**
|
|
151
150
|
* ID of the signed Letter of Authorization (LOA) document uploaded to the document
|
|
152
151
|
* service
|
|
@@ -164,7 +163,7 @@ export interface ReputationUpdateFrequencyParams {
|
|
|
164
163
|
check_frequency: 'business_daily' | 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'never';
|
|
165
164
|
}
|
|
166
165
|
export declare namespace Reputation {
|
|
167
|
-
export { type EnterpriseReputationPublic as EnterpriseReputationPublic, type
|
|
168
|
-
export { Numbers as Numbers, type
|
|
166
|
+
export { type EnterpriseReputationPublic as EnterpriseReputationPublic, type ReputationRetrieveResponse as ReputationRetrieveResponse, type ReputationEnableResponse as ReputationEnableResponse, type ReputationUpdateFrequencyResponse as ReputationUpdateFrequencyResponse, type ReputationEnableParams as ReputationEnableParams, type ReputationUpdateFrequencyParams as ReputationUpdateFrequencyParams, };
|
|
167
|
+
export { Numbers as Numbers, type NumberRetrieveResponse as NumberRetrieveResponse, type NumberAssociateResponse as NumberAssociateResponse, type NumberRetrieveParams as NumberRetrieveParams, type NumberListParams as NumberListParams, type NumberAssociateParams as NumberAssociateParams, type NumberDisassociateParams as NumberDisassociateParams, };
|
|
169
168
|
}
|
|
170
169
|
//# sourceMappingURL=reputation.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reputation.d.mts","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/reputation.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,
|
|
1
|
+
{"version":3,"file":"reputation.d.mts","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/reputation.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACtB,OAAO,EACR;OACM,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIhG;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,eAAe,CACb,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;CAGjD;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,eAAe,CAAC,EAAE,gBAAgB,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;IAE3F;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;IAEzD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,EAAE,0BAA0B,CAAC;CACnC;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,0BAA0B,CAAC;CACnC;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,0BAA0B,CAAC;CACnC;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,CAAC,EAAE,gBAAgB,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;CAC5F;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,eAAe,EAAE,gBAAgB,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;CAC3F;AAID,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../../core/resource.js";
|
|
2
2
|
import * as NumbersAPI from "./numbers.js";
|
|
3
|
-
import {
|
|
3
|
+
import { NumberAssociateParams, NumberAssociateResponse, NumberDisassociateParams, NumberListParams, NumberRetrieveParams, NumberRetrieveResponse, Numbers } from "./numbers.js";
|
|
4
4
|
import { APIPromise } from "../../../core/api-promise.js";
|
|
5
5
|
import { RequestOptions } from "../../../internal/request-options.js";
|
|
6
6
|
/**
|
|
@@ -8,6 +8,42 @@ import { RequestOptions } from "../../../internal/request-options.js";
|
|
|
8
8
|
*/
|
|
9
9
|
export declare class Reputation extends APIResource {
|
|
10
10
|
numbers: NumbersAPI.Numbers;
|
|
11
|
+
/**
|
|
12
|
+
* Retrieve the current Number Reputation settings for an enterprise.
|
|
13
|
+
*
|
|
14
|
+
* Returns the enrollment status (`pending`, `approved`, `rejected`, `deleted`),
|
|
15
|
+
* check frequency, and any rejection reasons.
|
|
16
|
+
*
|
|
17
|
+
* Returns `404` if reputation has not been enabled for this enterprise.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* const reputation =
|
|
22
|
+
* await client.enterprises.reputation.retrieve(
|
|
23
|
+
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
24
|
+
* );
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
retrieve(enterpriseID: string, options?: RequestOptions): APIPromise<ReputationRetrieveResponse>;
|
|
28
|
+
/**
|
|
29
|
+
* Disable Number Reputation for an enterprise.
|
|
30
|
+
*
|
|
31
|
+
* This will:
|
|
32
|
+
*
|
|
33
|
+
* - Delete the reputation settings record
|
|
34
|
+
* - Log the deletion for audit purposes
|
|
35
|
+
* - Stop all future automated reputation checks
|
|
36
|
+
*
|
|
37
|
+
* **Note:** Can only be performed on `approved` reputation settings.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* await client.enterprises.reputation.disable(
|
|
42
|
+
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
43
|
+
* );
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
disable(enterpriseID: string, options?: RequestOptions): APIPromise<void>;
|
|
11
47
|
/**
|
|
12
48
|
* Enable Number Reputation service for an enterprise.
|
|
13
49
|
*
|
|
@@ -37,50 +73,13 @@ export declare class Reputation extends APIResource {
|
|
|
37
73
|
*
|
|
38
74
|
* @example
|
|
39
75
|
* ```ts
|
|
40
|
-
* const
|
|
41
|
-
* await client.enterprises.reputation.create(
|
|
42
|
-
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
43
|
-
* { loa_document_id: 'doc_01HXYZ1234ABCDEF' },
|
|
44
|
-
* );
|
|
45
|
-
* ```
|
|
46
|
-
*/
|
|
47
|
-
create(enterpriseID: string, body: ReputationCreateParams, options?: RequestOptions): APIPromise<ReputationCreateResponse>;
|
|
48
|
-
/**
|
|
49
|
-
* Retrieve the current Number Reputation settings for an enterprise.
|
|
50
|
-
*
|
|
51
|
-
* Returns the enrollment status (`pending`, `approved`, `rejected`, `deleted`),
|
|
52
|
-
* check frequency, and any rejection reasons.
|
|
53
|
-
*
|
|
54
|
-
* Returns `404` if reputation has not been enabled for this enterprise.
|
|
55
|
-
*
|
|
56
|
-
* @example
|
|
57
|
-
* ```ts
|
|
58
|
-
* const reputations =
|
|
59
|
-
* await client.enterprises.reputation.list(
|
|
60
|
-
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
61
|
-
* );
|
|
62
|
-
* ```
|
|
63
|
-
*/
|
|
64
|
-
list(enterpriseID: string, options?: RequestOptions): APIPromise<ReputationListResponse>;
|
|
65
|
-
/**
|
|
66
|
-
* Disable Number Reputation for an enterprise.
|
|
67
|
-
*
|
|
68
|
-
* This will:
|
|
69
|
-
*
|
|
70
|
-
* - Delete the reputation settings record
|
|
71
|
-
* - Log the deletion for audit purposes
|
|
72
|
-
* - Stop all future automated reputation checks
|
|
73
|
-
*
|
|
74
|
-
* **Note:** Can only be performed on `approved` reputation settings.
|
|
75
|
-
*
|
|
76
|
-
* @example
|
|
77
|
-
* ```ts
|
|
78
|
-
* await client.enterprises.reputation.deleteAll(
|
|
76
|
+
* const response = await client.enterprises.reputation.enable(
|
|
79
77
|
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
78
|
+
* { loa_document_id: 'doc_01HXYZ1234ABCDEF' },
|
|
80
79
|
* );
|
|
81
80
|
* ```
|
|
82
81
|
*/
|
|
83
|
-
|
|
82
|
+
enable(enterpriseID: string, body: ReputationEnableParams, options?: RequestOptions): APIPromise<ReputationEnableResponse>;
|
|
84
83
|
/**
|
|
85
84
|
* Update how often reputation data is automatically refreshed.
|
|
86
85
|
*
|
|
@@ -137,16 +136,16 @@ export interface EnterpriseReputationPublic {
|
|
|
137
136
|
*/
|
|
138
137
|
updated_at?: string;
|
|
139
138
|
}
|
|
140
|
-
export interface
|
|
139
|
+
export interface ReputationRetrieveResponse {
|
|
141
140
|
data?: EnterpriseReputationPublic;
|
|
142
141
|
}
|
|
143
|
-
export interface
|
|
142
|
+
export interface ReputationEnableResponse {
|
|
144
143
|
data?: EnterpriseReputationPublic;
|
|
145
144
|
}
|
|
146
145
|
export interface ReputationUpdateFrequencyResponse {
|
|
147
146
|
data?: EnterpriseReputationPublic;
|
|
148
147
|
}
|
|
149
|
-
export interface
|
|
148
|
+
export interface ReputationEnableParams {
|
|
150
149
|
/**
|
|
151
150
|
* ID of the signed Letter of Authorization (LOA) document uploaded to the document
|
|
152
151
|
* service
|
|
@@ -164,7 +163,7 @@ export interface ReputationUpdateFrequencyParams {
|
|
|
164
163
|
check_frequency: 'business_daily' | 'daily' | 'weekly' | 'biweekly' | 'monthly' | 'never';
|
|
165
164
|
}
|
|
166
165
|
export declare namespace Reputation {
|
|
167
|
-
export { type EnterpriseReputationPublic as EnterpriseReputationPublic, type
|
|
168
|
-
export { Numbers as Numbers, type
|
|
166
|
+
export { type EnterpriseReputationPublic as EnterpriseReputationPublic, type ReputationRetrieveResponse as ReputationRetrieveResponse, type ReputationEnableResponse as ReputationEnableResponse, type ReputationUpdateFrequencyResponse as ReputationUpdateFrequencyResponse, type ReputationEnableParams as ReputationEnableParams, type ReputationUpdateFrequencyParams as ReputationUpdateFrequencyParams, };
|
|
167
|
+
export { Numbers as Numbers, type NumberRetrieveResponse as NumberRetrieveResponse, type NumberAssociateResponse as NumberAssociateResponse, type NumberRetrieveParams as NumberRetrieveParams, type NumberListParams as NumberListParams, type NumberAssociateParams as NumberAssociateParams, type NumberDisassociateParams as NumberDisassociateParams, };
|
|
169
168
|
}
|
|
170
169
|
//# sourceMappingURL=reputation.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reputation.d.ts","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/reputation.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,
|
|
1
|
+
{"version":3,"file":"reputation.d.ts","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/reputation.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,qBAAqB,EACrB,uBAAuB,EACvB,wBAAwB,EACxB,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACtB,OAAO,EACR;OACM,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIhG;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,eAAe,CACb,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;CAGjD;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,eAAe,CAAC,EAAE,gBAAgB,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;IAE3F;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;IAEzD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,EAAE,0BAA0B,CAAC;CACnC;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,0BAA0B,CAAC;CACnC;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,CAAC,EAAE,0BAA0B,CAAC;CACnC;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,eAAe,CAAC,EAAE,gBAAgB,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;CAC5F;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,eAAe,EAAE,gBAAgB,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;CAC3F;AAID,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|