@scaleway/sdk 1.13.0 → 1.15.0

package/dist/api/tem/v1alpha1/api.gen.js

@@ -3,7 +3,7 @@ import { API as API$1 } from '../../../scw/api.js';
 import { validatePathParam, urlParams } from '../../../helpers/marshalling.js';
 import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
 import { EMAIL_TRANSIENT_STATUSES, DOMAIN_TRANSIENT_STATUSES } from './content.gen.js';
-import { marshalCreateEmailRequest, unmarshalCreateEmailResponse, unmarshalEmail, unmarshalListEmailsResponse, unmarshalStatistics, marshalCreateDomainRequest, unmarshalDomain, unmarshalListDomainsResponse } from './marshalling.gen.js';
+import { marshalCreateEmailRequest, unmarshalCreateEmailResponse, unmarshalEmail, unmarshalListEmailsResponse, unmarshalStatistics, marshalCreateDomainRequest, unmarshalDomain, unmarshalListDomainsResponse, unmarshalDomainLastStatus } from './marshalling.gen.js';
 
 // This file was automatically generated. DO NOT EDIT.
 // If you have any remark or suggestion do not hesitate to open an issue.
@@ -13,190 +13,217 @@ const jsonContentHeaders = {
 
 /** Transactional Email API. */
 class API extends API$1 {
-  constructor() {
-    var _this;
-    super(...arguments);
-    _this = this;
-    /**
-     * 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.
-     *
-     * @param request - The request {@link CreateEmailRequest}
-     * @returns A Promise of CreateEmailResponse
-     */
-    this.createEmail = request => this.client.fetch({
-      body: JSON.stringify(marshalCreateEmailRequest(request, this.client.settings)),
-      headers: jsonContentHeaders,
-      method: 'POST',
-      path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/emails`
-    }, unmarshalCreateEmailResponse);
-    /**
-     * Get an email. Retrieve information about a specific email using the
-     * `email_id` and `region` parameters.
-     *
-     * @param request - The request {@link GetEmailRequest}
-     * @returns A Promise of Email
-     */
-    this.getEmail = request => this.client.fetch({
-      method: 'GET',
-      path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/emails/${validatePathParam('emailId', request.emailId)}`
-    }, unmarshalEmail);
-    /**
-     * Waits for {@link Email} to be in a final state.
-     *
-     * @param request - The request {@link GetEmailRequest}
-     * @param options - The waiting options
-     * @returns A Promise of Email
-     */
-    this.waitForEmail = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!EMAIL_TRANSIENT_STATUSES.includes(res.status))), this.getEmail, request, options);
-    this.pageOfListEmails = function (request) {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ['fr-par'];
+
+  /**
+   * 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.
+   *
+   * @param request - The request {@link CreateEmailRequest}
+   * @returns A Promise of CreateEmailResponse
+   */
+  createEmail = request => this.client.fetch({
+    body: JSON.stringify(marshalCreateEmailRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/emails`
+  }, unmarshalCreateEmailResponse);
+
+  /**
+   * Get an email. Retrieve information about a specific email using the
+   * `email_id` and `region` parameters.
+   *
+   * @param request - The request {@link GetEmailRequest}
+   * @returns A Promise of Email
+   */
+  getEmail = request => this.client.fetch({
+    method: 'GET',
+    path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/emails/${validatePathParam('emailId', request.emailId)}`
+  }, unmarshalEmail);
+
+  /**
+   * Waits for {@link Email} to be in a final state.
+   *
+   * @param request - The request {@link GetEmailRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Email
+   */
+  waitForEmail = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!EMAIL_TRANSIENT_STATUSES.includes(res.status))), this.getEmail, request, options);
+  pageOfListEmails = (() => {
+    var _this = this;
+    return function (request) {
       if (request === void 0) {
         request = {};
       }
       return _this.client.fetch({
         method: 'GET',
         path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/emails`,
-        urlParams: urlParams(['domain_id', request.domainId], ['mail_from', request.mailFrom], ['mail_rcpt', request.mailRcpt], ['mail_to', request.mailTo], ['message_id', request.messageId], ['order_by', request.orderBy ?? 'created_at_desc'], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId], ['since', request.since], ['statuses', request.statuses], ['subject', request.subject], ['until', request.until])
+        urlParams: urlParams(['domain_id', request.domainId], ['mail_from', request.mailFrom], ['mail_rcpt', request.mailRcpt], ['mail_to', request.mailTo], ['message_id', request.messageId], ['order_by', request.orderBy ?? 'created_at_desc'], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId], ['search', request.search], ['since', request.since], ['statuses', request.statuses], ['subject', request.subject], ['until', request.until])
       }, unmarshalListEmailsResponse);
     };
-    /**
-     * List emails. Retrieve the list of emails sent from a specific domain or for
-     * a specific Project or Organization. You must specify the `region`. You can
-     * filter your emails in ascending or descending order using:
-     *
-     * - Created_at
-     * - Updated_at
-     * - Status
-     * - Mail_from
-     * - Mail_rcpt
-     * - Subject
-     *
-     * @param request - The request {@link ListEmailsRequest}
-     * @returns A Promise of ListEmailsResponse
-     */
-    this.listEmails = function (request) {
+  })();
+
+  /**
+   * List emails. Retrieve the list of emails sent from a specific domain or for
+   * a specific Project or Organization. You must specify the `region`.
+   *
+   * @param request - The request {@link ListEmailsRequest}
+   * @returns A Promise of ListEmailsResponse
+   */
+  listEmails = (() => {
+    var _this2 = this;
+    return function (request) {
       if (request === void 0) {
         request = {};
       }
-      return enrichForPagination('emails', _this.pageOfListEmails, request);
+      return enrichForPagination('emails', _this2.pageOfListEmails, request);
     };
-    /**
-     * Email statuses. Get information on your emails' statuses.
-     *
-     * @param request - The request {@link GetStatisticsRequest}
-     * @returns A Promise of Statistics
-     */
-    this.getStatistics = function (request) {
+  })();
+
+  /**
+   * Email statuses. Get information on your emails' statuses.
+   *
+   * @param request - The request {@link GetStatisticsRequest}
+   * @returns A Promise of Statistics
+   */
+  getStatistics = (() => {
+    var _this3 = this;
+    return function (request) {
       if (request === void 0) {
         request = {};
       }
-      return _this.client.fetch({
+      return _this3.client.fetch({
         method: 'GET',
-        path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/statistics`,
+        path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? _this3.client.settings.defaultRegion)}/statistics`,
         urlParams: urlParams(['domain_id', request.domainId], ['mail_from', request.mailFrom], ['project_id', request.projectId], ['since', request.since], ['until', request.until])
       }, unmarshalStatistics);
     };
-    /**
-     * 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.
-     *
-     * @param request - The request {@link CancelEmailRequest}
-     * @returns A Promise of Email
-     */
-    this.cancelEmail = request => this.client.fetch({
-      body: '{}',
-      headers: jsonContentHeaders,
-      method: 'POST',
-      path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/emails/${validatePathParam('emailId', request.emailId)}/cancel`
-    }, unmarshalEmail);
-    /**
-     * Register a domain in a project. You must specify the `region`, `project_id`
-     * and `domain_name` to register a domain in a specific Project.
-     *
-     * @param request - The request {@link CreateDomainRequest}
-     * @returns A Promise of Domain
-     */
-    this.createDomain = request => this.client.fetch({
-      body: JSON.stringify(marshalCreateDomainRequest(request, this.client.settings)),
-      headers: jsonContentHeaders,
-      method: 'POST',
-      path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains`
-    }, unmarshalDomain);
-    /**
-     * Get information about a domain. Retrieve information about a specific
-     * domain using the `region` and `domain_id` parameters.
-     *
-     * @param request - The request {@link GetDomainRequest}
-     * @returns A Promise of Domain
-     */
-    this.getDomain = request => this.client.fetch({
-      method: 'GET',
-      path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam('domainId', request.domainId)}`
-    }, unmarshalDomain);
-    /**
-     * Waits for {@link Domain} to be in a final state.
-     *
-     * @param request - The request {@link GetDomainRequest}
-     * @param options - The waiting options
-     * @returns A Promise of Domain
-     */
-    this.waitForDomain = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES.includes(res.status))), this.getDomain, request, options);
-    this.pageOfListDomains = function (request) {
+  })();
+
+  /**
+   * 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.
+   *
+   * @param request - The request {@link CancelEmailRequest}
+   * @returns A Promise of Email
+   */
+  cancelEmail = request => this.client.fetch({
+    body: '{}',
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/emails/${validatePathParam('emailId', request.emailId)}/cancel`
+  }, unmarshalEmail);
+
+  /**
+   * Register a domain in a project. You must specify the `region`, `project_id`
+   * and `domain_name` to register a domain in a specific Project.
+   *
+   * @param request - The request {@link CreateDomainRequest}
+   * @returns A Promise of Domain
+   */
+  createDomain = request => this.client.fetch({
+    body: JSON.stringify(marshalCreateDomainRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains`
+  }, unmarshalDomain);
+
+  /**
+   * Get information about a domain. Retrieve information about a specific
+   * domain using the `region` and `domain_id` parameters.
+   *
+   * @param request - The request {@link GetDomainRequest}
+   * @returns A Promise of Domain
+   */
+  getDomain = request => this.client.fetch({
+    method: 'GET',
+    path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam('domainId', request.domainId)}`
+  }, unmarshalDomain);
+
+  /**
+   * Waits for {@link Domain} to be in a final state.
+   *
+   * @param request - The request {@link GetDomainRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Domain
+   */
+  waitForDomain = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES.includes(res.status))), this.getDomain, request, options);
+  pageOfListDomains = (() => {
+    var _this4 = this;
+    return function (request) {
       if (request === void 0) {
         request = {};
       }
-      return _this.client.fetch({
+      return _this4.client.fetch({
         method: 'GET',
-        path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/domains`,
-        urlParams: urlParams(['name', request.name], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId], ['status', request.status])
+        path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? _this4.client.settings.defaultRegion)}/domains`,
+        urlParams: urlParams(['name', request.name], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this4.client.settings.defaultPageSize], ['project_id', request.projectId], ['status', request.status])
       }, unmarshalListDomainsResponse);
     };
-    /**
-     * List domains. Retrieve domains in a specific project or in a specific
-     * Organization using the `region` parameter.
-     *
-     * @param request - The request {@link ListDomainsRequest}
-     * @returns A Promise of ListDomainsResponse
-     */
-    this.listDomains = function (request) {
+  })();
+
+  /**
+   * List domains. Retrieve domains in a specific project or in a specific
+   * Organization using the `region` parameter.
+   *
+   * @param request - The request {@link ListDomainsRequest}
+   * @returns A Promise of ListDomainsResponse
+   */
+  listDomains = (() => {
+    var _this5 = this;
+    return function (request) {
       if (request === void 0) {
         request = {};
       }
-      return enrichForPagination('domains', _this.pageOfListDomains, request);
+      return enrichForPagination('domains', _this5.pageOfListDomains, request);
     };
-    /**
-     * 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.
-     *
-     * @param request - The request {@link RevokeDomainRequest}
-     * @returns A Promise of Domain
-     */
-    this.revokeDomain = request => this.client.fetch({
-      body: '{}',
-      headers: jsonContentHeaders,
-      method: 'POST',
-      path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam('domainId', request.domainId)}/revoke`
-    }, unmarshalDomain);
-    /**
-     * Domain DNS check. Perform an immediate DNS check of a domain using the
-     * `region` and `domain_id` parameters.
-     *
-     * @param request - The request {@link CheckDomainRequest}
-     * @returns A Promise of Domain
-     */
-    this.checkDomain = request => this.client.fetch({
-      body: '{}',
-      headers: jsonContentHeaders,
-      method: 'POST',
-      path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam('domainId', request.domainId)}/check`
-    }, unmarshalDomain);
-  }
-  /** Lists the available regions of the API. */
+  })();
+
+  /**
+   * 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.
+   *
+   * @param request - The request {@link RevokeDomainRequest}
+   * @returns A Promise of Domain
+   */
+  revokeDomain = request => this.client.fetch({
+    body: '{}',
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam('domainId', request.domainId)}/revoke`
+  }, unmarshalDomain);
+
+  /**
+   * Domain DNS check. Perform an immediate DNS check of a domain using the
+   * `region` and `domain_id` parameters.
+   *
+   * @param request - The request {@link CheckDomainRequest}
+   * @returns A Promise of Domain
+   */
+  checkDomain = request => this.client.fetch({
+    body: '{}',
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam('domainId', request.domainId)}/check`
+  }, unmarshalDomain);
+
+  /**
+   * Display SPF and DKIM records status and potential errors. Display SPF and
+   * DKIM records status and potential errors, including the found records to
+   * make debugging easier.
+   *
+   * @param request - The request {@link GetDomainLastStatusRequest}
+   * @returns A Promise of DomainLastStatus
+   */
+  getDomainLastStatus = request => this.client.fetch({
+    method: 'GET',
+    path: `/transactional-email/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam('domainId', request.domainId)}/verification`
+  }, unmarshalDomainLastStatus);
 }
-API.LOCALITIES = ['fr-par'];
 
 export { API };

package/dist/api/tem/v1alpha1/marshalling.gen.js

@@ -46,6 +46,26 @@ const unmarshalDomain = data => {
     status: data.status
   };
 };
+const unmarshalDomainLastStatusDkimRecord = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'DomainLastStatusDkimRecord' failed as data isn't a dictionary.`);
+  }
+  return {
+    error: data.error,
+    lastValidAt: unmarshalDate(data.last_valid_at),
+    status: data.status
+  };
+};
+const unmarshalDomainLastStatusSpfRecord = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'DomainLastStatusSpfRecord' failed as data isn't a dictionary.`);
+  }
+  return {
+    error: data.error,
+    lastValidAt: unmarshalDate(data.last_valid_at),
+    status: data.status
+  };
+};
 const unmarshalEmail = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'Email' failed as data isn't a dictionary.`);
