/
Client.ts
321 lines (299 loc) · 12 KB
/
Client.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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
/**
* This file was auto-generated by Fern from our API Definition.
*/
import * as environments from "../../../../environments";
import * as core from "../../../../core";
import * as Courier from "../../..";
import urlJoin from "url-join";
import * as errors from "../../../../errors";
export declare namespace Bulk {
interface Options {
environment?: core.Supplier<environments.CourierEnvironment | string>;
authorizationToken?: core.Supplier<core.BearerToken | undefined>;
}
interface RequestOptions {
timeoutInSeconds?: number;
maxRetries?: number;
}
interface IdempotentRequestOptions extends RequestOptions {
idempotencyKey?: string | undefined;
idempotencyExpiry?: number | undefined;
}
}
export class Bulk {
constructor(protected readonly _options: Bulk.Options = {}) {}
/**
* @throws {@link Courier.BadRequestError}
*/
public async createJob(
request: Courier.BulkCreateJobParams,
requestOptions?: Bulk.IdempotentRequestOptions
): Promise<Courier.BulkCreateJobResponse> {
const _response = await core.fetcher({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.CourierEnvironment.Production,
"/bulk"
),
method: "POST",
headers: {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@trycourier/courier",
"X-Fern-SDK-Version": "v6.0.5",
"Idempotency-Key": requestOptions?.idempotencyKey != null ? requestOptions?.idempotencyKey : undefined,
"X-Idempotency-Expiration":
requestOptions?.idempotencyExpiry != null
? requestOptions?.idempotencyExpiry.toString()
: undefined,
},
contentType: "application/json",
body: request,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
});
if (_response.ok) {
return _response.body as Courier.BulkCreateJobResponse;
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new Courier.BadRequestError(_response.error.body as Courier.BadRequest);
default:
throw new errors.CourierError({
statusCode: _response.error.statusCode,
body: _response.error.body,
});
}
}
switch (_response.error.reason) {
case "non-json":
throw new errors.CourierError({
statusCode: _response.error.statusCode,
body: _response.error.rawBody,
});
case "timeout":
throw new errors.CourierTimeoutError();
case "unknown":
throw new errors.CourierError({
message: _response.error.errorMessage,
});
}
}
/**
* Ingest user data into a Bulk Job
*/
public async ingestUsers(
jobId: string,
request: Courier.BulkIngestUsersParams,
requestOptions?: Bulk.IdempotentRequestOptions
): Promise<void> {
const _response = await core.fetcher({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.CourierEnvironment.Production,
`/bulk/${jobId}`
),
method: "POST",
headers: {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@trycourier/courier",
"X-Fern-SDK-Version": "v6.0.5",
"Idempotency-Key": requestOptions?.idempotencyKey != null ? requestOptions?.idempotencyKey : undefined,
"X-Idempotency-Expiration":
requestOptions?.idempotencyExpiry != null
? requestOptions?.idempotencyExpiry.toString()
: undefined,
},
contentType: "application/json",
body: request,
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
});
if (_response.ok) {
return;
}
if (_response.error.reason === "status-code") {
throw new errors.CourierError({
statusCode: _response.error.statusCode,
body: _response.error.body,
});
}
switch (_response.error.reason) {
case "non-json":
throw new errors.CourierError({
statusCode: _response.error.statusCode,
body: _response.error.rawBody,
});
case "timeout":
throw new errors.CourierTimeoutError();
case "unknown":
throw new errors.CourierError({
message: _response.error.errorMessage,
});
}
}
/**
* Run a bulk job
* @throws {@link Courier.BadRequestError}
*/
public async runJob(jobId: string, requestOptions?: Bulk.IdempotentRequestOptions): Promise<void> {
const _response = await core.fetcher({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.CourierEnvironment.Production,
`/bulk/${jobId}/run`
),
method: "POST",
headers: {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@trycourier/courier",
"X-Fern-SDK-Version": "v6.0.5",
"Idempotency-Key": requestOptions?.idempotencyKey != null ? requestOptions?.idempotencyKey : undefined,
"X-Idempotency-Expiration":
requestOptions?.idempotencyExpiry != null
? requestOptions?.idempotencyExpiry.toString()
: undefined,
},
contentType: "application/json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
});
if (_response.ok) {
return;
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new Courier.BadRequestError(_response.error.body as Courier.BadRequest);
default:
throw new errors.CourierError({
statusCode: _response.error.statusCode,
body: _response.error.body,
});
}
}
switch (_response.error.reason) {
case "non-json":
throw new errors.CourierError({
statusCode: _response.error.statusCode,
body: _response.error.rawBody,
});
case "timeout":
throw new errors.CourierTimeoutError();
case "unknown":
throw new errors.CourierError({
message: _response.error.errorMessage,
});
}
}
/**
* Get a bulk job
* @throws {@link Courier.BadRequestError}
*/
public async getJob(jobId: string, requestOptions?: Bulk.RequestOptions): Promise<Courier.BulkGetJobResponse> {
const _response = await core.fetcher({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.CourierEnvironment.Production,
`/bulk/${jobId}`
),
method: "GET",
headers: {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@trycourier/courier",
"X-Fern-SDK-Version": "v6.0.5",
},
contentType: "application/json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
});
if (_response.ok) {
return _response.body as Courier.BulkGetJobResponse;
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new Courier.BadRequestError(_response.error.body as Courier.BadRequest);
default:
throw new errors.CourierError({
statusCode: _response.error.statusCode,
body: _response.error.body,
});
}
}
switch (_response.error.reason) {
case "non-json":
throw new errors.CourierError({
statusCode: _response.error.statusCode,
body: _response.error.rawBody,
});
case "timeout":
throw new errors.CourierTimeoutError();
case "unknown":
throw new errors.CourierError({
message: _response.error.errorMessage,
});
}
}
/**
* Get Bulk Job Users
* @throws {@link Courier.BadRequestError}
*/
public async getUsers(
jobId: string,
requestOptions?: Bulk.RequestOptions
): Promise<Courier.BulkGetJobUsersResponse> {
const _response = await core.fetcher({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.CourierEnvironment.Production,
`/bulk/${jobId}/users`
),
method: "GET",
headers: {
Authorization: await this._getAuthorizationHeader(),
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "@trycourier/courier",
"X-Fern-SDK-Version": "v6.0.5",
},
contentType: "application/json",
timeoutMs: requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
maxRetries: requestOptions?.maxRetries,
});
if (_response.ok) {
return _response.body as Courier.BulkGetJobUsersResponse;
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 400:
throw new Courier.BadRequestError(_response.error.body as Courier.BadRequest);
default:
throw new errors.CourierError({
statusCode: _response.error.statusCode,
body: _response.error.body,
});
}
}
switch (_response.error.reason) {
case "non-json":
throw new errors.CourierError({
statusCode: _response.error.statusCode,
body: _response.error.rawBody,
});
case "timeout":
throw new errors.CourierTimeoutError();
case "unknown":
throw new errors.CourierError({
message: _response.error.errorMessage,
});
}
}
protected async _getAuthorizationHeader() {
const bearer = (await core.Supplier.get(this._options.authorizationToken)) ?? process.env["COURIER_AUTH_TOKEN"];
if (bearer == null) {
throw new errors.CourierError({
message: "Please specify COURIER_AUTH_TOKEN when instantiating the client.",
});
}
return `Bearer ${bearer}`;
}
}