@rewritetoday/types 1.0.0 → 1.0.2

package/README.md

@@ -43,6 +43,9 @@ Types used in direct API requests.
 
   - Suffix `Data` → data returned by the API
   E.g.: `RESTGetListWebhooksData`
+  
+- Prefix `Webhook*`
+Represents any data that come from a webhook.
 
 <div align="center">
 
@@ -66,6 +69,35 @@ async function fetchHooks() {
 
 <div align="center">
 
+### Typing webhook events
+
+We are using [Bun](https://elysiajs.com/) here as example, but you can use it however you want.
+
+</div>
+
+```ts
+import { type WebhookEvent, WebhookEventType } from '@rewritetoday/types/v1';
+
+const server = Bun.serve({
+	port: 3000,
+	routes: {
+		async '/webhooks/rewrite'(request) {
+			const event: WebhookEvent = await request.json();
+			
+			switch (event.type) {
+				case WebhookEventType.MessageSent:
+					console.log('Hey, a new message!');
+					
+					return Response.json({});
+				case ...
+			}
+		},
+	},
+});
+```
+
+<div align="center">
+
 ### Using Route Builders
 
 </div>

package/dist/v1/index.d.ts

@@ -7,3 +7,4 @@ export * from './resources/templates';
 export * from './resources/webhooks';
 export * from './rest';
 export { API_BASE_URL, Routes } from './routes';
+export * from './webhooks';

package/dist/v1/index.js

@@ -7,3 +7,4 @@ export * from './resources/templates';
 export * from './resources/webhooks';
 export * from './rest';
 export { API_BASE_URL, Routes } from './routes';
+export * from './webhooks';

package/dist/v1/rest.d.ts

@@ -103,7 +103,10 @@ export interface RESTGetListTemplatesQueryParams extends RESTCursorOptions {
 /** `POST https://api.rewritetoday.com/v1/templates`. */
 export type RESTPostCreateTemplateData = APIResponse<Pick<APITemplate, 'id' | 'createdAt'>>;
 /** `POST https://api.rewritetoday.com/v1/templates`. */
-export type RESTPostCreateTemplateBody = Pick<APITemplate, 'name' | 'i18n' | 'content' | 'variables' | 'description'>;
+export interface RESTPostCreateTemplateBody extends Pick<APITemplate, 'name' | 'content' | 'variables' | 'description'> {
+    /** Locale-specific overrides available for the template. */
+    i18n?: Partial<Record<CountryCode, string>>;
+}
 /** `PATCH https://api.rewritetoday.com/v1/templates/:id`. */
 export type RESTPatchUpdateTemplateData = APIResponse<null>;
 /** `PATCH https://api.rewritetoday.com/v1/templates/:id`. */
@@ -159,7 +162,7 @@ export type RESTPostSendMessageBody = {
     /** Destination number in E.164 format. */
     to: string;
     /** Optional metadata stored with the message. */
-    tags: APIMessageTag[];
+    tags?: APIMessageTag[];
     /** When provided, Rewrite schedules the message for later delivery. */
     scheduledAt?: string;
     /** Optional segmentation rules for long SMS bodies. */

package/dist/v1/routes.d.ts

@@ -1,4 +1,4 @@
-import type { RESTCursorOptions } from './rest';
+import type { RESTGetListMessagesQueryParams, RESTGetListTemplatesQueryParams, RESTGetListWebhookLogsQueryParams, RESTGetListWebhooksQueryParams } from './rest';
 export declare const API_BASE_URL = "https://api.rewritetoday.com";
 export declare const Routes: {
     otp: {
@@ -13,7 +13,7 @@ export declare const Routes: {
         /** `POST https://api.rewritetoday.com/v1/messages/batch`. */
         batch(): string;
         /** `GET https://api.rewritetoday.com/v1/messages`. */
-        list(): string;
+        list(options?: RESTGetListMessagesQueryParams): string;
         /** `GET https://api.rewritetoday.com/v1/messages/:id`. */
         get(id: string): string;
         /** `POST https://api.rewritetoday.com/v1/messages/:id/cancel`. */
@@ -21,7 +21,7 @@ export declare const Routes: {
     };
     webhooks: {
         /** `GET https://api.rewritetoday.com/v1/webhooks`. */
-        list(options?: RESTCursorOptions): string;
+        list(options?: RESTGetListWebhooksQueryParams): string;
         /** `POST https://api.rewritetoday.com/v1/webhooks`. */
         create(): string;
         /** `PATCH https://api.rewritetoday.com/v1/webhooks/:id`. */
@@ -31,11 +31,11 @@ export declare const Routes: {
         /** `GET https://api.rewritetoday.com/v1/webhooks/:id`. */
         get(id: string): string;
         /** `GET https://api.rewritetoday.com/v1/webhooks/:id/logs`. */
-        logs(id: string): string;
+        logs(id: string, options?: RESTGetListWebhookLogsQueryParams): string;
     };
     templates: {
         /** `GET https://api.rewritetoday.com/v1/templates`. */
-        list(options?: RESTCursorOptions): string;
+        list(options?: RESTGetListTemplatesQueryParams): string;
         /** `POST https://api.rewritetoday.com/v1/templates`. */
         create(): string;
         /** `PATCH https://api.rewritetoday.com/v1/templates/:id`. */

package/dist/v1/routes.js

@@ -21,8 +21,8 @@ export const Routes = {
             return '/messages/batch';
         },
         /** `GET https://api.rewritetoday.com/v1/messages`. */
-        list() {
-            return '/messages';
+        list(options) {
+            return `/messages?${createCursorQuery(options)}`;
         },
         /** `GET https://api.rewritetoday.com/v1/messages/:id`. */
         get(id) {
@@ -55,8 +55,8 @@ export const Routes = {
             return `/webhooks/${id}`;
         },
         /** `GET https://api.rewritetoday.com/v1/webhooks/:id/logs`. */
-        logs(id) {
-            return `/webhooks/${id}/logs`;
+        logs(id, options) {
+            return `/webhooks/${id}/logs?${createCursorQuery(options)}`;
         },
     },
     templates: {

package/dist/v1/webhooks.d.ts

@@ -0,0 +1,90 @@
+import type { Snowflake } from './resources/globals';
+import type { APIMessage, MessageStatus, MessageType } from './resources/message';
+import type { APIOTPMessage } from './resources/otp';
+import type { WebhookEventType } from './resources/webhooks';
+export interface WebhookBase<Type extends WebhookEventType, Data extends object> {
+    /** Event name. See {@link WebhookEventType}. */
+    type: Type;
+    /** The data of the event. */
+    data: Data & {
+        /** The ID of the project that sent the OTP message. See {@link Snowflake}. */
+        projectId: Snowflake;
+    };
+    /** Webhook event identifier. See {@link Snowflake}. */
+    id: Snowflake;
+    /** Timestamp when Rewrite sent the event. */
+    createdAt: string;
+}
+/** https://docs.rewritetoday.com/en/webhooks/events/sms-otp */
+export type WebhookSMSOTPEvent = WebhookBase<WebhookEventType.SMSOTP, Omit<APIMessage, 'type' | 'status'> & {
+    /** OTP data. */
+    otp: Pick<APIOTPMessage, 'prefix' | 'expiresAt'>;
+    /** The type of the message. Always {@link MessageType.OTP} */
+    type: MessageType.OTP;
+    /** Latest delivery status known by Rewrite. Always {@link MessageStatus.Sent} */
+    status: MessageStatus.Sent;
+}>;
+/** https://docs.rewritetoday.com/en/webhooks/events/message-sent */
+export type WebhookMessageSentEvent = WebhookBase<WebhookEventType.MessageSent, Omit<APIMessage, 'type' | 'status'> & {
+    /** The type of the message. Always {@link MessageType.SMS} */
+    type: MessageType.SMS;
+    /** Latest delivery status known by Rewrite. Always {@link MessageStatus.Sent} */
+    status: MessageStatus.Sent;
+}>;
+/** https://docs.rewritetoday.com/en/webhooks/events/message-batch */
+export type WebhookMessageBatchEvent = WebhookBase<WebhookEventType.MessageBatch, {
+    /** Message ID in {@link Snowflake} format. */
+    id: Snowflake;
+    /**
+     * The IDs of the messages in {@link Snowflake} format that were sent.
+     *
+     * @remarks Can be longer than the original number of request items when some entries were segmented into multiple SMS parts.
+     * @see {@link https://docs.rewritetoday.com/en/webhooks/events/message-batch}
+     */
+    ids: Snowflake[];
+}>;
+/** https://docs.rewritetoday.com/en/webhooks/events/message-queued */
+export type WebhookMessageQueuedEvent = WebhookBase<WebhookEventType.MessageQueued, Omit<APIMessage, 'type' | 'status'> & {
+    /** The type of the message. Always {@link MessageType.SMS} */
+    type: MessageType.SMS;
+    /** Latest delivery status known by Rewrite. Always {@link MessageStatus.Queued} */
+    status: MessageStatus.Queued;
+}>;
+/**
+ * https://docs.rewritetoday.com/en/webhooks/events/message-delivered
+ *
+ * @wip
+ */
+export type WebhookMessageDeliveredEvent = WebhookBase<WebhookEventType.MessageDelivered, never>;
+/** https://docs.rewritetoday.com/en/webhooks/events/message-scheduled */
+export type WebhookMessageScheduledEvent = WebhookBase<WebhookEventType.MessageScheduled, Omit<APIMessage, 'type' | 'status' | 'scheduledAt'> & {
+    /** Scheduled send time, when the message was delayed intentionally. */
+    scheduledAt: string;
+    /** The type of the message. Always {@link MessageType.SMS} */
+    type: MessageType.SMS;
+    /** Latest delivery status known by Rewrite. Always {@link MessageStatus.Scheduled} */
+    status: MessageStatus.Scheduled;
+}>;
+/** https://docs.rewritetoday.com/en/webhooks/events/message-failed */
+export type WebhookMessageFailedEvent = WebhookBase<WebhookEventType.MessageFailed, Omit<APIMessage, 'status'> & {
+    /** Latest delivery status known by Rewrite. Always {@link MessageStatus.Failed} */
+    status: MessageStatus.Failed;
+    /** The error explaining why the message failed. */
+    error: {
+        /** A human-readable error code. */
+        code: string;
+        /** Internal message error. */
+        message: string;
+    };
+}>;
+/** https://docs.rewritetoday.com/en/webhooks/events/message-canceled */
+export type WebhookMessageCanceledEvent = WebhookBase<WebhookEventType.MessageCanceled, Omit<APIMessage, 'type' | 'status' | ('scheduledAt' & {
+    /** Scheduled send time, when the message was delayed intentionally. */
+    scheduledAt: string;
+    /** The type of the message. Always {@link MessageType.SMS} */
+    type: MessageType.SMS;
+    /** Latest delivery status known by Rewrite. Always {@link MessageStatus.Canceled} */
+    status: MessageStatus.Canceled;
+})>>;
+/** https://docs.rewritetoday.com/en/webhooks */
+export type WebhookEvent = WebhookSMSOTPEvent | WebhookMessageSentEvent | WebhookMessageBatchEvent | WebhookMessageQueuedEvent | WebhookMessageDeliveredEvent | WebhookMessageScheduledEvent | WebhookMessageFailedEvent | WebhookMessageCanceledEvent;

package/dist/v1/webhooks.js

@@ -0,0 +1 @@
+export {};

package/dist/version.d.ts

@@ -1,7 +1,7 @@
 /**
  * Current version of [@rewritetoday/types](https://www.npmjs.com/package/@rewritetoday/types).
  */
-export declare const version: "1.0.0";
+export declare const version: "1.0.2";
 /**
  * Current Rewrite API version.
  */

package/dist/version.js

@@ -2,7 +2,7 @@
 /**
  * Current version of [@rewritetoday/types](https://www.npmjs.com/package/@rewritetoday/types).
  */
-export const version = '1.0.0';
+export const version = '1.0.2';
 /**
  * Current Rewrite API version.
  */

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.0.0",
+	"version": "1.0.2",
 	"name": "@rewritetoday/types",
 	"description": "Official Rewrite API typings that are always up to date",
 	"type": "module",