termination, tollfree and uctrunking product's settings api spec (#724)

Co-authored-by: ichesnov <[email protected]>

Author: xxlaykxx

site/specs-temp/numbers.json

@@ -12206,6 +12206,102 @@
         }
       }
     },
+    "/accounts/{accountId}/products/termination/settings": {
+      "get": {
+        "tags": [
+          "/accounts"
+        ],
+        "description": "Retrieve existing termination settings on account.",
+        "operationId": "GetAccountTerminationProductSettings",
+        "summary": "Retrieve termination settings on account",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountIdPathParam"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/xml": {
+                "schema": {
+                  "$ref": "#/components/schemas/TerminationSettingsResponse"
+                },
+                "examples": {
+                  "example": {
+                    "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<TerminationSettingResponse>\n    <TerminationSettings>\n        <RogerUsedForTerminationSettings>false</RogerUsedForTerminationSettings>\n        <LegacyTerminationSettings>\n            <CustomerTrafficAllowed>ALL</CustomerTrafficAllowed>\n            <CpsQueue>300</CpsQueue>\n            <ConcurrentOutboundCalls>15</ConcurrentOutboundCalls>\n            <ConcurrentBidirectionalCalls>0</ConcurrentBidirectionalCalls>\n            <BillingType>DNIS</BillingType>\n            <RateType>npanxx</RateType>\n            <DiscountPercentage>29</DiscountPercentage>\n            <GuaranteedTermination>false</GuaranteedTermination>\n        </LegacyTerminationSettings>\n        <RogerTerminationSettings/>\n    </TerminationSettings>\n    <!-- For Full Termination -->\n    <TerminationSettings>\n        <RogerUsedForTerminationSettings>true</RogerUsedForTerminationSettings>\n        <HttpVoiceProxyTermHost>[Host IP address]</HttpVoiceProxyTermHost>\n        <RogerTerminationSettings>\n            <SubnetAddressingAllowed>true</SubnetAddressingAllowed>\n        </RogerTerminationSettings>\n    </TerminationSettings>\n</TerminationSettingResponse>"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/accounts/{accountId}/products/tollfree/settings": {
+      "get": {
+        "tags": [
+          "/accounts"
+        ],
+        "description": "Retrieve existing tollfree settings on account.",
+        "operationId": "GetAccountTollFreeProductSettings",
+        "summary": "Retrieve tollfree settings on account",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountIdPathParam"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/xml": {
+                "schema": {
+                  "$ref": "#/components/schemas/TollFreeSettingsResponse"
+                },
+                "examples": {
+                  "example": {
+                    "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<TollFreeSettingsResponse>\n    <TollFreeSettings>\n        <RespOrgException>true</RespOrgException>\n        <RespOrgIdList>\n            <RespOrgId>SFD01</RespOrgId>\n            <RespOrgId>WER01</RespOrgId>\n            <RespOrgId>WER02</RespOrgId>\n            <RespOrgId>XMD01</RespOrgId>\n            <RespOrgId>PIU02</RespOrgId>\n        </RespOrgIdList>\n        <TargetBandwidthRespOrgId>JYT50</TargetBandwidthRespOrgId>\n    </TollFreeSettings>\n</TollFreeSettingsResponse>"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/accounts/{accountId}/products/uctrunking/settings": {
+      "get": {
+        "tags": [
+          "/accounts"
+        ],
+        "description": "Retrieve existing uctrunking settings on account.",
+        "operationId": "GetAccountUcTrunkingProductSettings",
+        "summary": "Retrieve uctrunking settings on account",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/AccountIdPathParam"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/xml": {
+                "schema": {
+                  "$ref": "#/components/schemas/UcTrunkingSettingsResponse"
+                },
+                "examples": {
+                  "example": {
+                    "value": "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<UcTrunkingSettingsResponse>\n    <UcTrunkingSettings>\n        <PartnerType>AGENT</PartnerType>\n        <MaxUcTrunks>40</MaxUcTrunks>\n        <BillingType>DNIS</BillingType>\n        <CustomerTrafficAllowed>ALL</CustomerTrafficAllowed>\n        <UsageCategory>UC500</UsageCategory>\n        <TrunkAllocationRules>\n            <TrunkAllocationRule>\n                <LowerBound>1</LowerBound>\n                <Ratio>1</Ratio>\n            </TrunkAllocationRule>\n            <TrunkAllocationRule>\n                <LowerBound>10</LowerBound>\n                <Ratio>2</Ratio>\n            </TrunkAllocationRule>\n            <TrunkAllocationRule>\n                <LowerBound>15</LowerBound>\n                <Ratio>5</Ratio>\n            </TrunkAllocationRule>\n        </TrunkAllocationRules>\n    </UcTrunkingSettings>\n</UcTrunkingSettingsResponse>"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/accounts/{accountId}/realms": {
       "get": {
         "tags": [
@@ -21111,7 +21207,7 @@
             "type": "string"
           },
           "PreDirectional": {
-            "description":"The PreDirectional is the non-numeric street name prefix of the ServiceAddress. This element is optional when not needed to fully specify the ServiceAddress.",
+            "description": "The PreDirectional is the non-numeric street name prefix of the ServiceAddress. This element is optional when not needed to fully specify the ServiceAddress.",
             "type": "string"
           },
           "StreetName": {
@@ -21511,7 +21607,8 @@
           "PinNumber": {
             "description": "Element of WirelessInfo. Not applicable to toll free port-ins. Cannot be SUPPed for Automated off-net port-ins. If you want to SUPP WirelessInfo, you must include both AccountNumber and PinNumber in the payload, even if you are not changing both.",
             "type": "string"
-          },"SiteId": {
+          },
+          "SiteId": {
             "description": "The numeric designation for the Site ID that applied to the Port-in Order. The SiteId is used to provide a home within the account for the TN(s) that were ported in by the Port-in Order.",
             "type": "string"
           },
@@ -26987,7 +27084,7 @@
                 "type": "integer"
               },
               "resultMessage": {
-                "description":"Results of the attempt to fetch the list of files.",
+                "description": "Results of the attempt to fetch the list of files.",
                 "type": "string"
               }
             }
@@ -30827,7 +30924,7 @@
                 "description": "This field is used to specify a new billing telephone number on the losing carrier account."
               },
               "Triggered": {
-                "description":"The Triggered field must be set to true if you want an activation time other than the 11:30 AM ET default. The desired activation time can then be specified in the time portion of the RequestedFocDate. Triggered activation is not yet supported for toll free port-in orders.",
+                "description": "The Triggered field must be set to true if you want an activation time other than the 11:30 AM ET default. The desired activation time can then be specified in the time portion of the RequestedFocDate. Triggered activation is not yet supported for toll free port-in orders.",
                 "type": "string"
               }
             }
@@ -33464,8 +33561,11 @@
           "RestrictedAccessTypes": {
             "type": "array",
             "items": {
-              "RestrictedAccessType": {
-                "type": "string"
+              "type": "object",
+              "properties": {
+                "RestrictedAccessType": {
+                  "type": "string"
+                }
               }
             }
           }
@@ -33604,6 +33704,182 @@
             "type": "integer"
           }
         }
+      },
+      "TerminationSettingsResponse": {
+        "type": "object",
+        "properties": {
+          "TerminationSettings": {
+            "$ref": "#/components/schemas/TerminationSettings"
+          }
+        }
+      },
+      "TerminationSettings": {
+        "type": "object",
+        "properties": {
+          "RogerUsedForTerminationSettings": {
+            "type": "boolean"
+          },
+          "LegacyTerminationSettings": {
+            "$ref": "#/components/schemas/LegacyTerminationSettings"
+          },
+          "RogerTerminationSettings": {
+            "$ref": "#/components/schemas/RogerTerminationSettings"
+          },
+          "HttpVoiceProxyTermHost": {
+            "type": "string",
+            "description": "can be used only with RogerTerminationSettings"
+          }
+        }
+      },
+      "LegacyTerminationSettings": {
+        "type": "object",
+        "properties": {
+          "CustomerTrafficAllowed": {
+            "type": "string",
+            "enum": [
+              "ALL",
+              "LITE",
+              "DOMESTIC",
+              "NONE"
+            ]
+          },
+          "CpsQueue": {
+            "type": "integer"
+          },
+          "ConcurrentOutboundCalls": {
+            "type": "integer"
+          },
+          "ConcurrentBidirectionalCalls": {
+            "type": "integer"
+          },
+          "BillingType": {
+            "type": "string",
+            "enum": [
+              "DNIS",
+              "LRN"
+            ]
+          },
+          "RateType": {
+            "type": "string",
+            "enum": [
+              "FLAT",
+              "FULL_CR",
+              "NPANXX",
+              "BILL_NUM_LCR"
+            ]
+          },
+          "DiscountPercentage": {
+            "type": "integer"
+          },
+          "GuaranteedTermination": {
+            "type": "boolean"
+          }
+        }
+      },
+      "RogerTerminationSettings": {
+        "type": "object",
+        "properties": {
+          "SubnetAddressingAllowed": {
+            "type": "boolean"
+          },
+          "TerminationId": {
+            "type": "integer"
+          }
+        }
+      },
+      "TollFreeSettingsResponse": {
+        "type": "object",
+        "properties": {
+          "TerminationSettings": {
+            "$ref": "#/components/schemas/TollFreeSettings"
+          }
+        }
+      },
+      "TollFreeSettings": {
+        "type": "object",
+        "properties": {
+          "RespOrgException": {
+            "type": "boolean"
+          },
+          "RespOrgIdList": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "RespOrgId": {
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "TargetBandwidthRespOrgId": {
+            "type": "string"
+          }
+        }
+      },
+      "UcTrunkingSettingsResponse": {
+        "type": "object",
+        "properties": {
+          "UcTrunkingSettings": {
+            "$ref": "#/components/schemas/UcTrunkingSettings"
+          }
+        }
+      },
+      "UcTrunkingSettings": {
+        "type": "object",
+        "properties": {
+          "PartnerType": {
+            "type": "string",
+            "enum": [
+              "RESELLER",
+              "AGENT"
+            ]
+          },
+          "MaxUcTrunks": {
+            "type": "integer"
+          },
+          "BillingType": {
+            "type": "string",
+            "enum": [
+              "DNIS",
+              "LRN"
+            ]
+          },
+          "CustomerTrafficAllowed": {
+            "type": "string",
+            "enum": [
+              "ALL",
+              "LITE",
+              "DOMESTIC",
+              "NONE"
+            ]
+          },
+          "UsageCategory": {
+            "type": "string",
+            "enum": [
+              "UC250",
+              "UC500",
+              "UC1000"
+            ]
+          },
+          "TrunkAllocationRules": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/TrunkAllocationRule"
+            }
+          }
+        }
+      },
+      "TrunkAllocationRule": {
+        "type": "object",
+        "properties": {
+          "LowerBound": {
+            "type": "integer"
+          },
+          "Ratio": {
+            "type": "integer"
+          }
+        }
       }
     },
     "parameters": {