twilio 6.0.0 → 6.0.2
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/lib/rest/ConversationsBase.d.ts +3 -0
- package/lib/rest/ConversationsBase.js +5 -0
- package/lib/rest/InsightsBase.d.ts +3 -0
- package/lib/rest/InsightsBase.js +5 -0
- package/lib/rest/IntelligenceBase.d.ts +3 -0
- package/lib/rest/IntelligenceBase.js +5 -0
- package/lib/rest/KnowledgeBase.d.ts +3 -0
- package/lib/rest/KnowledgeBase.js +5 -0
- package/lib/rest/Memory.d.ts +4 -0
- package/lib/rest/Memory.js +8 -0
- package/lib/rest/MemoryBase.d.ts +13 -0
- package/lib/rest/MemoryBase.js +31 -0
- package/lib/rest/Twilio.d.ts +5 -0
- package/lib/rest/Twilio.js +5 -0
- package/lib/rest/VoiceBase.d.ts +3 -0
- package/lib/rest/VoiceBase.js +5 -0
- package/lib/rest/api/v2010/account/call/recording.d.ts +2 -0
- package/lib/rest/api/v2010/account/call/recording.js +4 -0
- package/lib/rest/api/v2010/account/call/transcription.d.ts +1 -1
- package/lib/rest/api/v2010/account/call/transcription.js +6 -4
- package/lib/rest/api/v2010/account/call.d.ts +2 -0
- package/lib/rest/api/v2010/account/call.js +4 -0
- package/lib/rest/api/v2010/account/conference/participant.d.ts +2 -0
- package/lib/rest/api/v2010/account/conference/participant.js +4 -0
- package/lib/rest/conversations/V2.d.ts +38 -0
- package/lib/rest/conversations/V2.js +72 -0
- package/lib/rest/conversations/v2/action.d.ts +241 -0
- package/lib/rest/conversations/v2/action.js +246 -0
- package/lib/rest/conversations/v2/communication.d.ts +479 -0
- package/lib/rest/conversations/v2/communication.js +436 -0
- package/lib/rest/conversations/v2/configuration.d.ts +906 -0
- package/lib/rest/conversations/v2/configuration.js +619 -0
- package/lib/rest/conversations/v2/conversation.d.ts +936 -0
- package/lib/rest/conversations/v2/conversation.js +664 -0
- package/lib/rest/conversations/v2/operation.d.ts +167 -0
- package/lib/rest/conversations/v2/operation.js +170 -0
- package/lib/rest/conversations/v2/participant.d.ts +469 -0
- package/lib/rest/conversations/v2/participant.js +442 -0
- package/lib/rest/flexApi/v1/plugin/pluginVersions.d.ts +1 -1
- package/lib/rest/flexApi/v1/plugin/pluginVersions.js +8 -6
- package/lib/rest/insights/V3.d.ts +20 -0
- package/lib/rest/insights/V3.js +42 -0
- package/lib/rest/insights/v1/call/callSummary.d.ts +10 -10
- package/lib/rest/insights/v1/call/event.d.ts +4 -4
- package/lib/rest/insights/v1/callSummaries.d.ts +12 -9
- package/lib/rest/insights/v3/metadata.d.ts +115 -0
- package/lib/rest/insights/v3/metadata.js +118 -0
- package/lib/rest/insights/v3/query.d.ts +180 -0
- package/lib/rest/insights/v3/query.js +214 -0
- package/lib/rest/intelligence/V3.d.ts +35 -0
- package/lib/rest/intelligence/V3.js +65 -0
- package/lib/rest/intelligence/v3/configuration.d.ts +693 -0
- package/lib/rest/intelligence/v3/configuration.js +528 -0
- package/lib/rest/intelligence/v3/conversation.d.ts +478 -0
- package/lib/rest/intelligence/v3/conversation.js +342 -0
- package/lib/rest/intelligence/v3/operator.d.ts +619 -0
- package/lib/rest/intelligence/v3/operator.js +493 -0
- package/lib/rest/intelligence/v3/operatorResult.d.ts +543 -0
- package/lib/rest/intelligence/v3/operatorResult.js +478 -0
- package/lib/rest/intelligence/v3/version.d.ts +469 -0
- package/lib/rest/intelligence/v3/version.js +341 -0
- package/lib/rest/knowledge/V2.d.ts +31 -0
- package/lib/rest/knowledge/V2.js +62 -0
- package/lib/rest/knowledge/v2/chunk.d.ts +209 -0
- package/lib/rest/knowledge/v2/chunk.js +178 -0
- package/lib/rest/knowledge/v2/knowledge.d.ts +507 -0
- package/lib/rest/knowledge/v2/knowledge.js +466 -0
- package/lib/rest/knowledge/v2/knowledgeBasis.d.ts +484 -0
- package/lib/rest/knowledge/v2/knowledgeBasis.js +441 -0
- package/lib/rest/knowledge/v2/operation.d.ts +162 -0
- package/lib/rest/knowledge/v2/operation.js +175 -0
- package/lib/rest/knowledge/v2/search.d.ts +180 -0
- package/lib/rest/knowledge/v2/search.js +174 -0
- package/lib/rest/memory/V1.d.ts +76 -0
- package/lib/rest/memory/V1.js +140 -0
- package/lib/rest/memory/v1/bulk.d.ts +129 -0
- package/lib/rest/memory/v1/bulk.js +158 -0
- package/lib/rest/memory/v1/conversationSummary.d.ts +531 -0
- package/lib/rest/memory/v1/conversationSummary.js +473 -0
- package/lib/rest/memory/v1/dataMapping.d.ts +630 -0
- package/lib/rest/memory/v1/dataMapping.js +512 -0
- package/lib/rest/memory/v1/event.d.ts +153 -0
- package/lib/rest/memory/v1/event.js +159 -0
- package/lib/rest/memory/v1/identifier.d.ts +362 -0
- package/lib/rest/memory/v1/identifier.js +369 -0
- package/lib/rest/memory/v1/identityResolutionSetting.d.ts +247 -0
- package/lib/rest/memory/v1/identityResolutionSetting.js +229 -0
- package/lib/rest/memory/v1/import.d.ts +292 -0
- package/lib/rest/memory/v1/import.js +280 -0
- package/lib/rest/memory/v1/lookup.d.ts +82 -0
- package/lib/rest/memory/v1/lookup.js +118 -0
- package/lib/rest/memory/v1/observation.d.ts +521 -0
- package/lib/rest/memory/v1/observation.js +477 -0
- package/lib/rest/memory/v1/operation.d.ts +162 -0
- package/lib/rest/memory/v1/operation.js +175 -0
- package/lib/rest/memory/v1/profile.d.ts +548 -0
- package/lib/rest/memory/v1/profile.js +531 -0
- package/lib/rest/memory/v1/recall.d.ts +306 -0
- package/lib/rest/memory/v1/recall.js +234 -0
- package/lib/rest/memory/v1/revision.d.ts +246 -0
- package/lib/rest/memory/v1/revision.js +195 -0
- package/lib/rest/memory/v1/store.d.ts +544 -0
- package/lib/rest/memory/v1/store.js +534 -0
- package/lib/rest/memory/v1/trait.d.ts +233 -0
- package/lib/rest/memory/v1/trait.js +190 -0
- package/lib/rest/memory/v1/traitGroup.d.ts +758 -0
- package/lib/rest/memory/v1/traitGroup.js +555 -0
- package/lib/rest/messaging/v2/channelsSender.d.ts +8 -0
- package/lib/rest/messaging/v2/channelsSender.js +2 -0
- package/lib/rest/previewIam/versionless/organization/roleAssignment.d.ts +32 -0
- package/lib/rest/previewIam/versionless/organization/roleAssignment.js +14 -0
- package/lib/rest/studio/v2/flow.d.ts +4 -0
- package/lib/rest/studio/v2/flow.js +8 -0
- package/lib/rest/verify/v2/service/webhook.d.ts +2 -2
- package/lib/rest/verify/v2/service/webhook.js +8 -8
- package/lib/rest/voice/V3.d.ts +15 -0
- package/lib/rest/voice/V3.js +37 -0
- package/lib/rest/voice/v3/transcription.d.ts +378 -0
- package/lib/rest/voice/v3/transcription.js +264 -0
- package/lib/twiml/VoiceResponse.d.ts +8 -0
- package/package.json +1 -1
|
@@ -0,0 +1,369 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/*
|
|
3
|
+
* This code was generated by
|
|
4
|
+
* ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
|
|
5
|
+
* | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
|
|
6
|
+
* | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
|
|
7
|
+
*
|
|
8
|
+
* Twilio Memory API
|
|
9
|
+
* APIs for managing memory stores, profiles, events, and conversational intelligence capabilities.
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator.
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.IdentifierInstance = exports.IdentifierContextImpl = exports.IdentifierUpdate = exports.Identifier = void 0;
|
|
17
|
+
exports.IdentifierListInstance = IdentifierListInstance;
|
|
18
|
+
const util_1 = require("util");
|
|
19
|
+
const deserialize = require("../../../base/deserialize");
|
|
20
|
+
const serialize = require("../../../base/serialize");
|
|
21
|
+
const utility_1 = require("../../../base/utility");
|
|
22
|
+
/**
|
|
23
|
+
* Represents a single identifier value paired with its `idType`. Write operations obey limits, uniqueness, and normalization rules configured via identifier settings.
|
|
24
|
+
*/
|
|
25
|
+
class Identifier {
|
|
26
|
+
constructor(payload) {
|
|
27
|
+
this.idType = payload["idType"];
|
|
28
|
+
this.value = payload["value"];
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
exports.Identifier = Identifier;
|
|
32
|
+
class IdentifierUpdate {
|
|
33
|
+
constructor(payload) {
|
|
34
|
+
this.idType = payload["idType"];
|
|
35
|
+
this.oldValue = payload["oldValue"];
|
|
36
|
+
this.newValue = payload["newValue"];
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
exports.IdentifierUpdate = IdentifierUpdate;
|
|
40
|
+
class IdentifierContextImpl {
|
|
41
|
+
constructor(_version, storeId, profileId, idType) {
|
|
42
|
+
this._version = _version;
|
|
43
|
+
if (!(0, utility_1.isValidPathParam)(storeId)) {
|
|
44
|
+
throw new Error("Parameter 'storeId' is not valid.");
|
|
45
|
+
}
|
|
46
|
+
if (!(0, utility_1.isValidPathParam)(profileId)) {
|
|
47
|
+
throw new Error("Parameter 'profileId' is not valid.");
|
|
48
|
+
}
|
|
49
|
+
if (!(0, utility_1.isValidPathParam)(idType)) {
|
|
50
|
+
throw new Error("Parameter 'idType' is not valid.");
|
|
51
|
+
}
|
|
52
|
+
this._solution = { storeId, profileId, idType };
|
|
53
|
+
this._uri = `/Stores/${storeId}/Profiles/${profileId}/Identifiers/${idType}`;
|
|
54
|
+
}
|
|
55
|
+
remove(params, callback) {
|
|
56
|
+
if (params instanceof Function) {
|
|
57
|
+
callback = params;
|
|
58
|
+
params = {};
|
|
59
|
+
}
|
|
60
|
+
else {
|
|
61
|
+
params = params || {};
|
|
62
|
+
}
|
|
63
|
+
let data = {};
|
|
64
|
+
if (params["removeAll"] !== undefined)
|
|
65
|
+
data["removeAll"] = serialize.bool(params["removeAll"]);
|
|
66
|
+
const headers = {};
|
|
67
|
+
headers["Accept"] = "application/json";
|
|
68
|
+
const instance = this;
|
|
69
|
+
let operationVersion = instance._version, operationPromise = operationVersion.fetch({
|
|
70
|
+
uri: instance._uri,
|
|
71
|
+
method: "delete",
|
|
72
|
+
params: data,
|
|
73
|
+
headers,
|
|
74
|
+
});
|
|
75
|
+
operationPromise = operationPromise.then((payload) => new IdentifierInstance(operationVersion, payload, instance._solution.storeId, instance._solution.profileId, instance._solution.idType));
|
|
76
|
+
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
|
|
77
|
+
return operationPromise;
|
|
78
|
+
}
|
|
79
|
+
removeWithHttpInfo(params, callback) {
|
|
80
|
+
if (params instanceof Function) {
|
|
81
|
+
callback = params;
|
|
82
|
+
params = {};
|
|
83
|
+
}
|
|
84
|
+
else {
|
|
85
|
+
params = params || {};
|
|
86
|
+
}
|
|
87
|
+
let data = {};
|
|
88
|
+
if (params["removeAll"] !== undefined)
|
|
89
|
+
data["removeAll"] = serialize.bool(params["removeAll"]);
|
|
90
|
+
const headers = {};
|
|
91
|
+
headers["Accept"] = "application/json";
|
|
92
|
+
const instance = this;
|
|
93
|
+
let operationVersion = instance._version;
|
|
94
|
+
// DELETE operation that returns a response model
|
|
95
|
+
let operationPromise = operationVersion
|
|
96
|
+
.fetchWithResponseInfo({
|
|
97
|
+
uri: instance._uri,
|
|
98
|
+
method: "delete",
|
|
99
|
+
params: data,
|
|
100
|
+
headers,
|
|
101
|
+
})
|
|
102
|
+
.then((response) => ({
|
|
103
|
+
...response,
|
|
104
|
+
body: new IdentifierInstance(operationVersion, response.body, instance._solution.storeId, instance._solution.profileId, instance._solution.idType),
|
|
105
|
+
}));
|
|
106
|
+
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
|
|
107
|
+
return operationPromise;
|
|
108
|
+
}
|
|
109
|
+
fetch(callback) {
|
|
110
|
+
const headers = {};
|
|
111
|
+
headers["Accept"] = "application/json";
|
|
112
|
+
const instance = this;
|
|
113
|
+
let operationVersion = instance._version, operationPromise = operationVersion.fetch({
|
|
114
|
+
uri: instance._uri,
|
|
115
|
+
method: "get",
|
|
116
|
+
headers,
|
|
117
|
+
});
|
|
118
|
+
operationPromise = operationPromise.then((payload) => new IdentifierInstance(operationVersion, payload, instance._solution.storeId, instance._solution.profileId, instance._solution.idType));
|
|
119
|
+
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
|
|
120
|
+
return operationPromise;
|
|
121
|
+
}
|
|
122
|
+
fetchWithHttpInfo(callback) {
|
|
123
|
+
const headers = {};
|
|
124
|
+
headers["Accept"] = "application/json";
|
|
125
|
+
const instance = this;
|
|
126
|
+
let operationVersion = instance._version;
|
|
127
|
+
// CREATE, FETCH, UPDATE operations
|
|
128
|
+
let operationPromise = operationVersion
|
|
129
|
+
.fetchWithResponseInfo({
|
|
130
|
+
uri: instance._uri,
|
|
131
|
+
method: "get",
|
|
132
|
+
headers,
|
|
133
|
+
})
|
|
134
|
+
.then((response) => ({
|
|
135
|
+
...response,
|
|
136
|
+
body: new IdentifierInstance(operationVersion, response.body, instance._solution.storeId, instance._solution.profileId, instance._solution.idType),
|
|
137
|
+
}));
|
|
138
|
+
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
|
|
139
|
+
return operationPromise;
|
|
140
|
+
}
|
|
141
|
+
patch(params, headers, callback) {
|
|
142
|
+
if (params === null || params === undefined) {
|
|
143
|
+
throw new Error('Required parameter "params" missing.');
|
|
144
|
+
}
|
|
145
|
+
let data = {};
|
|
146
|
+
data = params;
|
|
147
|
+
if (headers === null || headers === undefined) {
|
|
148
|
+
headers = {};
|
|
149
|
+
}
|
|
150
|
+
headers["Content-Type"] = "application/json";
|
|
151
|
+
headers["Accept"] = "application/json";
|
|
152
|
+
const instance = this;
|
|
153
|
+
let operationVersion = instance._version, operationPromise = operationVersion.patch({
|
|
154
|
+
uri: instance._uri,
|
|
155
|
+
method: "patch",
|
|
156
|
+
data,
|
|
157
|
+
headers,
|
|
158
|
+
});
|
|
159
|
+
operationPromise = operationPromise.then((payload) => new IdentifierInstance(operationVersion, payload, instance._solution.storeId, instance._solution.profileId, instance._solution.idType));
|
|
160
|
+
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
|
|
161
|
+
return operationPromise;
|
|
162
|
+
}
|
|
163
|
+
patchWithHttpInfo(params, headers, callback) {
|
|
164
|
+
if (params === null || params === undefined) {
|
|
165
|
+
throw new Error('Required parameter "params" missing.');
|
|
166
|
+
}
|
|
167
|
+
let data = {};
|
|
168
|
+
data = params;
|
|
169
|
+
if (headers === null || headers === undefined) {
|
|
170
|
+
headers = {};
|
|
171
|
+
}
|
|
172
|
+
headers["Content-Type"] = "application/json";
|
|
173
|
+
headers["Accept"] = "application/json";
|
|
174
|
+
const instance = this;
|
|
175
|
+
let operationVersion = instance._version;
|
|
176
|
+
// CREATE, FETCH, UPDATE operations
|
|
177
|
+
let operationPromise = operationVersion
|
|
178
|
+
.patchWithResponseInfo({
|
|
179
|
+
uri: instance._uri,
|
|
180
|
+
method: "patch",
|
|
181
|
+
data,
|
|
182
|
+
headers,
|
|
183
|
+
})
|
|
184
|
+
.then((response) => ({
|
|
185
|
+
...response,
|
|
186
|
+
body: new IdentifierInstance(operationVersion, response.body, instance._solution.storeId, instance._solution.profileId, instance._solution.idType),
|
|
187
|
+
}));
|
|
188
|
+
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
|
|
189
|
+
return operationPromise;
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* Provide a user-friendly representation
|
|
193
|
+
*
|
|
194
|
+
* @returns Object
|
|
195
|
+
*/
|
|
196
|
+
toJSON() {
|
|
197
|
+
return this._solution;
|
|
198
|
+
}
|
|
199
|
+
[util_1.inspect.custom](_depth, options) {
|
|
200
|
+
return (0, util_1.inspect)(this.toJSON(), options);
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
exports.IdentifierContextImpl = IdentifierContextImpl;
|
|
204
|
+
class IdentifierInstance {
|
|
205
|
+
constructor(_version, _payload, storeId, profileId, idType) {
|
|
206
|
+
this._version = _version;
|
|
207
|
+
const payload = _payload;
|
|
208
|
+
this.message = payload.message;
|
|
209
|
+
this.idType = payload.idType;
|
|
210
|
+
this.values = payload.values;
|
|
211
|
+
this._solution = { storeId, profileId, idType: idType };
|
|
212
|
+
}
|
|
213
|
+
get _proxy() {
|
|
214
|
+
this._context =
|
|
215
|
+
this._context ||
|
|
216
|
+
new IdentifierContextImpl(this._version, this._solution.storeId, this._solution.profileId, this._solution.idType);
|
|
217
|
+
return this._context;
|
|
218
|
+
}
|
|
219
|
+
remove(params, callback) {
|
|
220
|
+
return this._proxy.remove(params, callback);
|
|
221
|
+
}
|
|
222
|
+
removeWithHttpInfo(params, callback) {
|
|
223
|
+
return this._proxy.removeWithHttpInfo(params, callback);
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* Fetch a IdentifierInstance
|
|
227
|
+
*
|
|
228
|
+
* @param callback - Callback to handle processed record
|
|
229
|
+
*
|
|
230
|
+
* @returns Resolves to processed IdentifierInstance
|
|
231
|
+
*/
|
|
232
|
+
fetch(callback) {
|
|
233
|
+
return this._proxy.fetch(callback);
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* Fetch a IdentifierInstance and return HTTP info
|
|
237
|
+
*
|
|
238
|
+
* @param callback - Callback to handle processed record
|
|
239
|
+
*
|
|
240
|
+
* @returns Resolves to processed IdentifierInstance with HTTP metadata
|
|
241
|
+
*/
|
|
242
|
+
fetchWithHttpInfo(callback) {
|
|
243
|
+
return this._proxy.fetchWithHttpInfo(callback);
|
|
244
|
+
}
|
|
245
|
+
patch(params, callback) {
|
|
246
|
+
return this._proxy.patch(params, callback);
|
|
247
|
+
}
|
|
248
|
+
patchWithHttpInfo(params, callback) {
|
|
249
|
+
return this._proxy.patchWithHttpInfo(params, callback);
|
|
250
|
+
}
|
|
251
|
+
/**
|
|
252
|
+
* Provide a user-friendly representation
|
|
253
|
+
*
|
|
254
|
+
* @returns Object
|
|
255
|
+
*/
|
|
256
|
+
toJSON() {
|
|
257
|
+
return {
|
|
258
|
+
message: this.message,
|
|
259
|
+
idType: this.idType,
|
|
260
|
+
values: this.values,
|
|
261
|
+
};
|
|
262
|
+
}
|
|
263
|
+
[util_1.inspect.custom](_depth, options) {
|
|
264
|
+
return (0, util_1.inspect)(this.toJSON(), options);
|
|
265
|
+
}
|
|
266
|
+
}
|
|
267
|
+
exports.IdentifierInstance = IdentifierInstance;
|
|
268
|
+
function IdentifierListInstance(version, storeId, profileId) {
|
|
269
|
+
if (!(0, utility_1.isValidPathParam)(storeId)) {
|
|
270
|
+
throw new Error("Parameter 'storeId' is not valid.");
|
|
271
|
+
}
|
|
272
|
+
if (!(0, utility_1.isValidPathParam)(profileId)) {
|
|
273
|
+
throw new Error("Parameter 'profileId' is not valid.");
|
|
274
|
+
}
|
|
275
|
+
const instance = ((idType) => instance.get(idType));
|
|
276
|
+
instance.get = function get(idType) {
|
|
277
|
+
return new IdentifierContextImpl(version, storeId, profileId, idType);
|
|
278
|
+
};
|
|
279
|
+
instance._version = version;
|
|
280
|
+
instance._solution = { storeId, profileId };
|
|
281
|
+
instance._uri = `/Stores/${storeId}/Profiles/${profileId}/Identifiers`;
|
|
282
|
+
instance.create = function create(params, headers, callback) {
|
|
283
|
+
if (params === null || params === undefined) {
|
|
284
|
+
throw new Error('Required parameter "params" missing.');
|
|
285
|
+
}
|
|
286
|
+
let data = {};
|
|
287
|
+
data = params;
|
|
288
|
+
if (headers === null || headers === undefined) {
|
|
289
|
+
headers = {};
|
|
290
|
+
}
|
|
291
|
+
headers["Content-Type"] = "application/json";
|
|
292
|
+
headers["Accept"] = "application/json";
|
|
293
|
+
let operationVersion = version, operationPromise = operationVersion.create({
|
|
294
|
+
uri: instance._uri,
|
|
295
|
+
method: "post",
|
|
296
|
+
data,
|
|
297
|
+
headers,
|
|
298
|
+
});
|
|
299
|
+
operationPromise = operationPromise.then((payload) => new IdentifierInstance(operationVersion, payload, instance._solution.storeId, instance._solution.profileId));
|
|
300
|
+
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
|
|
301
|
+
return operationPromise;
|
|
302
|
+
};
|
|
303
|
+
instance.createWithHttpInfo = function createWithHttpInfo(params, headers, callback) {
|
|
304
|
+
if (params === null || params === undefined) {
|
|
305
|
+
throw new Error('Required parameter "params" missing.');
|
|
306
|
+
}
|
|
307
|
+
let data = {};
|
|
308
|
+
data = params;
|
|
309
|
+
if (headers === null || headers === undefined) {
|
|
310
|
+
headers = {};
|
|
311
|
+
}
|
|
312
|
+
headers["Content-Type"] = "application/json";
|
|
313
|
+
headers["Accept"] = "application/json";
|
|
314
|
+
let operationVersion = version;
|
|
315
|
+
// CREATE, FETCH, UPDATE operations
|
|
316
|
+
let operationPromise = operationVersion
|
|
317
|
+
.createWithResponseInfo({
|
|
318
|
+
uri: instance._uri,
|
|
319
|
+
method: "post",
|
|
320
|
+
data,
|
|
321
|
+
headers,
|
|
322
|
+
})
|
|
323
|
+
.then((response) => ({
|
|
324
|
+
...response,
|
|
325
|
+
body: new IdentifierInstance(operationVersion, response.body, instance._solution.storeId, instance._solution.profileId),
|
|
326
|
+
}));
|
|
327
|
+
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
|
|
328
|
+
return operationPromise;
|
|
329
|
+
};
|
|
330
|
+
instance.list = function list(callback) {
|
|
331
|
+
const headers = {};
|
|
332
|
+
const data = {};
|
|
333
|
+
headers["Accept"] = "application/json";
|
|
334
|
+
let operationVersion = version, operationPromise = operationVersion.fetch({
|
|
335
|
+
uri: instance._uri,
|
|
336
|
+
method: "get",
|
|
337
|
+
headers,
|
|
338
|
+
});
|
|
339
|
+
operationPromise = operationPromise.then((payload) => (payload["identifiers"] || []).map((item) => new IdentifierInstance(operationVersion, item, instance._solution.storeId, instance._solution.profileId)));
|
|
340
|
+
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
|
|
341
|
+
return operationPromise;
|
|
342
|
+
};
|
|
343
|
+
instance.listWithHttpInfo = function listWithHttpInfo(callback) {
|
|
344
|
+
const headers = {};
|
|
345
|
+
const data = {};
|
|
346
|
+
headers["Accept"] = "application/json";
|
|
347
|
+
let operationVersion = version;
|
|
348
|
+
let operationPromise = operationVersion
|
|
349
|
+
.fetchWithResponseInfo({
|
|
350
|
+
uri: instance._uri,
|
|
351
|
+
method: "get",
|
|
352
|
+
headers,
|
|
353
|
+
})
|
|
354
|
+
.then((response) => ({
|
|
355
|
+
statusCode: response.statusCode,
|
|
356
|
+
headers: response.headers,
|
|
357
|
+
body: (response.body["identifiers"] || []).map((item) => new IdentifierInstance(operationVersion, item, instance._solution.storeId, instance._solution.profileId)),
|
|
358
|
+
}));
|
|
359
|
+
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
|
|
360
|
+
return operationPromise;
|
|
361
|
+
};
|
|
362
|
+
instance.toJSON = function toJSON() {
|
|
363
|
+
return instance._solution;
|
|
364
|
+
};
|
|
365
|
+
instance[util_1.inspect.custom] = function inspectImpl(_depth, options) {
|
|
366
|
+
return (0, util_1.inspect)(instance.toJSON(), options);
|
|
367
|
+
};
|
|
368
|
+
return instance;
|
|
369
|
+
}
|
|
@@ -0,0 +1,247 @@
|
|
|
1
|
+
import { inspect, InspectOptions } from "util";
|
|
2
|
+
import V1 from "../V1";
|
|
3
|
+
import { ApiResponse } from "../../../base/ApiResponse";
|
|
4
|
+
export declare class IdentifierConfig {
|
|
5
|
+
/**
|
|
6
|
+
* Name of the identifier type. Usual values are email, phone, external_id etc.
|
|
7
|
+
*/
|
|
8
|
+
"idType": string;
|
|
9
|
+
/**
|
|
10
|
+
* The algorithm to use for matching identifier values. - `exact`, exact string match. - `fuzzy`, low precision match allowing for some variations.
|
|
11
|
+
*/
|
|
12
|
+
"matchingAlgo"?: string;
|
|
13
|
+
/**
|
|
14
|
+
* The `fuzzy` matching threshold percentage.
|
|
15
|
+
*/
|
|
16
|
+
"matchingThreshold"?: number;
|
|
17
|
+
/**
|
|
18
|
+
* Maximum number of historical values to retain.
|
|
19
|
+
*/
|
|
20
|
+
"limit"?: number;
|
|
21
|
+
/**
|
|
22
|
+
* Removal policy to apply when the number of values exceeds the limit and is based on the timestamp of the request when the identifier was added. - `fifo`: First In First Out, removes the oldest values first. - `lifo`: Last In First Out, removes the most recent values first.
|
|
23
|
+
*/
|
|
24
|
+
"limitPolicy"?: string;
|
|
25
|
+
/**
|
|
26
|
+
* When enabled, more than one profile may not share the same identifier value. Adding a shared identifier to a second profile may trigger a merge. Disabling creates a compound identifier where merges are only triggered if two or more identifiers satisfy a matching rule.
|
|
27
|
+
*/
|
|
28
|
+
"enforceUnique"?: boolean;
|
|
29
|
+
/**
|
|
30
|
+
* Normalization to apply to the identifier value before storing and matching. - `phone`: Normalize phone numbers to E.164 format. - `email`: Normalize email addresses by coverting to lowercase and removing spaces. - `trim`: Removes spaces from both ends of the string. - `none`: No normalization. **Important Note for Phone Number Normalization:** When using the `phone` normalization option, please adhere to the following guidelines to ensure proper formatting: - All US numbers must be at least valid 10 digit phone numbers with area code. They may also include or omit the \"+1\" prefix. - Non-US numbers must include a 1-3 digit country code (a \"+\" prefix is optional). Non-US national formats are not supported and will be interpreted as US numbers.
|
|
31
|
+
*/
|
|
32
|
+
"normalization"?: string;
|
|
33
|
+
constructor(payload: any);
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Identity Resolution settings help determine if a new profile should be created, or if the incoming conversation should be added to an existing profile. These settings resolve how profiles are looked up and which profiles should merge together.
|
|
37
|
+
*/
|
|
38
|
+
export declare class IdentityResolutionSettingsCore {
|
|
39
|
+
/**
|
|
40
|
+
* List of identifier types and their resolution settings.
|
|
41
|
+
*/
|
|
42
|
+
"identifierConfigs"?: Array<IdentifierConfig>;
|
|
43
|
+
/**
|
|
44
|
+
* Priority list of identifiers to locate profiles to apply new data to, or for determining if two existing profiles should merge. Rules are evaluated in order. - If no rule matches against existing profiles, a new profile will be created. - If a rule matches to a single existing profile, the profile will be updated. - If a rule matches to multiple existing profiles, those existing profiles will be merged.
|
|
45
|
+
*/
|
|
46
|
+
"matchingRules"?: Array<string>;
|
|
47
|
+
constructor(payload: any);
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Options to pass to update a IdentityResolutionSettingInstance
|
|
51
|
+
*/
|
|
52
|
+
export interface IdentityResolutionSettingContextUpdateOptions {
|
|
53
|
+
/** */
|
|
54
|
+
identityResolutionSettingsCore: IdentityResolutionSettingsCore;
|
|
55
|
+
/** Allows for optimistic concurrency control by making the request conditional. Server will only act if the resource\'s current Entity Tag (ETag) matches the one provided, preventing accidental overwrites. */
|
|
56
|
+
ifMatch?: string;
|
|
57
|
+
}
|
|
58
|
+
export interface IdentityResolutionSettingContext {
|
|
59
|
+
/**
|
|
60
|
+
* Fetch a IdentityResolutionSettingInstance
|
|
61
|
+
*
|
|
62
|
+
* @param callback - Callback to handle processed record
|
|
63
|
+
*
|
|
64
|
+
* @returns Resolves to processed IdentityResolutionSettingInstance
|
|
65
|
+
*/
|
|
66
|
+
fetch(callback?: (error: Error | null, item?: IdentityResolutionSettingInstance) => any): Promise<IdentityResolutionSettingInstance>;
|
|
67
|
+
/**
|
|
68
|
+
* Fetch a IdentityResolutionSettingInstance and return HTTP info
|
|
69
|
+
*
|
|
70
|
+
* @param callback - Callback to handle processed record
|
|
71
|
+
*
|
|
72
|
+
* @returns Resolves to processed IdentityResolutionSettingInstance with HTTP metadata
|
|
73
|
+
*/
|
|
74
|
+
fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<IdentityResolutionSettingInstance>) => any): Promise<ApiResponse<IdentityResolutionSettingInstance>>;
|
|
75
|
+
/**
|
|
76
|
+
* Update a IdentityResolutionSettingInstance
|
|
77
|
+
*
|
|
78
|
+
* @param params - Body for request
|
|
79
|
+
* @param headers - header params for request
|
|
80
|
+
* @param callback - Callback to handle processed record
|
|
81
|
+
*
|
|
82
|
+
* @returns Resolves to processed IdentityResolutionSettingInstance
|
|
83
|
+
*/
|
|
84
|
+
update(params: IdentityResolutionSettingsCore, headers?: any, callback?: (error: Error | null, item?: IdentityResolutionSettingInstance) => any): Promise<IdentityResolutionSettingInstance>;
|
|
85
|
+
/**
|
|
86
|
+
* Update a IdentityResolutionSettingInstance and return HTTP info
|
|
87
|
+
*
|
|
88
|
+
* @param params - Body for request
|
|
89
|
+
* @param headers - header params for request
|
|
90
|
+
* @param callback - Callback to handle processed record
|
|
91
|
+
*
|
|
92
|
+
* @returns Resolves to processed IdentityResolutionSettingInstance with HTTP metadata
|
|
93
|
+
*/
|
|
94
|
+
updateWithHttpInfo(params: IdentityResolutionSettingsCore, headers?: any, callback?: (error: Error | null, item?: ApiResponse<IdentityResolutionSettingInstance>) => any): Promise<ApiResponse<IdentityResolutionSettingInstance>>;
|
|
95
|
+
/**
|
|
96
|
+
* Provide a user-friendly representation
|
|
97
|
+
*/
|
|
98
|
+
toJSON(): any;
|
|
99
|
+
[inspect.custom](_depth: any, options: InspectOptions): any;
|
|
100
|
+
}
|
|
101
|
+
export interface IdentityResolutionSettingContextSolution {
|
|
102
|
+
storeId: string;
|
|
103
|
+
}
|
|
104
|
+
export declare class IdentityResolutionSettingContextImpl implements IdentityResolutionSettingContext {
|
|
105
|
+
protected _version: V1;
|
|
106
|
+
protected _solution: IdentityResolutionSettingContextSolution;
|
|
107
|
+
protected _uri: string;
|
|
108
|
+
constructor(_version: V1, storeId: string);
|
|
109
|
+
fetch(callback?: (error: Error | null, item?: IdentityResolutionSettingInstance) => any): Promise<IdentityResolutionSettingInstance>;
|
|
110
|
+
fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<IdentityResolutionSettingInstance>) => any): Promise<ApiResponse<IdentityResolutionSettingInstance>>;
|
|
111
|
+
update(params: IdentityResolutionSettingsCore, headers?: any, callback?: (error: Error | null, item?: IdentityResolutionSettingInstance) => any): Promise<IdentityResolutionSettingInstance>;
|
|
112
|
+
updateWithHttpInfo(params: IdentityResolutionSettingsCore, headers?: any, callback?: (error: Error | null, item?: ApiResponse<IdentityResolutionSettingInstance>) => any): Promise<ApiResponse<IdentityResolutionSettingInstance>>;
|
|
113
|
+
/**
|
|
114
|
+
* Provide a user-friendly representation
|
|
115
|
+
*
|
|
116
|
+
* @returns Object
|
|
117
|
+
*/
|
|
118
|
+
toJSON(): IdentityResolutionSettingContextSolution;
|
|
119
|
+
[inspect.custom](_depth: any, options: InspectOptions): string;
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Nested model for IdentifierConfig
|
|
123
|
+
*/
|
|
124
|
+
export interface IdentifierConfig {
|
|
125
|
+
idType: string;
|
|
126
|
+
matchingAlgo?: string;
|
|
127
|
+
matchingThreshold?: number;
|
|
128
|
+
limit?: number;
|
|
129
|
+
limitPolicy?: string;
|
|
130
|
+
enforceUnique?: boolean;
|
|
131
|
+
normalization?: string;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Nested model for IdentityResolutionSettingsCore
|
|
135
|
+
*/
|
|
136
|
+
export interface IdentityResolutionSettingsCore {
|
|
137
|
+
identifierConfigs?: Array<IdentifierConfig>;
|
|
138
|
+
matchingRules?: Array<string>;
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Response model for IdentityResolutionSettings operations
|
|
142
|
+
*/
|
|
143
|
+
interface IdentityResolutionSettings_ResponseResource {
|
|
144
|
+
identifierConfigs?: Array<IdentifierConfig>;
|
|
145
|
+
matchingRules?: Array<string>;
|
|
146
|
+
version: number;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Response model for UpdateIdentityResolutionSettings202Response operations
|
|
150
|
+
*/
|
|
151
|
+
interface UpdateIdentityResolutionSettings202Response_ResponseResource {
|
|
152
|
+
message?: string;
|
|
153
|
+
statusUrl?: string;
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* Union type for all possible response models
|
|
157
|
+
*/
|
|
158
|
+
type IdentityResolutionSettingResource = IdentityResolutionSettings_ResponseResource | UpdateIdentityResolutionSettings202Response_ResponseResource;
|
|
159
|
+
export declare class IdentityResolutionSettingInstance {
|
|
160
|
+
protected _version: V1;
|
|
161
|
+
protected _solution: IdentityResolutionSettingContextSolution;
|
|
162
|
+
protected _context?: IdentityResolutionSettingContext;
|
|
163
|
+
constructor(_version: V1, _payload: IdentityResolutionSettingResource, storeId?: string);
|
|
164
|
+
/**
|
|
165
|
+
* List of identifier types and their resolution settings.
|
|
166
|
+
*/
|
|
167
|
+
identifierConfigs?: Array<IdentifierConfig>;
|
|
168
|
+
/**
|
|
169
|
+
* Priority list of identifiers to locate profiles to apply new data to, or for determining if two existing profiles should merge. Rules are evaluated in order. - If no rule matches against existing profiles, a new profile will be created. - If a rule matches to a single existing profile, the profile will be updated. - If a rule matches to multiple existing profiles, those existing profiles will be merged.
|
|
170
|
+
*/
|
|
171
|
+
matchingRules?: Array<string>;
|
|
172
|
+
/**
|
|
173
|
+
* The current version number of the Identity Resolution Settings. Incremented on each successful update.
|
|
174
|
+
*/
|
|
175
|
+
version?: number;
|
|
176
|
+
message?: string;
|
|
177
|
+
/**
|
|
178
|
+
* URI to check operation status.
|
|
179
|
+
*/
|
|
180
|
+
statusUrl?: string;
|
|
181
|
+
private get _proxy();
|
|
182
|
+
/**
|
|
183
|
+
* Fetch a IdentityResolutionSettingInstance
|
|
184
|
+
*
|
|
185
|
+
* @param callback - Callback to handle processed record
|
|
186
|
+
*
|
|
187
|
+
* @returns Resolves to processed IdentityResolutionSettingInstance
|
|
188
|
+
*/
|
|
189
|
+
fetch(callback?: (error: Error | null, item?: IdentityResolutionSettingInstance) => any): Promise<IdentityResolutionSettingInstance>;
|
|
190
|
+
/**
|
|
191
|
+
* Fetch a IdentityResolutionSettingInstance and return HTTP info
|
|
192
|
+
*
|
|
193
|
+
* @param callback - Callback to handle processed record
|
|
194
|
+
*
|
|
195
|
+
* @returns Resolves to processed IdentityResolutionSettingInstance with HTTP metadata
|
|
196
|
+
*/
|
|
197
|
+
fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<IdentityResolutionSettingInstance>) => any): Promise<ApiResponse<IdentityResolutionSettingInstance>>;
|
|
198
|
+
/**
|
|
199
|
+
* Update a IdentityResolutionSettingInstance
|
|
200
|
+
*
|
|
201
|
+
* @param params - Body for request
|
|
202
|
+
* @param headers - header params for request
|
|
203
|
+
* @param callback - Callback to handle processed record
|
|
204
|
+
*
|
|
205
|
+
* @returns Resolves to processed IdentityResolutionSettingInstance
|
|
206
|
+
*/
|
|
207
|
+
update(params: IdentityResolutionSettingsCore, headers?: any, callback?: (error: Error | null, item?: IdentityResolutionSettingInstance) => any): Promise<IdentityResolutionSettingInstance>;
|
|
208
|
+
/**
|
|
209
|
+
* Update a IdentityResolutionSettingInstance and return HTTP info
|
|
210
|
+
*
|
|
211
|
+
* @param params - Body for request
|
|
212
|
+
* @param headers - header params for request
|
|
213
|
+
* @param callback - Callback to handle processed record
|
|
214
|
+
*
|
|
215
|
+
* @returns Resolves to processed IdentityResolutionSettingInstance with HTTP metadata
|
|
216
|
+
*/
|
|
217
|
+
updateWithHttpInfo(params: IdentityResolutionSettingsCore, headers?: any, callback?: (error: Error | null, item?: ApiResponse<IdentityResolutionSettingInstance>) => any): Promise<ApiResponse<IdentityResolutionSettingInstance>>;
|
|
218
|
+
/**
|
|
219
|
+
* Provide a user-friendly representation
|
|
220
|
+
*
|
|
221
|
+
* @returns Object
|
|
222
|
+
*/
|
|
223
|
+
toJSON(): {
|
|
224
|
+
identifierConfigs: IdentifierConfig[];
|
|
225
|
+
matchingRules: string[];
|
|
226
|
+
version: number;
|
|
227
|
+
message: string;
|
|
228
|
+
statusUrl: string;
|
|
229
|
+
};
|
|
230
|
+
[inspect.custom](_depth: any, options: InspectOptions): string;
|
|
231
|
+
}
|
|
232
|
+
export interface IdentityResolutionSettingSolution {
|
|
233
|
+
}
|
|
234
|
+
export interface IdentityResolutionSettingListInstance {
|
|
235
|
+
_version: V1;
|
|
236
|
+
_solution: IdentityResolutionSettingSolution;
|
|
237
|
+
_uri: string;
|
|
238
|
+
(storeId: string): IdentityResolutionSettingContext;
|
|
239
|
+
get(storeId: string): IdentityResolutionSettingContext;
|
|
240
|
+
/**
|
|
241
|
+
* Provide a user-friendly representation
|
|
242
|
+
*/
|
|
243
|
+
toJSON(): any;
|
|
244
|
+
[inspect.custom](_depth: any, options: InspectOptions): any;
|
|
245
|
+
}
|
|
246
|
+
export declare function IdentityResolutionSettingListInstance(version: V1): IdentityResolutionSettingListInstance;
|
|
247
|
+
export {};
|