@routr/common 2.0.8-alpha.14 → 2.0.8-alpha.15

package/dist/connect/protos/numbers.proto

@@ -0,0 +1,184 @@
+/*
+ * 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;
+  // The date when the Number was created
+  int32 created_at = 10;
+  // The date when the Number was last updated
+  int32 updated_at = 11;
+  // The trunk this number is associated with
+  fonoster.routr.connect.trunks.v2draft1.Trunk trunk = 12;
+  // The extended attributes of the Number
+  .google.protobuf.Struct extended = 13;
+}
+
+// The request message for Numbers.Update
+message UpdateNumberRequest {
+  // 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 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,166 @@
+/*
+ * 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) {}
+}
+
+// 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 status of the Peer
+  bool enabled = 7;
+  // The date and time when the Peer was created
+  int32 created_at = 8;
+  // The date and time when the Peer was last updated
+  int32 updated_at = 9;
+  // The list of IP addresses that are allowed to access the Peer
+  fonoster.routr.connect.acl.v2draft1.AccessControlList access_control_list = 10;
+  // The credentials of the Peer
+  fonoster.routr.connect.credentials.v2draft1.Credentials credentials = 11;
+  // The extended attributes of the Peer
+  .google.protobuf.Struct extended = 12;
+}
+
+// The request message for the Peers.Create method
+message CreatePeerRequest  {
+  // The API version of the Peer
+  string api_version = 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 status of the Peer
+  bool enabled = 6;
+  // The date and time when the Peer was created
+  int32 created_at = 7;
+  // The date and time when the Peer was last updated
+  int32 updated_at = 8;
+  //The list of IP addresses that are allowed to access the Peer
+  fonoster.routr.connect.acl.v2draft1.AccessControlList access_control_list = 9;
+  // The credentials of the Peer
+  fonoster.routr.connect.credentials.v2draft1.Credentials credentials = 10;
+  // The extended attributes of the Peer
+  .google.protobuf.Struct extended = 11;
+}
+
+// The request message for the Peers.Update method
+message UpdatePeerRequest {
+  // 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 status of the Peer
+  bool enabled = 7;
+  // The date and time when the Peer was created
+  int32 created_at = 8;
+  // The date and time when the Peer was last updated
+  int32 updated_at = 9;
+  // The list of IP addresses that are allowed to access the Peer
+  fonoster.routr.connect.acl.v2draft1.AccessControlList access_control_list = 10;
+  // The credentials of the Peer
+  fonoster.routr.connect.credentials.v2draft1.Credentials credentials = 11;
+  // The extended attributes of the Peer
+  .google.protobuf.Struct extended = 12;
+}
+
+// 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;
+}

package/dist/connect/protos/trunks.proto

@@ -0,0 +1,186 @@
+/*
+ * 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.trunks.v2draft1;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/empty.proto";
+import "acl.proto";
+import "credentials.proto";
+
+// The Trunks service definition
+service Trunks {
+  // Create a new Trunk
+  rpc Create (CreateTrunkRequest) returns (Trunk) {}
+  // Update an existing Trunk
+  rpc Update (UpdateTrunkRequest) returns (Trunk) {}
+  // Get a Trunk by reference
+  rpc Get (GetTrunkRequest) returns (Trunk) {}
+  // Delete a Trunk by reference
+  rpc Delete (DeleteTrunkRequest) returns (.google.protobuf.Empty) {}
+  // List all Trunks
+  rpc List (ListTrunkRequest) returns (ListTrunksResponse) {}
+  // Find Trunks by field name and value
+  rpc FindBy (FindByRequest) returns (FindByResponse) {}
+}
+
+// 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 API version of the Trunk
+  string api_version = 2;
+  // The reference of the Trunk
+  string ref = 1;
+  // The name of the Trunk
+  string name = 3;
+  // A flag to indicate if we should send a REGISTER request to the Trunk
+  bool send_register = 4;
+  // The URI for inbound requests
+  string inbound_uri = 5;
+  // The date and time when the Trunk was created
+  int32 created_at = 6;
+  // The date and time when the Trunk was last updated
+  int32 updated_at = 7;
+  // The list of IP addresses that are allowed to access the Trunks
+  fonoster.routr.connect.acl.v2draft1.AccessControlList access_control_list = 8;
+  // The credentials to use when authenticating with the Trunk
+  fonoster.routr.connect.credentials.v2draft1.Credentials inbound_credentials = 9;
+  // The credentials to use when authenticating with the Provider
+  fonoster.routr.connect.credentials.v2draft1.Credentials outbound_credentials = 10;
+  // The list of URIs for the Trunk
+  repeated TrunkUri uris = 11;
+  // The extended attributes of the Trunk
+  .google.protobuf.Struct extended = 12;
+}
+
+// The message for the Trunk.Create
+message CreateTrunkRequest {
+  // The API version of the Trunk
+  string api_version = 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
+  int32 created_at = 5;
+  // The date and time when the Trunk was last updated
+  int32 updated_at = 6;
+  // The list of IP addresses that are allowed to access the Trunks
+  fonoster.routr.connect.acl.v2draft1.AccessControlList access_control_list = 7;
+  // The credentials to use when authenticating with the Trunk
+  fonoster.routr.connect.credentials.v2draft1.Credentials inbound_credentials = 8;
+  // The credentials to use when authenticating with the Provider
+  fonoster.routr.connect.credentials.v2draft1.Credentials outbound_credentials = 9;
+  // The list of URIs for the Trunk
+  repeated TrunkUri uris = 10;
+  // The extended attributes of the Trunk
+  .google.protobuf.Struct extended = 11;
+}
+
+// The message for the Trunk.Update
+message UpdateTrunkRequest {
+  // The API version of the Trunk
+  string api_version = 1;
+  // The reference of the Trunk
+  string ref = 2;
+  // The name of the Trunk
+  string name = 3;
+  // A flag to indicate if we should send a REGISTER request to the Trunk
+  bool send_register = 4;
+  // The URI for inbound requests
+  string inbound_uri = 5;
+  // The date and time when the Trunk was created
+  int32 created_at = 6;
+  // The date and time when the Trunk was last updated
+  int32 updated_at = 7;
+  // // The list of IP addresses that are allowed to access the Trunks
+  fonoster.routr.connect.acl.v2draft1.AccessControlList access_control_list = 8;
+  // The credentials to use when authenticating with the Trunk
+  fonoster.routr.connect.credentials.v2draft1.Credentials inbound_credentials = 9;
+  // The credentials to use when authenticating with the Provider
+  fonoster.routr.connect.credentials.v2draft1.Credentials outbound_credentials = 10;
+  // The list of URIs for the Trunk
+  repeated TrunkUri uris = 11;
+  // The extended attributes of the Trunk
+  .google.protobuf.Struct extended = 12;
+}
+
+// The message for the Trunk.Get
+message GetTrunkRequest {
+  // The reference of the Trunk
+  string ref = 1;
+}
+
+// The message for the Trunk.Delete
+message DeleteTrunkRequest {
+  // The reference of the Trunk
+  string ref = 1;
+}
+
+// The message for the Trunk.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 Trunks.FindBy method
+message FindByResponse {
+  // The list of Trunks items
+  repeated Trunk items = 1;
+} 
+
+// The message for the Trunk.List
+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.List 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;
+}

package/dist/connect/schemas/acl.d.ts

@@ -23,6 +23,7 @@ declare const _default: {
                     type: string;
                 };
             };
+            required: string[];
         };
         spec: {
             description: string;

package/dist/connect/schemas/acl.js

@@ -28,7 +28,7 @@ exports.default = {
             enum: ["v2draft1", "v2.0", "v2"]
         },
         kind: {
-            enum: ["AccessControlList", "accesscontrolList"]
+            enum: ["AccessControlList", "accesscontrollist"]
         },
         ref: {
             description: "Unique identifier for this resource",
@@ -42,7 +42,8 @@ exports.default = {
                     description: "Resource's friendly name",
                     type: "string"
                 }
-            }
+            },
+            required: ["name"]
         },
         spec: {
             description: "Operations spec for ACL",

package/dist/connect/schemas/agent.d.ts

@@ -23,6 +23,7 @@ declare const _default: {
                     type: string;
                 };
             };
+            required: string[];
         };
         spec: {
             description: string;

package/dist/connect/schemas/agent.js

@@ -42,7 +42,8 @@ exports.default = {
                     description: "Resource's friendly name",
                     type: "string"
                 }
-            }
+            },
+            required: ["name"]
         },
         spec: {
             description: "Operations spec for an Agent",
@@ -64,15 +65,15 @@ exports.default = {
                     type: "string"
                 },
                 enabled: {
-                    description: "Whether the Agent is enabled",
+                    description: "Whether the Agent is enabled (reserved for future use)",
                     type: "boolean"
                 },
                 privacy: {
                     enum: ["Private", "None", "private", "none"]
                 }
             },
-            required: ["username", "domainRef", "credentialsRef"]
+            required: ["username"]
         }
     },
-    required: ["apiVersion", "kind", "ref", "metadata", "spec"]
+    required: ["apiVersion", "kind", "metadata", "spec"]
 };

package/dist/connect/schemas/crendentials.d.ts

@@ -23,6 +23,7 @@ declare const _default: {
                     type: string;
                 };
             };
+            required: string[];
         };
         spec: {
             description: string;

package/dist/connect/schemas/crendentials.js

@@ -42,7 +42,8 @@ exports.default = {
                     description: "Resource's friendly name",
                     type: "string"
                 }
-            }
+            },
+            required: ["name"]
         },
         spec: {
             description: "Operations spec for Credentials",

package/dist/connect/schemas/domain.d.ts

@@ -23,6 +23,7 @@ declare const _default: {
                     type: string;
                 };
             };
+            required: string[];
         };
         spec: {
             description: string;
@@ -42,7 +43,7 @@ declare const _default: {
                             description: string;
                             type: string;
                         };
-                        egressPolicy: {
+                        egressPolicies: {
                             description: string;
                             type: string;
                             items: {

package/dist/connect/schemas/domain.js

@@ -42,7 +42,8 @@ exports.default = {
                     description: "Resource's friendly name",
                     type: "string"
                 }
-            }
+            },
+            required: ["name"]
         },
         spec: {
             description: "Operations spec for an Domain",
@@ -62,7 +63,7 @@ exports.default = {
                             description: "The reference to the AccessControlList",
                             type: "string"
                         },
-                        egressPolicy: {
+                        egressPolicies: {
                             description: "The egress policy for the Domain",
                             type: "array",
                             items: {

package/dist/connect/schemas/number.d.ts

@@ -23,6 +23,7 @@ declare const _default: {
                     type: string;
                 };
             };
+            required: string[];
         };
         spec: {
             description: string;

package/dist/connect/schemas/number.js

@@ -42,7 +42,8 @@ exports.default = {
                     description: "Resource's friendly name",
                     type: "string"
                 }
-            }
+            },
+            required: ["name"]
         },
         spec: {
             description: "Operations spec for Numbers",
@@ -86,10 +87,10 @@ exports.default = {
                             }
                         }
                     },
-                    required: ["telUrl", "aorLink"]
+                    required: ["telUrl"]
                 }
             },
-            required: ["trunkRef", "location"]
+            required: ["location"]
         }
     },
     required: ["apiVersion", "kind", "ref", "metadata", "spec"]