twilio
Version:
A Twilio helper library
665 lines (664 loc) • 25.7 kB
JavaScript
"use strict";
/*
* This code was generated by
* ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
* | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
* | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
*
* Conversation Orchestrator
* Manage configurations, conversations, participants, and communications. Create configurations to define capture rules and channel settings, then use conversations to group related communications.
*
* NOTE: This class is auto generated by OpenAPI Generator.
* https://openapi-generator.tech
* Do not edit the class manually.
*/
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ConversationPage = exports.ConversationInstance = exports.ConversationContextImpl = exports.UpdateConversationByIdRequest = exports.PatchConversationByIdRequestConfiguration = exports.PatchConversationByIdRequest = exports.ListConversationByAccount200ResponseConversationsConfiguration = exports.CreateConversationWithConfigRequestParticipantsAddresses = exports.CreateConversationWithConfigRequestParticipants = exports.CreateConversationWithConfigRequestConfiguration = exports.CreateConversationWithConfigRequest = exports.ConversationsV2StatusCallbackConfig = exports.ConversationsV2Participant = exports.ConversationsV2ConversationsV1Bridge = exports.ConversationsV2Address = void 0;
exports.ConversationListInstance = ConversationListInstance;
const util_1 = require("util");
const TokenPage_1 = __importDefault(require("../../../base/TokenPage"));
const deserialize = require("../../../base/deserialize");
const serialize = require("../../../base/serialize");
const utility_1 = require("../../../base/utility");
class ConversationsV2Address {
constructor(payload) {
this.channel = payload["channel"];
this.address = payload["address"];
this.channelId = payload["channelId"];
}
}
exports.ConversationsV2Address = ConversationsV2Address;
/**
* Configuration for Conversations V1 bridge. When set, messaging channels route through Conversations V1. Use this to integrate with existing Conversations V1 applications.
*/
class ConversationsV2ConversationsV1Bridge {
constructor(payload) {
this.serviceId = payload["serviceId"];
}
}
exports.ConversationsV2ConversationsV1Bridge = ConversationsV2ConversationsV1Bridge;
class ConversationsV2Participant {
constructor(payload) {
this.id = payload["id"];
this.conversationId = payload["conversationId"];
this.accountId = payload["accountId"];
this.name = payload["name"];
this.type = payload["type"];
this.profileId = payload["profileId"];
this.addresses = payload["addresses"];
this.createdAt = payload["createdAt"];
this.updatedAt = payload["updatedAt"];
}
}
exports.ConversationsV2Participant = ConversationsV2Participant;
/**
* Default webhook configuration for Conversation-level events under this Configuration.
*/
class ConversationsV2StatusCallbackConfig {
constructor(payload) {
this.url = payload["url"];
this.method = payload["method"];
}
}
exports.ConversationsV2StatusCallbackConfig = ConversationsV2StatusCallbackConfig;
class CreateConversationWithConfigRequest {
constructor(payload) {
this.configurationId = payload["configurationId"];
this.name = payload["name"];
this.configuration = payload["configuration"];
this.participants = payload["participants"];
}
}
exports.CreateConversationWithConfigRequest = CreateConversationWithConfigRequest;
/**
* Conversation configuration settings.
*/
class CreateConversationWithConfigRequestConfiguration {
constructor(payload) {
this.intelligenceConfigurationIds = payload["intelligenceConfigurationIds"];
}
}
exports.CreateConversationWithConfigRequestConfiguration = CreateConversationWithConfigRequestConfiguration;
class CreateConversationWithConfigRequestParticipants {
constructor(payload) {
this.name = payload["name"];
this.type = payload["type"];
this.profileId = payload["profileId"];
this.addresses = payload["addresses"];
}
}
exports.CreateConversationWithConfigRequestParticipants = CreateConversationWithConfigRequestParticipants;
class CreateConversationWithConfigRequestParticipantsAddresses {
constructor(payload) {
this.channel = payload["channel"];
this.address = payload["address"];
this.channelId = payload["channelId"];
}
}
exports.CreateConversationWithConfigRequestParticipantsAddresses = CreateConversationWithConfigRequestParticipantsAddresses;
/**
* Full configuration settings for this Conversation.
*/
class ListConversationByAccount200ResponseConversationsConfiguration {
constructor(payload) {
this.displayName = payload["displayName"];
this.description = payload["description"];
this.conversationGroupingType = payload["conversationGroupingType"];
this.memoryStoreId = payload["memoryStoreId"];
this.channelSettings = payload["channelSettings"];
this.statusCallbacks = payload["statusCallbacks"];
this.intelligenceConfigurationIds = payload["intelligenceConfigurationIds"];
this.memoryExtractionEnabled = payload["memoryExtractionEnabled"];
this.conversationsV1Bridge = payload["conversationsV1Bridge"];
}
}
exports.ListConversationByAccount200ResponseConversationsConfiguration = ListConversationByAccount200ResponseConversationsConfiguration;
class PatchConversationByIdRequest {
constructor(payload) {
this.name = payload["name"];
this.status = payload["status"];
this.configuration = payload["configuration"];
}
}
exports.PatchConversationByIdRequest = PatchConversationByIdRequest;
/**
* Partial configuration update for an existing conversation. Only statusCallbacks can be modified.
*/
class PatchConversationByIdRequestConfiguration {
constructor(payload) {
this.statusCallbacks = payload["statusCallbacks"];
}
}
exports.PatchConversationByIdRequestConfiguration = PatchConversationByIdRequestConfiguration;
class UpdateConversationByIdRequest {
constructor(payload) {
this.name = payload["name"];
this.status = payload["status"];
}
}
exports.UpdateConversationByIdRequest = UpdateConversationByIdRequest;
class ConversationContextImpl {
constructor(_version, sid) {
this._version = _version;
if (!(0, utility_1.isValidPathParam)(sid)) {
throw new Error("Parameter 'sid' is not valid.");
}
this._solution = { sid };
this._uri = `/Conversations/${sid}`;
}
remove(params, callback) {
if (params instanceof Function) {
callback = params;
params = {};
}
else {
params = params || {};
}
let data = {};
const headers = {};
headers["Accept"] = "application/json";
if (params["idempotencyKey"] !== undefined)
headers["Idempotency-Key"] = params["idempotencyKey"];
const instance = this;
let operationVersion = instance._version, operationPromise = operationVersion.fetch({
uri: instance._uri,
method: "delete",
params: data,
headers,
});
operationPromise = operationPromise.then((payload) => new ConversationInstance(operationVersion, payload, instance._solution.sid));
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
return operationPromise;
}
removeWithHttpInfo(params, callback) {
if (params instanceof Function) {
callback = params;
params = {};
}
else {
params = params || {};
}
let data = {};
const headers = {};
headers["Accept"] = "application/json";
if (params["idempotencyKey"] !== undefined)
headers["Idempotency-Key"] = params["idempotencyKey"];
const instance = this;
let operationVersion = instance._version;
// DELETE operation that returns a response model
let operationPromise = operationVersion
.fetchWithResponseInfo({
uri: instance._uri,
method: "delete",
params: data,
headers,
})
.then((response) => ({
...response,
body: new ConversationInstance(operationVersion, response.body, instance._solution.sid),
}));
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
return operationPromise;
}
fetch(callback) {
const headers = {};
headers["Accept"] = "application/json";
const instance = this;
let operationVersion = instance._version, operationPromise = operationVersion.fetch({
uri: instance._uri,
method: "get",
headers,
});
operationPromise = operationPromise.then((payload) => new ConversationInstance(operationVersion, payload, instance._solution.sid));
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
return operationPromise;
}
fetchWithHttpInfo(callback) {
const headers = {};
headers["Accept"] = "application/json";
const instance = this;
let operationVersion = instance._version;
// CREATE, FETCH, UPDATE operations
let operationPromise = operationVersion
.fetchWithResponseInfo({
uri: instance._uri,
method: "get",
headers,
})
.then((response) => ({
...response,
body: new ConversationInstance(operationVersion, response.body, instance._solution.sid),
}));
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
return operationPromise;
}
patch(params, headers, callback) {
if (params instanceof Function) {
callback = params;
params =
{};
}
else {
params =
params ||
{};
}
let data = {};
data = params;
if (headers === null || headers === undefined) {
headers = {};
}
headers["Content-Type"] = "application/json";
headers["Accept"] = "application/json";
const instance = this;
let operationVersion = instance._version, operationPromise = operationVersion.patch({
uri: instance._uri,
method: "patch",
data,
headers,
});
operationPromise = operationPromise.then((payload) => new ConversationInstance(operationVersion, payload, instance._solution.sid));
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
return operationPromise;
}
patchWithHttpInfo(params, headers, callback) {
if (params instanceof Function) {
callback = params;
params =
{};
}
else {
params =
params ||
{};
}
let data = {};
data = params;
if (headers === null || headers === undefined) {
headers = {};
}
headers["Content-Type"] = "application/json";
headers["Accept"] = "application/json";
const instance = this;
let operationVersion = instance._version;
// CREATE, FETCH, UPDATE operations
let operationPromise = operationVersion
.patchWithResponseInfo({
uri: instance._uri,
method: "patch",
data,
headers,
})
.then((response) => ({
...response,
body: new ConversationInstance(operationVersion, response.body, instance._solution.sid),
}));
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
return operationPromise;
}
update(params, headers, callback) {
if (params instanceof Function) {
callback = params;
params =
{};
}
else {
params =
params ||
{};
}
let data = {};
data = params;
if (headers === null || headers === undefined) {
headers = {};
}
headers["Content-Type"] = "application/json";
headers["Accept"] = "application/json";
const instance = this;
let operationVersion = instance._version, operationPromise = operationVersion.update({
uri: instance._uri,
method: "put",
data,
headers,
});
operationPromise = operationPromise.then((payload) => new ConversationInstance(operationVersion, payload, instance._solution.sid));
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
return operationPromise;
}
updateWithHttpInfo(params, headers, callback) {
if (params instanceof Function) {
callback = params;
params =
{};
}
else {
params =
params ||
{};
}
let data = {};
data = params;
if (headers === null || headers === undefined) {
headers = {};
}
headers["Content-Type"] = "application/json";
headers["Accept"] = "application/json";
const instance = this;
let operationVersion = instance._version;
// CREATE, FETCH, UPDATE operations
let operationPromise = operationVersion
.updateWithResponseInfo({
uri: instance._uri,
method: "put",
data,
headers,
})
.then((response) => ({
...response,
body: new ConversationInstance(operationVersion, response.body, instance._solution.sid),
}));
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
return operationPromise;
}
/**
* Provide a user-friendly representation
*
* @returns Object
*/
toJSON() {
return this._solution;
}
[util_1.inspect.custom](_depth, options) {
return (0, util_1.inspect)(this.toJSON(), options);
}
}
exports.ConversationContextImpl = ConversationContextImpl;
class ConversationInstance {
constructor(_version, _payload, sid) {
this._version = _version;
const payload = _payload;
this.statusUrl = payload.statusUrl;
this.related = payload.related;
this.id = payload.id;
this.accountId = payload.accountId;
this.configurationId = payload.configurationId;
this.status = payload.status;
this.name = payload.name;
this.createdAt = deserialize.iso8601DateTime(payload.createdAt);
this.updatedAt = deserialize.iso8601DateTime(payload.updatedAt);
this.configuration =
payload.configuration !== null && payload.configuration !== undefined
? new ListConversationByAccount200ResponseConversationsConfiguration(payload.configuration)
: null;
this.participants =
payload.participants !== null && payload.participants !== undefined
? payload.participants.map((payload) => new ConversationsV2Participant(payload))
: null;
this._solution = { sid: sid };
}
get _proxy() {
this._context =
this._context ||
new ConversationContextImpl(this._version, this._solution.sid);
return this._context;
}
remove(params, callback) {
return this._proxy.remove(params, callback);
}
removeWithHttpInfo(params, callback) {
return this._proxy.removeWithHttpInfo(params, callback);
}
/**
* Fetch a ConversationInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed ConversationInstance
*/
fetch(callback) {
return this._proxy.fetch(callback);
}
/**
* Fetch a ConversationInstance and return HTTP info
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed ConversationInstance with HTTP metadata
*/
fetchWithHttpInfo(callback) {
return this._proxy.fetchWithHttpInfo(callback);
}
patch(params, callback) {
return this._proxy.patch(params, callback);
}
patchWithHttpInfo(params, callback) {
return this._proxy.patchWithHttpInfo(params, callback);
}
update(params, callback) {
return this._proxy.update(params, callback);
}
updateWithHttpInfo(params, callback) {
return this._proxy.updateWithHttpInfo(params, callback);
}
/**
* Provide a user-friendly representation
*
* @returns Object
*/
toJSON() {
return {
statusUrl: this.statusUrl,
related: this.related,
id: this.id,
accountId: this.accountId,
configurationId: this.configurationId,
status: this.status,
name: this.name,
createdAt: this.createdAt,
updatedAt: this.updatedAt,
configuration: this.configuration,
participants: this.participants,
};
}
[util_1.inspect.custom](_depth, options) {
return (0, util_1.inspect)(this.toJSON(), options);
}
}
exports.ConversationInstance = ConversationInstance;
function ConversationListInstance(version) {
const instance = ((sid) => instance.get(sid));
instance.get = function get(sid) {
return new ConversationContextImpl(version, sid);
};
instance._version = version;
instance._solution = {};
instance._uri = `/Conversations`;
instance.create = function create(params, headers, callback) {
if (params instanceof Function) {
callback = params;
params =
{};
}
else {
params =
params ||
{};
}
let data = {};
data = params;
if (headers === null || headers === undefined) {
headers = {};
}
headers["Content-Type"] = "application/json";
headers["Accept"] = "application/json";
let operationVersion = version, operationPromise = operationVersion.create({
uri: instance._uri,
method: "post",
data,
headers,
});
operationPromise = operationPromise.then((payload) => new ConversationInstance(operationVersion, payload));
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
return operationPromise;
};
instance.createWithHttpInfo = function createWithHttpInfo(params, headers, callback) {
if (params instanceof Function) {
callback = params;
params =
{};
}
else {
params =
params ||
{};
}
let data = {};
data = params;
if (headers === null || headers === undefined) {
headers = {};
}
headers["Content-Type"] = "application/json";
headers["Accept"] = "application/json";
let operationVersion = version;
// CREATE, FETCH, UPDATE operations
let operationPromise = operationVersion
.createWithResponseInfo({
uri: instance._uri,
method: "post",
data,
headers,
})
.then((response) => ({
...response,
body: new ConversationInstance(operationVersion, response.body),
}));
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
return operationPromise;
};
instance.page = function page(params, callback) {
if (params instanceof Function) {
callback = params;
params = {};
}
else {
params = params || {};
}
let data = {};
if (params["status"] !== undefined)
data["status"] = serialize.map(params["status"], (e) => e);
if (params["channelId"] !== undefined)
data["channelId"] = params["channelId"];
if (params["pageSize"] !== undefined)
data["pageSize"] = params["pageSize"];
if (params["pageToken"] !== undefined)
data["pageToken"] = params["pageToken"];
const headers = {};
headers["Accept"] = "application/json";
let operationVersion = version, operationPromise = operationVersion.page({
uri: instance._uri,
method: "get",
params: data,
headers,
});
operationPromise = operationPromise.then((payload) => new ConversationPage(operationVersion, payload, instance._uri, data, instance._solution));
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
return operationPromise;
};
instance.each = instance._version.each;
instance.list = instance._version.list;
instance.getPage = function getPage(targetUrl, callback) {
const operationPromise = instance._version._domain.twilio.request({
method: "get",
uri: targetUrl,
});
let pagePromise = operationPromise.then((payload) => new ConversationPage(instance._version, payload, instance._uri, {}, instance._solution));
pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
return pagePromise;
};
instance.pageWithHttpInfo = function pageWithHttpInfo(params, callback) {
if (params instanceof Function) {
callback = params;
params = {};
}
else {
params = params || {};
}
let data = {};
if (params["status"] !== undefined)
data["status"] = serialize.map(params["status"], (e) => e);
if (params["channelId"] !== undefined)
data["channelId"] = params["channelId"];
if (params["pageSize"] !== undefined)
data["pageSize"] = params["pageSize"];
if (params["pageToken"] !== undefined)
data["pageToken"] = params["pageToken"];
const headers = {};
headers["Accept"] = "application/json";
let operationVersion = version;
// For page operations, use page() directly as it already returns { statusCode, body, headers }
// IMPORTANT: Pass full response to Page constructor, not response.body
let operationPromise = operationVersion
.page({ uri: instance._uri, method: "get", params: data, headers })
.then((response) => ({
statusCode: response.statusCode,
headers: response.headers,
body: new ConversationPage(operationVersion, response, instance._uri, data, instance._solution),
}));
operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
return operationPromise;
};
instance.each = instance._version.each;
instance.eachWithHttpInfo = instance._version.eachWithHttpInfo;
instance.list = instance._version.list;
instance.listWithHttpInfo = instance._version.listWithHttpInfo;
instance.getPageWithHttpInfo = function getPageWithHttpInfo(targetUrl, callback) {
// Use request() directly as it already returns { statusCode, body, headers }
const operationPromise = instance._version._domain.twilio.request({
method: "get",
uri: targetUrl,
});
let pagePromise = operationPromise.then((response) => ({
statusCode: response.statusCode,
headers: response.headers,
body: new ConversationPage(instance._version, response, instance._uri, {}, instance._solution),
}));
pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
return pagePromise;
};
instance.toJSON = function toJSON() {
return instance._solution;
};
instance[util_1.inspect.custom] = function inspectImpl(_depth, options) {
return (0, util_1.inspect)(instance.toJSON(), options);
};
return instance;
}
class ConversationPage extends TokenPage_1.default {
/**
* Initialize the ConversationPage
*
* @param version - Version of the resource
* @param response - Response from the API
* @param uri - URI of the resource
* @param params - Query parameters
* @param solution - Path solution
*/
constructor(version, response, uri, params, solution) {
super(version, response, uri, params, solution);
}
/**
* Build an instance of ConversationInstance
*
* @param payload - Payload response from the API
*/
getInstance(payload) {
return new ConversationInstance(this._version, payload);
}
[util_1.inspect.custom](depth, options) {
return (0, util_1.inspect)(this.toJSON(), options);
}
}
exports.ConversationPage = ConversationPage;