samva 0.19.0 → 0.20.0

package/dist/client/sdk.gen.js

@@ -41,6 +41,10 @@ var Messages = class {
 				in: "query",
 				key: "from"
 			},
+			{
+				in: "query",
+				key: "namespaceId"
+			},
 			{
 				in: "query",
 				key: "after"
@@ -1081,7 +1085,7 @@ var Email = class {
 	/**
 	* List sending domains
 	*
-	* Returns the organization's sending domains, newest first. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. `sendable=true` lists only domains a send can use now: active, and verified, or verified before and degraded since. Each row carries `deliverability` (bounce and complaint rates over the last 24 hours, the window the 5% bounce limit is enforced over) and `series`, the last 14 days of daily email sends attributed to the domain, oldest first.
+	* Returns the organization's sending domains, newest first. A namespace-scoped key lists only its namespace's domains; an organization-wide caller lists every domain, or one namespace's with `namespaceId`. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. `sendable=true` lists only domains a send can use now: active, and verified, or verified before and degraded since. Each row carries `deliverability` (bounce and complaint rates over the last 24 hours, the window the 5% bounce limit is enforced over) and `series`, the last 14 days of daily email sends attributed to the domain, oldest first.
 	*/
 	static listDomains(parameters, options) {
 		const params = buildClientParams([parameters], [{ args: [
@@ -1096,6 +1100,10 @@ var Email = class {
 			{
 				in: "query",
 				key: "sendable"
+			},
+			{
+				in: "query",
+				key: "namespaceId"
 			}
 		] }]);
 		return (options?.client ?? client).get({
@@ -1111,16 +1119,23 @@ var Email = class {
 	/**
 	* Add a sending domain
 	*
-	* Registers a domain for sending and returns it with the DNS records required to verify ownership and configure DKIM. Responds with 201. Supplying a connection attaches the domain to that DNS account; the domain must sit inside the zone given with it. When Samva cannot register another sending domain right now, this responds with 429 and no domain is created. A banned organization is refused with 403.
+	* Registers a domain for sending and returns it with the DNS records required to verify ownership and configure DKIM. Responds with 201. Supplying a connection attaches the domain to that DNS account; the domain must sit inside the zone given with it. When Samva cannot register another sending domain right now, this responds with 429 and no domain is created. A banned organization is refused with 403. `namespaceId` places the domain in a namespace, and only that namespace's keys and organization-wide callers reach it; a namespace-scoped key always adds to its own namespace.
 	*/
 	static addDomain(parameters, options) {
-		const params = buildClientParams([parameters], [{ args: [{
-			in: "body",
-			key: "domain"
-		}, {
-			in: "body",
-			key: "connection"
-		}] }]);
+		const params = buildClientParams([parameters], [{ args: [
+			{
+				in: "body",
+				key: "domain"
+			},
+			{
+				in: "body",
+				key: "connection"
+			},
+			{
+				in: "body",
+				key: "namespaceId"
+			}
+		] }]);
 		return (options?.client ?? client).post({
 			security: [{
 				name: "x-api-key",
@@ -1661,7 +1676,7 @@ var Email = class {
 	/**
 	* List senders
 	*
-	* Returns senders, newest first, optionally filtered by verification status, active state, or default flag. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. Each row carries `deliverability` (bounce and complaint rates over the last 24 hours) and `series`, the last 14 days of daily email sends from the address, oldest first.
+	* Returns senders, newest first. A namespace-scoped key lists only its namespace's senders; an organization-wide caller lists every sender, or one namespace's with `namespaceId`. Optionally filtered by verification status, active state, or default flag. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page. Each row carries `deliverability` (bounce and complaint rates over the last 24 hours) and `series`, the last 14 days of daily email sends from the address, oldest first.
 	*/
 	static listSenders(parameters, options) {
 		const params = buildClientParams([parameters], [{ args: [
@@ -1684,6 +1699,10 @@ var Email = class {
 			{
 				in: "query",
 				key: "isDefault"
+			},
+			{
+				in: "query",
+				key: "namespaceId"
 			}
 		] }]);
 		return (options?.client ?? client).get({
@@ -1699,7 +1718,7 @@ var Email = class {
 	/**
 	* Add a sender
 	*
-	* Creates a sender. The required Idempotency-Key replays the original sender for an identical request and conflicts when reused with different input.
+	* Creates a sender. A sender on a domain takes the domain's namespace, and a `namespaceId` that names another namespace is refused; a sender with no domain joins `namespaceId`, or its key's namespace. A namespace-scoped key cannot add a sender on a domain outside its namespace. The required Idempotency-Key replays the original sender for an identical request and conflicts when reused with different input.
 	*/
 	static addSender(parameters, options) {
 		const params = buildClientParams([parameters], [{ args: [
@@ -1722,6 +1741,10 @@ var Email = class {
 			{
 				in: "body",
 				key: "replyToEmails"
+			},
+			{
+				in: "body",
+				key: "namespaceId"
 			}
 		] }]);
 		return (options?.client ?? client).post({
@@ -1800,9 +1823,9 @@ var Email = class {
 		});
 	}
 	/**
-	* Set the organization default sender
+	* Set the default sender
 	*
-	* Marks a verified, active sender as the organization default, atomically clearing any previous default. Omitted-`from` sends use it when neither the request nor the template names a `from`; with no default, the organization's sole verified sender is used.
+	* Marks a verified, active sender as the default of its scope, atomically clearing the previous default of the same scope: the organization level, or the sender's namespace. Omitted-`from` sends use it when neither the request nor the template names a `from`; with no default, the organization's sole verified sender is used.
 	*/
 	static setDefaultSender(parameters, options) {
 		const params = buildClientParams([parameters], [{ args: [{
@@ -3419,6 +3442,10 @@ var Contacts = class {
 				in: "query",
 				key: "cursor"
 			},
+			{
+				in: "query",
+				key: "namespaceId"
+			},
 			{
 				in: "query",
 				key: "search"
@@ -3465,6 +3492,10 @@ var Contacts = class {
 	*/
 	static create(parameters, options) {
 		const params = buildClientParams([parameters], [{ args: [
+			{
+				in: "body",
+				key: "namespaceId"
+			},
 			{
 				in: "body",
 				key: "name"
@@ -3532,6 +3563,10 @@ var Contacts = class {
 	*/
 	static find(parameters, options) {
 		const params = buildClientParams([parameters], [{ args: [
+			{
+				in: "body",
+				key: "namespaceId"
+			},
 			{
 				in: "body",
 				key: "email"
@@ -3566,13 +3601,20 @@ var Contacts = class {
 	* Looks up exactly one identifier through `lookup: { type, value }`. Returns `{ contact, created: false }` unchanged when it exists. Otherwise creates the lookup identity (or external ID), applies `create` attributes, and returns `{ contact, created: true }`. Additional addresses belong in `create.identities`, custom fields in `create.profile.customFields`; custom field keys must be defined and values must match their types. An external ID lookup cannot be contradicted by `create.externalId`. Creation returns HTTP 409 ConflictError if an externalId or address belongs to another contact; the conflicting field is named and no contact is created. Use the update endpoint to change an existing contact.
 	*/
 	static findOrCreate(parameters, options) {
-		const params = buildClientParams([parameters], [{ args: [{
-			in: "body",
-			key: "lookup"
-		}, {
-			in: "body",
-			key: "create"
-		}] }]);
+		const params = buildClientParams([parameters], [{ args: [
+			{
+				in: "body",
+				key: "namespaceId"
+			},
+			{
+				in: "body",
+				key: "lookup"
+			},
+			{
+				in: "body",
+				key: "create"
+			}
+		] }]);
 		return (options?.client ?? client).post({
 			security: [{
 				name: "x-api-key",
@@ -3886,13 +3928,20 @@ var Contacts = class {
 	* Creates contacts in bulk from a list of entries shaped like a create request, returning per-entry results with created, updated, skipped, and error counts. An entry whose identities match an existing contact is skipped, or updates it with `onConflict: "update"`.
 	*/
 	static bulkImport(parameters, options) {
-		const params = buildClientParams([parameters], [{ args: [{
-			in: "body",
-			key: "contacts"
-		}, {
-			in: "body",
-			key: "onConflict"
-		}] }]);
+		const params = buildClientParams([parameters], [{ args: [
+			{
+				in: "body",
+				key: "namespaceId"
+			},
+			{
+				in: "body",
+				key: "contacts"
+			},
+			{
+				in: "body",
+				key: "onConflict"
+			}
+		] }]);
 		return (options?.client ?? client).post({
 			security: [{
 				name: "x-api-key",
@@ -5543,6 +5592,10 @@ var Templates = class {
 			{
 				in: "query",
 				key: "projectId"
+			},
+			{
+				in: "query",
+				key: "namespaceId"
 			}
 		] }]);
 		return (options?.client ?? client).get({
@@ -5594,6 +5647,10 @@ var Templates = class {
 				in: "body",
 				key: "isActive"
 			},
+			{
+				in: "body",
+				key: "namespaceId"
+			},
 			{
 				in: "body",
 				key: "idempotencyKey"
@@ -7553,7 +7610,7 @@ var Mailboxes = class {
 	/**
 	* Create a mailbox
 	*
-	* Creates a mailbox with one endpoint and returns it with status 201; the caller gets an admin grant on it. Email is the channel a mailbox endpoint uses today; another channel is refused (422). An email endpoint's address must be under the organization's Samva-hosted mail domain or a verified domain with receiving enabled, and the mailbox sends from it. The slug defaults to the address's local part. Pass `slug` when that is taken or not a valid slug. The mailbox receives mail from now on; mail that arrived earlier is not added to it. Conflicts if the address or slug is already in use. Returns 402 when the organization is at its plan's mailbox allowance or at its mailbox storage allowance; incoming mail is still received past the storage allowance.
+	* Creates a mailbox with one endpoint and returns it with status 201; the caller gets an admin grant on it. An email endpoint's address must be under the organization's Samva-hosted mail domain or a verified domain with receiving enabled, and the mailbox sends from it. A phone endpoint's address is a number the organization connected on that channel, in E.164 form. The slug defaults to the address's local part, or a phone number's digits. Pass `slug` when that is taken or not a valid slug. The mailbox receives mail from now on; mail that arrived earlier is not added to it. Conflicts if the address or slug is already in use. Returns 402 when the organization is at its plan's mailbox allowance or at its mailbox storage allowance; incoming mail is still received past the storage allowance.
 	*/
 	static create(parameters, options) {
 		const params = buildClientParams([parameters], [{ args: [
@@ -7671,7 +7728,7 @@ var Mailboxes = class {
 	/**
 	* Add an endpoint to a mailbox
 	*
-	* Adds an endpoint to a mailbox and returns the mailbox with status 201. It follows the same rules as the endpoint of a new mailbox: email is the channel a mailbox endpoint uses today (422 otherwise), the address must be under the organization's Samva-hosted mail domain or a verified domain with receiving enabled, and no mailbox may already hold it (409). Messages sent to it reach the mailbox from now on. It becomes the default on its channel only when the mailbox has no endpoint there yet.
+	* Adds an endpoint to a mailbox and returns the mailbox with status 201. It follows the same rules as the endpoint of a new mailbox: an email address must be under the organization's Samva-hosted mail domain or a verified domain with receiving enabled, a phone number must be one the organization connected on that channel, and no mailbox may already hold it (409). Messages sent to it reach the mailbox from now on. It becomes the default on its channel only when the mailbox has no endpoint there yet.
 	*/
 	static createEndpoint(parameters, options) {
 		const params = buildClientParams([parameters], [{ args: [
@@ -8698,7 +8755,7 @@ var Mailboxes = class {
 	/**
 	* Send a new message
 	*
-	* Starts a new conversation from the mailbox's default endpoint on the channel the body names (email when omitted); a channel the mailbox cannot send on yet is refused (422). Records a send action and returns 202 with its current receipt and a Location for action status. An installation, grant, or policy may require approval; otherwise the send is queued. Observe the same action through acceptance and mailbox completion. A policy refusal returns 403 with the recorded receipt.
+	* Starts a new conversation from the mailbox's default endpoint on the channel the body names (email when omitted); a mailbox with no endpoint on that channel is refused (422). A message to a number joins the mailbox's thread with that number when it has one. Records a send action and returns 202 with its current receipt and a Location for action status. An installation, grant, or policy may require approval; otherwise the send is queued. Observe the same action through acceptance and mailbox completion. A policy refusal returns 403 with the recorded receipt.
 	*/
 	static sendMessage(parameters, options) {
 		const params = buildClientParams([parameters], [{ args: [
@@ -8871,7 +8928,7 @@ var Mailboxes = class {
 	/**
 	* Reply to a message
 	*
-	* Replies to the message's Reply-To address, or its sender, in the same thread and from the thread's endpoint. The server sets the recipients, subject, and threading headers. The body's `channel` must match the thread's.
+	* Replies to the message's Reply-To address, or its sender, in the same thread and from the thread's endpoint. The server sets the recipients, subject, and threading headers. The body's `channel` must match the thread's. On a phone channel the reply goes to the number on the other side of the thread.
 	*/
 	static reply(parameters, options) {
 		const params = buildClientParams([parameters], [{ args: [
@@ -8930,7 +8987,7 @@ var Mailboxes = class {
 	/**
 	* Reply to all recipients of a message
 	*
-	* Replies to the sender and every other recipient of the message except the mailbox itself, in the same thread and from the thread's endpoint.
+	* Replies to the sender and every other recipient of the message except the mailbox itself, in the same thread and from the thread's endpoint. A phone thread has one other side, so it answers like a reply.
 	*/
 	static replyAll(parameters, options) {
 		const params = buildClientParams([parameters], [{ args: [
@@ -9166,7 +9223,7 @@ var Mailboxes = class {
 	/**
 	* Create a draft
 	*
-	* Saves a draft of a new message, or of a reply when `inReplyToMessageId` names a message in the mailbox, and returns it with status 201. Email drafts are the kind a mailbox saves today; another channel is refused (422). Send it with `POST /v1/mailboxes/{id}/drafts/{draftId}/send`.
+	* Saves a draft of a new message, or of a reply when `inReplyToMessageId` names a message in the mailbox, and returns it with status 201. A phone channel's draft holds a recipient number and text. Send it with `POST /v1/mailboxes/{id}/drafts/{draftId}/send`.
 	*/
 	static createDraft(parameters, options) {
 		const params = buildClientParams([parameters], [{ args: [
@@ -9651,7 +9708,7 @@ var Namespaces = class {
 	/**
 	* Delete a namespace
 	*
-	* Deletes an empty namespace. A namespace that still holds mailboxes, API keys, or webhook endpoints conflicts: remove them first.
+	* Deletes an empty namespace. A namespace that still holds anything conflicts, and the error counts what remains: mailboxes, API keys, webhook endpoints filtered to it, domains, senders, contacts, or template projects. Delete each, or return it to organization level with `DELETE /v1/namespaces/{id}/resources/{type}/{resourceId}`; mailboxes, keys, and webhook endpoints cannot move and are deleted. Messages keep the namespace they ran in.
 	*/
 	static remove(parameters, options) {
 		const params = buildClientParams([parameters], [{ args: [{
@@ -9723,6 +9780,101 @@ var Namespaces = class {
 			}
 		});
 	}
+	/**
+	* Move a resource into a namespace
+	*
+	* Moves a resource from organization level or another namespace into this one. A domain brings its senders; a sender on a domain cannot move alone (assign the domain); a contact brings its identities; a template brings every template in its project. A moved resource stops being a default. An address or external id the namespace already holds conflicts. Keys scoped to the old namespace stop reaching the resource at once. Mailboxes, API keys, and webhook endpoints keep the namespace they were created in.
+	*/
+	static assignResource(parameters, options) {
+		const params = buildClientParams([parameters], [{ args: [
+			{
+				in: "path",
+				key: "id"
+			},
+			{
+				in: "body",
+				key: "type"
+			},
+			{
+				in: "body",
+				key: "resourceId"
+			}
+		] }]);
+		return (options?.client ?? client).post({
+			security: [{
+				name: "x-api-key",
+				type: "apiKey"
+			}],
+			url: "/v1/namespaces/{id}/resources",
+			...options,
+			...params,
+			headers: {
+				"Content-Type": "application/json",
+				...options?.headers,
+				...params.headers
+			}
+		});
+	}
+	/**
+	* Return a resource to organization level
+	*
+	* Moves a resource out of this namespace to organization level, with what follows it as in `POST /v1/namespaces/{id}/resources`. A resource in a different namespace is not found.
+	*/
+	static removeResource(parameters, options) {
+		const params = buildClientParams([parameters], [{ args: [
+			{
+				in: "path",
+				key: "id"
+			},
+			{
+				in: "path",
+				key: "type"
+			},
+			{
+				in: "path",
+				key: "resourceId"
+			}
+		] }]);
+		return (options?.client ?? client).delete({
+			security: [{
+				name: "x-api-key",
+				type: "apiKey"
+			}],
+			url: "/v1/namespaces/{id}/resources/{type}/{resourceId}",
+			...options,
+			...params
+		});
+	}
+	/**
+	* Get namespace usage
+	*
+	* Counts the messages the namespace sent and received in the window that count toward usage, by channel, with the same statuses as `GET /v1/organizations/usage`. A message counts toward the namespace it was sent or received in: that of the sender, mailbox, or key it used. The organization is billed for every namespace; read this to charge your own customer.
+	*/
+	static getUsage(parameters, options) {
+		const params = buildClientParams([parameters], [{ args: [
+			{
+				in: "path",
+				key: "id"
+			},
+			{
+				in: "query",
+				key: "after"
+			},
+			{
+				in: "query",
+				key: "before"
+			}
+		] }]);
+		return (options?.client ?? client).get({
+			security: [{
+				name: "x-api-key",
+				type: "apiKey"
+			}],
+			url: "/v1/namespaces/{id}/usage",
+			...options,
+			...params
+		});
+	}
 };
 var Extensions = class {
 	/**