@toshicloud/sdk 0.5.1 → 0.7.0

package/dist/client.js

@@ -4,7 +4,7 @@ import { executeCommand } from "./execute.js";
 import { AccountService } from "./gen/toshi/workspace/v1/account_pb.js";
 import { ArtifactService, ArtifactUploadService } from "./gen/toshi/workspace/v1/artifacts_pb.js";
 import { AuditEventService } from "./gen/toshi/workspace/v1/audit_events_pb.js";
-import { ChannelService } from "./gen/toshi/workspace/v1/channels_pb.js";
+import { EndpointService } from "./gen/toshi/workspace/v1/endpoints_pb.js";
 import { ConnectionService } from "./gen/toshi/workspace/v1/connections_pb.js";
 import { DiscoveryService } from "./gen/toshi/workspace/v1/discovery_pb.js";
 import { DisplayService } from "./gen/toshi/workspace/v1/display_pb.js";
@@ -14,6 +14,7 @@ import { GrantService } from "./gen/toshi/workspace/v1/grants_pb.js";
 import { ImageService } from "./gen/toshi/workspace/v1/images_pb.js";
 import { HostJobService } from "./gen/toshi/workspace/v1/hostjobs_pb.js";
 import { HostService } from "./gen/toshi/workspace/v1/hosts_pb.js";
+import { ModelCredentialService } from "./gen/toshi/workspace/v1/model_credentials_pb.js";
 import { ProductService } from "./gen/toshi/workspace/v1/products_pb.js";
 import { ProjectService } from "./gen/toshi/workspace/v1/projects_pb.js";
 import { RecordingService } from "./gen/toshi/workspace/v1/recordings_pb.js";
@@ -26,8 +27,8 @@ import { VolumeService } from "./gen/toshi/workspace/v1/volumes_pb.js";
 import { WebhookService } from "./gen/toshi/workspace/v1/webhook_pb.js";
 import { WorkspaceService } from "./gen/toshi/workspace/v1/workspace_service_pb.js";
 import { CreatePreviewShareLinkRequestSchema, ListPreviewShareLinksRequestSchema, RevokePreviewShareLinkRequestSchema, StartSandboxRequestSchema, StopSandboxRequestSchema, } from "./gen/toshi/workspace/v1/workspace_pb.js";
-import { CancelJobRequestSchema, CreateJobRequestSchema, CreateSandboxRequestSchema, CreateServiceRequestSchema, DeleteJobRequestSchema, DeleteSandboxRequestSchema, DeleteServiceRequestSchema, GetJobRequestSchema, GetSandboxRequestSchema, GetServiceRequestSchema, ListJobsRequestSchema, ListSandboxesRequestSchema, ListServicesRequestSchema, UpdateJobRequestSchema, UpdateSandboxRequestSchema, UpdateServiceRequestSchema, WaitJobRequestSchema, WaitSandboxRequestSchema, WaitServiceRequestSchema, WatchJobsRequestSchema, WatchSandboxesRequestSchema, WatchServicesRequestSchema, WorkloadService, } from "./gen/toshi/workspace/v1/workloads_pb.js";
-import { ExecuteStartSchema, GetOperationRequestSchema, GetServiceRevisionRequestSchema, HoldServiceRequestSchema, ListEventsRequestSchema, ListServiceActivationsRequestSchema, ListServiceRevisionsRequestSchema, ListServiceRunsRequestSchema, ReleaseServiceRequestSchema, RollbackServiceRequestSchema, SetServiceModeRequestSchema, StartServiceRequestSchema, StopServiceRequestSchema, WaitOperationRequestSchema, WakeServiceRequestSchema, WatchEventsRequestSchema, WatchOutputRequestSchema, } from "./gen/toshi/workspace/v1/workspace_pb.js";
+import { CancelJobRequestSchema, CreateJobRequestSchema, CreateSandboxRequestSchema, CreateServiceRequestSchema, DeleteJobRequestSchema, DeleteSandboxRequestSchema, DeleteServiceAlarmRequestSchema, DeleteServiceRequestSchema, EmitWorkloadEventRequestSchema, GetJobRequestSchema, GetSandboxRequestSchema, GetServiceAlarmRequestSchema, GetServiceRequestSchema, ListJobsRequestSchema, ListSandboxesRequestSchema, ListServiceAlarmsRequestSchema, ListServicesRequestSchema, PauseServiceAlarmRequestSchema, ResumeServiceAlarmRequestSchema, RunServiceAlarmNowRequestSchema, SetServiceAlarmRequestSchema, UpdateJobRequestSchema, UpdateSandboxRequestSchema, UpdateServiceRequestSchema, WaitJobRequestSchema, WaitSandboxRequestSchema, WaitServiceRequestSchema, WatchJobsRequestSchema, WatchSandboxesRequestSchema, WatchServicesRequestSchema, WorkloadService, } from "./gen/toshi/workspace/v1/workloads_pb.js";
+import { AnswerServiceSignInRequestSchema, CancelServiceSignInRequestSchema, ExecuteStartSchema, GetOperationRequestSchema, GetServiceRevisionRequestSchema, GetServiceSignInStatusRequestSchema, HoldServiceRequestSchema, HoldWorkloadRequestSchema, ListEventsRequestSchema, ListServiceActivationsRequestSchema, ListServiceRevisionsRequestSchema, ListServiceRunsRequestSchema, ReleaseServiceRequestSchema, ReleaseWorkloadRequestSchema, RollbackServiceRequestSchema, SetServiceModeRequestSchema, StartServiceRequestSchema, StartServiceSignInRequestSchema, StopServiceRequestSchema, WaitOperationRequestSchema, WakeServiceRequestSchema, WatchEventsRequestSchema, WatchOutputRequestSchema, } from "./gen/toshi/workspace/v1/workspace_pb.js";
 import { openOutputWatch } from "./output.js";
 import { paginate } from "./paginate.js";
 import { authInterceptor, keyInterceptor, refusalInterceptor, retryInterceptor, scopeInterceptor, } from "./interceptors.js";
