BWDB-13646: API docs description for Disconnect reason and related guide changes (#776)

Author: DX-Bandwidth

site/docs/numbers/disconnectNumbers.mdx

@@ -44,7 +44,7 @@ Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
 
 <?xml version="1.0"?>
 <DisconnectTelephoneNumberOrder>
-    <name>training run</name>
+    <CustomerOrderId>My OrderId</CustomerOrderId>
     <DisconnectTelephoneNumberOrderType>
         <TelephoneNumberList>
             <TelephoneNumber>5405514342</TelephoneNumber>

site/specs/numbers.yml

@@ -2372,14 +2372,21 @@ components:
       properties:
         DisconnectTelephoneNumberOrder:
           properties:
+            CustomerOrderId:
+              description: >-
+                The CustomerOrderId is an optional field that may be provided by
+                the customer and will remain with the order. Only alphanumeric
+                values, dashes and spaces are allowed.The value is opaque to
+                Bandwidth.
+              maxLength: 40
+              type: string
             DisconnectTelephoneNumberOrderType:
               $ref: '#/components/schemas/DisconnectTelephoneNumberOrderType'
             Name:
+              deprecated: true
               description: The name of the order.
               maxLength: 50
               type: string
-          required:
-            - Name
           type: object
       type: object
     DisconnectTelephoneNumberOrderErrorResponse:
@@ -2435,15 +2442,15 @@ components:
     DisconnectTelephoneNumberOrderType:
       properties:
         DisconnectMode:
-          description: The severity of disconnect order. Typically Normal.
+          default: NORMAL
+          description: The severity of disconnect order.
           enum:
             - NORMAL
             - PURGE
           type: string
         Protected:
-          description: >-
-            Change protected status of telephones during disconnection.
-            Typically `UNCHANGED`.
+          default: UNCHANGED
+          description: Change protected status of telephones during disconnection.
           enum:
             - 'TRUE'
             - 'FALSE'
@@ -14743,7 +14750,7 @@ paths:
                 value: |-
                   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                   <DisconnectTelephoneNumberOrder>
-                      <name>training run</name>
+                      <CustomerOrderId>My OrderId</CustomerOrderId>
                       <DisconnectTelephoneNumberOrderType>
                           <TelephoneNumberList>
                               <TelephoneNumber>4158714245</TelephoneNumber>
@@ -14766,19 +14773,20 @@ paths:
                     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                     <DisconnectTelephoneNumberOrderResponse>
                         <orderRequest>
-                            <CustomerOrderId/>
+                            <CustomerOrderId>My OrderId</CustomerOrderId>
                             <id>ba05e04b-192a-47cb-b182-b1bf6cfef0d7</id>
-                            <OrderCreateDate>2014-07-03T14-12-57.840Z</OrderCreateDate>
+                            <OrderCreateDate>2022-05-25T14-12-57.840Z</OrderCreateDate>
                             <DisconnectTelephoneNumberOrderType>
+                                <DisconnectMode>normal</DisconnectMode>
+                                <Protected>UNCHANGED</Protected>
                                 <TelephoneNumberList>
                                     <TelephoneNumber>4158714245</TelephoneNumber>
                                     <TelephoneNumber>4352154439</TelephoneNumber>
                                     <TelephoneNumber>4352154466</TelephoneNumber>
                                 </TelephoneNumberList>
-                                <DisconnectMode>normal</DisconnectMode>
-                                <Protected>UNCHANGED</Protected>
                             </DisconnectTelephoneNumberOrderType>
                         </orderRequest>
+                        <OrderStatus>RECEIVED</OrderStatus>
                     </DisconnectTelephoneNumberOrderResponse>
               schema:
                 $ref: '#/components/schemas/DisconnectTelephoneNumberOrderResponse'
@@ -14864,17 +14872,17 @@ paths:
                     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
                     <DisconnectTelephoneNumberOrderResponse>
                       <DisconnectedTelephoneNumberList>
-                        <TelephoneNumber>9199998830</TelephoneNumber>
+                        <TelephoneNumber>9194392566</TelephoneNumber>
                       </DisconnectedTelephoneNumberList>
                       <orderRequest>
                         <id>4ffe9262-1965-4479-a1d5-b8584440667d</id>
                         <OrderCreateDate>2013-12-04T21:59:32.243Z</OrderCreateDate>
                         <DisconnectTelephoneNumberOrderType>
-                          <TelephoneNumberList>
-                            <TelephoneNumber>9199998830</TelephoneNumber>
-                          </TelephoneNumberList>
                           <DisconnectMode>normal</DisconnectMode>
                           <Protected>UNCHANGED</Protected>
+                          <TelephoneNumberList>
+                            <TelephoneNumber>9194392566</TelephoneNumber>
+                          </TelephoneNumberList>
                         </DisconnectTelephoneNumberOrderType>
                       </orderRequest>
                       <OrderStatus>COMPLETE</OrderStatus>