/
job.ts
304 lines (268 loc) · 8.06 KB
/
job.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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
/*
* This code was generated by
* ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
* | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
* | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
*
* Twilio - Bulkexports
* 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";
export interface JobContext {
/**
* Remove a JobInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed boolean
*/
remove(
callback?: (error: Error | null, item?: boolean) => any
): Promise<boolean>;
/**
* Fetch a JobInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed JobInstance
*/
fetch(
callback?: (error: Error | null, item?: JobInstance) => any
): Promise<JobInstance>;
/**
* Provide a user-friendly representation
*/
toJSON(): any;
[inspect.custom](_depth: any, options: InspectOptions): any;
}
export interface JobContextSolution {
jobSid: string;
}
export class JobContextImpl implements JobContext {
protected _solution: JobContextSolution;
protected _uri: string;
constructor(protected _version: V1, jobSid: string) {
if (!isValidPathParam(jobSid)) {
throw new Error("Parameter 'jobSid' is not valid.");
}
this._solution = { jobSid };
this._uri = `/Exports/Jobs/${jobSid}`;
}
remove(
callback?: (error: Error | null, item?: boolean) => any
): Promise<boolean> {
const instance = this;
let operationVersion = instance._version,
operationPromise = operationVersion.remove({
uri: instance._uri,
method: "delete",
});
operationPromise = instance._version.setPromiseCallback(
operationPromise,
callback
);
return operationPromise;
}
fetch(
callback?: (error: Error | null, item?: JobInstance) => any
): Promise<JobInstance> {
const instance = this;
let operationVersion = instance._version,
operationPromise = operationVersion.fetch({
uri: instance._uri,
method: "get",
});
operationPromise = operationPromise.then(
(payload) =>
new JobInstance(operationVersion, payload, instance._solution.jobSid)
);
operationPromise = instance._version.setPromiseCallback(
operationPromise,
callback
);
return operationPromise;
}
/**
* Provide a user-friendly representation
*
* @returns Object
*/
toJSON() {
return this._solution;
}
[inspect.custom](_depth: any, options: InspectOptions) {
return inspect(this.toJSON(), options);
}
}
interface JobPayload extends JobResource {}
interface JobResource {
resource_type: string;
friendly_name: string;
details: any;
start_day: string;
end_day: string;
job_sid: string;
webhook_url: string;
webhook_method: string;
email: string;
url: string;
job_queue_position: string;
estimated_completion_time: string;
}
export class JobInstance {
protected _solution: JobContextSolution;
protected _context?: JobContext;
constructor(protected _version: V1, payload: JobResource, jobSid?: string) {
this.resourceType = payload.resource_type;
this.friendlyName = payload.friendly_name;
this.details = payload.details;
this.startDay = payload.start_day;
this.endDay = payload.end_day;
this.jobSid = payload.job_sid;
this.webhookUrl = payload.webhook_url;
this.webhookMethod = payload.webhook_method;
this.email = payload.email;
this.url = payload.url;
this.jobQueuePosition = payload.job_queue_position;
this.estimatedCompletionTime = payload.estimated_completion_time;
this._solution = { jobSid: jobSid || this.jobSid };
}
/**
* The type of communication – Messages, Calls, Conferences, and Participants
*/
resourceType: string;
/**
* The friendly name specified when creating the job
*/
friendlyName: string;
/**
* The details of a job which is an object that contains an array of status grouped by `status` state. Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days.
*/
details: any;
/**
* The start time for the export specified when creating the job
*/
startDay: string;
/**
* The end time for the export specified when creating the job
*/
endDay: string;
/**
* The job_sid returned when the export was created
*/
jobSid: string;
/**
* The optional webhook url called on completion
*/
webhookUrl: string;
/**
* This is the method used to call the webhook
*/
webhookMethod: string;
/**
* The optional email to send the completion notification to
*/
email: string;
url: string;
/**
* This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease
*/
jobQueuePosition: string;
/**
* this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position
*/
estimatedCompletionTime: string;
private get _proxy(): JobContext {
this._context =
this._context || new JobContextImpl(this._version, this._solution.jobSid);
return this._context;
}
/**
* Remove a JobInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed boolean
*/
remove(
callback?: (error: Error | null, item?: boolean) => any
): Promise<boolean> {
return this._proxy.remove(callback);
}
/**
* Fetch a JobInstance
*
* @param callback - Callback to handle processed record
*
* @returns Resolves to processed JobInstance
*/
fetch(
callback?: (error: Error | null, item?: JobInstance) => any
): Promise<JobInstance> {
return this._proxy.fetch(callback);
}
/**
* Provide a user-friendly representation
*
* @returns Object
*/
toJSON() {
return {
resourceType: this.resourceType,
friendlyName: this.friendlyName,
details: this.details,
startDay: this.startDay,
endDay: this.endDay,
jobSid: this.jobSid,
webhookUrl: this.webhookUrl,
webhookMethod: this.webhookMethod,
email: this.email,
url: this.url,
jobQueuePosition: this.jobQueuePosition,
estimatedCompletionTime: this.estimatedCompletionTime,
};
}
[inspect.custom](_depth: any, options: InspectOptions) {
return inspect(this.toJSON(), options);
}
}
export interface JobSolution {}
export interface JobListInstance {
_version: V1;
_solution: JobSolution;
_uri: string;
(jobSid: string): JobContext;
get(jobSid: string): JobContext;
/**
* Provide a user-friendly representation
*/
toJSON(): any;
[inspect.custom](_depth: any, options: InspectOptions): any;
}
export function JobListInstance(version: V1): JobListInstance {
const instance = ((jobSid) => instance.get(jobSid)) as JobListInstance;
instance.get = function get(jobSid): JobContext {
return new JobContextImpl(version, jobSid);
};
instance._version = version;
instance._solution = {};
instance._uri = ``;
instance.toJSON = function toJSON() {
return instance._solution;
};
instance[inspect.custom] = function inspectImpl(
_depth: any,
options: InspectOptions
) {
return inspect(instance.toJSON(), options);
};
return instance;
}