@@ -62,7 +63,7 @@ export function createToshiClient(options) {
         secret: createClient(SecretService, transport),
         webhook: createClient(WebhookService, transport),
         display: createClient(DisplayService, transport),
-        channel: createClient(ChannelService, transport),
+        endpoint: createClient(EndpointService, transport),
         recording: createClient(RecordingService, transport),
         volume: createClient(VolumeService, transport),
         artifact: createClient(ArtifactService, transport),
@@ -118,11 +119,25 @@ export function createToshiClient(options) {
                 getRevision: (req, opts) => workloadService.getServiceRevision(req, opts),
                 rollback: (req, opts) => workloadService.rollbackService(req, opts),
                 listActivations: (req, opts) => workloadService.listServiceActivations(req, opts),
+                setAlarm: (req, opts) => workloadService.setServiceAlarm(req, opts),
+                getAlarm: (req, opts) => workloadService.getServiceAlarm(req, opts),
+                listAlarms: (req, opts) => workloadService.listServiceAlarms(req, opts),
+                deleteAlarm: (req, opts) => workloadService.deleteServiceAlarm(req, opts),
+                pauseAlarm: (req, opts) => workloadService.pauseServiceAlarm(req, opts),
+                resumeAlarm: (req, opts) => workloadService.resumeServiceAlarm(req, opts),
+                runAlarmNow: (req, opts) => workloadService.runServiceAlarmNow(req, opts),
+                startSignIn: (req, opts) => workloadService.startServiceSignIn(req, opts),
+                answerSignIn: (req, opts) => workloadService.answerServiceSignIn(req, opts),
+                cancelSignIn: (req, opts) => workloadService.cancelServiceSignIn(req, opts),
+                getSignInStatus: (req, opts) => workloadService.getServiceSignInStatus(req, opts),
             },
             waitOperation: (req, opts) => waitOperation(workloadService, create(WaitOperationRequestSchema, req), opts),
             listEvents: (req, opts) => workloadService.listEvents(req, opts),
             allEvents: (req, opts) => paginate(req, workloadService.listEvents, (resp) => resp.events, opts),
             watchEvents: (req, opts) => openEventWatch(workloadService, retry, create(WatchEventsRequestSchema, req), opts),
+            emitEvent: (req, opts) => workloadService.emitWorkloadEvent(req, opts),
+            holdWorkload: (req, opts) => workloadService.holdWorkload(req, opts),
+            releaseWorkload: (req, opts) => workloadService.releaseWorkload(req, opts),
             getOperation: (req, opts) => workloadService.getOperation(req, opts),
         },
         run: (req, opts) => runJob(workloadService, retry, create(CreateJobRequestSchema, req), opts),
@@ -142,5 +157,6 @@ export function createToshiClient(options) {
         account: createClient(AccountService, transport),
         image: createClient(ImageService, transport),
         domain: createClient(DomainService, transport),
+        modelCredential: createClient(ModelCredentialService, transport),
     };
 }

package/dist/gen/toshi/permission_pb.d.ts

@@ -232,6 +232,18 @@ export declare const by_field: GenExtension<MethodOptions, boolean>;
  * @generated from extension: toshi.MCP mcp = 51005;
  */
 export declare const mcp: GenExtension<MethodOptions, MCP>;
