Add Code Snippets to Spec Files

Author: DX-Bandwidth

site/specs/numbers.yml

@@ -1230,6 +1230,8 @@ components:
           examples:
             unsuccessful404ErrorFindCoverageResponseExample:
               $ref: '#/components/examples/RateCenterFindCoverage404Error'
+          schema:
+            $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse'
       description: >-
         Unsuccessful response because the rate center coverage entry could not
         be found.
@@ -1239,13 +1241,17 @@ components:
           examples:
             successfulGetCoverageResponseExample:
               $ref: '#/components/examples/RateCenterGetCoverageResponseExample'
+          schema:
+            $ref: '#/components/schemas/RateCenterCoverageSuccessfulResponseList'
       description: Successful response with a rate center's coverage.
     rateCenterGetCoverageResponse400Error:
       content:
         application/xml:
           examples:
             unsuccessful400ErrorGetCoverageResponseExample:
               $ref: '#/components/examples/RateCenterGetCoverage400Error'
+          schema:
+            $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse'
       description: >-
         Unsucessful response of a rate center's coverage due to a validation
         error. No search parameters were provided.
@@ -1255,13 +1261,17 @@ components:
           examples:
             successfulPostCoverageResponseExample:
               $ref: '#/components/examples/RateCenterPostCoverageResponseExample'
+          schema:
+            $ref: '#/components/schemas/CoverageMatrixEntry'
       description: Successful response with the generating matrix entry.
     rateCenterPostCoverageResponse400Error:
       content:
         application/xml:
           examples:
             unsuccessful400ErrorPostCoverageResponseExample:
               $ref: '#/components/examples/RateCenterPostCoverage400Error'
+          schema:
+            $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse'
       description: >-
         Unsuccessful response due to a validation error. A LRN was provided for
         offnet coverage.
@@ -1271,6 +1281,8 @@ components:
           examples:
             successfulPutCoverageResponseExample:
               $ref: '#/components/examples/RateCenterPutCoverageResponseExample'
+          schema:
+            $ref: '#/components/schemas/CoverageMatrixEntry'
       description: Successful response for the update of a coverage matrix entry.
     removeImportedVoiceTnOrdersResponse:
       content:
@@ -4200,6 +4212,8 @@ components:
         TierId:
           description: A rate center's tier ID.
           example: 1
+          maximum: 6
+          minimum: 0
           type: number
         VendorId:
           description: A rate center's vendor ID.
@@ -9809,6 +9823,26 @@ components:
               type: integer
           type: object
       type: object
+    RateCenterCoverageSuccessfulResponseList:
+      description: A list of all coverage matrix entries returned by a GET endpoint.
+      properties:
+        data:
+          items:
+            $ref: '#/components/schemas/CoverageMatrixEntry'
+          type: array
+      required:
+        - data
+      type: object
+    RateCenterCoverageUnsuccessfulResponse:
+      description: A generic error object for coverage matrix / rate center responses.
+      properties:
+        description:
+          example: Error Message
+          type: string
+        errorCode:
+          example: '1234'
+          type: number
+      type: object
     RateCenterGroup:
       properties:
         City:
@@ -12626,6 +12660,12 @@ components:
             - unchanged
             - systemDefault
           type: string
+        CallVerificationEnabled:
+          enum:
+            - '{custom value}'
+            - 'true'
+            - 'false'
+          type: string
         CallingNameDisplay:
           enum:
             - 'on'
@@ -12872,6 +12912,8 @@ components:
       properties:
         CallForward:
           $ref: '#/components/schemas/TelephoneNumber'
+        CallVerificationEnabled:
+          type: string
         CallingNameDisplay:
           type: string
         FinalDestinationURI:
@@ -39029,6 +39071,14 @@ paths:
         phone number in the option
         group</td></tr><tr><td>false</td><td>Explicitly disables Pindrop
         integration on each phone number in the option
+        group</td></tr></tbody></table><li>for Call Verification Enabled
+        attribute</li><table style="text-align: left; width: 80%;" border="1"
+        cellpadding="2" cellspacing="0"><tbody><tr><th>Action
+        value</th><th>Description of
+        action</th></tr><tr><td>true</td><td>Enables Call Verification on each
+        phone number in the option
+        group</td></tr><tr><td>false</td><td>Explicitly disables Call
+        Verification on each phone number in the option
         group</td></tr></tbody></table><li>for other attribute</li><ul><li
         type="square"> <i>systemDefault</i> - implies that the element profile
         value should be removed so that the TN changes back to the default
@@ -39110,6 +39160,12 @@ paths:
                           <TelephoneNumber>2018551026</TelephoneNumber>
                         </TelephoneNumbers>
                       </TnOptionGroup>
+                      <TnOptionGroup>
+                        <CallVerificationEnabled>true</CallVerificationEnabled>
+                        <TelephoneNumbers>
+                          <TelephoneNumber>2018551027</TelephoneNumber>
+                        </TelephoneNumbers>
+                      </TnOptionGroup>
                     </TnOptionGroups>
                   </TnOptionOrder>
             schema: