@textbee/sdk 0.3.1 → 0.4.0

package/dist/index.cjs

@@ -48,7 +48,7 @@ var TextbeeError = class extends Error {
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://api.textbee.dev/api/v1";
-var CLIENT_ID = `textbee-js/${"0.3.1"}`;
+var CLIENT_ID = `textbee-js/${"0.4.0"}`;
 var Textbee = class {
   #apiKey;
   #baseUrl;

package/dist/index.d.cts

@@ -136,6 +136,20 @@ interface MessageDevice {
     buildId?: string;
     enabled?: boolean;
 }
+/** Where a failure was reported from. */
+type MessageIssueSource = 'push' | 'device' | 'server';
+/** One failure a message had. Kept after the message later succeeds. */
+interface MessageIssueEntry {
+    code: string;
+    message?: string;
+    /** When the failure happened. ISO date. */
+    at: string;
+    source: MessageIssueSource;
+    /** Set on entries rebuilt from old message fields. */
+    backfilled?: boolean;
+    /** True when the entry is a delivery report that did not confirm delivery. The message was sent; this is not a send failure. */
+    deliveryReport?: boolean;
+}
 interface Message {
     _id: string;
     message: string;
@@ -160,10 +174,15 @@ interface Message {
     dispatchedAt?: string;
     sentAt?: string;
     deliveredAt?: string;
+    /** When the message failed. Present only while status is `failed`. */
     failedAt?: string;
     receivedAt?: string;
+    /** Current failure code. Present only while status is `failed` (test accounts can keep `FCM_SEND_SKIPPED`). */
     errorCode?: string;
+    /** Current failure text. Present only while status is `failed`, or as a timeout note on `unknown`. */
     errorMessage?: string;
+    /** Every failure the message had, plus delivery reports that did not confirm delivery (`deliveryReport: true`, not failures). Oldest first. At most 15: the first 5 and the newest 10. */
+    issueHistory?: MessageIssueEntry[];
     simSubscriptionId?: number;
     smsBatch?: string;
     createdAt?: string;
@@ -400,4 +419,4 @@ interface VerifyWebhookSignatureOptions {
  */
 declare function verifyWebhookSignature(options: VerifyWebhookSignatureOptions): Promise<boolean>;
 
-export { type Device, type IterateMessagesOptions, type ListMessagesOptions, type Message, type MessageDevice, type MessageList, type MessageListMeta, type NormalizePhoneNumberOptions, type SanitizeForGsm7Options, type SendSmsImmediateResponse, type SendSmsQueuedResponse, type SendSmsRequest, type SendSmsResponse, type SendSmsWarning, type Sms, type SmsBatch, type SmsBatchResult, type SmsEncoding, type SmsSegmentInfo, Textbee, TextbeeError, type TextbeeOptions, type VerifyWebhookSignatureOptions, type WebhookEvent, countSmsSegments, findNonGsm7Characters, getSmsEncoding, isValidE164, normalizePhoneNumber, sanitizeForGsm7, verifyWebhookSignature };
+export { type Device, type IterateMessagesOptions, type ListMessagesOptions, type Message, type MessageDevice, type MessageIssueEntry, type MessageIssueSource, type MessageList, type MessageListMeta, type NormalizePhoneNumberOptions, type SanitizeForGsm7Options, type SendSmsImmediateResponse, type SendSmsQueuedResponse, type SendSmsRequest, type SendSmsResponse, type SendSmsWarning, type Sms, type SmsBatch, type SmsBatchResult, type SmsEncoding, type SmsSegmentInfo, Textbee, TextbeeError, type TextbeeOptions, type VerifyWebhookSignatureOptions, type WebhookEvent, countSmsSegments, findNonGsm7Characters, getSmsEncoding, isValidE164, normalizePhoneNumber, sanitizeForGsm7, verifyWebhookSignature };

package/dist/index.d.ts

@@ -136,6 +136,20 @@ interface MessageDevice {
     buildId?: string;
     enabled?: boolean;
 }
+/** Where a failure was reported from. */
+type MessageIssueSource = 'push' | 'device' | 'server';
+/** One failure a message had. Kept after the message later succeeds. */
+interface MessageIssueEntry {
+    code: string;
+    message?: string;
+    /** When the failure happened. ISO date. */
+    at: string;
+    source: MessageIssueSource;
+    /** Set on entries rebuilt from old message fields. */
+    backfilled?: boolean;
+    /** True when the entry is a delivery report that did not confirm delivery. The message was sent; this is not a send failure. */
+    deliveryReport?: boolean;
+}
 interface Message {
     _id: string;
     message: string;
@@ -160,10 +174,15 @@ interface Message {
     dispatchedAt?: string;
     sentAt?: string;
     deliveredAt?: string;
+    /** When the message failed. Present only while status is `failed`. */
     failedAt?: string;
     receivedAt?: string;
+    /** Current failure code. Present only while status is `failed` (test accounts can keep `FCM_SEND_SKIPPED`). */
     errorCode?: string;
+    /** Current failure text. Present only while status is `failed`, or as a timeout note on `unknown`. */
     errorMessage?: string;
+    /** Every failure the message had, plus delivery reports that did not confirm delivery (`deliveryReport: true`, not failures). Oldest first. At most 15: the first 5 and the newest 10. */
+    issueHistory?: MessageIssueEntry[];
     simSubscriptionId?: number;
     smsBatch?: string;
     createdAt?: string;
@@ -400,4 +419,4 @@ interface VerifyWebhookSignatureOptions {
  */
 declare function verifyWebhookSignature(options: VerifyWebhookSignatureOptions): Promise<boolean>;
 
-export { type Device, type IterateMessagesOptions, type ListMessagesOptions, type Message, type MessageDevice, type MessageList, type MessageListMeta, type NormalizePhoneNumberOptions, type SanitizeForGsm7Options, type SendSmsImmediateResponse, type SendSmsQueuedResponse, type SendSmsRequest, type SendSmsResponse, type SendSmsWarning, type Sms, type SmsBatch, type SmsBatchResult, type SmsEncoding, type SmsSegmentInfo, Textbee, TextbeeError, type TextbeeOptions, type VerifyWebhookSignatureOptions, type WebhookEvent, countSmsSegments, findNonGsm7Characters, getSmsEncoding, isValidE164, normalizePhoneNumber, sanitizeForGsm7, verifyWebhookSignature };
+export { type Device, type IterateMessagesOptions, type ListMessagesOptions, type Message, type MessageDevice, type MessageIssueEntry, type MessageIssueSource, type MessageList, type MessageListMeta, type NormalizePhoneNumberOptions, type SanitizeForGsm7Options, type SendSmsImmediateResponse, type SendSmsQueuedResponse, type SendSmsRequest, type SendSmsResponse, type SendSmsWarning, type Sms, type SmsBatch, type SmsBatchResult, type SmsEncoding, type SmsSegmentInfo, Textbee, TextbeeError, type TextbeeOptions, type VerifyWebhookSignatureOptions, type WebhookEvent, countSmsSegments, findNonGsm7Characters, getSmsEncoding, isValidE164, normalizePhoneNumber, sanitizeForGsm7, verifyWebhookSignature };

package/dist/index.js

@@ -14,7 +14,7 @@ var TextbeeError = class extends Error {
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://api.textbee.dev/api/v1";
-var CLIENT_ID = `textbee-js/${"0.3.1"}`;
+var CLIENT_ID = `textbee-js/${"0.4.0"}`;
 var Textbee = class {
   #apiKey;
   #baseUrl;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@textbee/sdk",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Official JavaScript SDK for textbee.dev, the open source SMS gateway",
   "license": "MIT",
   "packageManager": "pnpm@9.14.2",