+/**
+ * own marks a call a member may make for what is their own with
+ * membership alone. A caller who holds a role in the workspace but not the
+ * method's permission is admitted for their own resources only: the
+ * handler refuses any other resource, as the permission check would, with
+ * PERMISSION_MISSING, and a list holds only the caller's own. A caller
+ * with the permission is admitted as usual. A call that acts for no
+ * person needs the permission.
+ *
+ * @generated from extension: bool own = 51006;
+ */
+export declare const own: GenExtension<MethodOptions, boolean>;
 /**
  * field_permission names what a caller needs to change the field through
  * the mask of an update call marked by_field: a field group of its own,

package/dist/gen/toshi/permission_pb.js

@@ -6,7 +6,7 @@ import { file_google_protobuf_descriptor } from "@bufbuild/protobuf/wkt";
 /**
  * Describes the file toshi/permission.proto.
  */
-export const file_toshi_permission = /*@__PURE__*/ fileDesc("ChZ0b3NoaS9wZXJtaXNzaW9uLnByb3RvEgV0b3NoaSInCgVBdWRpdBIOCgZhY3Rpb24YASABKAkSDgoGdGFyZ2V0GAIgASgJIrYBCgNNQ1ASFgoJcmVhZF9vbmx5GAEgASgISACIAQESGAoLZGVzdHJ1Y3RpdmUYAiABKAhIAYgBARIXCgppZGVtcG90ZW50GAMgASgISAKIAQESFwoKb3Blbl93b3JsZBgEIAEoCEgDiAEBEg8KB2V4Y2x1ZGUYBSABKAhCDAoKX3JlYWRfb25seUIOCgxfZGVzdHJ1Y3RpdmVCDQoLX2lkZW1wb3RlbnRCDQoLX29wZW5fd29ybGQ6QAoKcGVybWlzc2lvbhIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGLiOAyABKAlSCnBlcm1pc3Npb246NgoFc2NvcGUSHi5nb29nbGUucHJvdG9idWYuTWV0aG9kT3B0aW9ucxi5jgMgASgJUgVzY29wZTpECgVhdWRpdBIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGLqOAyABKAsyDC50b3NoaS5BdWRpdFIFYXVkaXQ6OwoIYnlfZmllbGQSHi5nb29nbGUucHJvdG9idWYuTWV0aG9kT3B0aW9ucxi8jgMgASgIUgdieUZpZWxkOj4KA21jcBIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGL2OAyABKAsyCi50b3NoaS5NQ1BSA21jcDpKChBmaWVsZF9wZXJtaXNzaW9uEh0uZ29vZ2xlLnByb3RvYnVmLkZpZWxkT3B0aW9ucxi7jgMgASgJUg9maWVsZFBlcm1pc3Npb25CHlocZ28udG9zaGljbG91ZC5pby9hcGkvdG9zaGlwYmIGcHJvdG8z", [file_google_protobuf_descriptor]);
+export const file_toshi_permission = /*@__PURE__*/ fileDesc("ChZ0b3NoaS9wZXJtaXNzaW9uLnByb3RvEgV0b3NoaSInCgVBdWRpdBIOCgZhY3Rpb24YASABKAkSDgoGdGFyZ2V0GAIgASgJIrYBCgNNQ1ASFgoJcmVhZF9vbmx5GAEgASgISACIAQESGAoLZGVzdHJ1Y3RpdmUYAiABKAhIAYgBARIXCgppZGVtcG90ZW50GAMgASgISAKIAQESFwoKb3Blbl93b3JsZBgEIAEoCEgDiAEBEg8KB2V4Y2x1ZGUYBSABKAhCDAoKX3JlYWRfb25seUIOCgxfZGVzdHJ1Y3RpdmVCDQoLX2lkZW1wb3RlbnRCDQoLX29wZW5fd29ybGQ6QAoKcGVybWlzc2lvbhIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGLiOAyABKAlSCnBlcm1pc3Npb246NgoFc2NvcGUSHi5nb29nbGUucHJvdG9idWYuTWV0aG9kT3B0aW9ucxi5jgMgASgJUgVzY29wZTpECgVhdWRpdBIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGLqOAyABKAsyDC50b3NoaS5BdWRpdFIFYXVkaXQ6OwoIYnlfZmllbGQSHi5nb29nbGUucHJvdG9idWYuTWV0aG9kT3B0aW9ucxi8jgMgASgIUgdieUZpZWxkOj4KA21jcBIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGL2OAyABKAsyCi50b3NoaS5NQ1BSA21jcDoyCgNvd24SHi5nb29nbGUucHJvdG9idWYuTWV0aG9kT3B0aW9ucxi+jgMgASgIUgNvd246SgoQZmllbGRfcGVybWlzc2lvbhIdLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE9wdGlvbnMYu44DIAEoCVIPZmllbGRQZXJtaXNzaW9uQh5aHGdvLnRvc2hpY2xvdWQuaW8vYXBpL3Rvc2hpcGJiBnByb3RvMw", [file_google_protobuf_descriptor]);
 /**
  * Describes the message toshi.Audit.
  * Use `create(AuditSchema)` to create a new message.
@@ -82,6 +82,18 @@ export const by_field = /*@__PURE__*/ extDesc(file_toshi_permission, 3);
  * @generated from extension: toshi.MCP mcp = 51005;
  */
 export const mcp = /*@__PURE__*/ extDesc(file_toshi_permission, 4);
