@scaleway/sdk 2.46.0 → 2.48.0
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/dist/api/baremetal/v1/api.gen.cjs +36 -1
- package/dist/api/baremetal/v1/api.gen.d.ts +17 -1
- package/dist/api/baremetal/v1/api.gen.js +37 -2
- package/dist/api/baremetal/v1/index.gen.d.ts +1 -1
- package/dist/api/baremetal/v1/marshalling.gen.cjs +200 -0
- package/dist/api/baremetal/v1/marshalling.gen.d.ts +4 -1
- package/dist/api/baremetal/v1/marshalling.gen.js +200 -0
- package/dist/api/baremetal/v1/types.gen.d.ts +74 -0
- package/dist/api/billing/v2alpha1/marshalling.gen.cjs +1 -0
- package/dist/api/billing/v2alpha1/marshalling.gen.js +1 -0
- package/dist/api/billing/v2alpha1/types.gen.d.ts +2 -0
- package/dist/api/billing/v2beta1/marshalling.gen.cjs +1 -0
- package/dist/api/billing/v2beta1/marshalling.gen.js +1 -0
- package/dist/api/billing/v2beta1/types.gen.d.ts +2 -0
- package/dist/api/edge_services/v1alpha1/api.gen.cjs +636 -0
- package/dist/api/edge_services/v1alpha1/api.gen.d.ts +5 -1
- package/dist/api/edge_services/v1alpha1/api.gen.js +636 -0
- package/dist/api/edge_services/v1alpha1/content.gen.cjs +8 -0
- package/dist/api/edge_services/v1alpha1/content.gen.js +8 -0
- package/dist/api/edge_services/v1alpha1/index.gen.cjs +7 -0
- package/dist/api/edge_services/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/edge_services/v1alpha1/index.gen.js +7 -0
- package/dist/api/edge_services/v1alpha1/marshalling.gen.cjs +474 -0
- package/dist/api/edge_services/v1alpha1/marshalling.gen.d.ts +5 -2
- package/dist/api/edge_services/v1alpha1/marshalling.gen.js +474 -0
- package/dist/api/edge_services/v1alpha1/types.gen.d.ts +51 -28
- package/dist/api/iam/v1alpha1/marshalling.gen.cjs +1 -0
- package/dist/api/iam/v1alpha1/marshalling.gen.js +1 -0
- package/dist/api/iam/v1alpha1/types.gen.d.ts +2 -0
- package/dist/api/index.d.ts +65 -35
- package/dist/api/inference/v1beta1/api.gen.cjs +306 -0
- package/dist/api/inference/v1beta1/api.gen.js +306 -0
- package/dist/api/inference/v1beta1/content.gen.cjs +8 -0
- package/dist/api/inference/v1beta1/content.gen.js +8 -0
- package/dist/api/inference/v1beta1/index.gen.cjs +8 -0
- package/dist/api/inference/v1beta1/index.gen.js +8 -0
- package/dist/api/inference/v1beta1/marshalling.gen.cjs +273 -0
- package/dist/api/inference/v1beta1/marshalling.gen.js +273 -0
- package/dist/api/inference/v1beta1/validation-rules.gen.cjs +56 -0
- package/dist/api/inference/v1beta1/validation-rules.gen.js +56 -0
- package/dist/api/k8s/v1/marshalling.gen.cjs +1 -0
- package/dist/api/k8s/v1/marshalling.gen.js +1 -0
- package/dist/api/k8s/v1/types.gen.d.ts +2 -0
- package/dist/api/k8s/v1/validation-rules.gen.cjs +63 -0
- package/dist/api/k8s/v1/validation-rules.gen.d.ts +60 -0
- package/dist/api/k8s/v1/validation-rules.gen.js +64 -1
- package/dist/api/mnq/index.gen.cjs +4 -0
- package/dist/api/mnq/index.gen.js +4 -0
- package/dist/api/qaas/v1alpha1/api.gen.cjs +527 -0
- package/dist/api/qaas/v1alpha1/api.gen.js +527 -0
- package/dist/api/qaas/v1alpha1/content.gen.cjs +19 -0
- package/dist/api/qaas/v1alpha1/content.gen.js +19 -0
- package/dist/api/qaas/v1alpha1/index.gen.cjs +10 -0
- package/dist/api/qaas/v1alpha1/index.gen.js +10 -0
- package/dist/api/qaas/v1alpha1/marshalling.gen.cjs +320 -0
- package/dist/api/qaas/v1alpha1/marshalling.gen.js +320 -0
- package/dist/api/qaas/v1alpha1/validation-rules.gen.cjs +14 -0
- package/dist/api/qaas/v1alpha1/validation-rules.gen.js +14 -0
- package/dist/api/tem/index.gen.cjs +4 -0
- package/dist/api/tem/index.gen.js +4 -0
- package/dist/api/tem/v1alpha1/api.gen.cjs +32 -0
- package/dist/api/tem/v1alpha1/api.gen.d.ts +17 -1
- package/dist/api/tem/v1alpha1/api.gen.js +33 -1
- package/dist/api/tem/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/tem/v1alpha1/marshalling.gen.cjs +36 -0
- package/dist/api/tem/v1alpha1/marshalling.gen.d.ts +3 -1
- package/dist/api/tem/v1alpha1/marshalling.gen.js +36 -0
- package/dist/api/tem/v1alpha1/types.gen.d.ts +51 -0
- package/dist/api/tem/v1alpha1/validation-rules.gen.cjs +11 -0
- package/dist/api/tem/v1alpha1/validation-rules.gen.d.ts +10 -0
- package/dist/api/tem/v1alpha1/validation-rules.gen.js +11 -0
- package/dist/api/webhosting/index.gen.cjs +6 -0
- package/dist/api/webhosting/index.gen.js +6 -0
- package/dist/api/webhosting/v1/api.gen.cjs +620 -0
- package/dist/api/webhosting/v1/api.gen.js +620 -0
- package/dist/api/webhosting/v1/content.gen.cjs +14 -0
- package/dist/api/webhosting/v1/content.gen.js +14 -0
- package/dist/api/webhosting/v1/index.gen.cjs +15 -0
- package/dist/api/webhosting/v1/index.gen.js +15 -0
- package/dist/api/webhosting/v1/marshalling.gen.cjs +391 -0
- package/dist/api/webhosting/v1/marshalling.gen.js +391 -0
- package/dist/api/webhosting/v1/types.gen.d.ts +5 -0
- package/dist/api/webhosting/v1/validation-rules.gen.cjs +82 -0
- package/dist/api/webhosting/v1/validation-rules.gen.js +82 -0
- package/dist/index.cjs +92 -70
- package/dist/index.js +92 -70
- package/dist/scw/constants.cjs +1 -1
- package/dist/scw/constants.d.ts +2 -2
- package/dist/scw/constants.js +1 -1
- package/package.json +2 -2
- package/dist/api/account/index.d.ts +0 -2
- package/dist/api/applesilicon/index.d.ts +0 -1
- package/dist/api/baremetal/index.d.ts +0 -1
- package/dist/api/billing/index.d.ts +0 -2
- package/dist/api/block/index.d.ts +0 -1
- package/dist/api/cockpit/index.d.ts +0 -2
- package/dist/api/container/index.d.ts +0 -1
- package/dist/api/dedibox/index.d.ts +0 -1
- package/dist/api/document_db/index.d.ts +0 -1
- package/dist/api/domain/index.d.ts +0 -1
- package/dist/api/edge_services/index.d.ts +0 -1
- package/dist/api/flexibleip/index.d.ts +0 -1
- package/dist/api/function/index.d.ts +0 -1
- package/dist/api/iam/index.d.ts +0 -1
- package/dist/api/instance/index.d.ts +0 -1
- package/dist/api/iot/index.d.ts +0 -1
- package/dist/api/ipam/index.d.ts +0 -1
- package/dist/api/ipfs/index.d.ts +0 -1
- package/dist/api/jobs/index.d.ts +0 -1
- package/dist/api/k8s/index.d.ts +0 -1
- package/dist/api/key_manager/index.d.ts +0 -1
- package/dist/api/lb/index.d.ts +0 -1
- package/dist/api/llm_inference/index.d.ts +0 -1
- package/dist/api/marketplace/index.d.ts +0 -1
- package/dist/api/mnq/index.d.ts +0 -1
- package/dist/api/rdb/index.d.ts +0 -1
- package/dist/api/redis/index.d.ts +0 -1
- package/dist/api/registry/index.d.ts +0 -1
- package/dist/api/secret/index.d.ts +0 -2
- package/dist/api/serverless_sqldb/index.d.ts +0 -1
- package/dist/api/tem/index.d.ts +0 -1
- package/dist/api/test/index.d.ts +0 -1
- package/dist/api/vpc/index.d.ts +0 -2
- package/dist/api/vpcgw/index.d.ts +0 -1
- package/dist/api/webhosting/index.d.ts +0 -1
- /package/dist/api/account/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/account/{index.js → index.gen.js} +0 -0
- /package/dist/api/applesilicon/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/applesilicon/{index.js → index.gen.js} +0 -0
- /package/dist/api/baremetal/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/baremetal/{index.js → index.gen.js} +0 -0
- /package/dist/api/billing/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/billing/{index.js → index.gen.js} +0 -0
- /package/dist/api/block/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/block/{index.js → index.gen.js} +0 -0
- /package/dist/api/cockpit/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/cockpit/{index.js → index.gen.js} +0 -0
- /package/dist/api/container/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/container/{index.js → index.gen.js} +0 -0
- /package/dist/api/dedibox/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/dedibox/{index.js → index.gen.js} +0 -0
- /package/dist/api/document_db/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/document_db/{index.js → index.gen.js} +0 -0
- /package/dist/api/domain/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/domain/{index.js → index.gen.js} +0 -0
- /package/dist/api/{flexibleip/index.cjs → edge_services/index.gen.cjs} +0 -0
- /package/dist/api/{flexibleip/index.js → edge_services/index.gen.js} +0 -0
- /package/dist/api/{iam/index.cjs → flexibleip/index.gen.cjs} +0 -0
- /package/dist/api/{iam/index.js → flexibleip/index.gen.js} +0 -0
- /package/dist/api/function/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/function/{index.js → index.gen.js} +0 -0
- /package/dist/api/{ipfs/index.cjs → iam/index.gen.cjs} +0 -0
- /package/dist/api/{ipfs/index.js → iam/index.gen.js} +0 -0
- /package/dist/api/{llm_inference/index.cjs → inference/index.gen.cjs} +0 -0
- /package/dist/api/{llm_inference/index.js → inference/index.gen.js} +0 -0
- /package/dist/api/instance/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/instance/{index.js → index.gen.js} +0 -0
- /package/dist/api/iot/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/iot/{index.js → index.gen.js} +0 -0
- /package/dist/api/ipam/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/ipam/{index.js → index.gen.js} +0 -0
- /package/dist/api/{jobs/index.cjs → ipfs/index.gen.cjs} +0 -0
- /package/dist/api/{jobs/index.js → ipfs/index.gen.js} +0 -0
- /package/dist/api/{key_manager/index.cjs → jobs/index.gen.cjs} +0 -0
- /package/dist/api/{key_manager/index.js → jobs/index.gen.js} +0 -0
- /package/dist/api/k8s/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/k8s/{index.js → index.gen.js} +0 -0
- /package/dist/api/{serverless_sqldb/index.cjs → key_manager/index.gen.cjs} +0 -0
- /package/dist/api/{serverless_sqldb/index.js → key_manager/index.gen.js} +0 -0
- /package/dist/api/lb/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/lb/{index.js → index.gen.js} +0 -0
- /package/dist/api/{mnq/index.cjs → llm_inference/index.gen.cjs} +0 -0
- /package/dist/api/{mnq/index.js → llm_inference/index.gen.js} +0 -0
- /package/dist/api/marketplace/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/marketplace/{index.js → index.gen.js} +0 -0
- /package/dist/api/{tem/index.cjs → qaas/index.gen.cjs} +0 -0
- /package/dist/api/{tem/index.js → qaas/index.gen.js} +0 -0
- /package/dist/api/rdb/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/rdb/{index.js → index.gen.js} +0 -0
- /package/dist/api/redis/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/redis/{index.js → index.gen.js} +0 -0
- /package/dist/api/registry/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/registry/{index.js → index.gen.js} +0 -0
- /package/dist/api/secret/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/secret/{index.js → index.gen.js} +0 -0
- /package/dist/api/{webhosting/index.cjs → serverless_sqldb/index.gen.cjs} +0 -0
- /package/dist/api/{webhosting/index.js → serverless_sqldb/index.gen.js} +0 -0
- /package/dist/api/test/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/test/{index.js → index.gen.js} +0 -0
- /package/dist/api/vpc/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/vpc/{index.js → index.gen.js} +0 -0
- /package/dist/api/vpcgw/{index.cjs → index.gen.cjs} +0 -0
- /package/dist/api/vpcgw/{index.js → index.gen.js} +0 -0
|
@@ -390,5 +390,37 @@ class API extends api.API {
|
|
|
390
390
|
* @returns A Promise of ListWebhookEventsResponse
|
|
391
391
|
*/
|
|
392
392
|
listWebhookEvents = (request) => resourcePaginator.enrichForPagination("webhookEvents", this.pageOfListWebhookEvents, request);
|
|
393
|
+
/**
|
|
394
|
+
* List project settings. Retrieve the project settings including periodic
|
|
395
|
+
* reports.
|
|
396
|
+
*
|
|
397
|
+
* @param request - The request {@link GetProjectSettingsRequest}
|
|
398
|
+
* @returns A Promise of ProjectSettings
|
|
399
|
+
*/
|
|
400
|
+
getProjectSettings = (request = {}) => this.client.fetch(
|
|
401
|
+
{
|
|
402
|
+
method: "GET",
|
|
403
|
+
path: `/transactional-email/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/project/${marshalling.validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}/settings`
|
|
404
|
+
},
|
|
405
|
+
marshalling_gen.unmarshalProjectSettings
|
|
406
|
+
);
|
|
407
|
+
/**
|
|
408
|
+
* Update project settings. Update the project settings including periodic
|
|
409
|
+
* reports.
|
|
410
|
+
*
|
|
411
|
+
* @param request - The request {@link UpdateProjectSettingsRequest}
|
|
412
|
+
* @returns A Promise of ProjectSettings
|
|
413
|
+
*/
|
|
414
|
+
updateProjectSettings = (request = {}) => this.client.fetch(
|
|
415
|
+
{
|
|
416
|
+
body: JSON.stringify(
|
|
417
|
+
marshalling_gen.marshalUpdateProjectSettingsRequest(request, this.client.settings)
|
|
418
|
+
),
|
|
419
|
+
headers: jsonContentHeaders,
|
|
420
|
+
method: "PATCH",
|
|
421
|
+
path: `/transactional-email/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/project/${marshalling.validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}/settings`
|
|
422
|
+
},
|
|
423
|
+
marshalling_gen.unmarshalProjectSettings
|
|
424
|
+
);
|
|
393
425
|
}
|
|
394
426
|
exports.API = API;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { API as ParentAPI } from '../../../bridge';
|
|
2
2
|
import type { Region, WaitForOptions } from '../../../bridge';
|
|
3
|
-
import type { CancelEmailRequest, CheckDomainRequest, CreateDomainRequest, CreateEmailRequest, CreateEmailResponse, CreateWebhookRequest, DeleteWebhookRequest, Domain, DomainLastStatus, Email, GetDomainLastStatusRequest, GetDomainRequest, GetEmailRequest, GetStatisticsRequest, GetWebhookRequest, ListDomainsRequest, ListDomainsResponse, ListEmailsRequest, ListEmailsResponse, ListWebhookEventsRequest, ListWebhookEventsResponse, ListWebhooksRequest, ListWebhooksResponse, RevokeDomainRequest, Statistics, UpdateDomainRequest, UpdateWebhookRequest, Webhook } from './types.gen';
|
|
3
|
+
import type { CancelEmailRequest, CheckDomainRequest, CreateDomainRequest, CreateEmailRequest, CreateEmailResponse, CreateWebhookRequest, DeleteWebhookRequest, Domain, DomainLastStatus, Email, GetDomainLastStatusRequest, GetDomainRequest, GetEmailRequest, GetProjectSettingsRequest, GetStatisticsRequest, GetWebhookRequest, ListDomainsRequest, ListDomainsResponse, ListEmailsRequest, ListEmailsResponse, ListWebhookEventsRequest, ListWebhookEventsResponse, ListWebhooksRequest, ListWebhooksResponse, ProjectSettings, RevokeDomainRequest, Statistics, UpdateDomainRequest, UpdateProjectSettingsRequest, UpdateWebhookRequest, Webhook } from './types.gen';
|
|
4
4
|
/**
|
|
5
5
|
* Transactional Email API.
|
|
6
6
|
*
|
|
@@ -194,4 +194,20 @@ export declare class API extends ParentAPI {
|
|
|
194
194
|
all: () => Promise<import("./types.gen").WebhookEvent[]>;
|
|
195
195
|
[Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").WebhookEvent[], void, void>;
|
|
196
196
|
};
|
|
197
|
+
/**
|
|
198
|
+
* List project settings. Retrieve the project settings including periodic
|
|
199
|
+
* reports.
|
|
200
|
+
*
|
|
201
|
+
* @param request - The request {@link GetProjectSettingsRequest}
|
|
202
|
+
* @returns A Promise of ProjectSettings
|
|
203
|
+
*/
|
|
204
|
+
getProjectSettings: (request?: Readonly<GetProjectSettingsRequest>) => Promise<ProjectSettings>;
|
|
205
|
+
/**
|
|
206
|
+
* Update project settings. Update the project settings including periodic
|
|
207
|
+
* reports.
|
|
208
|
+
*
|
|
209
|
+
* @param request - The request {@link UpdateProjectSettingsRequest}
|
|
210
|
+
* @returns A Promise of ProjectSettings
|
|
211
|
+
*/
|
|
212
|
+
updateProjectSettings: (request?: Readonly<UpdateProjectSettingsRequest>) => Promise<ProjectSettings>;
|
|
197
213
|
}
|
|
@@ -4,7 +4,7 @@ import { validatePathParam, urlParams } from "../../../helpers/marshalling.js";
|
|
|
4
4
|
import "../../../vendor/base64/index.js";
|
|
5
5
|
import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
|
|
6
6
|
import { EMAIL_TRANSIENT_STATUSES, DOMAIN_TRANSIENT_STATUSES } from "./content.gen.js";
|
|
7
|
-
import { marshalCreateEmailRequest, unmarshalCreateEmailResponse, unmarshalEmail, unmarshalListEmailsResponse, unmarshalStatistics, marshalCreateDomainRequest, unmarshalDomain, unmarshalListDomainsResponse, unmarshalDomainLastStatus, marshalUpdateDomainRequest, marshalCreateWebhookRequest, unmarshalWebhook, unmarshalListWebhooksResponse, marshalUpdateWebhookRequest, unmarshalListWebhookEventsResponse } from "./marshalling.gen.js";
|
|
7
|
+
import { marshalCreateEmailRequest, unmarshalCreateEmailResponse, unmarshalEmail, unmarshalListEmailsResponse, unmarshalStatistics, marshalCreateDomainRequest, unmarshalDomain, unmarshalListDomainsResponse, unmarshalDomainLastStatus, marshalUpdateDomainRequest, marshalCreateWebhookRequest, unmarshalWebhook, unmarshalListWebhooksResponse, marshalUpdateWebhookRequest, unmarshalListWebhookEventsResponse, unmarshalProjectSettings, marshalUpdateProjectSettingsRequest } from "./marshalling.gen.js";
|
|
8
8
|
const jsonContentHeaders = {
|
|
9
9
|
"Content-Type": "application/json; charset=utf-8"
|
|
10
10
|
};
|
|
@@ -388,6 +388,38 @@ class API extends API$1 {
|
|
|
388
388
|
* @returns A Promise of ListWebhookEventsResponse
|
|
389
389
|
*/
|
|
390
390
|
listWebhookEvents = (request) => enrichForPagination("webhookEvents", this.pageOfListWebhookEvents, request);
|
|
391
|
+
/**
|
|
392
|
+
* List project settings. Retrieve the project settings including periodic
|
|
393
|
+
* reports.
|
|
394
|
+
*
|
|
395
|
+
* @param request - The request {@link GetProjectSettingsRequest}
|
|
396
|
+
* @returns A Promise of ProjectSettings
|
|
397
|
+
*/
|
|
398
|
+
getProjectSettings = (request = {}) => this.client.fetch(
|
|
399
|
+
{
|
|
400
|
+
method: "GET",
|
|
401
|
+
path: `/transactional-email/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/project/${validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}/settings`
|
|
402
|
+
},
|
|
403
|
+
unmarshalProjectSettings
|
|
404
|
+
);
|
|
405
|
+
/**
|
|
406
|
+
* Update project settings. Update the project settings including periodic
|
|
407
|
+
* reports.
|
|
408
|
+
*
|
|
409
|
+
* @param request - The request {@link UpdateProjectSettingsRequest}
|
|
410
|
+
* @returns A Promise of ProjectSettings
|
|
411
|
+
*/
|
|
412
|
+
updateProjectSettings = (request = {}) => this.client.fetch(
|
|
413
|
+
{
|
|
414
|
+
body: JSON.stringify(
|
|
415
|
+
marshalUpdateProjectSettingsRequest(request, this.client.settings)
|
|
416
|
+
),
|
|
417
|
+
headers: jsonContentHeaders,
|
|
418
|
+
method: "PATCH",
|
|
419
|
+
path: `/transactional-email/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/project/${validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}/settings`
|
|
420
|
+
},
|
|
421
|
+
unmarshalProjectSettings
|
|
422
|
+
);
|
|
391
423
|
}
|
|
392
424
|
export {
|
|
393
425
|
API
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { API } from './api.gen';
|
|
2
2
|
export * from './content.gen';
|
|
3
|
-
export type { CancelEmailRequest, CheckDomainRequest, CreateDomainRequest, CreateEmailRequest, CreateEmailRequestAddress, CreateEmailRequestAttachment, CreateEmailRequestHeader, CreateEmailResponse, CreateWebhookRequest, DeleteWebhookRequest, Domain, DomainLastStatus, DomainLastStatusDkimRecord, DomainLastStatusDmarcRecord, DomainLastStatusRecordStatus, DomainLastStatusSpfRecord, DomainRecords, DomainRecordsDMARC, DomainReputation, DomainReputationStatus, DomainStatistics, DomainStatus, Email, EmailFlag, EmailRcptType, EmailStatus, EmailTry, GetDomainLastStatusRequest, GetDomainRequest, GetEmailRequest, GetStatisticsRequest, GetWebhookRequest, ListDomainsRequest, ListDomainsResponse, ListEmailsRequest, ListEmailsRequestOrderBy, ListEmailsResponse, ListWebhookEventsRequest, ListWebhookEventsRequestOrderBy, ListWebhookEventsResponse, ListWebhooksRequest, ListWebhooksRequestOrderBy, ListWebhooksResponse, RevokeDomainRequest, Statistics, UpdateDomainRequest, UpdateWebhookRequest, Webhook, WebhookEvent, WebhookEventStatus, WebhookEventType, } from './types.gen';
|
|
3
|
+
export type { CancelEmailRequest, CheckDomainRequest, CreateDomainRequest, CreateEmailRequest, CreateEmailRequestAddress, CreateEmailRequestAttachment, CreateEmailRequestHeader, CreateEmailResponse, CreateWebhookRequest, DeleteWebhookRequest, Domain, DomainLastStatus, DomainLastStatusDkimRecord, DomainLastStatusDmarcRecord, DomainLastStatusRecordStatus, DomainLastStatusSpfRecord, DomainRecords, DomainRecordsDMARC, DomainReputation, DomainReputationStatus, DomainStatistics, DomainStatus, Email, EmailFlag, EmailRcptType, EmailStatus, EmailTry, GetDomainLastStatusRequest, GetDomainRequest, GetEmailRequest, GetProjectSettingsRequest, GetStatisticsRequest, GetWebhookRequest, ListDomainsRequest, ListDomainsResponse, ListEmailsRequest, ListEmailsRequestOrderBy, ListEmailsResponse, ListWebhookEventsRequest, ListWebhookEventsRequestOrderBy, ListWebhookEventsResponse, ListWebhooksRequest, ListWebhooksRequestOrderBy, ListWebhooksResponse, ProjectSettings, ProjectSettingsPeriodicReport, ProjectSettingsPeriodicReportFrequency, RevokeDomainRequest, Statistics, UpdateDomainRequest, UpdateProjectSettingsRequest, UpdateProjectSettingsRequestUpdatePeriodicReport, UpdateWebhookRequest, Webhook, WebhookEvent, WebhookEventStatus, WebhookEventType, } from './types.gen';
|
|
4
4
|
export * as ValidationRules from './validation-rules.gen';
|
|
@@ -259,6 +259,29 @@ const unmarshalListWebhooksResponse = (data) => {
|
|
|
259
259
|
webhooks: marshalling.unmarshalArrayOfObject(data.webhooks, unmarshalWebhook)
|
|
260
260
|
};
|
|
261
261
|
};
|
|
262
|
+
const unmarshalProjectSettingsPeriodicReport = (data) => {
|
|
263
|
+
if (!json.isJSONObject(data)) {
|
|
264
|
+
throw new TypeError(
|
|
265
|
+
`Unmarshalling the type 'ProjectSettingsPeriodicReport' failed as data isn't a dictionary.`
|
|
266
|
+
);
|
|
267
|
+
}
|
|
268
|
+
return {
|
|
269
|
+
enabled: data.enabled,
|
|
270
|
+
frequency: data.frequency,
|
|
271
|
+
sendingDay: data.sending_day,
|
|
272
|
+
sendingHour: data.sending_hour
|
|
273
|
+
};
|
|
274
|
+
};
|
|
275
|
+
const unmarshalProjectSettings = (data) => {
|
|
276
|
+
if (!json.isJSONObject(data)) {
|
|
277
|
+
throw new TypeError(
|
|
278
|
+
`Unmarshalling the type 'ProjectSettings' failed as data isn't a dictionary.`
|
|
279
|
+
);
|
|
280
|
+
}
|
|
281
|
+
return {
|
|
282
|
+
periodicReport: data.periodic_report ? unmarshalProjectSettingsPeriodicReport(data.periodic_report) : void 0
|
|
283
|
+
};
|
|
284
|
+
};
|
|
262
285
|
const unmarshalStatistics = (data) => {
|
|
263
286
|
if (!json.isJSONObject(data)) {
|
|
264
287
|
throw new TypeError(
|
|
@@ -320,6 +343,17 @@ const marshalCreateWebhookRequest = (request, defaults) => ({
|
|
|
320
343
|
const marshalUpdateDomainRequest = (request, defaults) => ({
|
|
321
344
|
autoconfig: request.autoconfig
|
|
322
345
|
});
|
|
346
|
+
const marshalUpdateProjectSettingsRequestUpdatePeriodicReport = (request, defaults) => ({
|
|
347
|
+
enabled: request.enabled,
|
|
348
|
+
frequency: request.frequency,
|
|
349
|
+
sending_day: request.sendingDay,
|
|
350
|
+
sending_hour: request.sendingHour
|
|
351
|
+
});
|
|
352
|
+
const marshalUpdateProjectSettingsRequest = (request, defaults) => ({
|
|
353
|
+
periodic_report: request.periodicReport !== void 0 ? marshalUpdateProjectSettingsRequestUpdatePeriodicReport(
|
|
354
|
+
request.periodicReport
|
|
355
|
+
) : void 0
|
|
356
|
+
});
|
|
323
357
|
const marshalUpdateWebhookRequest = (request, defaults) => ({
|
|
324
358
|
event_types: request.eventTypes !== void 0 ? request.eventTypes : void 0,
|
|
325
359
|
name: request.name,
|
|
@@ -329,6 +363,7 @@ exports.marshalCreateDomainRequest = marshalCreateDomainRequest;
|
|
|
329
363
|
exports.marshalCreateEmailRequest = marshalCreateEmailRequest;
|
|
330
364
|
exports.marshalCreateWebhookRequest = marshalCreateWebhookRequest;
|
|
331
365
|
exports.marshalUpdateDomainRequest = marshalUpdateDomainRequest;
|
|
366
|
+
exports.marshalUpdateProjectSettingsRequest = marshalUpdateProjectSettingsRequest;
|
|
332
367
|
exports.marshalUpdateWebhookRequest = marshalUpdateWebhookRequest;
|
|
333
368
|
exports.unmarshalCreateEmailResponse = unmarshalCreateEmailResponse;
|
|
334
369
|
exports.unmarshalDomain = unmarshalDomain;
|
|
@@ -338,5 +373,6 @@ exports.unmarshalListDomainsResponse = unmarshalListDomainsResponse;
|
|
|
338
373
|
exports.unmarshalListEmailsResponse = unmarshalListEmailsResponse;
|
|
339
374
|
exports.unmarshalListWebhookEventsResponse = unmarshalListWebhookEventsResponse;
|
|
340
375
|
exports.unmarshalListWebhooksResponse = unmarshalListWebhooksResponse;
|
|
376
|
+
exports.unmarshalProjectSettings = unmarshalProjectSettings;
|
|
341
377
|
exports.unmarshalStatistics = unmarshalStatistics;
|
|
342
378
|
exports.unmarshalWebhook = unmarshalWebhook;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { DefaultValues } from '../../../bridge';
|
|
2
|
-
import type { CreateDomainRequest, CreateEmailRequest, CreateEmailResponse, CreateWebhookRequest, Domain, DomainLastStatus, Email, ListDomainsResponse, ListEmailsResponse, ListWebhookEventsResponse, ListWebhooksResponse, Statistics, UpdateDomainRequest, UpdateWebhookRequest, Webhook } from './types.gen';
|
|
2
|
+
import type { CreateDomainRequest, CreateEmailRequest, CreateEmailResponse, CreateWebhookRequest, Domain, DomainLastStatus, Email, ListDomainsResponse, ListEmailsResponse, ListWebhookEventsResponse, ListWebhooksResponse, ProjectSettings, Statistics, UpdateDomainRequest, UpdateProjectSettingsRequest, UpdateWebhookRequest, Webhook } from './types.gen';
|
|
3
3
|
export declare const unmarshalEmail: (data: unknown) => Email;
|
|
4
4
|
export declare const unmarshalDomain: (data: unknown) => Domain;
|
|
5
5
|
export declare const unmarshalWebhook: (data: unknown) => Webhook;
|
|
@@ -9,9 +9,11 @@ export declare const unmarshalListDomainsResponse: (data: unknown) => ListDomain
|
|
|
9
9
|
export declare const unmarshalListEmailsResponse: (data: unknown) => ListEmailsResponse;
|
|
10
10
|
export declare const unmarshalListWebhookEventsResponse: (data: unknown) => ListWebhookEventsResponse;
|
|
11
11
|
export declare const unmarshalListWebhooksResponse: (data: unknown) => ListWebhooksResponse;
|
|
12
|
+
export declare const unmarshalProjectSettings: (data: unknown) => ProjectSettings;
|
|
12
13
|
export declare const unmarshalStatistics: (data: unknown) => Statistics;
|
|
13
14
|
export declare const marshalCreateDomainRequest: (request: CreateDomainRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
14
15
|
export declare const marshalCreateEmailRequest: (request: CreateEmailRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
15
16
|
export declare const marshalCreateWebhookRequest: (request: CreateWebhookRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
16
17
|
export declare const marshalUpdateDomainRequest: (request: UpdateDomainRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
18
|
+
export declare const marshalUpdateProjectSettingsRequest: (request: UpdateProjectSettingsRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
17
19
|
export declare const marshalUpdateWebhookRequest: (request: UpdateWebhookRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
@@ -257,6 +257,29 @@ const unmarshalListWebhooksResponse = (data) => {
|
|
|
257
257
|
webhooks: unmarshalArrayOfObject(data.webhooks, unmarshalWebhook)
|
|
258
258
|
};
|
|
259
259
|
};
|
|
260
|
+
const unmarshalProjectSettingsPeriodicReport = (data) => {
|
|
261
|
+
if (!isJSONObject(data)) {
|
|
262
|
+
throw new TypeError(
|
|
263
|
+
`Unmarshalling the type 'ProjectSettingsPeriodicReport' failed as data isn't a dictionary.`
|
|
264
|
+
);
|
|
265
|
+
}
|
|
266
|
+
return {
|
|
267
|
+
enabled: data.enabled,
|
|
268
|
+
frequency: data.frequency,
|
|
269
|
+
sendingDay: data.sending_day,
|
|
270
|
+
sendingHour: data.sending_hour
|
|
271
|
+
};
|
|
272
|
+
};
|
|
273
|
+
const unmarshalProjectSettings = (data) => {
|
|
274
|
+
if (!isJSONObject(data)) {
|
|
275
|
+
throw new TypeError(
|
|
276
|
+
`Unmarshalling the type 'ProjectSettings' failed as data isn't a dictionary.`
|
|
277
|
+
);
|
|
278
|
+
}
|
|
279
|
+
return {
|
|
280
|
+
periodicReport: data.periodic_report ? unmarshalProjectSettingsPeriodicReport(data.periodic_report) : void 0
|
|
281
|
+
};
|
|
282
|
+
};
|
|
260
283
|
const unmarshalStatistics = (data) => {
|
|
261
284
|
if (!isJSONObject(data)) {
|
|
262
285
|
throw new TypeError(
|
|
@@ -318,6 +341,17 @@ const marshalCreateWebhookRequest = (request, defaults) => ({
|
|
|
318
341
|
const marshalUpdateDomainRequest = (request, defaults) => ({
|
|
319
342
|
autoconfig: request.autoconfig
|
|
320
343
|
});
|
|
344
|
+
const marshalUpdateProjectSettingsRequestUpdatePeriodicReport = (request, defaults) => ({
|
|
345
|
+
enabled: request.enabled,
|
|
346
|
+
frequency: request.frequency,
|
|
347
|
+
sending_day: request.sendingDay,
|
|
348
|
+
sending_hour: request.sendingHour
|
|
349
|
+
});
|
|
350
|
+
const marshalUpdateProjectSettingsRequest = (request, defaults) => ({
|
|
351
|
+
periodic_report: request.periodicReport !== void 0 ? marshalUpdateProjectSettingsRequestUpdatePeriodicReport(
|
|
352
|
+
request.periodicReport
|
|
353
|
+
) : void 0
|
|
354
|
+
});
|
|
321
355
|
const marshalUpdateWebhookRequest = (request, defaults) => ({
|
|
322
356
|
event_types: request.eventTypes !== void 0 ? request.eventTypes : void 0,
|
|
323
357
|
name: request.name,
|
|
@@ -328,6 +362,7 @@ export {
|
|
|
328
362
|
marshalCreateEmailRequest,
|
|
329
363
|
marshalCreateWebhookRequest,
|
|
330
364
|
marshalUpdateDomainRequest,
|
|
365
|
+
marshalUpdateProjectSettingsRequest,
|
|
331
366
|
marshalUpdateWebhookRequest,
|
|
332
367
|
unmarshalCreateEmailResponse,
|
|
333
368
|
unmarshalDomain,
|
|
@@ -337,6 +372,7 @@ export {
|
|
|
337
372
|
unmarshalListEmailsResponse,
|
|
338
373
|
unmarshalListWebhookEventsResponse,
|
|
339
374
|
unmarshalListWebhooksResponse,
|
|
375
|
+
unmarshalProjectSettings,
|
|
340
376
|
unmarshalStatistics,
|
|
341
377
|
unmarshalWebhook
|
|
342
378
|
};
|
|
@@ -8,6 +8,7 @@ export type EmailStatus = 'unknown' | 'new' | 'sending' | 'sent' | 'failed' | 'c
|
|
|
8
8
|
export type ListEmailsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'updated_at_desc' | 'updated_at_asc' | 'status_desc' | 'status_asc' | 'mail_from_desc' | 'mail_from_asc' | 'mail_rcpt_desc' | 'mail_rcpt_asc' | 'subject_desc' | 'subject_asc';
|
|
9
9
|
export type ListWebhookEventsRequestOrderBy = 'created_at_desc' | 'created_at_asc';
|
|
10
10
|
export type ListWebhooksRequestOrderBy = 'created_at_desc' | 'created_at_asc';
|
|
11
|
+
export type ProjectSettingsPeriodicReportFrequency = 'unknown_frequency' | 'monthly' | 'weekly' | 'daily';
|
|
11
12
|
export type WebhookEventStatus = 'unknown_status' | 'sending' | 'sent' | 'failed';
|
|
12
13
|
export type WebhookEventType = 'unknown_type' | 'email_queued' | 'email_dropped' | 'email_deferred' | 'email_delivered' | 'email_spam' | 'email_mailbox_not_found';
|
|
13
14
|
export interface DomainRecordsDMARC {
|
|
@@ -223,6 +224,32 @@ export interface Webhook {
|
|
|
223
224
|
/** Date and time of last Webhook updates. */
|
|
224
225
|
updatedAt?: Date;
|
|
225
226
|
}
|
|
227
|
+
export interface ProjectSettingsPeriodicReport {
|
|
228
|
+
/** Enable or disable periodic report notifications. */
|
|
229
|
+
enabled: boolean;
|
|
230
|
+
/** At which frequency you receive periodic report notifications. */
|
|
231
|
+
frequency: ProjectSettingsPeriodicReportFrequency;
|
|
232
|
+
/** At which hour you receive periodic report notifications. */
|
|
233
|
+
sendingHour: number;
|
|
234
|
+
/**
|
|
235
|
+
* On which day you receive periodic report notifications (1-7 weekly, 1-28
|
|
236
|
+
* monthly).
|
|
237
|
+
*/
|
|
238
|
+
sendingDay: number;
|
|
239
|
+
}
|
|
240
|
+
export interface UpdateProjectSettingsRequestUpdatePeriodicReport {
|
|
241
|
+
/** (Optional) Enable or disable periodic report notifications. */
|
|
242
|
+
enabled?: boolean;
|
|
243
|
+
/** (Optional) At which frequency you receive periodic report notifications. */
|
|
244
|
+
frequency?: ProjectSettingsPeriodicReportFrequency;
|
|
245
|
+
/** (Optional) At which hour you receive periodic report notifications. */
|
|
246
|
+
sendingHour?: number;
|
|
247
|
+
/**
|
|
248
|
+
* (Optional) On which day you receive periodic report notifications (1-7
|
|
249
|
+
* weekly, 1-28 monthly).
|
|
250
|
+
*/
|
|
251
|
+
sendingDay?: number;
|
|
252
|
+
}
|
|
226
253
|
export type CancelEmailRequest = {
|
|
227
254
|
/**
|
|
228
255
|
* Region to target. If none is passed will use default region from the
|
|
@@ -354,6 +381,15 @@ export type GetEmailRequest = {
|
|
|
354
381
|
/** ID of the email to retrieve. */
|
|
355
382
|
emailId: string;
|
|
356
383
|
};
|
|
384
|
+
export type GetProjectSettingsRequest = {
|
|
385
|
+
/**
|
|
386
|
+
* Region to target. If none is passed will use default region from the
|
|
387
|
+
* config.
|
|
388
|
+
*/
|
|
389
|
+
region?: Region;
|
|
390
|
+
/** ID of the project. */
|
|
391
|
+
projectId?: string;
|
|
392
|
+
};
|
|
357
393
|
export type GetStatisticsRequest = {
|
|
358
394
|
/**
|
|
359
395
|
* Region to target. If none is passed will use default region from the
|
|
@@ -507,6 +543,10 @@ export interface ListWebhooksResponse {
|
|
|
507
543
|
/** Single page of Webhooks matching the requested criteria. */
|
|
508
544
|
webhooks: Webhook[];
|
|
509
545
|
}
|
|
546
|
+
export interface ProjectSettings {
|
|
547
|
+
/** Information about your periodic report. */
|
|
548
|
+
periodicReport?: ProjectSettingsPeriodicReport;
|
|
549
|
+
}
|
|
510
550
|
export type RevokeDomainRequest = {
|
|
511
551
|
/**
|
|
512
552
|
* Region to target. If none is passed will use default region from the
|
|
@@ -559,6 +599,17 @@ export type UpdateDomainRequest = {
|
|
|
559
599
|
*/
|
|
560
600
|
autoconfig?: boolean;
|
|
561
601
|
};
|
|
602
|
+
export type UpdateProjectSettingsRequest = {
|
|
603
|
+
/**
|
|
604
|
+
* Region to target. If none is passed will use default region from the
|
|
605
|
+
* config.
|
|
606
|
+
*/
|
|
607
|
+
region?: Region;
|
|
608
|
+
/** ID of the project. */
|
|
609
|
+
projectId?: string;
|
|
610
|
+
/** Periodic report update details - all fields are optional. */
|
|
611
|
+
periodicReport?: UpdateProjectSettingsRequestUpdatePeriodicReport;
|
|
612
|
+
};
|
|
562
613
|
export type UpdateWebhookRequest = {
|
|
563
614
|
/**
|
|
564
615
|
* Region to target. If none is passed will use default region from the
|
|
@@ -85,6 +85,16 @@ const ListWebhooksRequest = {
|
|
|
85
85
|
lessThanOrEqual: 100
|
|
86
86
|
}
|
|
87
87
|
};
|
|
88
|
+
const UpdateProjectSettingsRequestUpdatePeriodicReport = {
|
|
89
|
+
sendingDay: {
|
|
90
|
+
greaterThanOrEqual: 1,
|
|
91
|
+
lessThanOrEqual: 28
|
|
92
|
+
},
|
|
93
|
+
sendingHour: {
|
|
94
|
+
greaterThanOrEqual: 0,
|
|
95
|
+
lessThanOrEqual: 23
|
|
96
|
+
}
|
|
97
|
+
};
|
|
88
98
|
const UpdateWebhookRequest = {
|
|
89
99
|
name: {
|
|
90
100
|
maxLength: 127,
|
|
@@ -105,4 +115,5 @@ exports.ListDomainsRequest = ListDomainsRequest;
|
|
|
105
115
|
exports.ListEmailsRequest = ListEmailsRequest;
|
|
106
116
|
exports.ListWebhookEventsRequest = ListWebhookEventsRequest;
|
|
107
117
|
exports.ListWebhooksRequest = ListWebhooksRequest;
|
|
118
|
+
exports.UpdateProjectSettingsRequestUpdatePeriodicReport = UpdateProjectSettingsRequestUpdatePeriodicReport;
|
|
108
119
|
exports.UpdateWebhookRequest = UpdateWebhookRequest;
|
|
@@ -83,6 +83,16 @@ export declare const ListWebhooksRequest: {
|
|
|
83
83
|
lessThanOrEqual: number;
|
|
84
84
|
};
|
|
85
85
|
};
|
|
86
|
+
export declare const UpdateProjectSettingsRequestUpdatePeriodicReport: {
|
|
87
|
+
sendingDay: {
|
|
88
|
+
greaterThanOrEqual: number;
|
|
89
|
+
lessThanOrEqual: number;
|
|
90
|
+
};
|
|
91
|
+
sendingHour: {
|
|
92
|
+
greaterThanOrEqual: number;
|
|
93
|
+
lessThanOrEqual: number;
|
|
94
|
+
};
|
|
95
|
+
};
|
|
86
96
|
export declare const UpdateWebhookRequest: {
|
|
87
97
|
name: {
|
|
88
98
|
maxLength: number;
|
|
@@ -83,6 +83,16 @@ const ListWebhooksRequest = {
|
|
|
83
83
|
lessThanOrEqual: 100
|
|
84
84
|
}
|
|
85
85
|
};
|
|
86
|
+
const UpdateProjectSettingsRequestUpdatePeriodicReport = {
|
|
87
|
+
sendingDay: {
|
|
88
|
+
greaterThanOrEqual: 1,
|
|
89
|
+
lessThanOrEqual: 28
|
|
90
|
+
},
|
|
91
|
+
sendingHour: {
|
|
92
|
+
greaterThanOrEqual: 0,
|
|
93
|
+
lessThanOrEqual: 23
|
|
94
|
+
}
|
|
95
|
+
};
|
|
86
96
|
const UpdateWebhookRequest = {
|
|
87
97
|
name: {
|
|
88
98
|
maxLength: 127,
|
|
@@ -104,5 +114,6 @@ export {
|
|
|
104
114
|
ListEmailsRequest,
|
|
105
115
|
ListWebhookEventsRequest,
|
|
106
116
|
ListWebhooksRequest,
|
|
117
|
+
UpdateProjectSettingsRequestUpdatePeriodicReport,
|
|
107
118
|
UpdateWebhookRequest
|
|
108
119
|
};
|