@messagebird/sdk 0.7.6 → 0.8.1

package/dist/index.mjs

@@ -1936,6 +1936,120 @@ const listWhatsAppTemplates = (options) => (options?.client ?? client).get({
 	url: "/v1/whatsapp/templates",
 	...options
 });
+/**
+* List sending domains
+*
+* Returns all sending domains for the current workspace, ordered by creation date descending.
+*/
+const listDomains = (options) => (options?.client ?? client).get({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/email/domains",
+	...options
+});
+/**
+* Add a sending domain
+*
+* Registers a new sending domain and returns the DNS records required for verification: a DKIM TXT record, a return-path CNAME (which also covers SPF — no separate SPF record is needed), a DMARC policy, and, when a tracking domain is configured, a tracking CNAME. The domain starts in `pending` status; records are checked automatically once published, or on demand via the verify endpoint.
+*
+*/
+const createDomain = (options) => (options.client ?? client).post({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/email/domains",
+	...options,
+	headers: {
+		"Content-Type": "application/json",
+		...options.headers
+	}
+});
+/**
+* Delete a sending domain
+*
+* Removes the domain and revokes its sender authorization. New sends from a deleted domain are rejected. Historical statistics and events for past sends from this domain are preserved.
+*
+*/
+const deleteDomain = (options) => (options.client ?? client).delete({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/email/domains/{domain_id}",
+	...options
+});
+/**
+* Get a sending domain
+*
+* Returns the domain with current DNS verification status per record.
+*/
+const getDomain = (options) => (options.client ?? client).get({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/email/domains/{domain_id}",
+	...options
+});
+/**
+* Update a sending domain
+*
+* Updates settings and configuration on a sending domain. `settings` changes apply immediately. Changes to `return_path`, `tracking`, or `dkim` on a verified capability are staged: the current configuration keeps serving until the new one's DNS records verify, then the change is promoted automatically. Staged values are visible under `capabilities.*.pending`; the records to publish appear in `dns_records` with `state: pending`.
+*
+*/
+const updateDomain = (options) => (options.client ?? client).patch({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/email/domains/{domain_id}",
+	...options,
+	headers: {
+		"Content-Type": "application/json",
+		...options.headers
+	}
+});
+/**
+* Trigger domain verification
+*
+* Triggers an immediate DNS check and returns the updated verification result. Rate-limited to prevent DNS abuse (max 5 calls per domain per hour).
+*
+*/
+const verifyDomain = (options) => (options.client ?? client).post({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/email/domains/{domain_id}/verify",
+	...options
+});
 //#endregion
 //#region src/resources/base.ts
 var Resource = class {
@@ -2303,6 +2417,112 @@ var AudiencesResource = class extends Resource {
 	}
 };
 //#endregion
