@routr/common 2.0.8-alpha.2 → 2.0.8-alpha.20

package/dist/connect/protos/credentials.proto

@@ -0,0 +1,114 @@
+/*
+ * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/routr
+ *
+ * This file is part of Routr
+ *
+ * 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.routr.connect.credentials.v2draft1;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/empty.proto";
+
+// The Credentials service definition
+service CredentialsService {
+  // Creates a new set of Credentials
+  rpc Create (CreateCredentialsRequest) returns (Credentials) {}
+  // Updates an existing set of C redentials
+  rpc Update (UpdateCredentialsRequest) returns (Credentials) {}
+  // Gets the details of a given set of Credentials
+  rpc Get (GetCredentialsRequest) returns (Credentials) {}
+  // Deletes an existing set of Credentials
+  rpc Delete (DeleteCredentialsRequest) returns (.google.protobuf.Empty) {}
+  // Lists all Credentials
+  rpc List (ListCredentialsRequest) returns (ListCredentialsResponse) {}
+}
+
+// The message for the Credentials resource
+message Credentials {
+  // The API version of the Credentials
+  string api_version = 1;
+  // The reference of the Credentials
+  string ref = 2;
+  // The name of the Credentials
+  string name = 3;
+  // The username of the Credentials
+  string username = 4;
+  // The password of the Credentials
+  string password = 5;
+  // The time the Credentials was created
+  int32 created_at = 6;
+  // The time the Credentials was updated
+  int32 updated_at = 7;
+  // The extended attributes for a set of Credentials
+  .google.protobuf.Struct extended = 8;    
+}
+
+// The request message for the CreateCredentials.Create 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 extended attributes for a set of Credentials
+  .google.protobuf.Struct extended = 4;  
+}
+
+// The request message for the UpdateCredentials.Update 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 extended attributes for a set of Credentials
+  .google.protobuf.Struct extended = 5;  
+}
+
+// The request message for the GetCredentials.Get method
+message GetCredentialsRequest  {
+  // The reference of the Credentials to retrieve
+  string ref = 1;
+}
+
+// The request message for the DeleteCredentials.Delete method
+message DeleteCredentialsRequest  {
+  // The reference of the Credentials to delete
+  string ref = 1;
+}
+
+// The request message for the ListCredentials.List 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 ListCredentials.List 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;
+}

package/dist/connect/protos/domains.proto

@@ -0,0 +1,148 @@
+/*
+ * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/routr
+ *
+ * This file is part of Routr
+ *
+ * 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.routr.connect.domains.v2draft1;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/empty.proto";
+import "acl.proto";
+import "numbers.proto";
+
+// The Domains service definition
+service Domains {
+  // Create a new Domain
+  rpc Create (CreateDomainRequest) returns (Domain) {}
+  // Update an existing Domain
+  rpc Update (UpdateDomainRequest) returns (Domain) {}
+  // Get an existing Domain
+  rpc Get (GetDomainRequest) returns (Domain) {}
+  // Delete an existing Domain
+  rpc Delete (DeleteDomainRequest) returns (.google.protobuf.Empty) {}
+  // List all Domains
+  rpc List (ListDomainRequest) returns (ListDomainsResponse) {}
+  // Find a Domain by field name and value
+  rpc FindBy (FindByRequest) returns (FindByResponse) {}
+}
+
+// EgressPolicy defines the policy for egress traffic
+message EgressPolicy {
+  // The pattern to match
+  string rule = 1;
+  // Reference to the number to use for egress
+  string number_ref = 2;
+  // The egress Number
+  fonoster.routr.connect.numbers.v2draft1.Number number = 3;
+}
+
+// The message for the Domain resource
+message Domain {
+  // The API version of the Domain
+  string api_version = 1;  
+  // The unique identifier of the Domain
+  string ref = 2;
+  // The name of the Domain
+  string name = 3;
+  // The URI of the Domain
+  string domain_uri = 4;
+  // The date of creation of the Domain
+  int32 created_at = 5;
+  // The date of the last update
+  int32 updated_at = 6;
+  // The list of IP addresses that are allowed to access the Domain
+  fonoster.routr.connect.acl.v2draft1.AccessControlList access_control_list = 7;
+  // The egress_policy of the Domain
+  repeated EgressPolicy egress_policies = 8;
+  // The extended attributes of the Domain
+  .google.protobuf.Struct extended = 9;
+}
+
+// The request message for Domains.Create
+message CreateDomainRequest {
+  // The name of the Domain
+  string name = 1;
+  // The domain_uri of the Domain
+  string domain_uri = 2;
+  // Reference to the ACL to use for this Domain
+  string access_control_list_ref = 3;
+  // The egress_policy of the Domain
+  repeated EgressPolicy egress_policies = 4;
+  // The extended attributes of the Domain
+  .google.protobuf.Struct extended = 5;
+}
+
+// The request message for Domains.Update
+message UpdateDomainRequest {
+  // The unique identifier of the Domain
+  string ref = 1;
+  // The name of the Domain
+  string name = 2;
+  // The domain_uri of the Domain
+  string domain_uri = 3;
+  // Reference to the ACL to use for this Domain
+  string access_control_list_ref = 4;
+  // The egress_policy of the Domain
+  repeated EgressPolicy egress_policies = 5;
+  // The extended attributes of the Domain
+  .google.protobuf.Struct extended = 6;
+}
+
+// The request message for Domains.Get
+message GetDomainRequest {
+  // The unique identifier of the Domain
+  string ref = 1;
+}
+
+// The request message for Domains.Delete
+message DeleteDomainRequest {
+  // The unique identifier of the Domain
+  string ref = 1;
+}
+
+// The request message for Domains.FindBy
+message FindByRequest {
+  // The field name to search
+  string field_name = 1;
+  // The value to search
+  string field_value = 2;
+}
+
+// The response message for the Domains.FindBy method
+message FindByResponse {
+  // The list of Domains
+  repeated Domain items = 1;
+} 
+
+// The request message for Domains.List
+message ListDomainRequest {
+  // 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 Domains.List
+message ListDomainsResponse {
+  // List of Domains
+  repeated Domain 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/connect/protos/numbers.proto

@@ -0,0 +1,174 @@
+/*
+ * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/routr
+ *
+ * This file is part of Routr
+ *
+ * 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.routr.connect.numbers.v2draft1;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/empty.proto";
+import "trunks.proto";
+
+// The Numbers service definition
+service Numbers {
+  // Create a new Number
+  rpc Create (CreateNumberRequest) returns (Number) {}
+  // Update an existing Number
+  rpc Update (UpdateNumberRequest) returns (Number) {}
+  // Get an existing Number
+  rpc Get (GetNumberRequest) returns (Number) {}
+  // Delete an existing Number
+  rpc Delete (DeleteNumberRequest) returns (.google.protobuf.Empty) {}
+  // List Numbers
+  rpc List (ListNumberRequest) returns (ListNumbersResponse) {}
+  // Find Numbers by field name and value
+  rpc FindBy (FindByRequest) returns (FindByResponse) {}
+}
+
+// The message for the Number resource
+message Number {
+  // The version of the Number
+  string api_version = 1;
+  // The unique identifier of the Number
+  string ref = 2;
+  // The name of the Number
+  string name = 3;
+  // The tel_url of the Number
+  string tel_url = 4;
+  // The aor_link of the Number
+  string aor_link = 5;
+  // The city of the Number
+  string city = 6;
+  // The country of the Number
+  string country = 7;
+  // The country_iso_code of the Number
+  string country_iso_code = 8;
+  // The header to use for session affinity
+  string session_affinity_header = 9;
+  // Extra headers to send to the trunk
+  repeated ExtraHeader extra_headers = 10;
+  // The date when the Number was created
+  int32 created_at = 11;
+  // The date when the Number was last updated
+  int32 updated_at = 12;
+  // The trunk this number is associated with
+  fonoster.routr.connect.trunks.v2draft1.Trunk trunk = 13;
+  // The extended attributes of the Number
+  .google.protobuf.Struct extended = 14;
+}
+
+// The message for the ExtraHeader field
+message ExtraHeader {
+  string name = 1;
+  string value = 2;
+}
+
+// The request message for Numbers.Create
+message CreateNumberRequest {
+  // The version of the Number
+  string api_version = 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;
+  // Reference to the trunk this number is associated with
+  string trunk_ref = 10;
+  // The extended attributes of the Number
+  .google.protobuf.Struct extended = 11;
+}
+
+// The request message for Numbers.Update
+message UpdateNumberRequest {
+  // 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;
+  // Reference to the trunk this number is associated with
+  string trunk_ref = 10;
+  // The extended attributes of the Number
+  .google.protobuf.Struct extended = 11;
+}
+
+// The request message for Numbers.Get
+message GetNumberRequest {
+  // The unique identifier of the Number
+  string ref = 1;
+}
+
+// The request message for Numbers.Delete
+message DeleteNumberRequest {
+  // The unique identifier of the Number
+  string ref = 1;
+}
+
+// The request message for Numbers.FindBy
+message FindByRequest {
+  // The field name to search
+  string field_name = 1;
+  // The value to search
+  string field_value = 2;
+}
+
+// The response message for the Numbers.FindBy method
+message FindByResponse {
+  // The list of Numbers
+  repeated Number items = 1;
+} 
+
+// The request message for Numbers.List
+message ListNumberRequest {
+  // 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;
+}
+
+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/connect/protos/peers.proto

@@ -0,0 +1,173 @@
+/*
+ * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/routr
+ *
+ * This file is part of Routr
+ *
+ * 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.routr.connect.peers.v2draft1;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/empty.proto";
+import "acl.proto";
+import "credentials.proto";
+
+// The Peer service definition
+service Peers {
+  // Creates a new Peer
+  rpc Create (CreatePeerRequest) returns (Peer) {}
+  // Updates an existing Peer
+  rpc Update (UpdatePeerRequest) returns (Peer) {}
+  // Gets an existing Peer
+  rpc Get (GetPeerRequest) returns (Peer) {}
+  // Deletes an existing Peer
+  rpc Delete (DeletePeerRequest) returns (.google.protobuf.Empty) {}
+  // Lists all Peers
+  rpc List (ListPeersRequest) returns (ListPeersResponse) {}
+  // Find Agents by field name and value
+  rpc FindBy (FindByRequest) returns (FindByResponse) {}
+}
+
+enum LoadBalancingAlgorithm {
+  // The round robin load balancing algorithm
+  ROUND_ROBIN = 0;
+  // The least sessions load balancing algorithm
+  LEAST_SESSIONS = 1;
+}
+
+// The message for the Peer resource
+message Peer {
+  // The API version of the Peer
+  string api_version = 1;
+  // The unique identifier of the Peer
+  string ref = 2;
+  // The name of the Peer
+  string name = 3;
+  // The username of the Peer
+  string username = 4;
+  // The address of record of the Peer
+  string aor = 5;
+  // The contact address of the Peer
+  string contact_addr = 6;
+  // The load balancing algorithm of the Peer
+  LoadBalancingAlgorithm load_balancing_algorithm = 7;
+  // The session affinity of the Peer
+  bool with_session_affinity = 8;
+  // The status of the Peer
+  bool enabled = 9;
+  // The date and time when the Peer was created
+  int32 created_at = 10;
+  // The date and time when the Peer was last updated
+  int32 updated_at = 11;
+  // The list of IP addresses that are allowed to access the Peer
+  fonoster.routr.connect.acl.v2draft1.AccessControlList access_control_list = 12;
+  // The credentials of the Peer
+  fonoster.routr.connect.credentials.v2draft1.Credentials credentials = 13;
+  // The extended attributes of the Peer
+  .google.protobuf.Struct extended = 14;
+}
+
+// The request message for the Peers.Create method
+message CreatePeerRequest  {
+  // The name of the Peer
+  string name = 1;
+  // The username of the Peer
+  string username = 2;
+  // The address of record of the Peer
+  string aor = 3;
+  // The contact address of the Peer
+  string contact_addr = 4;
+  // The load balancing algorithm of the Peer
+  LoadBalancingAlgorithm load_balancing_algorithm = 5;
+  // The session affinity of the Peer
+  bool with_session_affinity = 6;
+  // Reference to the ACL of the Peer
+  string access_control_list_ref = 7;
+  // Reference to the Credentials of the Peer
+  string credentials_ref = 8;
+  // The status of the Peer
+  bool enabled = 9;
+  // The extended attributes of the Peer
+  .google.protobuf.Struct extended = 10;
+}
+
+// The request message for the Peers.Update method
+message UpdatePeerRequest {
+  // The unique identifier of the Peer
+  string ref = 1;
+  // The name of the Peer
+  string name = 2;
+  // The username of the Peer
+  string username = 3;
+  // The address of record of the Peer
+  string aor = 4;
+  // The contact address of the Peer
+  string contact_addr = 5;
+  // The load balancing algorithm of the Peer
+  LoadBalancingAlgorithm load_balancing_algorithm = 6;
+  // The session affinity of the Peer
+  bool with_session_affinity = 7;
+  // Reference to the ACL of the Peer
+  string access_control_list_ref = 8;
+  // Reference to the Credentials of the Peer
+  string credentials_ref = 9;
+  // The status of the Peer
+  bool enabled = 10;
+  // The extended attributes of the Peer
+  .google.protobuf.Struct extended = 11;
+}
+
+// The request message for the Peers.Get method
+message GetPeerRequest {
+  // The unique identifier of the Peer
+  string ref = 1;
+}
+
+// The request message for the Peers.Delete method
+message DeletePeerRequest {
+  // The unique identifier of the Peer
+  string ref = 1;
+}
+
+// The request message for the Peers.FindBy method
+message FindByRequest {
+  // The field name to search
+  string fieldName = 1;
+  // The value to search
+  string fieldValue = 2;
+}
+
+// The response message for the Peers.FindBy method
+message FindByResponse {
+  // The list of Peers items
+  repeated Peer items = 1;
+} 
+
+message ListPeersRequest {
+  // 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;
+}
+
+message ListPeersResponse {
+  // List of Peers items
+  repeated Peer 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;
+}