BWDB-14964-v3 (#1149) Global portins

Author: DX-Bandwidth

site/specs/numbers.yml

@@ -2774,7 +2774,7 @@ components:
         AssociatedSipPeersResponse:
           $ref: '#/components/schemas/AssociatedSipPeersResponse'
       type: object
-    AutomatedTollFreeLnpOrderRequest:
+    AutomatedNANPTollFreeLnpOrderRequest:
       description: >-
         Indicates that the port-in contains toll-free numbers and that Toll-Free
         Automation is enabled. The numbers will be automatically validated and
@@ -2785,7 +2785,25 @@ components:
           allOf:
             - $ref: '#/components/schemas/LnpOrderBasic'
             - $ref: '#/components/schemas/LnpOrderAutomatedTollFreeFields'
-      title: Automated Toll-Free
+            - properties:
+                RequestedFocDate:
+                  description: >-
+                    Format: ISO8601 encoding such as “2013-05-10T15:14:22Z”, or
+                    "2019-10-31T17:15:00+04:00".<br/><br/>For all ports, if
+                    `RequestedFocDate` is specified, the date portion must
+                    be:<br/> - in the future<br/> - after the losing carrier's
+                    minimum number of days to port-out<br/> - not on a weekend
+                    or U.S. holiday<br/><br/>If `RequestedFocDate` is not
+                    specified, the next available FOC date meeting the criteria
+                    above will be used. If the Time portion of the
+                    `RequestedFocDate` is omitted the port-in order will be
+                    activated at the default activation time of 11:30 AM ET. If
+                    an activation time other than 11:30 AM ET is desired, that
+                    activation time should be included in the
+                    `RequestedFocDate`.
+                  type: string
+              type: object
+      title: Automated NANP Toll-Free LNP Order Request
       type: object
     AvailableNpaNxx:
       properties:
@@ -7366,7 +7384,7 @@ components:
         delete:
           type: boolean
       type: object
-    InternalLnpOrderRequest:
+    InternalNANPLnpOrderRequest:
       properties:
         LnpOrder:
           allOf:
@@ -7400,7 +7418,7 @@ components:
                     $ref: '#/components/schemas/TnAttribute'
                   type: array
               type: object
-      title: Internal
+      title: Internal NANP LNP Order Request
       type: object
     IrisStatus:
       properties:
@@ -7711,6 +7729,20 @@ components:
             carrier. For wireline port-in, the BillingTelephoneNumber is
             typically the telephone number being ported in.
           type: string
+        RequestedFocDate:
+          description: >-
+            Format: ISO8601 encoding such as “2013-05-10T15:14:22Z”, or
+            "2019-10-31T17:15:00+04:00".<br/><br/>For all ports, if
+            `RequestedFocDate` is specified, the date portion must be:<br/> - in
+            the future<br/> - after the losing carrier's minimum number of days
+            to port-out<br/> - not on a weekend or U.S. holiday<br/><br/>If
+            `RequestedFocDate` is not specified, the next available FOC date
+            meeting the criteria above will be used. If the Time portion of the
+            `RequestedFocDate` is omitted the port-in order will be activated at
+            the default activation time of 11:30 AM ET. If an activation time
+            other than 11:30 AM ET is desired, that activation time should be
+            included in the `RequestedFocDate`.
+          type: string
         Subscriber:
           oneOf:
             - $ref: '#/components/schemas/SubscriberBusiness'
@@ -8016,6 +8048,22 @@ components:
               type: string
           type: object
       type: object
+    LnpOrderRequest:
+      properties:
+        LnpOrder:
+          allOf:
+            - $ref: '#/components/schemas/LnpOrderBasic'
+            - properties:
+                RequestedFocDate:
+                  description: >-
+                    Format: ISO8601 encoding such as "2019-10-31".<br/><br/>For
+                    international ports, if `RequestedFocDate` is specified the
+                    time portions will be ignored and the date portion must
+                    be:<br/> - in the future<br/> - not on a weekend.
+                  type: string
+              type: object
+      title: LNP Order Request (Other)
+      type: object
     LnpOrderResponse:
       properties:
         LnpOrderResponse:
@@ -8768,6 +8816,25 @@ components:
         SkipAck:
           type: boolean
       type: object
+    ManualNANPTollFreeLnpOrderRequest:
+      description: >-
+        Manual indicates that the port-in will be processed manually by
+        Bandwidth’s Local Number Portability team. Currently all toll free
+        port-ins are handled manually by Bandwidth’s Local Number Portability
+        team. But Bandwidth is in the process of automating portions of toll
+        free porting, with a goal of eventually automating the entire process.
+      properties:
+        LnpOrder:
+          allOf:
+            - $ref: '#/components/schemas/LnpOrderBasic'
+          properties:
+            Subscriber:
+              allOf:
+                - $ref: '#/components/schemas/SubscriberBusiness'
+              type: object
+          type: object
+      title: Manual NANP Toll-Free LNP Order Request
+      type: object
     ManualPortOutRequest:
       properties:
         BulkPortOut:
@@ -8795,25 +8862,6 @@ components:
         TelephoneNumberToPort:
           type: string
       type: object
-    ManualTollFreeLnpOrderRequest:
-      description: >-
-        Manual indicates that the port-in will be processed manually by
-        Bandwidth’s Local Number Portability team. Currently all toll free
-        port-ins are handled manually by Bandwidth’s Local Number Portability
-        team. But Bandwidth is in the process of automating portions of toll
-        free porting, with a goal of eventually automating the entire process.
-      properties:
-        LnpOrder:
-          allOf:
-            - $ref: '#/components/schemas/LnpOrderBasic'
-          properties:
-            Subscriber:
-              allOf:
-                - $ref: '#/components/schemas/SubscriberBusiness'
-              type: object
-          type: object
-      title: Manual Toll-Free
-      type: object
     ManuallyPortableTollFreeNumberList:
       properties:
         DisconnectedTollFreeNumberList:
@@ -9412,15 +9460,15 @@ components:
           type: object
       title: Number Portability Response
       type: object
-    OffNetLnpOrderRequest:
+    OffNetNANPLnpOrderRequest:
       properties:
         LnpOrder:
           allOf:
             - $ref: '#/components/schemas/LnpOrderBasic'
             - $ref: '#/components/schemas/LnpOrderAdditionalFields'
-      title: Off-net
+      title: Off-net NANP LNP Order Request
       type: object
-    OnNetLnpOrderRequest:
+    OnNetNANPLnpOrderRequest:
       properties:
         LnpOrder:
           allOf:
@@ -9457,7 +9505,7 @@ components:
                     $ref: '#/components/schemas/TnAttribute'
                   type: array
               type: object
-      title: On-net
+      title: On-net NANP LNP Order Request
       type: object
     OrderCreatedDate:
       description: Creation date of the order.
@@ -29411,7 +29459,7 @@ paths:
           content:
             application/xml:
               examples:
-                Portins in FOC:
+                Portins containing NANP numbers:
                   description: List of portin orders with FOC processing status
                   value: |-
                     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
@@ -29459,7 +29507,7 @@ paths:
                             <PON>979E019287CDF6A1</PON>
                         </lnpPortInfoForGivenStatus>
                     </LNPResponseWrapper>
-                RespOrg exception toll-free portin order:
+                RespOrg exception toll-free order containing NANP numbers:
                   description: >-
                     List containing a single RespOrg exception toll-free portin
                     order
@@ -29511,25 +29559,26 @@ paths:
         content:
           application/xml:
             examples:
-              Automated Toll-Free Port-in:
+              Automated NANP Toll-Free Port-in:
                 value: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<LnpOrder>\n\t<CustomerOrderId>My order id</CustomerOrderId>\n\t<RequestedFocDate>2021-06-16Z</RequestedFocDate>\n\t<SiteId>2439</SiteId>\n\t<PeerId>23432</PeerId>\n\t<LoaAuthorizingPerson>The Authgal</LoaAuthorizingPerson>\n\t<TargetRespOrgId>JYT01</TargetRespOrgId>\n\t<ListOfPhoneNumbers>\n\t\t<PhoneNumber>8774809871</PhoneNumber>\n\t</ListOfPhoneNumbers>\n</LnpOrder>"
-              Regular Port-in:
+              On-net NANP Port-in:
                 value: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<LnpOrder>\n\t<RequestedFocDate>2016-03-25T21:15:00.000Z</RequestedFocDate>\n\t<AlternateSpid>X455</AlternateSpid>\n\t<BillingTelephoneNumber>9195551234</BillingTelephoneNumber>\n\t<NewBillingTelephoneNumber>9175131245</NewBillingTelephoneNumber>\n\t<SiteId>    SITE ID     </SiteId>\n\t<PeerId>  SIPPEER ID    </PeerId>\n\t<Subscriber>\n\t\t<SubscriberType>BUSINESS</SubscriberType>\n\t\t<FirstName>First</FirstName>\n\t\t<LastName>Last</LastName>\n\t\t<ServiceAddress>\n\t\t\t<HouseNumber>11235</HouseNumber>\n\t\t\t<StreetName>Back</StreetName>\n\t\t\t<City>Denver</City>\n\t\t\t<StateCode>CO</StateCode>\n\t\t\t<Zip>27541</Zip>\n\t\t\t<County>Canyon</County>\n\t\t</ServiceAddress>\n\t</Subscriber>\n\t<LoaAuthorizingPerson>The Authguy</LoaAuthorizingPerson>\n\t<WirelessInfo>\n\t\t<AccountNumber>771297665AABC</AccountNumber>\n\t\t<PinNumber>1234</PinNumber>\n\t</WirelessInfo>\n\t<TnAttributes>\n\t\t<TnAttribute>Protected</TnAttribute>\n\t\t<TnAttribute>External</TnAttribute>\n\t\t<TnAttribute>Imported</TnAttribute>\n\t</TnAttributes>\n\t<ListOfPhoneNumbers>\n\t\t<PhoneNumber>9194809871</PhoneNumber>\n\t</ListOfPhoneNumbers>\n\t<CustomerOrderId>myOrder</CustomerOrderId>\n\t<Triggered>true</Triggered>\n\t<PartialPort>true</PartialPort>\n\t<ProcessingStatus>DRAFT</ProcessingStatus>\n</LnpOrder>"
             schema:
               oneOf:
-                - $ref: '#/components/schemas/OnNetLnpOrderRequest'
-                - $ref: '#/components/schemas/ManualTollFreeLnpOrderRequest'
-                - $ref: '#/components/schemas/AutomatedTollFreeLnpOrderRequest'
-                - $ref: '#/components/schemas/OffNetLnpOrderRequest'
-                - $ref: '#/components/schemas/InternalLnpOrderRequest'
+                - $ref: '#/components/schemas/OnNetNANPLnpOrderRequest'
+                - $ref: '#/components/schemas/OffNetNANPLnpOrderRequest'
+                - $ref: '#/components/schemas/InternalNANPLnpOrderRequest'
+                - $ref: '#/components/schemas/ManualNANPTollFreeLnpOrderRequest'
+                - $ref: '#/components/schemas/AutomatedNANPTollFreeLnpOrderRequest'
+                - $ref: '#/components/schemas/LnpOrderRequest'
       responses:
         '201':
           content:
             application/xml:
               examples:
-                Automated Toll-Free Order Response:
+                Automated NANP Toll-Free Port-in Order Response:
                   value: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<LnpOrderResponse>\n\t<OrderId>03f194d5-3932-4e9f-8ba1-03ef767985e5</OrderId>\n\t<Status>\n\t\t<Code>201</Code>\n\t\t<Description>Order request received. Please use the order id to check the status of your order later.</Description>\n\t</Status>\n\t<ProcessingStatus>VALIDATE_TFNS</ProcessingStatus>\n\t<RequestedFocDate>2016-03-25T21:15:00.000Z</RequestedFocDate>\n\t<LoaAuthorizingPerson>The Authguy</LoaAuthorizingPerson>\n\t<ListOfPhoneNumbers>\n\t\t<PhoneNumber>8774809871</PhoneNumber>\n\t</ListOfPhoneNumbers>\n\t<TollFreeValidationStatus>PROCESSING</TollFreeValidationStatus>\n\t<TollFreePortType>PHASE_1_TOLLFREE</TollFreePortType>\n\t<TargetRespOrgId>JYT01</TargetRespOrgId>\n</LnpOrderResponse>"
-                Regular Order Response:
+                On-net NANP Port-in Order Response:
                   value: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>\n<LnpOrderResponse>\n\t<OrderId>03f194d5-3932-4e9f-8ba1-03ef767985e5</OrderId>\n\t<Status>\n\t\t<Code>201</Code>\n\t\t<Description>Order request received. Please use the order id to check the status of your order later.</Description>\n\t</Status>\n\t<ProcessingStatus>PENDING_DOCUMENTS</ProcessingStatus>\n\t<RequestedFocDate>2016-03-25T21:15:00.000Z</RequestedFocDate>\n\t<LoaAuthorizingPerson>The Authguy</LoaAuthorizingPerson>\n\t<Subscriber>\n\t\t<SubscriberType>BUSINESS</SubscriberType>\n\t\t<FirstName>First</FirstName>\n\t\t<LastName>Last</LastName>\n\t\t<ServiceAddress>\n\t\t\t<HouseNumber>11235</HouseNumber>\n\t\t\t<StreetName>Back</StreetName>\n\t\t\t<City>Denver</City>\n\t\t\t<StateCode>CO</StateCode>\n\t\t\t<Zip>27541</Zip>\n\t\t\t<County>Canyon</County>\n\t\t\t<Country>United States</Country>\n\t\t</ServiceAddress>\n\t</Subscriber>\n\t<WirelessInfo>\n\t\t<AccountNumber>771297665AABC</AccountNumber>\n\t\t<PinNumber>1234</PinNumber>\n\t</WirelessInfo>\n\t<TnAttributes>\n\t\t<TnAttribute>Protected</TnAttribute>\n\t\t<TnAttribute>External</TnAttribute>\n\t\t<TnAttribute>Imported</TnAttribute>\n\t</TnAttributes>\n\t<BillingTelephoneNumber>9195551234</BillingTelephoneNumber>\n\t<NewBillingTelephoneNumber>9175131245</NewBillingTelephoneNumber>\n\t<SiteId>    SITE ID     </SiteId>\n\t<PeerId>  SIPPEER ID    </PeerId>\n\t<ListOfPhoneNumbers>\n\t\t<PhoneNumber>9194809871</PhoneNumber>\n\t</ListOfPhoneNumbers>\n\t<CustomerOrderId>myOrder</CustomerOrderId>\n\t<Triggered>true</Triggered>\n\t<PartialPort>true</PartialPort>\n</LnpOrderResponse>"
               schema:
                 $ref: '#/components/schemas/LnpOrderResponse'