@scaleway/sdk-tem 1.3.0 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +96 -0
- package/dist/v1alpha1/api.gen.d.ts +2 -2
- package/dist/v1alpha1/api.gen.js +29 -46
- package/dist/v1alpha1/content.gen.js +4 -1
- package/dist/v1alpha1/index.gen.d.ts +1 -1
- package/dist/v1alpha1/marshalling.gen.js +5 -17
- package/dist/v1alpha1/validation-rules.gen.d.ts +0 -2
- package/dist/v1alpha1/validation-rules.gen.js +2 -4
- package/package.json +6 -9
- package/dist/index.gen.cjs +0 -4
- package/dist/v1alpha1/api.gen.cjs +0 -538
- package/dist/v1alpha1/content.gen.cjs +0 -9
- package/dist/v1alpha1/index.gen.cjs +0 -36
- package/dist/v1alpha1/marshalling.gen.cjs +0 -600
- package/dist/v1alpha1/validation-rules.gen.cjs +0 -147
|
@@ -1,538 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
3
|
-
const sdkClient = require("@scaleway/sdk-client");
|
|
4
|
-
const content_gen = require("./content.gen.cjs");
|
|
5
|
-
const marshalling_gen = require("./marshalling.gen.cjs");
|
|
6
|
-
const jsonContentHeaders = {
|
|
7
|
-
"Content-Type": "application/json; charset=utf-8"
|
|
8
|
-
};
|
|
9
|
-
class API extends sdkClient.API {
|
|
10
|
-
/**
|
|
11
|
-
* Locality of this API.
|
|
12
|
-
* type ∈ {'zone','region','global','unspecified'}
|
|
13
|
-
*/
|
|
14
|
-
static LOCALITY = sdkClient.toApiLocality({
|
|
15
|
-
regions: ["fr-par"]
|
|
16
|
-
});
|
|
17
|
-
/**
|
|
18
|
-
* Send an email. You must specify the `region`, the sender and the recipient's information and the `project_id` to send an email from a checked domain. The subject of the email must contain at least 6 characters.
|
|
19
|
-
*
|
|
20
|
-
* @param request - The request {@link CreateEmailRequest}
|
|
21
|
-
* @returns A Promise of CreateEmailResponse
|
|
22
|
-
*/
|
|
23
|
-
createEmail = (request) => this.client.fetch(
|
|
24
|
-
{
|
|
25
|
-
body: JSON.stringify(
|
|
26
|
-
marshalling_gen.marshalCreateEmailRequest(request, this.client.settings)
|
|
27
|
-
),
|
|
28
|
-
headers: jsonContentHeaders,
|
|
29
|
-
method: "POST",
|
|
30
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/emails`
|
|
31
|
-
},
|
|
32
|
-
marshalling_gen.unmarshalCreateEmailResponse
|
|
33
|
-
);
|
|
34
|
-
/**
|
|
35
|
-
* Get an email. Retrieve information about a specific email using the `email_id` and `region` parameters.
|
|
36
|
-
*
|
|
37
|
-
* @param request - The request {@link GetEmailRequest}
|
|
38
|
-
* @returns A Promise of Email
|
|
39
|
-
*/
|
|
40
|
-
getEmail = (request) => this.client.fetch(
|
|
41
|
-
{
|
|
42
|
-
method: "GET",
|
|
43
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/emails/${sdkClient.validatePathParam("emailId", request.emailId)}`
|
|
44
|
-
},
|
|
45
|
-
marshalling_gen.unmarshalEmail
|
|
46
|
-
);
|
|
47
|
-
/**
|
|
48
|
-
* Waits for {@link Email} to be in a final state.
|
|
49
|
-
*
|
|
50
|
-
* @param request - The request {@link GetEmailRequest}
|
|
51
|
-
* @param options - The waiting options
|
|
52
|
-
* @returns A Promise of Email
|
|
53
|
-
*/
|
|
54
|
-
waitForEmail = (request, options) => sdkClient.waitForResource(
|
|
55
|
-
options?.stop ?? ((res) => Promise.resolve(!content_gen.EMAIL_TRANSIENT_STATUSES.includes(res.status))),
|
|
56
|
-
this.getEmail,
|
|
57
|
-
request,
|
|
58
|
-
options
|
|
59
|
-
);
|
|
60
|
-
pageOfListEmails = (request = {}) => this.client.fetch(
|
|
61
|
-
{
|
|
62
|
-
method: "GET",
|
|
63
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/emails`,
|
|
64
|
-
urlParams: sdkClient.urlParams(
|
|
65
|
-
["domain_id", request.domainId],
|
|
66
|
-
["flags", request.flags],
|
|
67
|
-
["mail_from", request.mailFrom],
|
|
68
|
-
["mail_rcpt", request.mailRcpt],
|
|
69
|
-
["mail_to", request.mailTo],
|
|
70
|
-
["message_id", request.messageId],
|
|
71
|
-
["order_by", request.orderBy],
|
|
72
|
-
["page", request.page],
|
|
73
|
-
[
|
|
74
|
-
"page_size",
|
|
75
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
76
|
-
],
|
|
77
|
-
["project_id", request.projectId],
|
|
78
|
-
["search", request.search],
|
|
79
|
-
["since", request.since],
|
|
80
|
-
["statuses", request.statuses],
|
|
81
|
-
["subject", request.subject],
|
|
82
|
-
["until", request.until]
|
|
83
|
-
)
|
|
84
|
-
},
|
|
85
|
-
marshalling_gen.unmarshalListEmailsResponse
|
|
86
|
-
);
|
|
87
|
-
/**
|
|
88
|
-
* List emails. Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the `region`.
|
|
89
|
-
*
|
|
90
|
-
* @param request - The request {@link ListEmailsRequest}
|
|
91
|
-
* @returns A Promise of ListEmailsResponse
|
|
92
|
-
*/
|
|
93
|
-
listEmails = (request = {}) => sdkClient.enrichForPagination("emails", this.pageOfListEmails, request);
|
|
94
|
-
/**
|
|
95
|
-
* Email statuses. Get information on your emails' statuses.
|
|
96
|
-
*
|
|
97
|
-
* @param request - The request {@link GetStatisticsRequest}
|
|
98
|
-
* @returns A Promise of Statistics
|
|
99
|
-
*/
|
|
100
|
-
getStatistics = (request = {}) => this.client.fetch(
|
|
101
|
-
{
|
|
102
|
-
method: "GET",
|
|
103
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/statistics`,
|
|
104
|
-
urlParams: sdkClient.urlParams(
|
|
105
|
-
["domain_id", request.domainId],
|
|
106
|
-
["mail_from", request.mailFrom],
|
|
107
|
-
["project_id", request.projectId],
|
|
108
|
-
["since", request.since],
|
|
109
|
-
["until", request.until]
|
|
110
|
-
)
|
|
111
|
-
},
|
|
112
|
-
marshalling_gen.unmarshalStatistics
|
|
113
|
-
);
|
|
114
|
-
/**
|
|
115
|
-
* Cancel an email. You can cancel the sending of an email if it has not been sent yet. You must specify the `region` and the `email_id` of the email you want to cancel.
|
|
116
|
-
*
|
|
117
|
-
* @param request - The request {@link CancelEmailRequest}
|
|
118
|
-
* @returns A Promise of Email
|
|
119
|
-
*/
|
|
120
|
-
cancelEmail = (request) => this.client.fetch(
|
|
121
|
-
{
|
|
122
|
-
body: "{}",
|
|
123
|
-
headers: jsonContentHeaders,
|
|
124
|
-
method: "POST",
|
|
125
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/emails/${sdkClient.validatePathParam("emailId", request.emailId)}/cancel`
|
|
126
|
-
},
|
|
127
|
-
marshalling_gen.unmarshalEmail
|
|
128
|
-
);
|
|
129
|
-
/**
|
|
130
|
-
* Register a domain in a project. You must specify the `region`, `project_id` and `domain_name` to register a domain in a specific Project.
|
|
131
|
-
*
|
|
132
|
-
* @param request - The request {@link CreateDomainRequest}
|
|
133
|
-
* @returns A Promise of Domain
|
|
134
|
-
*/
|
|
135
|
-
createDomain = (request) => this.client.fetch(
|
|
136
|
-
{
|
|
137
|
-
body: JSON.stringify(
|
|
138
|
-
marshalling_gen.marshalCreateDomainRequest(request, this.client.settings)
|
|
139
|
-
),
|
|
140
|
-
headers: jsonContentHeaders,
|
|
141
|
-
method: "POST",
|
|
142
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains`
|
|
143
|
-
},
|
|
144
|
-
marshalling_gen.unmarshalDomain
|
|
145
|
-
);
|
|
146
|
-
/**
|
|
147
|
-
* Get information about a domain. Retrieve information about a specific domain using the `region` and `domain_id` parameters. Monitor your domain's reputation and improve **average** and **bad** reputation statuses, using your domain's **Email activity** tab on the [Scaleway console](https://console.scaleway.com/transactional-email/domains) to get a more detailed report. Check out our [dedicated documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/) to improve your domain's reputation.
|
|
148
|
-
*
|
|
149
|
-
* @param request - The request {@link GetDomainRequest}
|
|
150
|
-
* @returns A Promise of Domain
|
|
151
|
-
*/
|
|
152
|
-
getDomain = (request) => this.client.fetch(
|
|
153
|
-
{
|
|
154
|
-
method: "GET",
|
|
155
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${sdkClient.validatePathParam("domainId", request.domainId)}`
|
|
156
|
-
},
|
|
157
|
-
marshalling_gen.unmarshalDomain
|
|
158
|
-
);
|
|
159
|
-
/**
|
|
160
|
-
* Waits for {@link Domain} to be in a final state.
|
|
161
|
-
*
|
|
162
|
-
* @param request - The request {@link GetDomainRequest}
|
|
163
|
-
* @param options - The waiting options
|
|
164
|
-
* @returns A Promise of Domain
|
|
165
|
-
*/
|
|
166
|
-
waitForDomain = (request, options) => sdkClient.waitForResource(
|
|
167
|
-
options?.stop ?? ((res) => Promise.resolve(!content_gen.DOMAIN_TRANSIENT_STATUSES.includes(res.status))),
|
|
168
|
-
this.getDomain,
|
|
169
|
-
request,
|
|
170
|
-
options
|
|
171
|
-
);
|
|
172
|
-
pageOfListDomains = (request = {}) => this.client.fetch(
|
|
173
|
-
{
|
|
174
|
-
method: "GET",
|
|
175
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains`,
|
|
176
|
-
urlParams: sdkClient.urlParams(
|
|
177
|
-
["name", request.name],
|
|
178
|
-
["organization_id", request.organizationId],
|
|
179
|
-
["page", request.page],
|
|
180
|
-
[
|
|
181
|
-
"page_size",
|
|
182
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
183
|
-
],
|
|
184
|
-
["project_id", request.projectId],
|
|
185
|
-
["status", request.status]
|
|
186
|
-
)
|
|
187
|
-
},
|
|
188
|
-
marshalling_gen.unmarshalListDomainsResponse
|
|
189
|
-
);
|
|
190
|
-
/**
|
|
191
|
-
* List domains. Retrieve domains in a specific Project or in a specific Organization using the `region` parameter.
|
|
192
|
-
*
|
|
193
|
-
* @param request - The request {@link ListDomainsRequest}
|
|
194
|
-
* @returns A Promise of ListDomainsResponse
|
|
195
|
-
*/
|
|
196
|
-
listDomains = (request = {}) => sdkClient.enrichForPagination("domains", this.pageOfListDomains, request);
|
|
197
|
-
/**
|
|
198
|
-
* Delete a domain. You must specify the domain you want to delete by the `region` and `domain_id`. Deleting a domain is permanent and cannot be undone.
|
|
199
|
-
*
|
|
200
|
-
* @param request - The request {@link RevokeDomainRequest}
|
|
201
|
-
* @returns A Promise of Domain
|
|
202
|
-
*/
|
|
203
|
-
revokeDomain = (request) => this.client.fetch(
|
|
204
|
-
{
|
|
205
|
-
body: "{}",
|
|
206
|
-
headers: jsonContentHeaders,
|
|
207
|
-
method: "POST",
|
|
208
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${sdkClient.validatePathParam("domainId", request.domainId)}/revoke`
|
|
209
|
-
},
|
|
210
|
-
marshalling_gen.unmarshalDomain
|
|
211
|
-
);
|
|
212
|
-
/**
|
|
213
|
-
* Domain DNS check. Perform an immediate DNS check of a domain using the `region` and `domain_id` parameters.
|
|
214
|
-
*
|
|
215
|
-
* @param request - The request {@link CheckDomainRequest}
|
|
216
|
-
* @returns A Promise of Domain
|
|
217
|
-
*/
|
|
218
|
-
checkDomain = (request) => this.client.fetch(
|
|
219
|
-
{
|
|
220
|
-
body: "{}",
|
|
221
|
-
headers: jsonContentHeaders,
|
|
222
|
-
method: "POST",
|
|
223
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${sdkClient.validatePathParam("domainId", request.domainId)}/check`
|
|
224
|
-
},
|
|
225
|
-
marshalling_gen.unmarshalDomain
|
|
226
|
-
);
|
|
227
|
-
/**
|
|
228
|
-
* Display SPF, DKIM, DMARC and MX records status and potential errors. Display SPF, DKIM, DMARC and MX records status and potential errors, including the found records to make debugging easier.
|
|
229
|
-
*
|
|
230
|
-
* @param request - The request {@link GetDomainLastStatusRequest}
|
|
231
|
-
* @returns A Promise of DomainLastStatus
|
|
232
|
-
*/
|
|
233
|
-
getDomainLastStatus = (request) => this.client.fetch(
|
|
234
|
-
{
|
|
235
|
-
method: "GET",
|
|
236
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${sdkClient.validatePathParam("domainId", request.domainId)}/verification`
|
|
237
|
-
},
|
|
238
|
-
marshalling_gen.unmarshalDomainLastStatus
|
|
239
|
-
);
|
|
240
|
-
/**
|
|
241
|
-
* Update a domain. Update a domain auto-configuration.
|
|
242
|
-
*
|
|
243
|
-
* @param request - The request {@link UpdateDomainRequest}
|
|
244
|
-
* @returns A Promise of Domain
|
|
245
|
-
*/
|
|
246
|
-
updateDomain = (request) => this.client.fetch(
|
|
247
|
-
{
|
|
248
|
-
body: JSON.stringify(
|
|
249
|
-
marshalling_gen.marshalUpdateDomainRequest(request, this.client.settings)
|
|
250
|
-
),
|
|
251
|
-
headers: jsonContentHeaders,
|
|
252
|
-
method: "PATCH",
|
|
253
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${sdkClient.validatePathParam("domainId", request.domainId)}`
|
|
254
|
-
},
|
|
255
|
-
marshalling_gen.unmarshalDomain
|
|
256
|
-
);
|
|
257
|
-
/**
|
|
258
|
-
* Create a Webhook. Create a new Webhook triggered by a list of event types and pushed to a Scaleway SNS ARN.
|
|
259
|
-
*
|
|
260
|
-
* @param request - The request {@link CreateWebhookRequest}
|
|
261
|
-
* @returns A Promise of Webhook
|
|
262
|
-
*/
|
|
263
|
-
createWebhook = (request) => this.client.fetch(
|
|
264
|
-
{
|
|
265
|
-
body: JSON.stringify(
|
|
266
|
-
marshalling_gen.marshalCreateWebhookRequest(request, this.client.settings)
|
|
267
|
-
),
|
|
268
|
-
headers: jsonContentHeaders,
|
|
269
|
-
method: "POST",
|
|
270
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/webhooks`
|
|
271
|
-
},
|
|
272
|
-
marshalling_gen.unmarshalWebhook
|
|
273
|
-
);
|
|
274
|
-
pageOfListWebhooks = (request = {}) => this.client.fetch(
|
|
275
|
-
{
|
|
276
|
-
method: "GET",
|
|
277
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/webhooks`,
|
|
278
|
-
urlParams: sdkClient.urlParams(
|
|
279
|
-
["domain_id", request.domainId],
|
|
280
|
-
["order_by", request.orderBy],
|
|
281
|
-
["organization_id", request.organizationId],
|
|
282
|
-
["page", request.page],
|
|
283
|
-
[
|
|
284
|
-
"page_size",
|
|
285
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
286
|
-
],
|
|
287
|
-
["project_id", request.projectId]
|
|
288
|
-
)
|
|
289
|
-
},
|
|
290
|
-
marshalling_gen.unmarshalListWebhooksResponse
|
|
291
|
-
);
|
|
292
|
-
/**
|
|
293
|
-
* List Webhooks. Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
|
|
294
|
-
*
|
|
295
|
-
* @param request - The request {@link ListWebhooksRequest}
|
|
296
|
-
* @returns A Promise of ListWebhooksResponse
|
|
297
|
-
*/
|
|
298
|
-
listWebhooks = (request = {}) => sdkClient.enrichForPagination("webhooks", this.pageOfListWebhooks, request);
|
|
299
|
-
/**
|
|
300
|
-
* Get information about a Webhook. Retrieve information about a specific Webhook using the `webhook_id` and `region` parameters.
|
|
301
|
-
*
|
|
302
|
-
* @param request - The request {@link GetWebhookRequest}
|
|
303
|
-
* @returns A Promise of Webhook
|
|
304
|
-
*/
|
|
305
|
-
getWebhook = (request) => this.client.fetch(
|
|
306
|
-
{
|
|
307
|
-
method: "GET",
|
|
308
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/webhooks/${sdkClient.validatePathParam("webhookId", request.webhookId)}`
|
|
309
|
-
},
|
|
310
|
-
marshalling_gen.unmarshalWebhook
|
|
311
|
-
);
|
|
312
|
-
/**
|
|
313
|
-
* Update a Webhook. Update a Webhook events type, SNS ARN or name.
|
|
314
|
-
*
|
|
315
|
-
* @param request - The request {@link UpdateWebhookRequest}
|
|
316
|
-
* @returns A Promise of Webhook
|
|
317
|
-
*/
|
|
318
|
-
updateWebhook = (request) => this.client.fetch(
|
|
319
|
-
{
|
|
320
|
-
body: JSON.stringify(
|
|
321
|
-
marshalling_gen.marshalUpdateWebhookRequest(request, this.client.settings)
|
|
322
|
-
),
|
|
323
|
-
headers: jsonContentHeaders,
|
|
324
|
-
method: "PATCH",
|
|
325
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/webhooks/${sdkClient.validatePathParam("webhookId", request.webhookId)}`
|
|
326
|
-
},
|
|
327
|
-
marshalling_gen.unmarshalWebhook
|
|
328
|
-
);
|
|
329
|
-
/**
|
|
330
|
-
* Delete a Webhook. You must specify the Webhook you want to delete by the `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be undone.
|
|
331
|
-
*
|
|
332
|
-
* @param request - The request {@link DeleteWebhookRequest}
|
|
333
|
-
*/
|
|
334
|
-
deleteWebhook = (request) => this.client.fetch({
|
|
335
|
-
method: "DELETE",
|
|
336
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/webhooks/${sdkClient.validatePathParam("webhookId", request.webhookId)}`
|
|
337
|
-
});
|
|
338
|
-
pageOfListWebhookEvents = (request) => this.client.fetch(
|
|
339
|
-
{
|
|
340
|
-
method: "GET",
|
|
341
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/webhooks/${sdkClient.validatePathParam("webhookId", request.webhookId)}/events`,
|
|
342
|
-
urlParams: sdkClient.urlParams(
|
|
343
|
-
["domain_id", request.domainId],
|
|
344
|
-
["email_id", request.emailId],
|
|
345
|
-
["event_types", request.eventTypes],
|
|
346
|
-
["order_by", request.orderBy],
|
|
347
|
-
["organization_id", request.organizationId],
|
|
348
|
-
["page", request.page],
|
|
349
|
-
[
|
|
350
|
-
"page_size",
|
|
351
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
352
|
-
],
|
|
353
|
-
["project_id", request.projectId],
|
|
354
|
-
["statuses", request.statuses]
|
|
355
|
-
)
|
|
356
|
-
},
|
|
357
|
-
marshalling_gen.unmarshalListWebhookEventsResponse
|
|
358
|
-
);
|
|
359
|
-
/**
|
|
360
|
-
* List Webhook triggered events. Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
|
|
361
|
-
*
|
|
362
|
-
* @param request - The request {@link ListWebhookEventsRequest}
|
|
363
|
-
* @returns A Promise of ListWebhookEventsResponse
|
|
364
|
-
*/
|
|
365
|
-
listWebhookEvents = (request) => sdkClient.enrichForPagination("webhookEvents", this.pageOfListWebhookEvents, request);
|
|
366
|
-
/**
|
|
367
|
-
* List project settings. Retrieve the project settings including periodic reports.
|
|
368
|
-
*
|
|
369
|
-
* @param request - The request {@link GetProjectSettingsRequest}
|
|
370
|
-
* @returns A Promise of ProjectSettings
|
|
371
|
-
*/
|
|
372
|
-
getProjectSettings = (request = {}) => this.client.fetch(
|
|
373
|
-
{
|
|
374
|
-
method: "GET",
|
|
375
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/project/${sdkClient.validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}/settings`
|
|
376
|
-
},
|
|
377
|
-
marshalling_gen.unmarshalProjectSettings
|
|
378
|
-
);
|
|
379
|
-
/**
|
|
380
|
-
* Update project settings. Update the project settings including periodic reports.
|
|
381
|
-
*
|
|
382
|
-
* @param request - The request {@link UpdateProjectSettingsRequest}
|
|
383
|
-
* @returns A Promise of ProjectSettings
|
|
384
|
-
*/
|
|
385
|
-
updateProjectSettings = (request = {}) => this.client.fetch(
|
|
386
|
-
{
|
|
387
|
-
body: JSON.stringify(
|
|
388
|
-
marshalling_gen.marshalUpdateProjectSettingsRequest(request, this.client.settings)
|
|
389
|
-
),
|
|
390
|
-
headers: jsonContentHeaders,
|
|
391
|
-
method: "PATCH",
|
|
392
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/project/${sdkClient.validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}/settings`
|
|
393
|
-
},
|
|
394
|
-
marshalling_gen.unmarshalProjectSettings
|
|
395
|
-
);
|
|
396
|
-
pageOfListBlocklists = (request) => this.client.fetch(
|
|
397
|
-
{
|
|
398
|
-
method: "GET",
|
|
399
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/blocklists`,
|
|
400
|
-
urlParams: sdkClient.urlParams(
|
|
401
|
-
["custom", request.custom],
|
|
402
|
-
["domain_id", request.domainId],
|
|
403
|
-
["email", request.email],
|
|
404
|
-
["order_by", request.orderBy],
|
|
405
|
-
["page", request.page],
|
|
406
|
-
[
|
|
407
|
-
"page_size",
|
|
408
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
409
|
-
],
|
|
410
|
-
["type", request.type]
|
|
411
|
-
)
|
|
412
|
-
},
|
|
413
|
-
marshalling_gen.unmarshalListBlocklistsResponse
|
|
414
|
-
);
|
|
415
|
-
/**
|
|
416
|
-
* List blocklists. Retrieve the list of blocklists.
|
|
417
|
-
*
|
|
418
|
-
* @param request - The request {@link ListBlocklistsRequest}
|
|
419
|
-
* @returns A Promise of ListBlocklistsResponse
|
|
420
|
-
*/
|
|
421
|
-
listBlocklists = (request) => sdkClient.enrichForPagination("blocklists", this.pageOfListBlocklists, request);
|
|
422
|
-
/**
|
|
423
|
-
* Bulk create blocklists. Create multiple blocklists in a specific Project or Organization using the `region` parameter.
|
|
424
|
-
*
|
|
425
|
-
* @param request - The request {@link BulkCreateBlocklistsRequest}
|
|
426
|
-
* @returns A Promise of BulkCreateBlocklistsResponse
|
|
427
|
-
*/
|
|
428
|
-
bulkCreateBlocklists = (request) => this.client.fetch(
|
|
429
|
-
{
|
|
430
|
-
body: JSON.stringify(
|
|
431
|
-
marshalling_gen.marshalBulkCreateBlocklistsRequest(request, this.client.settings)
|
|
432
|
-
),
|
|
433
|
-
headers: jsonContentHeaders,
|
|
434
|
-
method: "POST",
|
|
435
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/blocklists`
|
|
436
|
-
},
|
|
437
|
-
marshalling_gen.unmarshalBulkCreateBlocklistsResponse
|
|
438
|
-
);
|
|
439
|
-
/**
|
|
440
|
-
* Delete a blocklist. You must specify the blocklist you want to delete by the `region` and `blocklist_id`.
|
|
441
|
-
*
|
|
442
|
-
* @param request - The request {@link DeleteBlocklistRequest}
|
|
443
|
-
*/
|
|
444
|
-
deleteBlocklist = (request) => this.client.fetch({
|
|
445
|
-
method: "DELETE",
|
|
446
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/blocklists/${sdkClient.validatePathParam("blocklistId", request.blocklistId)}`
|
|
447
|
-
});
|
|
448
|
-
/**
|
|
449
|
-
* Get information about subscribed offers. Retrieve information about the offers you are subscribed to using the `project_id` and `region` parameters.
|
|
450
|
-
*
|
|
451
|
-
* @param request - The request {@link ListOfferSubscriptionsRequest}
|
|
452
|
-
* @returns A Promise of ListOfferSubscriptionsResponse
|
|
453
|
-
*/
|
|
454
|
-
listOfferSubscriptions = (request = {}) => this.client.fetch(
|
|
455
|
-
{
|
|
456
|
-
method: "GET",
|
|
457
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/offer-subscriptions`,
|
|
458
|
-
urlParams: sdkClient.urlParams([
|
|
459
|
-
"project_id",
|
|
460
|
-
request.projectId ?? this.client.settings.defaultProjectId
|
|
461
|
-
])
|
|
462
|
-
},
|
|
463
|
-
marshalling_gen.unmarshalListOfferSubscriptionsResponse
|
|
464
|
-
);
|
|
465
|
-
/**
|
|
466
|
-
* Update a subscribed offer.
|
|
467
|
-
*
|
|
468
|
-
* @param request - The request {@link UpdateOfferSubscriptionRequest}
|
|
469
|
-
* @returns A Promise of OfferSubscription
|
|
470
|
-
*/
|
|
471
|
-
updateOfferSubscription = (request = {}) => this.client.fetch(
|
|
472
|
-
{
|
|
473
|
-
body: JSON.stringify(
|
|
474
|
-
marshalling_gen.marshalUpdateOfferSubscriptionRequest(request, this.client.settings)
|
|
475
|
-
),
|
|
476
|
-
headers: jsonContentHeaders,
|
|
477
|
-
method: "PATCH",
|
|
478
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/offer-subscriptions`
|
|
479
|
-
},
|
|
480
|
-
marshalling_gen.unmarshalOfferSubscription
|
|
481
|
-
);
|
|
482
|
-
/**
|
|
483
|
-
* List the available offers.. Retrieve the list of the available and free-of-charge offers you can subscribe to.
|
|
484
|
-
*
|
|
485
|
-
* @param request - The request {@link ListOffersRequest}
|
|
486
|
-
* @returns A Promise of ListOffersResponse
|
|
487
|
-
*/
|
|
488
|
-
listOffers = (request = {}) => this.client.fetch(
|
|
489
|
-
{
|
|
490
|
-
method: "GET",
|
|
491
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/offers`
|
|
492
|
-
},
|
|
493
|
-
marshalling_gen.unmarshalListOffersResponse
|
|
494
|
-
);
|
|
495
|
-
pageOfListPools = (request = {}) => this.client.fetch(
|
|
496
|
-
{
|
|
497
|
-
method: "GET",
|
|
498
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/pools`,
|
|
499
|
-
urlParams: sdkClient.urlParams(
|
|
500
|
-
["page", request.page],
|
|
501
|
-
[
|
|
502
|
-
"page_size",
|
|
503
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
504
|
-
],
|
|
505
|
-
[
|
|
506
|
-
"project_id",
|
|
507
|
-
request.projectId ?? this.client.settings.defaultProjectId
|
|
508
|
-
]
|
|
509
|
-
)
|
|
510
|
-
},
|
|
511
|
-
marshalling_gen.unmarshalListPoolsResponse
|
|
512
|
-
);
|
|
513
|
-
/**
|
|
514
|
-
* Get information about a sending pool.. Retrieve information about a sending pool, including its creation status and configuration parameters.
|
|
515
|
-
*
|
|
516
|
-
* @param request - The request {@link ListPoolsRequest}
|
|
517
|
-
* @returns A Promise of ListPoolsResponse
|
|
518
|
-
*/
|
|
519
|
-
listPools = (request = {}) => sdkClient.enrichForPagination("pools", this.pageOfListPools, request);
|
|
520
|
-
/**
|
|
521
|
-
* Get project resource consumption.. Get project resource consumption.
|
|
522
|
-
*
|
|
523
|
-
* @param request - The request {@link GetProjectConsumptionRequest}
|
|
524
|
-
* @returns A Promise of ProjectConsumption
|
|
525
|
-
*/
|
|
526
|
-
getProjectConsumption = (request = {}) => this.client.fetch(
|
|
527
|
-
{
|
|
528
|
-
method: "GET",
|
|
529
|
-
path: `/transactional-email/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/project-consumption`,
|
|
530
|
-
urlParams: sdkClient.urlParams([
|
|
531
|
-
"project_id",
|
|
532
|
-
request.projectId ?? this.client.settings.defaultProjectId
|
|
533
|
-
])
|
|
534
|
-
},
|
|
535
|
-
marshalling_gen.unmarshalProjectConsumption
|
|
536
|
-
);
|
|
537
|
-
}
|
|
538
|
-
exports.API = API;
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
3
|
-
const DOMAIN_TRANSIENT_STATUSES = [
|
|
4
|
-
"pending",
|
|
5
|
-
"autoconfiguring"
|
|
6
|
-
];
|
|
7
|
-
const EMAIL_TRANSIENT_STATUSES = ["new", "sending"];
|
|
8
|
-
exports.DOMAIN_TRANSIENT_STATUSES = DOMAIN_TRANSIENT_STATUSES;
|
|
9
|
-
exports.EMAIL_TRANSIENT_STATUSES = EMAIL_TRANSIENT_STATUSES;
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
3
|
-
const api_gen = require("./api.gen.cjs");
|
|
4
|
-
const content_gen = require("./content.gen.cjs");
|
|
5
|
-
const marshalling_gen = require("./marshalling.gen.cjs");
|
|
6
|
-
const validationRules_gen = require("./validation-rules.gen.cjs");
|
|
7
|
-
exports.API = api_gen.API;
|
|
8
|
-
exports.DOMAIN_TRANSIENT_STATUSES = content_gen.DOMAIN_TRANSIENT_STATUSES;
|
|
9
|
-
exports.EMAIL_TRANSIENT_STATUSES = content_gen.EMAIL_TRANSIENT_STATUSES;
|
|
10
|
-
exports.marshalBulkCreateBlocklistsRequest = marshalling_gen.marshalBulkCreateBlocklistsRequest;
|
|
11
|
-
exports.marshalCreateDomainRequest = marshalling_gen.marshalCreateDomainRequest;
|
|
12
|
-
exports.marshalCreateEmailRequest = marshalling_gen.marshalCreateEmailRequest;
|
|
13
|
-
exports.marshalCreateWebhookRequest = marshalling_gen.marshalCreateWebhookRequest;
|
|
14
|
-
exports.marshalUpdateDomainRequest = marshalling_gen.marshalUpdateDomainRequest;
|
|
15
|
-
exports.marshalUpdateOfferSubscriptionRequest = marshalling_gen.marshalUpdateOfferSubscriptionRequest;
|
|
16
|
-
exports.marshalUpdateProjectSettingsRequest = marshalling_gen.marshalUpdateProjectSettingsRequest;
|
|
17
|
-
exports.marshalUpdateWebhookRequest = marshalling_gen.marshalUpdateWebhookRequest;
|
|
18
|
-
exports.unmarshalBulkCreateBlocklistsResponse = marshalling_gen.unmarshalBulkCreateBlocklistsResponse;
|
|
19
|
-
exports.unmarshalCreateEmailResponse = marshalling_gen.unmarshalCreateEmailResponse;
|
|
20
|
-
exports.unmarshalDomain = marshalling_gen.unmarshalDomain;
|
|
21
|
-
exports.unmarshalDomainLastStatus = marshalling_gen.unmarshalDomainLastStatus;
|
|
22
|
-
exports.unmarshalEmail = marshalling_gen.unmarshalEmail;
|
|
23
|
-
exports.unmarshalListBlocklistsResponse = marshalling_gen.unmarshalListBlocklistsResponse;
|
|
24
|
-
exports.unmarshalListDomainsResponse = marshalling_gen.unmarshalListDomainsResponse;
|
|
25
|
-
exports.unmarshalListEmailsResponse = marshalling_gen.unmarshalListEmailsResponse;
|
|
26
|
-
exports.unmarshalListOfferSubscriptionsResponse = marshalling_gen.unmarshalListOfferSubscriptionsResponse;
|
|
27
|
-
exports.unmarshalListOffersResponse = marshalling_gen.unmarshalListOffersResponse;
|
|
28
|
-
exports.unmarshalListPoolsResponse = marshalling_gen.unmarshalListPoolsResponse;
|
|
29
|
-
exports.unmarshalListWebhookEventsResponse = marshalling_gen.unmarshalListWebhookEventsResponse;
|
|
30
|
-
exports.unmarshalListWebhooksResponse = marshalling_gen.unmarshalListWebhooksResponse;
|
|
31
|
-
exports.unmarshalOfferSubscription = marshalling_gen.unmarshalOfferSubscription;
|
|
32
|
-
exports.unmarshalProjectConsumption = marshalling_gen.unmarshalProjectConsumption;
|
|
33
|
-
exports.unmarshalProjectSettings = marshalling_gen.unmarshalProjectSettings;
|
|
34
|
-
exports.unmarshalStatistics = marshalling_gen.unmarshalStatistics;
|
|
35
|
-
exports.unmarshalWebhook = marshalling_gen.unmarshalWebhook;
|
|
36
|
-
exports.ValidationRules = validationRules_gen;
|