/
Client.ts
152 lines (139 loc) · 5.87 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
/**
* 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 Automations {
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 Automations {
constructor(protected readonly _options: Automations.Options = {}) {}
/**
* Invoke an automation run from an automation template.
*/
public async invokeAutomationTemplate(
templateId: string,
request: Courier.AutomationInvokeParams,
requestOptions?: Automations.IdempotentRequestOptions
): Promise<Courier.AutomationInvokeResponse> {
const _response = await core.fetcher({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.CourierEnvironment.Production,
`/automations/${templateId}/invoke`
),
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.AutomationInvokeResponse;
}
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,
});
}
}
/**
* Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a series of automation steps. For information about what steps are available, checkout the ad hoc automation guide [here](https://www.courier.com/docs/automations/steps/).
*/
public async invokeAdHocAutomation(
request: Courier.AutomationAdHocInvokeParams,
requestOptions?: Automations.IdempotentRequestOptions
): Promise<Courier.AutomationInvokeResponse> {
const _response = await core.fetcher({
url: urlJoin(
(await core.Supplier.get(this._options.environment)) ?? environments.CourierEnvironment.Production,
"/automations/invoke"
),
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.AutomationInvokeResponse;
}
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,
});
}
}
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}`;
}
}