@scaleway/sdk-tem 1.2.0 → 2.1.1

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-tem
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-tem.svg)](https://www.npmjs.com/package/@scaleway/sdk-tem)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-tem.svg)](https://www.npmjs.com/package/@scaleway/sdk-tem)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-tem.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Tem API.
+
+> **Note**  
+> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
+
+## Installation
+
+```bash
+npm install @scaleway/sdk-tem @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-tem @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-tem @scaleway/sdk-client
+```
+
+## Getting Started
+
+You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
+
+### Basic Usage
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { Tem } from '@scaleway/sdk-tem'
+
+const client = createClient({
+  accessKey: 'SCWXXXXXXXXXXXXXXXXX',
+  secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultRegion: 'fr-par',
+  defaultZone: 'fr-par-1',
+})
+
+const api = new Tem.v1.API(client)
+
+// Use the API
+// Example: await api.listServers()
+```
+
+### Using Configuration Loader
+
+For a simpler setup, you can load credentials from the configuration file or environment variables:
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
+import { Tem } from '@scaleway/sdk-tem'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new Tem.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Tem API Documentation](https://www.scaleway.com/en/developers/api/tem/)
+- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
+- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
+
+## Features
+
+- ✅ Full TypeScript support with complete type definitions
+- ✅ Promise-based API
+- ✅ Automatic pagination helpers
+- ✅ Built-in error handling
+- ✅ Compatible with Node.js ≥ 20
+
+## Support
+
+We love feedback! Feel free to reach us on:
+- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
+- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
+
+## Contributing
+
+This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
+
+## License
+
+This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
+

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

@@ -1,5 +1,5 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
+import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { BulkCreateBlocklistsRequest, BulkCreateBlocklistsResponse, CancelEmailRequest, CheckDomainRequest, CreateDomainRequest, CreateEmailRequest, CreateEmailResponse, CreateWebhookRequest, DeleteBlocklistRequest, DeleteWebhookRequest, Domain, DomainLastStatus, Email, GetDomainLastStatusRequest, GetDomainRequest, GetEmailRequest, GetProjectConsumptionRequest, GetProjectSettingsRequest, GetStatisticsRequest, GetWebhookRequest, ListBlocklistsRequest, ListBlocklistsResponse, ListDomainsRequest, ListDomainsResponse, ListEmailsRequest, ListEmailsResponse, ListOfferSubscriptionsRequest, ListOfferSubscriptionsResponse, ListOffersRequest, ListOffersResponse, ListPoolsRequest, ListPoolsResponse, ListWebhookEventsRequest, ListWebhookEventsResponse, ListWebhooksRequest, ListWebhooksResponse, OfferSubscription, ProjectConsumption, ProjectSettings, RevokeDomainRequest, Statistics, UpdateDomainRequest, UpdateOfferSubscriptionRequest, UpdateProjectSettingsRequest, UpdateWebhookRequest, Webhook } from './types.gen.js';
 /**
  * Transactional Email API.
@@ -13,7 +13,7 @@ export declare class API extends ParentAPI {
      */
     static readonly LOCALITY: ApiLocality;
     /**
-     * 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.
+     * 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.
      *
      * @param request - The request {@link CreateEmailRequest}
      * @returns A Promise of CreateEmailResponse

package/dist/v1alpha1/api.gen.js

@@ -10,10 +10,12 @@ class API extends API$1 {
    * type ∈ {'zone','region','global','unspecified'}
    */
   static LOCALITY = toApiLocality({
-    regions: ["fr-par"]
+    regions: [
+      "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.
+   * 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.
    *
    * @param request - The request {@link CreateEmailRequest}
    * @returns A Promise of CreateEmailResponse
@@ -68,10 +70,7 @@ class API extends API$1 {
         ["message_id", request.messageId],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId],
         ["search", request.search],
         ["since", request.since],
@@ -175,10 +174,7 @@ class API extends API$1 {
         ["name", request.name],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId],
         ["status", request.status]
       )
@@ -278,10 +274,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId]
       )
     },
@@ -329,10 +322,12 @@ class API extends API$1 {
    *
    * @param request - The request {@link DeleteWebhookRequest}
    */
-  deleteWebhook = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/transactional-email/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/webhooks/${validatePathParam("webhookId", request.webhookId)}`
-  });
+  deleteWebhook = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/transactional-email/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/webhooks/${validatePathParam("webhookId", request.webhookId)}`
+    }
+  );
   pageOfListWebhookEvents = (request) => this.client.fetch(
     {
       method: "GET",
@@ -344,10 +339,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId],
         ["statuses", request.statuses]
       )
@@ -401,10 +393,7 @@ class API extends API$1 {
         ["email", request.email],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["type", request.type]
       )
     },
@@ -439,10 +428,12 @@ class API extends API$1 {
    *
    * @param request - The request {@link DeleteBlocklistRequest}
    */
-  deleteBlocklist = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/transactional-email/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/blocklists/${validatePathParam("blocklistId", request.blocklistId)}`
-  });
+  deleteBlocklist = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/transactional-email/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/blocklists/${validatePathParam("blocklistId", request.blocklistId)}`
+    }
+  );
   /**
    * Get information about subscribed offers. Retrieve information about the offers you are subscribed to using the `project_id` and `region` parameters.
    *
@@ -453,10 +444,9 @@ class API extends API$1 {
     {
       method: "GET",
       path: `/transactional-email/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/offer-subscriptions`,
-      urlParams: urlParams([
-        "project_id",
-        request.projectId ?? this.client.settings.defaultProjectId
-      ])
+      urlParams: urlParams(
+        ["project_id", request.projectId ?? this.client.settings.defaultProjectId]
+      )
     },
     unmarshalListOfferSubscriptionsResponse
   );
@@ -496,14 +486,8 @@ class API extends API$1 {
       path: `/transactional-email/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/pools`,
       urlParams: urlParams(
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        [
-          "project_id",
-          request.projectId ?? this.client.settings.defaultProjectId
-        ]
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
+        ["project_id", request.projectId ?? this.client.settings.defaultProjectId]
       )
     },
     unmarshalListPoolsResponse
@@ -525,10 +509,9 @@ class API extends API$1 {
     {
       method: "GET",
       path: `/transactional-email/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/project-consumption`,
-      urlParams: urlParams([
-        "project_id",
-        request.projectId ?? this.client.settings.defaultProjectId
-      ])
+      urlParams: urlParams(
+        ["project_id", request.projectId ?? this.client.settings.defaultProjectId]
+      )
     },
     unmarshalProjectConsumption
   );

package/dist/v1alpha1/content.gen.js

@@ -2,7 +2,10 @@ const DOMAIN_TRANSIENT_STATUSES = [
   "pending",
   "autoconfiguring"
 ];
-const EMAIL_TRANSIENT_STATUSES = ["new", "sending"];
+const EMAIL_TRANSIENT_STATUSES = [
+  "new",
+  "sending"
+];
 export {
   DOMAIN_TRANSIENT_STATUSES,
   EMAIL_TRANSIENT_STATUSES

package/dist/v1alpha1/index.gen.d.ts

@@ -1,4 +1,4 @@
-export { API } from './api.gen.js';
+export { API, } from './api.gen.js';
 export * from './content.gen.js';
 export * from './marshalling.gen.js';
 export type { Blocklist, BlocklistType, BulkCreateBlocklistsRequest, BulkCreateBlocklistsResponse, CancelEmailRequest, CheckDomainRequest, CreateDomainRequest, CreateEmailRequest, CreateEmailRequestAddress, CreateEmailRequestAttachment, CreateEmailRequestHeader, CreateEmailResponse, CreateWebhookRequest, DeleteBlocklistRequest, DeleteWebhookRequest, Domain, DomainLastStatus, DomainLastStatusAutoconfigState, DomainLastStatusAutoconfigStateReason, DomainLastStatusDkimRecord, DomainLastStatusDmarcRecord, DomainLastStatusMXRecord, DomainLastStatusRecordStatus, DomainLastStatusSpfRecord, DomainRecords, DomainRecordsDKIM, DomainRecordsDMARC, DomainRecordsMX, DomainRecordsSPF, DomainReputation, DomainReputationStatus, DomainStatistics, DomainStatus, Email, EmailFlag, EmailRcptType, EmailStatus, EmailTry, GetDomainLastStatusRequest, GetDomainRequest, GetEmailRequest, GetProjectConsumptionRequest, GetProjectSettingsRequest, GetStatisticsRequest, GetWebhookRequest, ListBlocklistsRequest, ListBlocklistsRequestOrderBy, ListBlocklistsResponse, ListDomainsRequest, ListDomainsResponse, ListEmailsRequest, ListEmailsRequestOrderBy, ListEmailsResponse, ListOfferSubscriptionsRequest, ListOfferSubscriptionsResponse, ListOffersRequest, ListOffersResponse, ListPoolsRequest, ListPoolsResponse, ListWebhookEventsRequest, ListWebhookEventsRequestOrderBy, ListWebhookEventsResponse, ListWebhooksRequest, ListWebhooksRequestOrderBy, ListWebhooksResponse, Offer, OfferName, OfferSubscription, Pool, PoolStatus, ProjectConsumption, ProjectSettings, ProjectSettingsPeriodicReport, ProjectSettingsPeriodicReportFrequency, RevokeDomainRequest, Statistics, UpdateDomainRequest, UpdateOfferSubscriptionRequest, UpdateProjectSettingsRequest, UpdateProjectSettingsRequestUpdatePeriodicReport, UpdateWebhookRequest, Webhook, WebhookEvent, WebhookEventStatus, WebhookEventType, } from './types.gen.js';

package/dist/v1alpha1/marshalling.gen.js

@@ -338,10 +338,7 @@ const unmarshalListOfferSubscriptionsResponse = (data) => {
     );
   }
   return {
-    offerSubscriptions: unmarshalArrayOfObject(
-      data.offer_subscriptions,
-      unmarshalOfferSubscription
-    ),
+    offerSubscriptions: unmarshalArrayOfObject(data.offer_subscriptions, unmarshalOfferSubscription),
     totalCount: data.total_count
   };
 };
@@ -428,10 +425,7 @@ const unmarshalListWebhookEventsResponse = (data) => {
   }
   return {
     totalCount: data.total_count,
-    webhookEvents: unmarshalArrayOfObject(
-      data.webhook_events,
-      unmarshalWebhookEvent
-    )
+    webhookEvents: unmarshalArrayOfObject(data.webhook_events, unmarshalWebhookEvent)
   };
 };
 const unmarshalListWebhooksResponse = (data) => {
@@ -524,12 +518,8 @@ const marshalCreateEmailRequestHeader = (request, defaults) => ({
   value: request.value
 });
 const marshalCreateEmailRequest = (request, defaults) => ({
-  additional_headers: request.additionalHeaders !== void 0 ? request.additionalHeaders.map(
-    (elt) => marshalCreateEmailRequestHeader(elt)
-  ) : void 0,
-  attachments: request.attachments !== void 0 ? request.attachments.map(
-    (elt) => marshalCreateEmailRequestAttachment(elt)
-  ) : void 0,
+  additional_headers: request.additionalHeaders !== void 0 ? request.additionalHeaders.map((elt) => marshalCreateEmailRequestHeader(elt)) : void 0,
+  attachments: request.attachments !== void 0 ? request.attachments.map((elt) => marshalCreateEmailRequestAttachment(elt)) : void 0,
   bcc: request.bcc !== void 0 ? request.bcc.map((elt) => marshalCreateEmailRequestAddress(elt)) : void 0,
   cc: request.cc !== void 0 ? request.cc.map((elt) => marshalCreateEmailRequestAddress(elt)) : void 0,
   from: marshalCreateEmailRequestAddress(request.from),
@@ -561,9 +551,7 @@ const marshalUpdateProjectSettingsRequestUpdatePeriodicReport = (request, defaul
   sending_hour: request.sendingHour
 });
 const marshalUpdateProjectSettingsRequest = (request, defaults) => ({
-  periodic_report: request.periodicReport !== void 0 ? marshalUpdateProjectSettingsRequestUpdatePeriodicReport(
-    request.periodicReport
-  ) : void 0
+  periodic_report: request.periodicReport !== void 0 ? marshalUpdateProjectSettingsRequestUpdatePeriodicReport(request.periodicReport) : void 0
 });
 const marshalUpdateWebhookRequest = (request, defaults) => ({
   event_types: request.eventTypes !== void 0 ? request.eventTypes : void 0,

package/dist/v1alpha1/validation-rules.gen.d.ts

@@ -12,7 +12,6 @@ export declare const CreateDomainRequest: {
 export declare const CreateEmailRequest: {
     subject: {
         maxLength: number;
-        minLength: number;
     };
 };
 export declare const CreateEmailRequestAddress: {
@@ -78,7 +77,6 @@ export declare const ListEmailsRequest: {
     };
     subject: {
         maxLength: number;
-        minLength: number;
     };
 };
 export declare const ListPoolsRequest: {

package/dist/v1alpha1/validation-rules.gen.js

@@ -11,8 +11,7 @@ const CreateDomainRequest = {
 };
 const CreateEmailRequest = {
   subject: {
-    maxLength: 998,
-    minLength: 6
+    maxLength: 998
   }
 };
 const CreateEmailRequestAddress = {
@@ -77,8 +76,7 @@ const ListEmailsRequest = {
     minLength: 3
   },
   subject: {
-    maxLength: 998,
-    minLength: 6
+    maxLength: 998
   }
 };
 const ListPoolsRequest = {

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@scaleway/sdk-tem",
-  "version": "1.2.0",
+  "version": "2.1.1",
   "description": "Scaleway SDK tem",
   "license": "Apache-2.0",
   "files": [
+    "README.md",
     "dist"
   ],
   "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.gen.d.ts",
-      "import": "./dist/index.gen.js",
-      "require": "./dist/index.gen.cjs",
       "default": "./dist/index.gen.js"
     },
     "./*": {
       "types": "./dist/*/index.gen.d.ts",
-      "import": "./dist/*/index.gen.js",
-      "require": "./dist/*/index.gen.cjs",
       "default": "./dist/*/index.gen.js"
     }
   },
@@ -26,17 +23,17 @@
     "directory": "packages_generated/tem"
   },
   "engines": {
-    "node": ">=20.19.4"
+    "node": ">=20.19.6"
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.2",
-    "@scaleway/sdk-std": "1.1.0"
+    "@scaleway/sdk-std": "2.1.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "scripts": {
     "package:check": "pnpm publint",

package/dist/index.gen.cjs

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const index_gen = require("./v1alpha1/index.gen.cjs");
-exports.Temv1alpha1 = index_gen;