@fonoster/common 0.5.5 → 0.6.1-alpha.0

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;
+}

package/dist/protos/applications.proto

@@ -0,0 +1,154 @@
+/*
+ * 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.applications.v1beta2;
+
+import "google/protobuf/struct.proto";
+
+// Applications service definition
+service Applications {
+  // Create a new application
+  rpc CreateApplication(CreateApplicationRequest) returns (CreateApplicationResponse) {}
+  // Get an application
+  rpc GetApplication(GetApplicationRequest) returns (Application) {}
+  // List applications
+  rpc ListApplications(ListApplicationsRequest) returns (ListApplicationsResponse) {}
+  // Update an application
+  rpc UpdateApplication(UpdateApplicationRequest) returns (UpdateApplicationResponse) {}
+  // Delete an application
+  rpc DeleteApplication(DeleteApplicationRequest) returns (DeleteApplicationResponse) {}
+}
+
+// The type of application
+enum ApplicationType {
+  // Programmable Voice
+  PROGRAMMABLE_VOICE = 0;
+}
+
+message ProductContainer {
+  // Product reference
+  string product_ref = 1;
+  // Product configuration
+  google.protobuf.Struct config = 2;
+  // Product credentials
+  google.protobuf.Struct credentials = 3;
+}
+
+// Application definition
+message Application {
+  // Reference to the application
+  string ref = 1;
+  // The application's resource name
+  string name = 2;
+  // Application type
+  ApplicationType type = 3;
+  // Endpoint for programmable voice
+  string app_endpoint = 4;
+  // Text to speech product
+  ProductContainer text_to_speech = 5;
+  // Speech to text product
+  ProductContainer speech_to_text = 6;
+  // Conversation product
+  ProductContainer conversation = 7;
+  // Creation time
+  int64 created_at = 8;
+  // Update time
+  int64 updated_at = 9;
+}
+
+// Request to create a new application
+message CreateApplicationRequest {
+  // Name of the application
+  string name = 1;
+  // Application type
+  ApplicationType type = 2;
+  // App URL for programmable voice
+  string app_endpoint = 3;
+  // Text to speech product
+  ProductContainer text_to_speech = 4;
+  // Speech to text product
+  ProductContainer speech_to_text = 5;
+  // Conversation product
+  ProductContainer intelligence = 6;
+}
+
+// Response for create application
+message CreateApplicationResponse {
+  // Echo the reference of the application
+  string ref = 1;
+}
+
+// Request to get an application
+message GetApplicationRequest {
+  // The reference to the application
+  string ref = 1;
+}
+
+// Request to list applications
+message ListApplicationsRequest {
+  // The number of items to list
+  int32 page_size = 1;
+  // The page token
+  string page_token = 2;
+}
+
+// Response for list applications
+message ListApplicationsResponse {
+  // List of applications
+  repeated Application items = 1;
+  // The page token
+  string next_page_token = 2;
+}
+
+// Request to update an application
+message UpdateApplicationRequest {
+  // Reference to the application
+  string ref = 1;
+  // Name of the application
+  string name = 2;
+  // Application type
+  ApplicationType type = 3;
+  // App URL for programmable voice
+  string app_endpoint = 4;
+  // Text to speech product
+  ProductContainer text_to_speech = 5;
+  // Speech to text product
+  ProductContainer speech_to_text = 6;
+  // Conversation product
+  ProductContainer intelligence = 7;
+}
+
+// Response for update application
+message UpdateApplicationResponse {
+  // Echo the reference of the application
+  string ref = 1;
+}
+
+// Request to delete an application
+message DeleteApplicationRequest {
+  // The reference to the application
+  string ref = 1;
+}
+
+// Response for delete application
+message DeleteApplicationResponse {
+  // Echo the reference of the application
+  string ref = 1;
+}

package/dist/protos/calls.proto

@@ -0,0 +1,164 @@
+/*
+ * 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.calls.v1beta2;
+
+// TODO: Consider using Timestamp instead of int64
+// import "google/protobuf/timestamp.proto";
+
+// Calls service definition
+service Calls {
+  // Call a number and returns the call status
+  rpc CreateCall (CreateCallRequest) returns (CreateCallResponse) {}
+  // Get a list of Call Detail Records
+  rpc ListCalls (ListCallsRequest) returns (ListCallsResponse) {}
+  // Get a Call Detail Record
+  rpc GetCall (GetCallRequest) returns (CallDetailRecord) {}
+  // Stream call status
+  rpc TrackCall (TrackCallRequest) returns (stream TrackCallResponse) {}
+}
+
+enum CallType {
+  PROGRAMMABLE = 0;
+  SIP_TRUNKING = 1;
+}
+
+enum HangupCause {
+  NORMAL_CLEARING = 0;
+  CALL_REJECTED = 1;
+  UNALLOCATED = 2;
+  NO_USER_RESPONSE = 3;
+  NO_ROUTE_DESTINATION = 4;
+  NO_ANSWER = 5;
+  USER_BUSY = 6;
+  NOT_ACCEPTABLE_HERE = 7;
+  SERVICE_UNAVAILABLE = 8;
+  INVALID_NUMBER_FORMAT = 9;
+  UNKNOWN = 10;
+}
+
+enum CallStatus {
+  QUEUED = 0;
+  RINGING = 1;
+  IN_PROGRESS = 2;
+  COMPLETED = 3;
+  FAILED = 4;
+  BUSY = 5;
+  // TODO: Refactor to avoid clash with HangupCause
+  // NO_ANSWER = 6;
+  CANCELED = 7;
+  REJECTED = 8;
+  TIMEOUT = 9;
+  // TODO: Refactor to avoid clash with HangupCause
+  // UNKNOWN = 10;
+}
+
+enum CallDirection {
+  INBOUND = 0;
+  OUTBOUND = 1;
+}
+
+// Message for a Call Detail Record
+message CallDetailRecord {
+  // The unique identifier of the Call
+  string ref = 1;
+  // The call type
+  CallType type = 2;
+  // The call status
+  CallStatus status = 3;
+  // Hangup cause
+  HangupCause hangup_cause = 4;
+  // Start time of the call
+  int64 started_at = 5;
+  // End time of the call
+  int64 ended_at = 6;
+  // The from number (E.164 format or SIP URI)
+  string from = 7;
+  // The to number (E.164 format or SIP URI)
+  string to = 8;
+  // The call duration in seconds
+  int32 duration = 9;
+  // The call direction
+  CallDirection direction = 10;
+}
+
+// The request message for Calls.Call
+message CreateCallRequest {
+  // The from number (E.164 format or SIP URI)
+  string from = 1;
+  // The to number (E.164 format or SIP URI)
+  string to = 2;
+  // Optional application reference
+  string app_ref = 3;
+}
+
+// The response message for Calls.Call
+message CreateCallResponse {
+  // The refence of the call
+  string ref = 1;
+}
+
+// The request message for Calls.ListCalls
+message ListCallsRequest {
+  // Optional start date in RFC3339 format
+  string after = 1;
+  // Optional end date in RFC3339 format
+  string before = 2;
+  // Optional call type
+  CallType type = 3;
+  // Optional call status
+  CallStatus status = 4;
+  // Optional from number (E.164 format or SIP URI)
+  string from = 5;
+  // Optional to number (E.164 format or SIP URI)
+  string to = 6;
+  // The page size
+  int32 page_size = 7;
+  // The page token
+  string page_token = 8;
+}
+
+// The response message for Calls.ListCalls
+message ListCallsResponse {
+  // The list of Call Detail Records
+  repeated CallDetailRecord items = 1;
+  // The token to retrieve the next page of results
+  string next_page_token = 2;
+}
+
+// The request message for Calls.GetCall
+message GetCallRequest {
+  // The unique identifier of the Call
+  string ref = 1;
+}
+
+// The request message for Calls.TrackCall
+message TrackCallRequest {
+  // The unique identifier of the Call
+  string ref = 1;
+}
+
+// The response message for Calls.TrackCall
+message TrackCallResponse {
+  // The refence of the call
+  string ref = 1;
+  // The call status
+  CallStatus status = 2;
+}

package/dist/protos/credentials.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.credentials.v1beta2;
+
+// The Credentials service definition
+service CredentialsService {
+  // Creates a new set of Credentials
+  rpc CreateCredentials (CreateCredentialsRequest) returns (CreateCredentialsResponse) {}
+  // Updates an existing set of Credentials
+  rpc UpdateCredentials (UpdateCredentialsRequest) returns (UpdateCredentialsResponse) {}
+  // Gets the details of a given set of Credentials
+  rpc GetCredentials (GetCredentialsRequest) returns (Credentials) {}
+  // Deletes an existing set of Credentials
+  rpc DeleteCredentials (DeleteCredentialsRequest) returns (DeleteCredentialsResponse) {}
+  // Lists all Credentials
+  rpc ListCredentials (ListCredentialsRequest) returns (ListCredentialsResponse) {}
+}
+
+// The message for the Credentials resource
+message Credentials {
+  // The reference of the Credentials
+  string ref = 1;
+  // The name of the Credentials
+  string name = 2;
+  // The username of the Credentials
+  string username = 3;
+  // The password of the Credentials
+  string password = 4;
+  // The time the Credentials was created
+  int64 created_at = 5;
+  // The time the Credentials was updated
+  int64 updated_at = 6;
+}
+
+// The request message for the Credentials.CreateCredentials method
+message CreateCredentialsRequest {
+  // The name of the Credentials
+  string name = 1;
+  // The username of the Credentials
+  string username = 2;
+  // The password of the Credentials
+  string password = 3;
+}
+
+// The response message for the Credentials.CreateCredentials method
+message CreateCredentialsResponse {
+  // The reference of the created Credentials
+  string ref = 1;
+}
+
+// The request message for the Credentials.UpdateCredentials method
+message UpdateCredentialsRequest {
+  // The reference of the Credentials to update
+  string ref = 1;
+  // The new name of the Credentials
+  string name = 2;
+  // The new username of the Credentials
+  string username = 3;
+  // The new password of the Credentials
+  string password = 4;
+}
+
+// The response message for the Credentials.UpdateCredentials method
+message UpdateCredentialsResponse {
+  // The reference of the updated Credentials
+  string ref = 1;
+}
+
+// The request message for the Credentials.GetCredentials method
+message GetCredentialsRequest  {
+  // The reference of the Credentials to retrieve
+  string ref = 1;
+}
+
+// The request message for the Credentials.DeleteCredentials method
+message DeleteCredentialsRequest  {
+  // The reference of the Credentials to delete
+  string ref = 1;
+}
+
+// The response message for the Credentials.DeleteCredentials method
+message DeleteCredentialsResponse {
+  // The reference of the deleted Credentials
+  string ref = 1;
+}
+
+// The request message for the Credentials.ListCredentials method
+message ListCredentialsRequest {
+  // 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 Credentials.ListCredentials method
+message ListCredentialsResponse {
+  // List of Credentials
+  repeated Credentials 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;
+}