@fonoster/common 0.5.4 → 0.6.0

package/README.md

@@ -0,0 +1,3 @@
+[<a href="https://gitpod.io/#https://github.com/fonoster/fonoster"> <img src="https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod" alt="Contribute with Gitpod" />
+
+This module is part of the \[Fonoster\](https://fonoster.com) project. By itself, it does not do much. It is intended to be used as a dependency for other modules. For more information about the project, please visit \[https://github.com/fonoster/fonoster\](https://github.com/fonoster/fonoster).a](../apiserver/README.md)

package/dist/constants.d.ts

@@ -0,0 +1,4 @@
+import { ServingStatus } from "grpc-health-check";
+export declare const GRPC_SERVING_STATUS: ServingStatus;
+export declare const GRPC_NOT_SERVING_STATUS: ServingStatus;
+export declare const STASIS_APP_NAME = "mediacontroller";

package/dist/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STASIS_APP_NAME = exports.GRPC_NOT_SERVING_STATUS = exports.GRPC_SERVING_STATUS = void 0;
+exports.GRPC_SERVING_STATUS = "SERVING";
+exports.GRPC_NOT_SERVING_STATUS = "NOT_SERVING";
+exports.STASIS_APP_NAME = "mediacontroller";

package/dist/errors.d.ts

@@ -0,0 +1,8 @@
+type GRPCError = {
+    code: number;
+    message: string;
+};
+declare function handleError(error: Error | {
+    code: string;
+}, callback: (error: GRPCError) => void): void;
+export { handleError, GRPCError };

package/dist/errors.js

@@ -0,0 +1,95 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleError = void 0;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const logger_1 = require("@fonoster/logger");
+const grpc = __importStar(require("@grpc/grpc-js"));
+const grpc_js_1 = require("@grpc/grpc-js");
+const zod_1 = require("zod");
+const zod_validation_error_1 = require("zod-validation-error");
+const logger = (0, logger_1.getLogger)({ service: "apiserver", filePath: __filename });
+function handleError(error, callback) {
+    const code = error.code;
+    if (error instanceof zod_1.z.ZodError) {
+        const validationError = (0, zod_validation_error_1.fromError)(error);
+        logger.error("validation error:", {
+            message: validationError.toString()
+        });
+        logger.error("validation error:", { message: error });
+        callback({
+            code: grpc_js_1.status.INVALID_ARGUMENT,
+            message: validationError.toString()
+        });
+    }
+    else if (code === "P2002" || code === grpc.status.ALREADY_EXISTS) {
+        const message = "Duplicated resource";
+        logger.error("duplicated entity error:", { message });
+        callback({ code: grpc_js_1.status.ALREADY_EXISTS, message });
+    }
+    else if (code === "P2025" || code === grpc.status.NOT_FOUND) {
+        const message = "The requested resource was not found";
+        logger.error("not found error:", { message });
+        callback({ code: grpc_js_1.status.NOT_FOUND, message });
+    }
+    else if (code === "P2003" || code === grpc.status.FAILED_PRECONDITION) {
+        // FIXME: Improve for clarity
+        const message = "Failed precondition error (e.g., missing dependency)";
+        logger.error("missing foreign key error:", { message });
+        callback({ code: grpc_js_1.status.FAILED_PRECONDITION, message });
+    }
+    else if (code === grpc.status.PERMISSION_DENIED) {
+        const message = "Permission denied";
+        logger.error("permission denied error:", { message });
+        callback({ code: grpc_js_1.status.PERMISSION_DENIED, message });
+    }
+    else if (code === grpc.status.UNAUTHENTICATED) {
+        const message = "Unauthenticated";
+        logger.error("unauthenticated error:", { message });
+        callback({ code: grpc_js_1.status.UNAUTHENTICATED, message });
+    }
+    else {
+        logger.error("unknown error:", error);
+        callback({ code: grpc_js_1.status.UNKNOWN, message: "Unknown error" });
+    }
+}
+exports.handleError = handleError;

package/dist/grpcStatusMap.d.ts

@@ -0,0 +1,4 @@
+declare const statusMap: {
+    "": import("grpc-health-check").ServingStatus;
+};
+export { statusMap };

package/dist/{envs.js → grpcStatusMap.js}

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GRPC_ALLOW_INSECURE = exports.APISERVER_ACCESS_KEY_SECRET = exports.APISERVER_ACCESS_KEY_ID = exports.APISERVER_ENDPOINT = void 0;
+exports.statusMap = void 0;
 /*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
  *
  * This file is part of Fonoster
@@ -19,7 +19,9 @@ exports.GRPC_ALLOW_INSECURE = exports.APISERVER_ACCESS_KEY_SECRET = exports.APIS
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-exports.APISERVER_ENDPOINT = process.env.APISERVER_ENDPOINT || "api.fonoster.io";
-exports.APISERVER_ACCESS_KEY_ID = process.env.APISERVER_ACCESS_KEY_ID;
-exports.APISERVER_ACCESS_KEY_SECRET = process.env.APISERVER_ACCESS_KEY_SECRET;
-exports.GRPC_ALLOW_INSECURE = process.env.GRPC_ALLOW_INSECURE || "false";
+const constants_1 = require("./constants");
+const statusMap = {
+    // By convention, the empty string represents the entire server
+    "": constants_1.GRPC_NOT_SERVING_STATUS
+};
+exports.statusMap = statusMap;

package/dist/index.d.ts

@@ -1,8 +1,7 @@
-import { ClientOptions } from "./types";
-import { getClientCredentials, getServerCredentials } from "./trust_util";
-import { Plugin } from "./speech/plugin";
-import { SpeechProvider, SpeechTracker, SpeechResult, StreamSpeechResult } from "./speech/types";
-import APIClient from "./api_client";
-import healthcheck from "./healthcheck";
-import runServices from "./service_runner";
-export { APIClient, ClientOptions, Plugin, SpeechTracker, SpeechResult, SpeechProvider, StreamSpeechResult, getClientCredentials, getServerCredentials, runServices, healthcheck };
+export * from "./utils";
+export * from "./notifications";
+export * from "./errors";
+export * from "./constants";
+export * from "./grpcStatusMap";
+export * from "./voice";
+export * from "./tts";

package/dist/index.js

@@ -1,17 +1,41 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.healthcheck = exports.runServices = exports.getServerCredentials = exports.getClientCredentials = exports.Plugin = exports.APIClient = void 0;
-const trust_util_1 = require("./trust_util");
-Object.defineProperty(exports, "getClientCredentials", { enumerable: true, get: function () { return trust_util_1.getClientCredentials; } });
-Object.defineProperty(exports, "getServerCredentials", { enumerable: true, get: function () { return trust_util_1.getServerCredentials; } });
-const plugin_1 = require("./speech/plugin");
-Object.defineProperty(exports, "Plugin", { enumerable: true, get: function () { return plugin_1.Plugin; } });
-const api_client_1 = __importDefault(require("./api_client"));
-exports.APIClient = api_client_1.default;
-const healthcheck_1 = __importDefault(require("./healthcheck"));
-exports.healthcheck = healthcheck_1.default;
-const service_runner_1 = __importDefault(require("./service_runner"));
-exports.runServices = service_runner_1.default;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+__exportStar(require("./utils"), exports);
+__exportStar(require("./notifications"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./grpcStatusMap"), exports);
+__exportStar(require("./voice"), exports);
+__exportStar(require("./tts"), exports);

package/dist/notifications/compileTemplate.d.ts

@@ -0,0 +1,6 @@
+type CompileTemplateParams = {
+    filePath: string;
+    data: Record<string, string>;
+};
+declare function compileTemplate(params: CompileTemplateParams): string;
+export { compileTemplate, CompileTemplateParams };

package/dist/{env_is_set.js → notifications/compileTemplate.js}

@@ -3,8 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.compileTemplate = void 0;
 /*
- * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/fonoster
  *
  * This file is part of Fonoster
@@ -21,18 +22,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const logger_1 = __importDefault(require("@fonoster/logger"));
-function assertEnvIsSet(name) {
-    const register = require(process.env.SERVICES_ENVS ||
-        "/home/fonoster/service_envs.json");
-    const services = register.filter((service) => service.module === name);
-    for (const value of services) {
-        value.env.forEach(function (variable) {
-            if (!(variable in process.env)) {
-                logger_1.default.error(`The environment variable ${variable} is required but was not found`);
-                process.exit(1);
-            }
-        });
+const fs_1 = __importDefault(require("fs"));
+const handlebars_1 = __importDefault(require("handlebars"));
+function compileTemplate(params) {
+    const { filePath, data } = params;
+    if (!fs_1.default.existsSync(filePath)) {
+        throw new Error(`Template file not found: ${filePath}`);
     }
+    const source = fs_1.default.readFileSync(filePath, "utf-8").toString();
+    const template = handlebars_1.default.compile(source);
+    return template(data);
 }
-exports.default = assertEnvIsSet;
+exports.compileTemplate = compileTemplate;

package/dist/notifications/createEmailSender.d.ts

@@ -0,0 +1,17 @@
+type EmailSenderConfig = {
+    sender: string;
+    host: string;
+    port: number;
+    secure: boolean;
+    auth: {
+        user: string;
+        pass: string;
+    };
+};
+type EmailParams = {
+    to: string;
+    subject: string;
+    html: string;
+};
+declare function createEmailSender(config: EmailSenderConfig): (params: EmailParams) => Promise<void>;
+export { createEmailSender, EmailSenderConfig, EmailParams };

package/dist/notifications/createEmailSender.js

@@ -0,0 +1,55 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createEmailSender = void 0;
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const logger_1 = require("@fonoster/logger");
+const nodemailer_1 = require("nodemailer");
+const logger = (0, logger_1.getLogger)({ service: "common", filePath: __filename });
+function createEmailSender(config) {
+    const { sender, host, port, secure, auth } = config;
+    const transporter = (0, nodemailer_1.createTransport)({
+        host,
+        port,
+        secure,
+        auth
+    });
+    return function sendEmail(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { to, subject, html } = params;
+            const info = yield transporter.sendMail({
+                from: sender,
+                to,
+                subject,
+                html
+            });
+            logger.verbose(`message sent: ${info.messageId}`);
+        });
+    };
+}
+exports.createEmailSender = createEmailSender;

package/dist/notifications/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./compileTemplate";
+export * from "./createEmailSender";

package/dist/notifications/index.js

@@ -0,0 +1,36 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+__exportStar(require("./compileTemplate"), exports);
+__exportStar(require("./createEmailSender"), exports);

package/dist/protos/acls.proto

@@ -0,0 +1,119 @@
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+syntax = "proto3";
+
+package fonoster.acls.v1beta2;
+
+// AccessControlList(Acl) service definition
+service Acls {
+  // Create a new Acl
+  rpc CreateAcl (CreateAclRequest) returns (CreateAclResponse) {}
+  // Update an existing Acl
+  rpc UpdateAcl (UpdateAclRequest) returns (UpdateAclResponse) {}
+  // Get an existing Acl
+  rpc GetAcl (GetAclRequest) returns (Acl) {}
+  // Delete an existing Acl
+  rpc DeleteAcl (DeleteAclRequest) returns (DeleteAclResponse) {}
+  // Get a list of Acls
+  rpc ListAcls (ListAclsRequest) returns (ListAclsResponse) {}
+}
+
+// The message for Acl resource
+message Acl {
+  // The Acl reference
+  string ref = 1;
+  // A friendly name for the Acl
+  string name = 2;
+  // The list of allowed IP addresses
+  repeated string allow = 3;
+  // The list of denied IP addresses
+  repeated string deny = 4;
+  // The date the Acl was created
+  int64 created_at = 5;
+  // The date the Acl was last updated
+  int64 updated_at = 6;
+}
+
+// The request message for the Acl.CreateAcl method
+message CreateAclRequest {
+  // A friendly name for the Acl
+  string name = 1;
+  // The list of allowed IP addresses
+  repeated string allow = 2;
+  // The list of denied IP addresses
+  repeated string deny = 3;
+}
+
+// The response message for the Acl.CreateAcl method
+message CreateAclResponse {
+  // The Acl reference
+  string ref = 1;
+}
+
+// The request message for the Acl.UpdateAcl method
+message UpdateAclRequest {
+  // The Acl reference
+  string ref = 1;
+  // A friendly name for the Acl
+  string name = 2;
+  // The list of allowed IP addresses
+  repeated string allow = 3;
+  // The list of denied IP addresses
+  repeated string deny = 4;
+} 
+
+// The response message for the Acl.UpdateAcl method
+message UpdateAclResponse {
+  // The Acl reference
+  string ref = 1;
+}
+
+// The request message for the Acl.GetAcl method
+message GetAclRequest  {
+  // The Acl reference
+  string ref = 1;
+}
+
+// The request message for the Acl.DeleteAcl method
+message DeleteAclRequest  {
+  // The Acl reference
+  string ref = 1;
+}
+
+// The response message for the Acl.DeleteAcl method
+message DeleteAclResponse  {
+  // The Acl reference
+  string ref = 1;
+}
+
+// The request message for the Acl.ListAcl method
+message ListAclsRequest {
+  // The maximum number of items in the list
+  int32 page_size = 1;
+  // The next_page_token value returned from the previous request, if any
+  string page_token = 2;
+}
+
+// The response message for the Acl.ListAcl method
+message ListAclsResponse {
+  // List of items
+  repeated Acl items = 1;
+  // Token to retrieve the next page of results, or empty if there are no more results in the list
+  string next_page_token = 2;
+}

package/dist/protos/agents.proto

@@ -0,0 +1,155 @@
+/*
+ * Copyright (C) 2024 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/fonoster
+ *
+ * This file is part of Fonoster
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+syntax = "proto3";
+
+package fonoster.agents.v1beta2;
+
+import "domains.proto";
+import "credentials.proto";
+
+// The Agents service definition
+service Agents {
+  // Create a new Agent
+  rpc CreateAgent (CreateAgentRequest) returns (CreateAgentResponse) {}
+  // Update an existing Agent
+  rpc UpdateAgent (UpdateAgentRequest) returns (UpdateAgentResponse) {}
+  // Get an existing Agent
+  rpc GetAgent (GetAgentRequest) returns (Agent) {}
+  // Delete an existing Agent
+  rpc DeleteAgent (DeleteAgentRequest) returns (DeleteAgentResponse) {}
+  // List all Agents
+  rpc ListAgents (ListAgentsRequest) returns (ListAgentsResponse) {}
+}
+
+// The message for a new Agent
+message Agent {
+  // The unique identifier of the Agent
+  string ref = 1;
+  // The name of the Agent
+  string name = 2;
+  // The username of the Agent
+  string username = 3;
+  // The privacy settings of the Agent
+  Privacy privacy = 4;
+  // The enabled status of the Agent
+  bool enabled = 5;
+  // The created_at timestamp of the Agent
+  int64 created_at = 6;
+  // The updated_at timestamp of the Agent
+  int64 updated_at = 7;
+  // The maximum number of contacts that can be created for this Agent
+  int32 max_contacts = 8;
+  // Value to override the expires requested by the Agent
+  int32 expires = 9;
+  // The domain of the Agent
+  fonoster.domains.v1beta2.Domain domain = 10;
+  // The credentials of the Agent
+  fonoster.credentials.v1beta2.Credentials credentials = 11;
+}
+
+// The request message for Agents.CreateAgent
+message CreateAgentRequest {
+  // The name of the Agent
+  string name = 1;
+  // The username of the Agent
+  string username = 2;
+  // The privacy settings of the Agent
+  Privacy privacy = 3;
+  // The enabled status of the Agent
+  bool enabled = 4;
+  // Reference to the Domain of the Agent
+  string domain_ref = 5;
+  // Reference to the Credentials of the Agent
+  string credentials_ref = 6;
+  // The maximum number of contacts that can be created for this Agent
+  int32 max_contacts = 7;
+  // Value to override the expires requested by the Agent
+  int32 expires = 8;
+}
+
+// The response message for Agents.CreateAgent
+message CreateAgentResponse {
+  // The unique identifier of the Agent
+  string ref = 1;
+}
+
+// The request message for Agents.UpdateAgent
+message UpdateAgentRequest {
+  // The unique identifier of the Agent
+  string ref = 1;
+  // The name of the Agent
+  string name = 2;
+  // The privacy settings of the Agent
+  Privacy privacy = 3;
+  // The enabled status of the Agent
+  bool enabled = 4;
+  // Reference to the Domain of the Agent
+  string domain_ref = 5;
+  // Reference to the Credentials of the Agent
+  string credentials_ref = 6;
+  // The maximum number of contacts that can be created for this Agent
+  int32 max_contacts = 7;
+  // Value to override the expires requested by the Agent
+  int32 expires = 8;
+}
+
+// The response message for Agents.UpdateAgent
+message UpdateAgentResponse {
+  // The id of the updated Agent
+  string ref = 1;
+}
+
+// The request message for Agents.GetAgent
+message GetAgentRequest {
+  // The unique identifier of the Agent
+  string ref = 1;
+}
+
+// The request message for Agents.DeleteAgent
+message DeleteAgentRequest {
+  // The unique identifier of the Agent
+  string ref = 1;
+}
+
+// The response message for Agents.DeleteAgent
+message DeleteAgentResponse {
+  // Echo back the id of the deleted Agent
+  string ref = 1;
+}
+
+// The request message for Agents.ListAgents
+message ListAgentsRequest {
+  // The maximum number of items in the list
+  int32 page_size = 1;
+  // The next_page_token value returned from the previous request, if any
+  string page_token = 2;
+}
+
+// The response message for Agents.ListAgents
+message ListAgentsResponse {
+  // List of Agents
+  repeated Agent items = 1;
+  // Token to retrieve the next page of results, or empty if there are no more results in the list
+  string next_page_token = 2;
+}
+
+enum Privacy {
+  PRIVATE = 0;
+  NONE = 1;
+}