@collective-intelligence/external-apps-server-sdk 0.1.13 → 0.1.15

package/dist/index.d.ts

@@ -163,6 +163,39 @@ export type ExternalApplicationsCreateOrGetAppUserResponses = {
 	};
 };
 export type ExternalApplicationsCreateOrGetAppUserResponse = ExternalApplicationsCreateOrGetAppUserResponses[keyof ExternalApplicationsCreateOrGetAppUserResponses];
+export type ExternalApplicationsCheckAppUserEmailData = {
+	body: {
+		email: string;
+	};
+	headers: {
+		authorization?: string;
+		"x-organization-id": string;
+		"x-correlation-id"?: string;
+		"x-external-audit-issuer"?: string;
+		"x-external-audit-subject"?: string;
+		"x-external-caller-kind"?: "anonymous_visitor";
+		"x-external-ci-user-id"?: string;
+		"x-external-server-role"?: string;
+	};
+	path?: never;
+	query?: never;
+	url: "/application/v1/users/check-email";
+};
+export type ExternalApplicationsCheckAppUserEmailResponses = {
+	/**
+	 * Success
+	 */
+	200: {
+		correlationId: string;
+		result: {
+			usable: true;
+		} | {
+			reason: "user_unavailable" | "target_inactive";
+			usable: false;
+		};
+	};
+};
+export type ExternalApplicationsCheckAppUserEmailResponse = ExternalApplicationsCheckAppUserEmailResponses[keyof ExternalApplicationsCheckAppUserEmailResponses];
 export type ExternalApplicationsGetAppUserResponses = {
 	/**
 	 * Success
@@ -558,6 +591,9 @@ interface DurableFileUpload {
 	sizeBytes: number;
 }
 export type ExternalApplicationServiceOperationRequest = {
+	input: ExternalApplicationsCheckAppUserEmailData["body"];
+	operationId: "users_check_email";
+} | {
 	input: DurableFileUpload;
 	operationId: "files_upload";
 } | {
@@ -577,11 +613,16 @@ export type ExternalApplicationServiceOperationRequest = {
 	};
 	operationId: "users_link_companies";
 };
+/**
+ * Whether `users_create_or_get` would accept an email, checked without
+ * creating anything; an unknown email is usable.
+ */
+export type ApplicationUserEmailCheck = ExternalApplicationsCheckAppUserEmailResponse["result"];
 /** A user's linked company entities, in entity id order. */
 export interface UserCompanyLinks {
 	entityIds: string[];
 }
-export type ExternalApplicationServiceOperationSuccess = EnvelopeSuccess<"files_upload", {
+export type ExternalApplicationServiceOperationSuccess = EnvelopeSuccess<"users_check_email", ApplicationUserEmailCheck> | EnvelopeSuccess<"files_upload", {
 	storageFileId: StorageFileId;
 }> | EnvelopeSuccess<"origins_set_runtime", {
 	origin: string;
@@ -971,6 +1012,13 @@ export interface ServerClient {
 	 * remain limited to service credentials and Organization members.
 	 */
 	readonly users: Readonly<{
+		/**
+		 * Whether `createOrGet` would accept `email`, without creating anything:
+		 * `{ usable: true }`, or `{ usable: false, reason }` with
+		 * `user_unavailable` or `target_inactive`. An unknown email is usable.
+		 * Service credentials only, under the users-create permission.
+		 */
+		checkEmail: ServerOperationMethod<"users_check_email">;
 		createOrGet: ServerOperationMethod<"users_create_or_get">;
 		deactivate: ServerOperationMethod<"users_deactivate">;
 		get: ServerOperationMethod<"users_get">;