+//#region src/resources/domains.ts
+var DomainsResource = class extends Resource {
+	/**
+	* Register a sending domain. Returns it in `pending` with the `dns_records`
+	* to publish at your DNS provider; call `verify` once they are in place.
+	*
+	* @example Register a sending domain
+	* const domain = await bird.domains.create({ domain: "mail.acme.com" });
+	* console.log(domain.id, domain.status); // "dom_…", "pending"
+	*/
+	create(params, options) {
+		return this.call("POST", options, ({ signal, headers }) => createDomain({
+			client: this.client,
+			body: params,
+			headers,
+			signal
+		}));
+	}
+	/**
+	* List the workspace's sending domains, newest first. `await` resolves the
+	* first page; `for await` walks every domain across pages.
+	*
+	* @example
+	* for await (const domain of bird.domains.list()) {
+	*   console.log(domain.id, domain.status);
+	* }
+	*/
+	list(query, options) {
+		return this.paginated("GET", options, ({ signal, headers }, cursor) => listDomains({
+			client: this.client,
+			query: {
+				...query,
+				starting_after: cursor ?? query?.starting_after
+			},
+			headers,
+			signal
+		}));
+	}
+	/**
+	* Fetch a single sending domain by id, with its DNS records and their
+	* per-record verification state.
+	*
+	* @example
+	* const domain = await bird.domains.get("dom_01krdgeqcxet5s7t44vh8rt9mg");
+	*/
+	get(domainId, options) {
+		return this.call("GET", options, ({ signal, headers }) => getDomain({
+			client: this.client,
+			path: { domain_id: domainId },
+			headers,
+			signal
+		}));
+	}
+	/**
+	* Update a sending domain. Only the fields you send change; `settings` apply
+	* immediately, while `return_path`/`tracking`/`dkim` changes are staged until
+	* their new DNS records verify.
+	*
+	* @example
+	* await bird.domains.update("dom_01krdgeqcxet5s7t44vh8rt9mg", {
+	*   settings: { click_tracking: true, open_tracking: true },
+	*   tracking: { name: "links" },
+	* });
+	*/
+	update(domainId, params, options) {
+		return this.call("PATCH", options, ({ signal, headers }) => updateDomain({
+			client: this.client,
+			path: { domain_id: domainId },
+			body: params,
+			headers,
+			signal
+		}));
+	}
+	/**
+	* Delete a sending domain. Mail already accepted still sends; you can no
+	* longer send new mail from it.
+	*
+	* @example
+	* await bird.domains.delete("dom_01krdgeqcxet5s7t44vh8rt9mg");
+	*/
+	delete(domainId, options) {
+		return this.call("DELETE", options, ({ signal, headers }) => deleteDomain({
+			client: this.client,
+			path: { domain_id: domainId },
+			headers,
+			signal
+		}));
+	}
+	/**
+	* Trigger a fresh DNS check and return the refreshed domain with per-record
+	* results. Safe to repeat while waiting for DNS to propagate.
+	*
+	* @example
+	* const domain = await bird.domains.verify("dom_01krdgeqcxet5s7t44vh8rt9mg");
+	* console.log(domain.status); // "verified" once DNS is in place
+	*/
+	verify(domainId, options) {
+		return this.call("POST", options, ({ signal, headers }) => verifyDomain({
+			client: this.client,
+			path: { domain_id: domainId },
+			headers,
+			signal
+		}));
+	}
+};
+//#endregion
 //#region src/resources/contactProperties.ts
 var ContactPropertiesResource = class extends Resource {
 	/**
@@ -2922,6 +3142,8 @@ var BirdClient = class {
 	audiences;
 	/** Contact properties — `bird.contactProperties.create(...)`, `.list(...)`, `.archive(...)`, … */
 	contactProperties;
+	/** Sending domains — `bird.domains.create(...)`, `.list(...)`, `.verify(...)`, … */
+	domains;
 	/** Webhooks — `bird.webhooks.unwrap(payload, headers)` verifies an inbound delivery. */
 	webhooks;
 	constructor(options) {
@@ -2931,9 +3153,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.7.6`,
+			"User-Agent": `bird-sdk-js/0.8.1`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.7.6"
+			"Bird-Version": "0.8.1"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -2955,6 +3177,7 @@ var BirdClient = class {
 		this.contacts = new ContactsResource(this.core, this.#client);
 		this.audiences = new AudiencesResource(this.core, this.#client);
 		this.contactProperties = new ContactPropertiesResource(this.core, this.#client);
+		this.domains = new DomainsResource(this.core, this.#client);
 		this.webhooks = new WebhooksResource(opts.webhooks);
 	}
 	/**
@@ -3050,7 +3273,12 @@ const WebhookEventType = {
 	SmsFailed: "sms.failed",
 	SmsRejected: "sms.rejected",
 	SmsSent: "sms.sent",
-	SmsUndelivered: "sms.undelivered"
+	SmsUndelivered: "sms.undelivered",
+	WhatsappAccepted: "whatsapp.accepted",
+	WhatsappDelivered: "whatsapp.delivered",
+	WhatsappFailed: "whatsapp.failed",
+	WhatsappRead: "whatsapp.read",
+	WhatsappSent: "whatsapp.sent"
 };
 //#endregion
 export { BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, BirdWebhookVerificationError, WebhookEventType, baseUrlForRegion, regionFromApiKey };