@scaleway/sdk 2.26.0 → 2.28.0

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

@@ -0,0 +1,260 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const intervalRetrier = require("../../../internal/async/interval-retrier.cjs");
+const api = require("../../../scw/api.cjs");
+const marshalling = require("../../../helpers/marshalling.cjs");
+const resourcePaginator = require("../../../scw/fetch/resource-paginator.cjs");
+const content_gen = require("./content.gen.cjs");
+const marshalling_gen = require("./marshalling.gen.cjs");
+const jsonContentHeaders = {
+  "Content-Type": "application/json; charset=utf-8"
+};
+class API extends api.API {
+  /** 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(
+        marshalling_gen.marshalCreateEmailRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/transactional-email/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/emails`
+    },
+    marshalling_gen.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/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/emails/${marshalling.validatePathParam("emailId", request.emailId)}`
+    },
+    marshalling_gen.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) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!content_gen.EMAIL_TRANSIENT_STATUSES.includes(res.status))),
+    this.getEmail,
+    request,
+    options
+  );
+  pageOfListEmails = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/transactional-email/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/emails`,
+      urlParams: marshalling.urlParams(
+        ["domain_id", request.domainId],
+        ["flags", request.flags],
+        ["mail_from", request.mailFrom],
+        ["mail_rcpt", request.mailRcpt],
+        ["mail_to", request.mailTo],
+        ["message_id", request.messageId],
+        ["order_by", request.orderBy],
+        ["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]
+      )
+    },
+    marshalling_gen.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`.
+   *
+   * @param request - The request {@link ListEmailsRequest}
+   * @returns A Promise of ListEmailsResponse
+   */
+  listEmails = (request = {}) => resourcePaginator.enrichForPagination("emails", this.pageOfListEmails, request);
+  /**
+   * Email statuses. Get information on your emails' statuses.
+   *
+   * @param request - The request {@link GetStatisticsRequest}
+   * @returns A Promise of Statistics
+   */
+  getStatistics = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/transactional-email/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/statistics`,
+      urlParams: marshalling.urlParams(
+        ["domain_id", request.domainId],
+        ["mail_from", request.mailFrom],
+        ["project_id", request.projectId],
+        ["since", request.since],
+        ["until", request.until]
+      )
+    },
+    marshalling_gen.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
+   */
+  cancelEmail = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/transactional-email/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/emails/${marshalling.validatePathParam("emailId", request.emailId)}/cancel`
+    },
+    marshalling_gen.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(
+        marshalling_gen.marshalCreateDomainRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/transactional-email/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains`
+    },
+    marshalling_gen.unmarshalDomain
+  );
+  /**
+   * 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.
+   *
+   * @param request - The request {@link GetDomainRequest}
+   * @returns A Promise of Domain
+   */
+  getDomain = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/transactional-email/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${marshalling.validatePathParam("domainId", request.domainId)}`
+    },
+    marshalling_gen.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) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!content_gen.DOMAIN_TRANSIENT_STATUSES.includes(res.status))),
+    this.getDomain,
+    request,
+    options
+  );
+  pageOfListDomains = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/transactional-email/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains`,
+      urlParams: marshalling.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]
+      )
+    },
+    marshalling_gen.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
+   */
+  listDomains = (request = {}) => resourcePaginator.enrichForPagination("domains", this.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
+   */
+  revokeDomain = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/transactional-email/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${marshalling.validatePathParam("domainId", request.domainId)}/revoke`
+    },
+    marshalling_gen.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/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${marshalling.validatePathParam("domainId", request.domainId)}/check`
+    },
+    marshalling_gen.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/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${marshalling.validatePathParam("domainId", request.domainId)}/verification`
+    },
+    marshalling_gen.unmarshalDomainLastStatus
+  );
+}
+exports.API = API;

package/dist/api/tem/v1alpha1/api.gen.d.ts

@@ -0,0 +1,134 @@
+import { API as ParentAPI } from '../../../bridge';
+import type { Region, WaitForOptions } from '../../../bridge';
+import type { CancelEmailRequest, CheckDomainRequest, CreateDomainRequest, CreateEmailRequest, CreateEmailResponse, Domain, DomainLastStatus, Email, GetDomainLastStatusRequest, GetDomainRequest, GetEmailRequest, GetStatisticsRequest, ListDomainsRequest, ListDomainsResponse, ListEmailsRequest, ListEmailsResponse, RevokeDomainRequest, Statistics } from './types.gen';
+/**
+ * Transactional Email API.
+ *
+ * This API allows you to manage your Transactional Email services.
+ */
+export declare class API extends ParentAPI {
+    /** Lists the available regions of the API. */
+    static readonly LOCALITIES: Region[];
+    /**
+     * 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: Readonly<CreateEmailRequest>) => Promise<CreateEmailResponse>;
+    /**
+     * 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: Readonly<GetEmailRequest>) => Promise<Email>;
+    /**
+     * 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: Readonly<GetEmailRequest>, options?: Readonly<WaitForOptions<Email>>) => Promise<Email>;
+    protected pageOfListEmails: (request?: Readonly<ListEmailsRequest>) => Promise<ListEmailsResponse>;
+    /**
+     * 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: (request?: Readonly<ListEmailsRequest>) => Promise<ListEmailsResponse> & {
+        all: () => Promise<Email[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Email[], void, void>;
+    };
+    /**
+     * Email statuses. Get information on your emails' statuses.
+     *
+     * @param request - The request {@link GetStatisticsRequest}
+     * @returns A Promise of Statistics
+     */
+    getStatistics: (request?: Readonly<GetStatisticsRequest>) => Promise<Statistics>;
+    /**
+     * 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: Readonly<CancelEmailRequest>) => Promise<Email>;
+    /**
+     * 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: Readonly<CreateDomainRequest>) => Promise<Domain>;
+    /**
+     * 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.
+     *
+     * @param request - The request {@link GetDomainRequest}
+     * @returns A Promise of Domain
+     */
+    getDomain: (request: Readonly<GetDomainRequest>) => Promise<Domain>;
+    /**
+     * 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: Readonly<GetDomainRequest>, options?: Readonly<WaitForOptions<Domain>>) => Promise<Domain>;
+    protected pageOfListDomains: (request?: Readonly<ListDomainsRequest>) => Promise<ListDomainsResponse>;
+    /**
+     * 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: (request?: Readonly<ListDomainsRequest>) => Promise<ListDomainsResponse> & {
+        all: () => Promise<Domain[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Domain[], void, void>;
+    };
+    /**
+     * 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: Readonly<RevokeDomainRequest>) => Promise<Domain>;
+    /**
+     * 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: Readonly<CheckDomainRequest>) => Promise<Domain>;
+    /**
+     * 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: Readonly<GetDomainLastStatusRequest>) => Promise<DomainLastStatus>;
+}