+/**
+ * own marks a call a member may make for what is their own with
+ * membership alone. A caller who holds a role in the workspace but not the
+ * method's permission is admitted for their own resources only: the
+ * handler refuses any other resource, as the permission check would, with
+ * PERMISSION_MISSING, and a list holds only the caller's own. A caller
+ * with the permission is admitted as usual. A call that acts for no
+ * person needs the permission.
+ *
+ * @generated from extension: bool own = 51006;
+ */
+export const own = /*@__PURE__*/ extDesc(file_toshi_permission, 5);
 /**
  * field_permission names what a caller needs to change the field through
  * the mask of an update call marked by_field: a field group of its own,
@@ -91,4 +103,4 @@ export const mcp = /*@__PURE__*/ extDesc(file_toshi_permission, 4);
  *
  * @generated from extension: string field_permission = 51003;
  */
-export const field_permission = /*@__PURE__*/ extDesc(file_toshi_permission, 5);
+export const field_permission = /*@__PURE__*/ extDesc(file_toshi_permission, 6);

package/dist/gen/toshi/workspace/v1/connections_pb.d.ts

@@ -1,5 +1,6 @@
 import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
 import type { Duration, DurationJson, FieldMask, FieldMaskJson, Timestamp, TimestampJson } from "@bufbuild/protobuf/wkt";
+import type { DomainRecord, DomainRecordJson } from "./domains_pb.js";
 import type { Message } from "@bufbuild/protobuf";
 /**
  * Describes the file toshi/workspace/v1/connections.proto.
@@ -20,15 +21,15 @@ export type Connection = Message<"toshi.workspace.v1.Connection"> & {
      */
     kind: ConnectionKind;
     /**
-     * Unique among the workspace's WEBHOOK connections; for GITHUB, the
-     * login of the account the App is installed on.
+     * Unique among the workspace's live connections of its kind, WEBHOOK or
+     * MAIL; for GITHUB, the login of the account the App is installed on.
      *
      * @generated from field: string name = 3;
      */
     name: string;
     /**
-     * The project and environment a WEBHOOK connection's events belong to;
-     * empty for GITHUB, whose events belong to their repository's project.
+     * The project and environment a WEBHOOK or MAIL connection's events belong
+     * to; empty for GITHUB, whose events belong to their repository's project.
      *
      * @generated from field: string project = 4;
      */
