/
taskQueueBulkRealTimeStatistics.ts
217 lines (192 loc) · 6.36 KB
/
taskQueueBulkRealTimeStatistics.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/*
* This code was generated by
* ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
* | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
* | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
*
* Twilio - Taskrouter
* This is the public Twilio REST API.
*
* NOTE: This class is auto generated by OpenAPI Generator.
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { inspect, InspectOptions } from "util";
import V1 from "../../../V1";
const deserialize = require("../../../../../base/deserialize");
const serialize = require("../../../../../base/serialize");
import { isValidPathParam } from "../../../../../base/utility";
/**
* Options to pass to create a TaskQueueBulkRealTimeStatisticsInstance
*/
export interface TaskQueueBulkRealTimeStatisticsListInstanceCreateOptions {
/** */
body?: object;
}
export interface TaskQueueBulkRealTimeStatisticsSolution {
workspaceSid: string;
}
export interface TaskQueueBulkRealTimeStatisticsListInstance {
_version: V1;
_solution: TaskQueueBulkRealTimeStatisticsSolution;
_uri: string;
/**
* Create a TaskQueueBulkRealTimeStatisticsInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed TaskQueueBulkRealTimeStatisticsInstance
*/
create(
callback?: (
error: Error | null,
item?: TaskQueueBulkRealTimeStatisticsInstance
) => any
): Promise<TaskQueueBulkRealTimeStatisticsInstance>;
/**
* Create a TaskQueueBulkRealTimeStatisticsInstance
*
* @param params - Body for request
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed TaskQueueBulkRealTimeStatisticsInstance
*/
create(
params: object,
callback?: (
error: Error | null,
item?: TaskQueueBulkRealTimeStatisticsInstance
) => any
): Promise<TaskQueueBulkRealTimeStatisticsInstance>;
/**
* Provide a user-friendly representation
*/
toJSON(): any;
[inspect.custom](_depth: any, options: InspectOptions): any;
}
export function TaskQueueBulkRealTimeStatisticsListInstance(
version: V1,
workspaceSid: string
): TaskQueueBulkRealTimeStatisticsListInstance {
if (!isValidPathParam(workspaceSid)) {
throw new Error("Parameter 'workspaceSid' is not valid.");
}
const instance = {} as TaskQueueBulkRealTimeStatisticsListInstance;
instance._version = version;
instance._solution = { workspaceSid };
instance._uri = `/Workspaces/${workspaceSid}/TaskQueues/RealTimeStatistics`;
instance.create = function create(
params?:
| object
| ((
error: Error | null,
items: TaskQueueBulkRealTimeStatisticsInstance
) => any),
callback?: (
error: Error | null,
items: TaskQueueBulkRealTimeStatisticsInstance
) => any
): Promise<TaskQueueBulkRealTimeStatisticsInstance> {
if (params instanceof Function) {
callback = params;
params = {};
} else {
params = params || {};
}
let data: any = {};
data = params;
const headers: any = {};
headers["Content-Type"] = "application/json";
let operationVersion = version,
operationPromise = operationVersion.create({
uri: instance._uri,
method: "post",
data,
headers,
});
operationPromise = operationPromise.then(
(payload) =>
new TaskQueueBulkRealTimeStatisticsInstance(
operationVersion,
payload,
instance._solution.workspaceSid
)
);
operationPromise = instance._version.setPromiseCallback(
operationPromise,
callback
);
return operationPromise;
};
instance.toJSON = function toJSON() {
return instance._solution;
};
instance[inspect.custom] = function inspectImpl(
_depth: any,
options: InspectOptions
) {
return inspect(instance.toJSON(), options);
};
return instance;
}
interface TaskQueueBulkRealTimeStatisticsPayload
extends TaskQueueBulkRealTimeStatisticsResource {}
interface TaskQueueBulkRealTimeStatisticsResource {
account_sid: string;
workspace_sid: string;
task_queue_data: Array<any>;
task_queue_response_count: number;
url: string;
}
export class TaskQueueBulkRealTimeStatisticsInstance {
constructor(
protected _version: V1,
payload: TaskQueueBulkRealTimeStatisticsResource,
workspaceSid: string
) {
this.accountSid = payload.account_sid;
this.workspaceSid = payload.workspace_sid;
this.taskQueueData = payload.task_queue_data;
this.taskQueueResponseCount = deserialize.integer(
payload.task_queue_response_count
);
this.url = payload.url;
}
/**
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource.
*/
accountSid: string;
/**
* The SID of the Workspace that contains the TaskQueue.
*/
workspaceSid: string;
/**
* The real-time statistics for each requested TaskQueue SID. `task_queue_data` returns the following attributes: `task_queue_sid`: The SID of the TaskQueue from which these statistics were calculated. `total_available_workers`: The total number of Workers available for Tasks in the TaskQueue. `total_eligible_workers`: The total number of Workers eligible for Tasks in the TaskQueue, regardless of their Activity state. `total_tasks`: The total number of Tasks. `longest_task_waiting_age`: The age of the longest waiting Task. `longest_task_waiting_sid`: The SID of the longest waiting Task. `tasks_by_status`: The number of Tasks grouped by their current status. `tasks_by_priority`: The number of Tasks grouped by priority. `activity_statistics`: The number of current Workers grouped by Activity.
*/
taskQueueData: Array<any>;
/**
* The number of TaskQueue statistics received in task_queue_data.
*/
taskQueueResponseCount: number;
/**
* The absolute URL of the TaskQueue statistics resource.
*/
url: string;
/**
* Provide a user-friendly representation
*
* @returns Object
*/
toJSON() {
return {
accountSid: this.accountSid,
workspaceSid: this.workspaceSid,
taskQueueData: this.taskQueueData,
taskQueueResponseCount: this.taskQueueResponseCount,
url: this.url,
};
}
[inspect.custom](_depth: any, options: InspectOptions) {
return inspect(this.toJSON(), options);
}
}