@fonoster/common 0.5.4 → 0.6.0

package/dist/protos/identity.proto

@@ -0,0 +1,286 @@
+/*
+ * 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.identity.v1beta2;
+
+import "google/protobuf/empty.proto";
+
+service Identity {
+  // Workspace actions
+  rpc CreateWorkspace (CreateWorkspaceRequest) returns (CreateWorkspaceResponse) {}
+  rpc DeleteWorkspace (DeleteWorkspaceRequest) returns (DeleteWorkspaceResponse) {}
+  rpc GetWorkspace (GetWorkspaceRequest) returns (Workspace) {}
+  rpc ListWorkspaces (ListWorkspacesRequest) returns (ListWorkspacesResponse) {}
+  rpc UpdateWorkspace (UpdateWorkspaceRequest) returns (UpdateWorkspaceResponse) {}
+  rpc InviteUserToWorkspace (InviteUserToWorkspaceRequest) returns (InviteUserToWorkspaceResponse) {}
+  rpc RemoveUserFromWorkspace (RemoveUserFromWorkspaceRequest) returns (RemoveUserFromWorkspaceResponse) {}
+  rpc ResendWorkspaceMembershipInvitation (ResendWorkspaceMembershipInvitationRequest) returns (ResendWorkspaceMembershipInvitationResponse) {}
+  
+  // User specific actions
+  rpc CreateUser (CreateUserRequest) returns (CreateUserResponse) {}
+  rpc GetUser (GetUserRequest) returns (GetUserResponse) {}
+  rpc UpdateUser (UpdateUserRequest) returns (UpdateUserResponse) {}
+  rpc DeleteUser (DeleteUserRequest) returns (DeleteUserResponse) {}
+  
+  // ApiKey actions
+  rpc CreateApiKey (CreateApiKeyRequest) returns (CreateApiKeyResponse) {}
+  rpc DeleteApiKey (DeleteApiKeyRequest) returns (DeleteApiKeyResponse) {}
+  rpc ListApiKeys (ListApiKeysRequest) returns (ListApiKeysResponse) {}
+  rpc RegenerateApiKey (RegenerateApiKeyRequest) returns (RegenerateApiKeyResponse) {}
+
+  // Token exchange actions
+  rpc ExchangeCredentials (ExchangeCredentialsRequest) returns (ExchangeCredentialsResponse) {}
+  rpc ExchangeApiKey (ExchangeApiKeyRequest) returns (ExchangeApiKeyResponse) {}
+  rpc ExchangeOAuth2Code (ExchangeOAuth2CodeRequest) returns (ExchangeOAuth2CodeResponse) {}
+  rpc ExchangeRefreshToken (ExchangeRefreshTokenRequest) returns (ExchangeRefreshTokenResponse) {}
+  rpc RevokeToken (RevokeTokenRequest) returns (RevokeTokenResponse) {}
+
+  // Get the public key for verifying JWTs
+  rpc GetPublicKey (google.protobuf.Empty) returns (GetPublicKeyResponse) {}
+}
+
+// Workspace Resources
+
+message CreateWorkspaceRequest {
+  string name = 1;
+}
+
+message CreateWorkspaceResponse {
+  string ref = 1;
+}
+
+message DeleteWorkspaceRequest {
+  string ref = 1;
+}
+
+message DeleteWorkspaceResponse {
+  string ref = 1;
+}
+
+message GetWorkspaceRequest {
+  string ref = 1;
+}
+
+message ListWorkspacesRequest {
+  string page_token = 1;
+  int32 page_size = 2;
+}
+
+message ListWorkspacesResponse {
+  repeated Workspace workspaces = 1;
+  string next_page_token = 2;
+}
+
+message UpdateWorkspaceRequest {
+  string ref = 1;
+  string name = 2;
+}
+
+message UpdateWorkspaceResponse {
+  string ref = 1;
+}
+
+message InviteUserToWorkspaceRequest {
+  string email = 1;
+  string role = 2;
+  string name = 3;
+}
+
+message InviteUserToWorkspaceResponse {
+  string user_ref = 1;
+}
+
+message RemoveUserFromWorkspaceRequest {
+  string user_ref = 1;
+}
+
+message RemoveUserFromWorkspaceResponse {
+  string user_ref = 1;
+}
+
+message ResendWorkspaceMembershipInvitationRequest {
+  string user_ref = 1;
+}
+
+message ResendWorkspaceMembershipInvitationResponse {
+  string user_ref = 1;
+}
+
+// User Resources
+
+message CreateUserRequest {
+  string email = 1;
+  string password = 2;
+  string name = 3;
+  string avatar = 4;
+}
+
+message CreateUserResponse {
+  string ref = 1;
+}
+
+message GetUserRequest {
+  string ref = 1;
+}
+
+message GetUserResponse {
+  string ref = 1;
+  string email = 2;
+  string name = 3;
+  string avatar = 4;
+  int64 created_at = 5;
+  int64 updated_at = 6;
+}
+
+message UpdateUserRequest {
+  string ref = 1;
+  string password = 2;
+  string name = 3;
+  string avatar = 4;
+}
+
+message UpdateUserResponse {
+  string ref = 1;
+}
+
+message DeleteUserRequest {
+  string ref = 1;
+}
+
+message DeleteUserResponse {
+  string ref = 1;
+}
+
+message Workspace {
+  string ref = 1;
+  string name = 2;
+  string owner_ref = 3;
+  int64 created_at = 4;
+  int64 updated_at = 5;
+}
+
+// ApiKey Resources
+
+message CreateApiKeyRequest {
+  string role = 1;
+  int32 expires_at = 2;
+}
+
+message CreateApiKeyResponse {
+  string ref = 1;
+  string access_key_id = 2;
+  string access_key_secret = 3;
+}
+
+message DeleteApiKeyRequest {
+  string ref = 1;
+}
+
+message DeleteApiKeyResponse {
+  string ref = 1;
+}
+
+message ListApiKeysRequest {
+  int32 page_size = 3;
+  string page_token = 2;
+}
+
+message ListApiKeysResponse {
+  repeated ApiKey items = 1;
+  string next_page_token = 2;
+}
+
+message RegenerateApiKeyRequest {
+  string ref = 1;
+}
+
+message RegenerateApiKeyResponse {
+  string ref = 1;
+  string access_key_id = 2;
+  string access_key_secret = 3;
+}
+
+message ApiKey {
+  string ref = 1;
+  string access_key_id = 2;
+  string role = 3;
+  int32 expires_at = 4;
+  int64 created_at = 5;
+  int64 updated_at = 6;
+}
+
+// Token Exchange Resources
+
+message ExchangeCredentialsRequest {
+  string username = 1;
+  string password = 2;
+  // Optional code for multi-factor authentication
+  string ephemeral_code = 3;
+}
+
+message ExchangeCredentialsResponse {
+  string id_token = 1;
+  string access_token = 2;
+  string refresh_token = 3;
+}
+
+message ExchangeApiKeyRequest {
+  string access_key_id = 1;
+  string access_key_secret = 2;
+}
+
+message ExchangeApiKeyResponse {
+  string id_token = 1;
+  string access_token = 2;
+  string refresh_token = 3;
+}
+
+message ExchangeOAuth2CodeRequest {
+  string code = 1;
+}
+
+message ExchangeOAuth2CodeResponse {
+  string id_token = 1;
+  string access_token = 2;
+  string refresh_token = 3;
+}
+
+message ExchangeRefreshTokenRequest {
+  string refresh_token = 1;
+}
+
+message ExchangeRefreshTokenResponse {
+  string id_token = 1;
+  string access_token = 2;
+  string refresh_token = 3;
+}
+
+message RevokeTokenRequest {
+  string token = 1;
+}
+
+message RevokeTokenResponse {
+  string token = 1;
+}
+
+// Message with response with the public key
+message GetPublicKeyResponse {
+  string public_key = 1;
+}

package/dist/protos/numbers.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.numbers.v1beta2;
+
+import "trunks.proto";
+
+// The Numbers service definition
+service Numbers {
+  // Create a new Number
+  rpc CreateNumber (CreateNumberRequest) returns (CreateNumberResponse) {}
+  // Update an existing Number
+  rpc UpdateNumber (UpdateNumberRequest) returns (UpdateNumberResponse) {}
+  // Get an existing Number
+  rpc GetNumber (GetNumberRequest) returns (Number) {}
+  // Delete an existing Number
+  rpc DeleteNumber (DeleteNumberRequest) returns (DeleteNumberResponse) {}
+  // List Numbers
+  rpc ListNumbers (ListNumbersRequest) returns (ListNumbersResponse) {}
+}
+
+// The message for the Number resource
+message Number {
+  // The unique identifier of the Number
+  string ref = 1;
+  // The name of the Number
+  string name = 2;
+  // The tel_url of the Number
+  string tel_url = 3;
+  // The aor_link of the Number
+  string aor_link = 4;
+  // The city of the Number
+  string city = 5;
+  // The country of the Number
+  string country = 6;
+  // The country_iso_code of the Number
+  string country_iso_code = 7;
+  // The header to use for session affinity
+  string session_affinity_header = 8;
+  // Extra headers to send to the trunk
+  repeated ExtraHeader extra_headers = 9;
+  // The date when the Number was created
+  int64 created_at = 10;
+  // The date when the Number was last updated
+  int64 updated_at = 11;
+  // The trunk this number is associated with
+  fonoster.trunks.v1beta2.Trunk trunk = 12;
+}
+
+// The message for the ExtraHeader field
+message ExtraHeader {
+  string name = 1;
+  string value = 2;
+}
+
+// The request message for Numbers.CreateNumber
+message CreateNumberRequest {
+  // The name of the Number
+  string name = 1;
+  // The tel_url of the Number
+  string tel_url = 2;
+  // The aor_link of the Number
+  string aor_link = 3;
+  // The city of the Number
+  string city = 4;
+  // The country of the Number
+  string country = 5;
+  // The country_iso_code of the Number
+  string country_iso_code = 6;
+  // The header to use for session affinity
+  string session_affinity_header = 7;
+  // Extra headers to send to the trunk
+  repeated ExtraHeader extra_headers = 8;
+  // Reference to the trunk this number is associated with
+  string trunk_ref = 9;
+}
+
+// The response message for Numbers.CreateNumber
+message CreateNumberResponse {
+  // The reference of the Number
+  string ref = 1;
+}
+
+// The request message for Numbers.UpdateNumber
+message UpdateNumberRequest {
+  // The unique identifier of the Number
+  string ref = 1;
+  // The name of the Number
+  string name = 2;
+  // The aor_link of the Number
+  string aor_link = 4;
+  // The header to use for session affinity
+  string session_affinity_header = 8;
+  // Extra headers to send to the trunk
+  repeated ExtraHeader extra_headers = 9;
+  // Reference to the trunk this number is associated with
+  string trunk_ref = 10;
+}
+
+// The response message for Numbers.UpdateNumber
+message UpdateNumberResponse {
+  // The reference of the Number
+  string ref = 1;
+}
+
+// The request message for Numbers.GetNumber
+message GetNumberRequest {
+  // The unique identifier of the Number
+  string ref = 1;
+}
+
+// The request message for Numbers.DeleteNumber
+message DeleteNumberRequest {
+  // The unique identifier of the Number
+  string ref = 1;
+}
+
+// The response message for Numbers.DeleteNumber
+message DeleteNumberResponse {
+  // The reference of the Number
+  string ref = 1;
+}
+
+// The request message for Numbers.ListNumbers
+message ListNumbersRequest {
+  // 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 Numbers.ListNumbers
+message ListNumbersResponse {
+  // List of Numbers
+  repeated Number 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/secrets.proto

@@ -0,0 +1,113 @@
+/*
+ * 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.secrets.v1beta2;
+
+// The Secrets service definition
+service Secrets {
+  // Creates a new Secret
+  rpc CreateSecret (CreateSecretRequest) returns (CreateSecretResponse) {}
+  // Updates an existing set of Secret
+  rpc UpdateSecret (UpdateSecretRequest) returns (UpdateSecretResponse) {}
+  // Gets the details of a given set of Secret
+  rpc GetSecret (GetSecretRequest) returns (Secret) {}
+  // Deletes an existing Secret
+  rpc DeleteSecret (DeleteSecretRequest) returns (DeleteSecretResponse) {}
+  // Lists all Secrets
+  rpc ListSecrets (ListSecretsRequest) returns (ListSecretsResponse) {}
+}
+
+// The message for the Secret resource
+message Secret {
+  // The reference of the Secret
+  string ref = 1;
+  // Friendly name of the Secret
+  string name = 2;
+  // The actual secret
+  string secret = 3;
+  // The time the Secret was created
+  int64 created_at = 4;
+  // The time the Secret was updated
+  int64 updated_at = 5;
+}
+
+// The request message for the Secrets.CreateSecret method
+message CreateSecretRequest {
+  // Friendly name of the Secret
+  string name = 1;
+  // The actual secret
+  string secret = 2;
+}
+
+// The response message for the Secrets.CreateSecret method
+message CreateSecretResponse {
+  // The reference of the created Secret
+  string ref = 1;
+}
+
+// The request message for the Secrets.UpdateSecret method
+message UpdateSecretRequest {
+  // The reference of the Secret to update
+  string ref = 1;
+  // The new name of the Secret
+  string name = 2;
+  // Updated secret
+  string secret = 3;
+}
+
+// The response message for the Secrets.UpdateSecret method
+message UpdateSecretResponse {
+  // The reference of the updated Secret
+  string ref = 1;
+}
+
+// The request message for the Secrets.GetSecret method
+message GetSecretRequest  {
+  // The reference of the Secret to retrieve
+  string ref = 1;
+}
+
+// The request message for the Secrets.DeleteSecret method
+message DeleteSecretRequest  {
+  // The reference of the Secret to delete
+  string ref = 1;
+}
+
+// The response message for the Secrets.DeleteSecret method
+message DeleteSecretResponse {
+  // The reference of the deleted Secret
+  string ref = 1;
+}
+
+// The request message for the Secrets.ListSecret method
+message ListSecretsRequest {
+  // 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 Secrets.ListSecret method
+message ListSecretsResponse {
+  // List of Secret
+  repeated Secret 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/trunks.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.trunks.v1beta2;
+
+import "acls.proto";
+import "credentials.proto";
+
+// The Trunks service definition
+service Trunks {
+  // Create a new Trunk
+  rpc CreateTrunk (CreateTrunkRequest) returns (CreateTrunkResponse) {}
+  // UpdateTrunk an existing Trunk
+  rpc UpdateTrunk (UpdateTrunkRequest) returns (UpdateTrunkResponse) {}
+  // Get a Trunk by reference
+  rpc GetTrunk (GetTrunkRequest) returns (Trunk) {}
+  // Delete a Trunk by reference
+  rpc DeleteTrunk (DeleteTrunkRequest) returns (DeleteTrunkResponse) {}
+  // List all Trunks
+  rpc ListTrunks (ListTrunkRequest) returns (ListTrunksResponse) {}
+}
+
+// The message for the Trunk URIs
+message TrunkURI {
+  // The host name or IP address of the Trunk
+  string host = 1;
+  // The port number of the Trunk
+  int32 port = 2;
+  // The transport protocol of the Trunk
+  string transport = 3;
+  // The username to use when authenticating with the Trunk
+  string user = 4;
+  // The weight of the Trunk
+  int32 weight = 5;
+  // The priority of the Trunk
+  int32 priority = 6;
+  // The flag to enable or disable the Trunk
+  bool enabled = 7;
+} 
+
+// The message for the Trunk resource
+message Trunk {
+  // The reference of the Trunk
+  string ref = 1;
+  // The name of the Trunk
+  string name = 2;
+  // A flag to indicate if we should send a REGISTER request to the Trunk
+  bool send_register = 3;
+  // The URI for inbound requests
+  string inbound_uri = 4;
+  // The date and time when the Trunk was created
+  int64 created_at = 5;
+  // The date and time when the Trunk was last updated
+  int64 updated_at = 6;
+  // The list of IP addresses that are allowed to access the Trunks
+  fonoster.acls.v1beta2.Acl access_control_list = 7;
+  // The credentials to use when authenticating with the Trunk
+  fonoster.credentials.v1beta2.Credentials inbound_credentials = 8;
+  // The credentials to use when authenticating with the Provider
+  fonoster.credentials.v1beta2.Credentials outbound_credentials = 9;
+  // The list of URIs for the Trunk
+  repeated TrunkURI uris = 10;
+}
+
+// The message for the Trunk.Create
+message CreateTrunkRequest {
+  // The name of the Trunk
+  string name = 1;
+  // A flag to indicate if we should send a REGISTER request to the Trunk
+  bool send_register = 2;
+  // The URI for inbound requests
+  string inbound_uri = 3;
+  // Reference to the AccessControlList
+  string access_control_list_ref = 4;
+  // Reference to the inbound Credentials
+  string inbound_credentials_ref = 5;
+  // Reference to the outbound Credentials
+  string outbound_credentials_ref = 6;
+  // The list of URIs for the Trunk
+  repeated TrunkURI uris = 7;
+}
+
+// The message for the Trunk.CreateTrunk response
+message CreateTrunkResponse {
+  // The reference of the Trunk
+  string ref = 1;
+}
+
+// The message for the Trunk.UpdateTrunk
+message UpdateTrunkRequest {
+  // The reference of the Trunk
+  string ref = 1;
+  // The name of the Trunk
+  string name = 2;
+  // A flag to indicate if we should send a REGISTER request to the Trunk
+  bool send_register = 3;
+  // The URI for inbound requests
+  string inbound_uri = 4;
+  // Reference to the AccessControlList
+  string access_control_list_ref = 5;
+  // Reference to the inbound Credentials
+  string inbound_credentials_ref = 6;
+  // Reference to the outbound Credentials
+  string outbound_credentials_ref = 7;
+  // The list of URIs for the Trunk
+  repeated TrunkURI uris = 8;
+}
+
+// The message for the Trunk.UpdateTrunk response
+message UpdateTrunkResponse {
+  // The reference of the Trunk
+  string ref = 1;
+}
+
+// The message for the Trunk.GetTrunk
+message GetTrunkRequest {
+  // The reference of the Trunk
+  string ref = 1;
+}
+
+// The message for the Trunk.DeleteTrunk
+message DeleteTrunkRequest {
+  // The reference of the Trunk
+  string ref = 1;
+}
+
+// The message for the Trunk.DeleteTrunk response
+message DeleteTrunkResponse {
+  // The reference of the Trunk
+  string ref = 1;
+}
+
+// The message for the Trunk.ListTrunk request
+message ListTrunkRequest {
+  // 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 message for the Trunk.ListTrunk response
+message ListTrunksResponse {
+  // List of Trunks
+  repeated Trunk 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;
+}