PORT-4: list agent ports (2600hz#5509)

jsemon · Mar 12, 2019 · 498ed6b · 498ed6b
1 parent 97382ec
commit 498ed6b
Show file tree

Hide file tree

Showing 43 changed files with 2,871 additions and 1,646 deletions.
diff --git a/applications/crossbar/doc/port_requests.md b/applications/crossbar/doc/port_requests.md
diff --git a/applications/crossbar/doc/ref/comments.md b/applications/crossbar/doc/ref/comments.md
@@ -2,7 +2,15 @@
 
 ## About Comments
 
-## Schema
+#### Schema
+
+Schema for comments
+
+
+
+Key | Description | Type | Default | Required | Support Level
+--- | ----------- | ---- | ------- | -------- | -------------
+`comments` | The history of comments made on a object | `["array(", "[#/definitions/comment](#comment)", ")"]` |   | `false` |  
 
 
 

diff --git a/applications/crossbar/doc/ref/port_requests.md b/applications/crossbar/doc/ref/port_requests.md
@@ -10,27 +10,32 @@ Schema for a port request
 
 Key | Description | Type | Default | Required | Support Level
 --- | ----------- | ---- | ------- | -------- | -------------
+`bill.account_number` | Account Number to identify account | `string()` |   | `false` |  
+`bill.btn` | Billing Telephone Number (BTN) to identify account | `string()` |   | `false` |  
 `bill.carrier` | The name of the losing carrier | `string()` |   | `false` |  
-`bill.extended_address` | The suite/floor/apt of the billing address the losing carrier has on record | `string()` |   | `false` |  
 `bill.locality` | The locality (city) of the billing address the losing carrier has on record | `string()` |   | `false` |  
 `bill.name` | The losing carrier billing/account name | `string()` |   | `false` |  
+`bill.pin` | Personal Identification Number (PIN) to identify account | `string()` |   | `false` |  
 `bill.postal_code` | The zip/postal code of the billing address the losing carrier has on record | `string()` |   | `false` |  
 `bill.region` | The region (state) of the billing address the losing carrier has on record | `string()` |   | `false` |  
 `bill.street_address` | The street name of the billing address the losing carrier has on record | `string()` |   | `false` |  
 `bill.street_number` | The street number of the billing address the losing carrier has on record | `string()` |   | `false` |  
+`bill.street_post_dir` | Street Post-Direction | `string('E' | 'N' | 'NE' | 'NW' | 'S' | 'SE' | 'SW' | 'W')` |   | `false` |  
+`bill.street_pre_dir` | Street Pre-Direction | `string('E' | 'N' | 'NE' | 'NW' | 'S' | 'SE' | 'SW' | 'W')` |   | `false` |  
 `bill.street_type` | The street type of the billing address the losing carrier has on record | `string()` |   | `false` |  
 `bill` | Billing information of the losing carrier | `object()` |   | `false` |  
-`comments` | The history of comments made on a port request | `array(object())` |   | `false` |  
+`comments` | The history of comments made on a port request | `["array(", "[#/definitions/comment](#comment)", ")"]` |   | `false` |  
 `name` | A friendly name for the port request | `string(1..128)` |   | `true` |  
 `notifications.email.send_to` | A list or string of email recipient(s) | `string() | array(string())` |   | `false` |  
 `notifications.email` | Inbound Email Notifications | `object()` |   | `false` |  
 `notifications` | Status notifications | `object()` |   | `false` |  
 `numbers./\+?[0-9]+/` |   | `object()` |   | `false` |  
 `numbers` | The numbers to port in | `object()` |   | `true` |  
-`port_state` | What state the port request is currently in | `string('unconfirmed' | 'pending' | 'submitted' | 'scheduled' | 'completed' | 'rejected' | 'canceled')` | `unconfirmed` | `false` |  
+`reference_number` | Winning carrier reference number or order ID | `string()` |   | `false` |  
 `signee_name` | The name of the person authorizing the release of numbers from the losing carrier | `string()` |   | `false` |  
 `signing_date` | The date in Gregorian timestamp on which the document releasing the numbers from the losing carrier was signed | `integer()` |   | `false` |  
 `transfer_date` | Requested transfer date in Gregorian timestamp | `integer()` |   | `false` |  
+`winning_carrier` | The name of winning carrier | `string()` |   | `false` |  
 
 
 
@@ -96,76 +101,6 @@ curl -v -X DELETE \
 
 ## Fetch
 
-> GET /v2/accounts/{ACCOUNT_ID}/port_requests/unconfirmed
-
-```shell
-curl -v -X GET \
-    -H "X-Auth-Token: {AUTH_TOKEN}" \
-    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/port_requests/unconfirmed
-```
-
-## Fetch
-
-> GET /v2/accounts/{ACCOUNT_ID}/port_requests/canceled
-
-```shell
-curl -v -X GET \
-    -H "X-Auth-Token: {AUTH_TOKEN}" \
-    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/port_requests/canceled
-```
-
-## Fetch
-
-> GET /v2/accounts/{ACCOUNT_ID}/port_requests/rejected
-
-```shell
-curl -v -X GET \
-    -H "X-Auth-Token: {AUTH_TOKEN}" \
-    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/port_requests/rejected
-```
-
-## Fetch
-
-> GET /v2/accounts/{ACCOUNT_ID}/port_requests/completed
-
-```shell
-curl -v -X GET \
-    -H "X-Auth-Token: {AUTH_TOKEN}" \
-    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/port_requests/completed
-```
-
-## Fetch
-
-> GET /v2/accounts/{ACCOUNT_ID}/port_requests/scheduled
-
-```shell
-curl -v -X GET \
-    -H "X-Auth-Token: {AUTH_TOKEN}" \
-    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/port_requests/scheduled
-```
-
-## Fetch
-
-> GET /v2/accounts/{ACCOUNT_ID}/port_requests/pending
-
-```shell
-curl -v -X GET \
-    -H "X-Auth-Token: {AUTH_TOKEN}" \
-    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/port_requests/pending
-```
-
-## Fetch
-
-> GET /v2/accounts/{ACCOUNT_ID}/port_requests/submitted
-
-```shell
-curl -v -X GET \
-    -H "X-Auth-Token: {AUTH_TOKEN}" \
-    http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/port_requests/submitted
-```
-
-## Fetch
-
 > GET /v2/accounts/{ACCOUNT_ID}/port_requests/last_submitted
 
 ```shell

diff --git a/applications/crossbar/doc/ref/whitelabel.md b/applications/crossbar/doc/ref/whitelabel.md
@@ -21,7 +21,7 @@ Key | Description | Type | Default | Required | Support Level
 `nav.learn_more` | The URL to use when the 'Learn More!' link is clicked | `string()` |   | `false` | `supported`
 `nav` | Properties related to navigation in the UI | `object()` |   | `false` |  
 `outbound_trunks_price` | The price to show for outbound trunks, this is currently only for display purposes | `string()` |   | `false` | `beta`
-`port.authority` | The email(s) to be used for admin port requests | `string() | array(string())` |   | `false` | `supported`
+`port.authority` | The account ID(s) to be used for administrating port requests | `string() | array(string())` |   | `false` | `supported`
 `port.features` | The URL to use when the features link is clicked | `string()` |   | `false` | `supported`
 `port.loa` | The URL to use when the LOA link is clicked | `string()` |   | `false` | `supported`
 `port.resporg` | The URL to use when the resporg link is clicked | `string()` |   | `false` | `supported`

diff --git a/applications/crossbar/doc/whitelabeling.md b/applications/crossbar/doc/whitelabeling.md
@@ -21,7 +21,7 @@ Key | Description | Type | Default | Required | Support Level
 `nav.learn_more` | The URL to use when the 'Learn More!' link is clicked | `string()` |   | `false` | `supported`
 `nav` | Properties related to navigation in the UI | `object()` |   | `false` |  
 `outbound_trunks_price` | The price to show for outbound trunks, this is currently only for display purposes | `string()` |   | `false` | `beta`
-`port.authority` | The email(s) to be used for admin port requests | `string() | array(string())` |   | `false` | `supported`
+`port.authority` | The account ID(s) to be used for administrating port requests | `string() | array(string())` |   | `false` | `supported`
 `port.features` | The URL to use when the features link is clicked | `string()` |   | `false` | `supported`
 `port.loa` | The URL to use when the LOA link is clicked | `string()` |   | `false` | `supported`
 `port.resporg` | The URL to use when the resporg link is clicked | `string()` |   | `false` | `supported`