@messagebird/sdk 0.23.0 → 0.25.0

package/dist/index.mjs

@@ -1950,6 +1950,8 @@ const unassignAudienceContact = (options) => (options.client ?? client).delete({
 *
 * Returns the workspace's SMS messages as a cursor-paginated list, newest first. Filter by direction, status, category, recipient, sender, failure reason, tag, or creation time; pass the response's `next_cursor` back as `starting_after` to fetch the next page. To follow a single message's delivery, use [Get an SMS message](/docs/api/reference/get-sms-message) instead.
 *
+* Messages are retained for **30 days**. A `created_after` earlier than that is accepted and raised to the retention bound rather than rejected, so a wider window returns what is still retained instead of failing. There is no way to read messages older than the window.
+*
 */
 const listSmsMessages = (options) => (options?.client ?? client).get({
 	security: [{
@@ -2088,7 +2090,7 @@ const getSmsTemplate = (options) => (options.client ?? client).get({
 /**
 * Create a verification
 *
-* Creates a verification for a recipient and sends them a one-time passcode. Provide the recipient in `to`: an email address (verified over email), a phone number (verified over SMS), or both. With both, the passcode is sent over one channel at a time and delivery falls over to the other channel if the first fails; it is never sent to both at once.
+* Creates a verification for a recipient and sends them a one-time passcode. Provide the recipient in `to`: an email address (verified over email), a phone number (verified over the phone channels enabled for its destination country), or both. The passcode is sent over one channel at a time and delivery falls over to the next channel in the plan if one fails; it is never sent over two channels at once.
 *
 * Calling this again for the same recipient resumes the verification in progress rather than starting a second one: within the resend cooldown the request returns the current state without sending, and after it a fresh passcode is sent. Use the same call to send and to resend.
 *
@@ -2138,10 +2140,38 @@ const createVerificationCheck = (options) => (options.client ?? client).post({
 	}
 });
 /**
+* Advance a verification to its next channel
+*
+* Advances an in-progress verification to the next channel in its plan and sends a fresh passcode there, for a recipient who reports not receiving the code. Identify the verification by the same `to` used to create it; you do not need to store a verification ID.
+*
+* The send bypasses the resend cooldown (a deliberate channel switch is a different act from a same-channel resend), and every passcode already sent stays valid, so a code that arrives late can still be checked. The response is the verification with `last_channel` set to the channel the new passcode went to. Concurrent requests for the same recipient are safe: each advances the plan at most one step. When two race, the request that completes the newer send is the authoritative one; the other returns the verification's committed state, whose `last_channel` still names the most recent send that completed. A later read of the verification always reflects the settled outcome.
+*
+* An error status is returned when the verification cannot be advanced: `404` when no verification is in progress for the recipient, `422` with `NoNextChannel` when the plan has no further channel (fall back to a plain resend), `422` with `NoAvailableChannel` when every remaining channel failed to send, and `429` when sends for the account are requested too quickly.
+*
+*/
+const createVerificationNextChannel = (options) => (options.client ?? client).post({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/verify/verifications/next-channel",
+	...options,
+	headers: {
+		"Content-Type": "application/json",
+		...options.headers
+	}
+});
+/**
 * List WhatsApp messages
 *
 * Returns the workspace's WhatsApp messages as a cursor-paginated list, newest first. Filter by direction, status, contact phone number, business-scoped user ID, template category, tag, or creation time; pass the response's `next_cursor` back as `starting_after` to fetch the next page. To follow a single message's delivery, use [Get a WhatsApp message](/docs/api/reference/get-whats-app-message) instead.
 *
+* Messages are retained for **30 days**. A `created_after` earlier than that is accepted and raised to the retention bound rather than rejected, so a wider window returns what is still retained instead of failing. There is no way to read messages older than the window.
+*
 */
 const listWhatsAppMessages = (options) => (options?.client ?? client).get({
 	security: [{
@@ -3154,6 +3184,47 @@ const listMailboxLabels = (options) => (options.client ?? client).get({
 	url: "/v1/email/mailboxes/{mailbox_id}/labels",
 	...options
 });
+/**
+* List calls
+*
+* Returns a paginated list of the workspace's calls, ordered by start time descending.
+*
+* The `status` filter selects where in the lifecycle you look, and any combination is a single page: in-flight statuses (`ringing`, `in_progress`), final ones, or both together. Omit it and you get completed calls, which is what this list has always returned.
+*
+* A call in flight carries no economics yet: `duration_ms`, `billable_ms`, `ended_at`, and `cost` are null until it ends. It keeps the same `id` throughout, so the same call answers under one identity from the first ring to settlement.
+*
+*/
+const listVoiceCalls = (options) => (options?.client ?? client).get({
+	querySerializer: { parameters: { status: { array: { explode: false } } } },
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/voice/calls",
+	...options
+});
+/**
+* Get a call
+*
+* Returns a single call at any point in its lifecycle. A call that is still ringing or connected answers with its in-flight `status` and no economics: `duration_ms`, `billable_ms`, `ended_at`, and `cost` fill in once it ends, at this same URL. Returns a 404 `not_found_error` if the call does not exist in the workspace.
+*
+*/
+const getVoiceCall = (options) => (options.client ?? client).get({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/voice/calls/{call_id}",
+	...options
+});
 //#endregion
 //#region src/resources/base.ts
 var Resource = class {
@@ -4767,10 +4838,49 @@ var WhatsappResource = class extends WhatsappResourceBase {
 	}
 };
 //#endregion
+//#region src/resources/voice.gen.ts
+var VoiceResource = class extends Resource {
+	/**
+	* List the workspace's calls, newest first. Filter to `ringing`/`in_progress` for the calls in progress right now, to final statuses for completed records, or to any mix of the two. Use `from`/`to` for one known party number in international form, and `number` to search either side by fragment. These are per-call records: for rates and totals over a period use voice_stats_summary rather than summing them here, and voice_get to follow one call to settlement.
+	*
+	* @example Iterate the calls happening right now
+	* for await (const call of bird.voice.list({ status: ["ringing", "in_progress"] })) {
+	*   console.log(call.id, call.status);
+	* }
+	*/
+	list(query, options) {
+		return this.paginated("GET", options, ({ signal, headers }, cursor) => listVoiceCalls({
+			client: this.client,
+			query: {
+				...query,
+				starting_after: cursor ?? query?.starting_after
+			},
+			headers,
+			signal
+		}));
+	}
+	/**
+	* Fetch one call by id, at any point in its lifecycle. A call still ringing or connected carries no economics yet: `duration_ms`, `billable_ms`, `ended_at`, and `cost` are null until it ends, and this same id then answers with the settled record. Poll here to watch one known call; use voice_list to find calls in the first place. When a call was refused, `rejection_reason` names the gate that turned it away.
+	*
+	* @example Read one call back
+	* const call = await bird.voice.get("vcl_01k0p3v9wera3v6q6xw3e9y2mh");
+	* // A call still ringing or connected carries no economics yet.
+	* call.status; // "answered" | "no_answer" | "ringing" | …
+	*/
+	get(callId, options) {
+		return this.call("GET", options, ({ signal, headers }) => getVoiceCall({
+			client: this.client,
+			path: { call_id: callId },
+			headers,
+			signal
+		}));
+	}
+};
+//#endregion
 //#region src/resources/verifyVerifications.gen.ts
 var VerifyVerificationsResource = class extends Resource {
 	/**
-	* Start a verification: generate a one-time passcode and send it to the recipient in `to` (a phone number over SMS, an email address over email, or both; with both, it is sent over one channel and fails over to the other, not to both at once). Calling again for the same recipient reuses the in-progress verification and sends a fresh code after the resend cooldown; it does not start a second one, so use this both to send and to resend. The passcode is never returned; submit what the recipient enters with verify_verifications_check. SMS delivery draws on the workspace's SMS balance.
+	* Start a verification: generate a one-time passcode and send it to the recipient in `to` (a phone number over the phone channels enabled for its destination country; an email address over email; or both). It is sent over one channel at a time and fails over to the next in the plan, never over two at once. Calling again for the same recipient reuses the in-progress verification and sends a fresh code after the resend cooldown; it does not start a second one, so use this both to send and to resend. The passcode is never returned; submit what the recipient enters with verify_verifications_check. SMS delivery draws on the workspace's SMS balance.
 	*
 	* @example Start a verification over SMS
 	* const verification = await bird.verify.verifications.create({
@@ -4804,6 +4914,23 @@ var VerifyVerificationsResource = class extends Resource {
 			signal
 		}));
 	}
+	/**
+	* Advance an in-progress verification to the next channel in its plan and send a fresh passcode there: the "I didn't receive my code" action. The verification is identified by the same `to` recipient used to start it, with no verification id needed. The send bypasses the resend cooldown, and earlier passcodes stay valid. Returns the verification with `last_channel` set to the channel the new code went to; when concurrent advances race for the same recipient, the response reflects committed state: `last_channel` names the most recent completed send, and the racing call that completed the newer send is authoritative. A plan with no further channel returns a 422 named NoNextChannel, after which only re-creating the verification will resend.
+	*
+	* @example Send the code again on the next channel
+	* const verification = await bird.verify.verifications.nextChannel({
+	*   to: { phone_number: "+15551234567" },
+	* });
+	* console.log(verification.last_channel);
+	*/
+	nextChannel(params, options) {
+		return this.call("POST", options, ({ signal, headers }) => createVerificationNextChannel({
+			client: this.client,
+			body: params,
+			headers,
+			signal
+		}));
+	}
 };
 //#endregion
 //#region src/resources/verify.ts
@@ -5088,6 +5215,8 @@ var BirdClient = class {
 	smsTemplates;
 	/** The WhatsApp channel — `bird.whatsapp.send(...)`, `.get(...)`, `.list(...)`, `.listEvents(...)`. */
 	whatsapp;
+	/** The Voice call log — `bird.voice.list(...)`, `.get(...)`. Calls are placed by your own SIP equipment, so this is a read surface. */
+	voice;
 	/** The Verify product — `bird.verify.verifications.create(...)`, `.check(...)`. */
 	verify;
 	/** Contacts — `bird.contacts.create(...)`, `.list(...)`, `.get(...)`, `.batch(...)`, … */
@@ -5109,9 +5238,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.23.0`,
+			"User-Agent": `bird-sdk-js/0.25.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.23.0"
+			"Bird-Version": "0.25.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -5140,6 +5269,7 @@ var BirdClient = class {
 		this.sms = new SmsResource(this.core, this.#client);
 		this.smsTemplates = new SmsTemplatesResource(this.core, this.#client);
 		this.whatsapp = new WhatsappResource(this.core, this.#client);
+		this.voice = new VoiceResource(this.core, this.#client);
 		this.verify = new VerifyResource(this.core, this.#client);
 		this.contacts = new ContactsResource(this.core, this.#client);
 		this.audiences = new AudiencesResource(this.core, this.#client);
@@ -5276,6 +5406,24 @@ const EmailEventType = {
 	EmailUnsubscribed: "email.unsubscribed"
 };
 /**
+* Values of SMSErrorCode known at this SDK version. The wire value is an open
+* string: a value added by a newer server deserializes unchanged, so switch on
+* these with a `default` branch rather than treating the set as closed.
+*/
+const SMSErrorCode = {
+	BlockedByCarrier: "blocked_by_carrier",
+	BlockedByRecipient: "blocked_by_recipient",
+	ContentRejected: "content_rejected",
+	InsufficientBalance: "insufficient_balance",
+	InvalidDestination: "invalid_destination",
+	LandlineUnreachable: "landline_unreachable",
+	ProviderUnavailable: "provider_unavailable",
+	RecipientOptedOut: "recipient_opted_out",
+	SenderUnregistered: "sender_unregistered",
+	Unknown: "unknown",
+	Unreachable: "unreachable"
+};
+/**
 * Values of VerificationAttemptFailureReason known at this SDK version. The wire value is an open
 * string: a value added by a newer server deserializes unchanged, so switch on
 * these with a `default` branch rather than treating the set as closed.
@@ -5336,8 +5484,15 @@ const WhatsAppTemplateCategory = {
 * string: a value added by a newer server deserializes unchanged, so switch on
 * these with a `default` branch rather than treating the set as closed.
 */
-const WhatsAppTemplateParameterType = { Text: "text" };
+const WhatsAppTemplateParameterType = {
+	Document: "document",
+	Gif: "gif",
+	Image: "image",
+	Location: "location",
+	Text: "text",
+	Video: "video"
+};
 //#endregion
-export { BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, BirdWebhookVerificationError, EmailEventType, VerificationAttemptFailureReason, VerificationChannel, VerificationTerminalReason, WebhookEventType, WhatsAppErrorCode, WhatsAppTemplateCategory, WhatsAppTemplateParameterType, baseUrlForRegion, regionFromApiKey };
+export { BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, BirdWebhookVerificationError, EmailEventType, SMSErrorCode, VerificationAttemptFailureReason, VerificationChannel, VerificationTerminalReason, WebhookEventType, WhatsAppErrorCode, WhatsAppTemplateCategory, WhatsAppTemplateParameterType, baseUrlForRegion, regionFromApiKey };
 
 //# sourceMappingURL=index.mjs.map