@@ -64,8 +65,8 @@ export type Connection = Message<"toshi.workspace.v1.Connection"> & {
     /**
      * The inbound address a WEBHOOK connection's sender POSTs to: the
      * deployment's public address and /ingress/ with the connection's
-     * address token. Empty for GITHUB, and when the deployment names no
-     * public address.
+     * address token. Empty for GITHUB and MAIL, and when the deployment names
+     * no public address.
      *
      * @generated from field: string ingress_url = 11;
      */
@@ -100,6 +101,13 @@ export type Connection = Message<"toshi.workspace.v1.Connection"> & {
      * @generated from field: string manifest_origin = 15;
      */
     manifestOrigin: string;
+    /**
+     * Where a MAIL connection receives mail and where it sends it; unset for
+     * the other kinds.
+     *
+     * @generated from field: toshi.workspace.v1.MailConnection mail = 16;
+     */
+    mail?: MailConnection | undefined;
 };
 /**
  * Connection is one source of a workspace's events.
@@ -116,15 +124,15 @@ export type ConnectionJson = {
      */
     kind?: ConnectionKindJson;
     /**
-     * Unique among the workspace's WEBHOOK connections; for GITHUB, the
-     * login of the account the App is installed on.
+     * Unique among the workspace's live connections of its kind, WEBHOOK or
+     * MAIL; for GITHUB, the login of the account the App is installed on.
      *
      * @generated from field: string name = 3;
      */
     name?: string;
     /**
-     * The project and environment a WEBHOOK connection's events belong to;
-     * empty for GITHUB, whose events belong to their repository's project.
+     * The project and environment a WEBHOOK or MAIL connection's events belong
+     * to; empty for GITHUB, whose events belong to their repository's project.
      *
      * @generated from field: string project = 4;
      */
@@ -160,8 +168,8 @@ export type ConnectionJson = {
     /**
      * The inbound address a WEBHOOK connection's sender POSTs to: the
      * deployment's public address and /ingress/ with the connection's
-     * address token. Empty for GITHUB, and when the deployment names no
-     * public address.
+     * address token. Empty for GITHUB and MAIL, and when the deployment names
+     * no public address.
      *
      * @generated from field: string ingress_url = 11;
      */
@@ -196,6 +204,13 @@ export type ConnectionJson = {
      * @generated from field: string manifest_origin = 15;
      */
     manifestOrigin?: string;
+    /**
+     * Where a MAIL connection receives mail and where it sends it; unset for
+     * the other kinds.
+     *
+     * @generated from field: toshi.workspace.v1.MailConnection mail = 16;
+     */
+    mail?: MailConnectionJson;
 };
 /**
  * Describes the message toshi.workspace.v1.Connection.
@@ -204,6 +219,200 @@ export type ConnectionJson = {
 export declare const ConnectionSchema: GenMessage<Connection, {
     jsonType: ConnectionJson;
 }>;
+/**
+ * MailConnection is where a MAIL connection receives mail and where it
+ * sends it.
+ *
+ * @generated from message toshi.workspace.v1.MailConnection
+ */
+export type MailConnection = Message<"toshi.workspace.v1.MailConnection"> & {
+    /**
+     * Output only. The lowercase address mail is received at: the connection's
+     * name at its custom domain, or at the workspace's name under the
+     * deployment's inbound mail domain when no custom domain is set.
+     *
+     * @generated from field: string address = 1;
+     */
+    address: string;
+    /**
+     * The service, by its ID, whose event endpoint the mail goes to.
+     *
+     * @generated from field: string service = 2;
+     */
+    service: string;
+    /**
+     * The name of that service's event endpoint.
+     *
+     * @generated from field: string endpoint = 3;
+     */
+    endpoint: string;
+    /**
+     * Output only. The mail provider that receives for the address, such as
+     * "ses".
+     *
+     * @generated from field: string provider = 4;
+     */
+    provider: string;
+    /**
+     * A custom mail domain, lowercase in ASCII. Empty uses the deployment's
+     * inbound mail domain.
+     *
+     * @generated from field: string domain = 5;
+     */
+    domain: string;
+    /**
+     * Output only. The custom domain's checks and required DNS records; unset
+     * when the connection uses the deployment's inbound mail domain.
+     *
+     * @generated from field: toshi.workspace.v1.MailDomainStatus domain_status = 6;
+     */
+    domainStatus?: MailDomainStatus | undefined;
+};
+/**
+ * MailConnection is where a MAIL connection receives mail and where it
+ * sends it.
+ *
+ * @generated from message toshi.workspace.v1.MailConnection
+ */
+export type MailConnectionJson = {
+    /**
+     * Output only. The lowercase address mail is received at: the connection's
+     * name at its custom domain, or at the workspace's name under the
+     * deployment's inbound mail domain when no custom domain is set.
+     *
+     * @generated from field: string address = 1;
+     */
+    address?: string;
+    /**
+     * The service, by its ID, whose event endpoint the mail goes to.
+     *
+     * @generated from field: string service = 2;
+     */
+    service?: string;
+    /**
+     * The name of that service's event endpoint.
+     *
+     * @generated from field: string endpoint = 3;
+     */
+    endpoint?: string;
+    /**
+     * Output only. The mail provider that receives for the address, such as
+     * "ses".
+     *
+     * @generated from field: string provider = 4;
+     */
+    provider?: string;
+    /**
+     * A custom mail domain, lowercase in ASCII. Empty uses the deployment's
+     * inbound mail domain.
+     *
+     * @generated from field: string domain = 5;
+     */
+    domain?: string;
+    /**
+     * Output only. The custom domain's checks and required DNS records; unset
+     * when the connection uses the deployment's inbound mail domain.
+     *
+     * @generated from field: toshi.workspace.v1.MailDomainStatus domain_status = 6;
+     */
+    domainStatus?: MailDomainStatusJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.MailConnection.
+ * Use `create(MailConnectionSchema)` to create a new message.
+ */
+export declare const MailConnectionSchema: GenMessage<MailConnection, {
+    jsonType: MailConnectionJson;
+}>;
+/**
+ * MailDomainStatus describes the checks and DNS records of a custom domain.
+ *
+ * @generated from message toshi.workspace.v1.MailDomainStatus
+ */
+export type MailDomainStatus = Message<"toshi.workspace.v1.MailDomainStatus"> & {
+    /**
+     * @generated from field: toshi.workspace.v1.MailDomainState state = 1;
+     */
+    state: MailDomainState;
+    /**
+     * @generated from field: toshi.workspace.v1.MailDomainCheck ownership = 2;
+     */
+    ownership: MailDomainCheck;
+    /**
+     * @generated from field: toshi.workspace.v1.MailDomainCheck mx = 3;
+     */
+    mx: MailDomainCheck;
+    /**
+     * @generated from field: toshi.workspace.v1.MailDomainCheck provider = 4;
+     */
+    provider: MailDomainCheck;
+    /**
+     * The ownership TXT, inbound MX and provider records, in that order.
+     *
+     * @generated from field: repeated toshi.workspace.v1.DomainRecord records = 5;
+     */
+    records: DomainRecord[];
+    /**
+     * Why the domain is not ready, or why the last lookup failed.
+     *
+     * @generated from field: string reason = 6;
+     */
+    reason: string;
+    /**
+     * Unset until the first check.
+     *
+     * @generated from field: google.protobuf.Timestamp checked_at = 7;
+     */
+    checkedAt?: Timestamp | undefined;
+};
+/**
+ * MailDomainStatus describes the checks and DNS records of a custom domain.
+ *
+ * @generated from message toshi.workspace.v1.MailDomainStatus
+ */
+export type MailDomainStatusJson = {
+    /**
+     * @generated from field: toshi.workspace.v1.MailDomainState state = 1;
+     */
+    state?: MailDomainStateJson;
+    /**
+     * @generated from field: toshi.workspace.v1.MailDomainCheck ownership = 2;
+     */
+    ownership?: MailDomainCheckJson;
+    /**
+     * @generated from field: toshi.workspace.v1.MailDomainCheck mx = 3;
+     */
+    mx?: MailDomainCheckJson;
+    /**
+     * @generated from field: toshi.workspace.v1.MailDomainCheck provider = 4;
+     */
+    provider?: MailDomainCheckJson;
+    /**
+     * The ownership TXT, inbound MX and provider records, in that order.
+     *
+     * @generated from field: repeated toshi.workspace.v1.DomainRecord records = 5;
+     */
+    records?: DomainRecordJson[];
+    /**
+     * Why the domain is not ready, or why the last lookup failed.
+     *
+     * @generated from field: string reason = 6;
+     */
+    reason?: string;
+    /**
+     * Unset until the first check.
+     *
+     * @generated from field: google.protobuf.Timestamp checked_at = 7;
+     */
+    checkedAt?: TimestampJson;
+};
+/**
+ * Describes the message toshi.workspace.v1.MailDomainStatus.
+ * Use `create(MailDomainStatusSchema)` to create a new message.
+ */
+export declare const MailDomainStatusSchema: GenMessage<MailDomainStatus, {
+    jsonType: MailDomainStatusJson;
+}>;
 /**
  * ConnectionTarget is the URL a WEBHOOK connection's deliveries are posted
  * to: each delivery's event, as the event log would hold it, signed as
@@ -410,7 +619,8 @@ export declare const GetConnectionResponseSchema: GenMessage<GetConnectionRespon
  */
 export type CreateConnectionRequest = Message<"toshi.workspace.v1.CreateConnectionRequest"> & {
     /**
-     * WEBHOOK; no other kind is created here.
+     * The kind to create: WEBHOOK or MAIL. Installing the GitHub App creates
+     * a GITHUB connection.
      *
      * @generated from field: toshi.workspace.v1.ConnectionKind kind = 1;
      */
@@ -422,6 +632,10 @@ export type CreateConnectionRequest = Message<"toshi.workspace.v1.CreateConnecti
      */
     name: string;
     /**
+     * The project and environment the connection's events belong to. Both
+     * are required for WEBHOOK. For MAIL they are optional, and when set must
+     * be the service's.
+     *
      * @generated from field: string project = 3;
      */
     project: string;
@@ -433,13 +647,22 @@ export type CreateConnectionRequest = Message<"toshi.workspace.v1.CreateConnecti
      * @generated from field: string request_key = 5;
      */
     requestKey: string;
+    /**
+     * The mail address and where its mail goes, for a MAIL connection; unset
+     * for WEBHOOK. service and endpoint are required; address and provider are
+     * output only, and ignored on input.
+     *
+     * @generated from field: toshi.workspace.v1.MailConnection mail = 6;
+     */
+    mail?: MailConnection | undefined;
 };
 /**
  * @generated from message toshi.workspace.v1.CreateConnectionRequest
  */
 export type CreateConnectionRequestJson = {
     /**
-     * WEBHOOK; no other kind is created here.
+     * The kind to create: WEBHOOK or MAIL. Installing the GitHub App creates
+     * a GITHUB connection.
      *
      * @generated from field: toshi.workspace.v1.ConnectionKind kind = 1;
      */
@@ -451,6 +674,10 @@ export type CreateConnectionRequestJson = {
      */
     name?: string;
     /**
+     * The project and environment the connection's events belong to. Both
+     * are required for WEBHOOK. For MAIL they are optional, and when set must
+     * be the service's.
+     *
      * @generated from field: string project = 3;
      */
     project?: string;
@@ -462,6 +689,14 @@ export type CreateConnectionRequestJson = {
      * @generated from field: string request_key = 5;
      */
     requestKey?: string;
+    /**
+     * The mail address and where its mail goes, for a MAIL connection; unset
+     * for WEBHOOK. service and endpoint are required; address and provider are
+     * output only, and ignored on input.
+     *
+     * @generated from field: toshi.workspace.v1.MailConnection mail = 6;
+     */
+    mail?: MailConnectionJson;
 };
 /**
  * Describes the message toshi.workspace.v1.CreateConnectionRequest.
@@ -480,7 +715,8 @@ export type CreateConnectionResponse = Message<"toshi.workspace.v1.CreateConnect
     connection?: Connection | undefined;
     /**
      * The signing secret in its whsec_ form, for the sender to sign its
-     * requests with. Shown only in this answer and an identical retry's.
+     * requests with; empty for a MAIL connection. Shown only in this answer
+     * and an identical retry's.
      *
      * @generated from field: string secret = 2;
      */
@@ -496,7 +732,8 @@ export type CreateConnectionResponseJson = {
     connection?: ConnectionJson;
     /**
      * The signing secret in its whsec_ form, for the sender to sign its
-     * requests with. Shown only in this answer and an identical retry's.
+     * requests with; empty for a MAIL connection. Shown only in this answer
+     * and an identical retry's.
      *
      * @generated from field: string secret = 2;
      */
@@ -1266,18 +1503,102 @@ export declare enum ConnectionKind {
      *
      * @generated from enum value: CONNECTION_KIND_WEBHOOK = 2;
      */
-    WEBHOOK = 2
+    WEBHOOK = 2,
+    /**
+     * An inbound mail address. The deployment's mail provider receives the
+     * messages; each is stored as a receipt before it goes to a service's
+     * event endpoint.
+     *
+     * @generated from enum value: CONNECTION_KIND_MAIL = 3;
+     */
+    MAIL = 3
 }
 /**
  * ConnectionKind is the kind of source a connection receives events from.
  *
  * @generated from enum toshi.workspace.v1.ConnectionKind
  */
-export type ConnectionKindJson = "CONNECTION_KIND_UNSPECIFIED" | "CONNECTION_KIND_GITHUB" | "CONNECTION_KIND_WEBHOOK";
+export type ConnectionKindJson = "CONNECTION_KIND_UNSPECIFIED" | "CONNECTION_KIND_GITHUB" | "CONNECTION_KIND_WEBHOOK" | "CONNECTION_KIND_MAIL";
 /**
  * Describes the enum toshi.workspace.v1.ConnectionKind.
  */
 export declare const ConnectionKindSchema: GenEnum<ConnectionKind, ConnectionKindJson>;
+/**
+ * MailDomainState is whether a connection's custom mail domain receives mail.
+ *
+ * @generated from enum toshi.workspace.v1.MailDomainState
+ */
+export declare enum MailDomainState {
+    /**
+     * No custom domain is set.
+     *
+     * @generated from enum value: MAIL_DOMAIN_STATE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * The domain has not yet passed all checks, or another workspace holds it.
+     *
+     * @generated from enum value: MAIL_DOMAIN_STATE_PENDING = 1;
+     */
+    PENDING = 1,
+    /**
+     * The ownership, MX and provider checks all pass.
+     *
+     * @generated from enum value: MAIL_DOMAIN_STATE_READY = 2;
+     */
+    READY = 2,
+    /**
+     * A previously ready domain no longer passes all checks.
+     *
+     * @generated from enum value: MAIL_DOMAIN_STATE_FAILING = 3;
+     */
+    FAILING = 3
+}
+/**
+ * MailDomainState is whether a connection's custom mail domain receives mail.
+ *
+ * @generated from enum toshi.workspace.v1.MailDomainState
+ */
+export type MailDomainStateJson = "MAIL_DOMAIN_STATE_UNSPECIFIED" | "MAIL_DOMAIN_STATE_PENDING" | "MAIL_DOMAIN_STATE_READY" | "MAIL_DOMAIN_STATE_FAILING";
+/**
+ * Describes the enum toshi.workspace.v1.MailDomainState.
+ */
+export declare const MailDomainStateSchema: GenEnum<MailDomainState, MailDomainStateJson>;
+/**
+ * MailDomainCheck is the result of one custom mail domain check.
+ *
+ * @generated from enum toshi.workspace.v1.MailDomainCheck
+ */
+export declare enum MailDomainCheck {
+    /**
+     * The check has not run yet.
+     *
+     * @generated from enum value: MAIL_DOMAIN_CHECK_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * The check passed.
+     *
+     * @generated from enum value: MAIL_DOMAIN_CHECK_PASSED = 1;
+     */
+    PASSED = 1,
+    /**
+     * The check failed.
+     *
+     * @generated from enum value: MAIL_DOMAIN_CHECK_FAILED = 2;
+     */
+    FAILED = 2
+}
+/**
+ * MailDomainCheck is the result of one custom mail domain check.
+ *
+ * @generated from enum toshi.workspace.v1.MailDomainCheck
+ */
+export type MailDomainCheckJson = "MAIL_DOMAIN_CHECK_UNSPECIFIED" | "MAIL_DOMAIN_CHECK_PASSED" | "MAIL_DOMAIN_CHECK_FAILED";
+/**
+ * Describes the enum toshi.workspace.v1.MailDomainCheck.
+ */
+export declare const MailDomainCheckSchema: GenEnum<MailDomainCheck, MailDomainCheckJson>;
 /**
  * ConnectionDeliveryState is where a WEBHOOK connection's delivery stands.
  *
@@ -1330,7 +1651,10 @@ export declare const ConnectionDeliveryStateSchema: GenEnum<ConnectionDeliverySt
  * GITHUB, which installing the App creates and removing it deletes; the
  * calls here list it and cannot create or delete it. A WEBHOOK connection
  * receives events from a sender that signs its requests as Standard
- * Webhooks does, with a secret the connection keeps.
+ * Webhooks does, with a secret the connection keeps. A MAIL connection
+ * receives mail at an address the deployment's inbound mail provider
+ * serves; each message is stored as a receipt before it goes to a
+ * service's event endpoint.
  *
  * The caller's credential names the workspace, as for WorkloadService.
  * CreateConnection and RotateConnectionSecret require a request_key, which
@@ -1367,11 +1691,15 @@ export declare const ConnectionService: GenService<{
         output: typeof GetConnectionResponseSchema;
     };
     /**
-     * CreateConnection creates a WEBHOOK connection whose events belong to a
-     * project's environment, and returns it with its signing secret. A kind
-     * other than WEBHOOK fails with INVALID_ARGUMENT, a name a live
-     * connection of the workspace has with ALREADY_EXISTS, and an
-     * environment the project does not have with NOT_FOUND.
+     * CreateConnection creates a WEBHOOK or MAIL connection. A WEBHOOK
+     * connection's events belong to a project's environment, and the call
+     * returns it with its signing secret. A MAIL connection receives mail at
+     * an address the deployment's inbound mail provider serves and sends each
+     * message to a service's event endpoint; it has no secret. A kind other
+     * than WEBHOOK or MAIL fails with INVALID_ARGUMENT, as does a missing
+     * required field, a name a live connection of the workspace has with
+     * ALREADY_EXISTS, and an environment the project does not have with
+     * NOT_FOUND.
      *
      * @generated from rpc toshi.workspace.v1.ConnectionService.CreateConnection
      */
@@ -1381,11 +1709,12 @@ export declare const ConnectionService: GenService<{
         output: typeof CreateConnectionResponseSchema;
     };
     /**
-     * DeleteConnection deletes a WEBHOOK connection: its events are no longer
-     * received. A GITHUB connection fails with FAILED_PRECONDITION, as only
-     * removing the GitHub App deletes it, as does one that live triggers match
-     * events from, naming them as project/name, and one the workspace does
-     * not have with NOT_FOUND.
+     * DeleteConnection deletes a WEBHOOK or MAIL connection: its events are no
+     * longer received, and a mail connection's address takes no more mail. A
+     * GITHUB connection fails with FAILED_PRECONDITION, as only removing the
+     * GitHub App deletes it, as does one that live triggers match events from,
+     * naming them as project/name, and one the workspace does not have with
+     * NOT_FOUND.
      *
      * @generated from rpc toshi.workspace.v1.ConnectionService.DeleteConnection
      */