@@ -75,6 +95,17 @@ const unmarshalCreateEmailResponse = data => {
     emails: unmarshalArrayOfObject(data.emails, unmarshalEmail)
   };
 };
+const unmarshalDomainLastStatus = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'DomainLastStatus' failed as data isn't a dictionary.`);
+  }
+  return {
+    dkimRecord: data.dkim_record ? unmarshalDomainLastStatusDkimRecord(data.dkim_record) : undefined,
+    domainId: data.domain_id,
+    domainName: data.domain_name,
+    spfRecord: data.spf_record ? unmarshalDomainLastStatusSpfRecord(data.spf_record) : undefined
+  };
+};
 const unmarshalListDomainsResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListDomainsResponse' failed as data isn't a dictionary.`);
@@ -133,4 +164,4 @@ const marshalCreateEmailRequest = (request, defaults) => ({
   to: request.to ? request.to.map(elt => marshalCreateEmailRequestAddress(elt)) : undefined
 });
 
-export { marshalCreateDomainRequest, marshalCreateEmailRequest, unmarshalCreateEmailResponse, unmarshalDomain, unmarshalEmail, unmarshalListDomainsResponse, unmarshalListEmailsResponse, unmarshalStatistics };
+export { marshalCreateDomainRequest, marshalCreateEmailRequest, unmarshalCreateEmailResponse, unmarshalDomain, unmarshalDomainLastStatus, unmarshalEmail, unmarshalListDomainsResponse, unmarshalListEmailsResponse, unmarshalStatistics };