Auto-merge PR based on merge event

Auto-merging PR based on merge event from upstream repository

Author: DX-Bandwidth

site/specs/numbers.yml

@@ -676,6 +676,85 @@ components:
           <Website>www.my.website.com</Website>
           <IsMain>true</IsMain>
         </Brand>
+    RateCenterFindCoverage404Error:
+      value: |-
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <RateCenterCoverageResponse>
+          <Error>
+            <Description>Rate center coverage with id 999 was not found.</Description>
+            <ErrorCode>3940</ErrorCode>
+          </Error>
+        </RateCenterCoverageResponse>
+    RateCenterGetCoverage400Error:
+      value: |-
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <RateCenterCoveragesResponse>
+            <Error>
+              <Description>You must provide at least one parameter in order to search.</Description>
+              <ErrorCode>3924</ErrorCode>
+            </Error>
+          </RateCenterCoveragesResponse>
+    RateCenterGetCoverageResponseExample:
+      value: |-
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <RateCenterCoveragesResponse>
+          <RateCenterCoverages>
+            <VendorId>49</VendorId>
+            <Abbreviation>ALABASTER</Abbreviation>
+            <Region>AL</Region>
+            <TierId>1</TierId>
+            <SupportsLnp>true</SupportsLnp>
+            <SupportsNewTns>true</SupportsNewTns>
+          </RateCenterCoverages>
+        </RateCenterCoveragesResponse>
+    RateCenterPostCoverage400Error:
+      value: |-
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <RateCenterCoverageResponse>
+          <Error>
+            <Description>Offnet coverage must not have an LRN.</Description>
+            <ErrorCode>3913</ErrorCode>
+          </Error>
+        </RateCenterCoverageResponse>
+    RateCenterPostCoverage409Error:
+      value: |-
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <RateCenterCoverageResponse>
+          <Error>
+            <Description>Coverage already exists for FARMVILLE.NC with vendor ID 49</Description>
+            <ErrorCode>3923</ErrorCode>
+          </Error>
+        </RateCenterCoverageResponse>
+    RateCenterPostCoverageResponseExample:
+      value: |-
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <RateCenterCoverageResponse>
+          <RateCenterCoverage>
+            <VendorId>49</VendorId>
+            <Abbreviation>FARMVILLE</Abbreviation>
+            <Region>NC</Region>
+            <TierId>1</TierId>
+            <SupportsLnp>false</SupportsLnp>
+            <SupportsNewTns>true</SupportsNewTns>
+            <Lrn>2529690000</Lrn>
+            <Lata>951</Lata>
+          </RateCenterCoverage>
+        </RateCenterCoverageResponse>
+    RateCenterPutCoverageResponseExample:
+      value: |-
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <RateCenterCoverageResponse>
+          <RateCenterCoverage>
+            <VendorId>49</VendorId>
+            <Abbreviation>FARMVILLE</Abbreviation>
+            <Region>NC</Region>
+            <TierId>1</TierId>
+            <SupportsLnp>false</SupportsLnp>
+            <SupportsNewTns>true</SupportsNewTns>
+            <Lrn>2529690000</Lrn>
+            <Lata>951</Lata>
+          </RateCenterCoverage>
+        </RateCenterCoverageResponse>
     RemoveImportedVoiceTnOrders:
       description: List all remove imported voice tn orders response
       value: |-
@@ -874,6 +953,69 @@ components:
       required: true
       schema:
         type: string
+    RCAbbreviationOptional:
+      description: A rate center's abbreviation
+      example: ALABASTER
+      in: query
+      name: abbreviation
+      required: false
+      schema:
+        type: string
+    RCAbbreviationRequired:
+      description: A rate center's abbreviation
+      example: FARMVILLE
+      in: query
+      name: abbreviation
+      required: true
+      schema:
+        type: string
+    RCCoverageMatrixId:
+      description: A rate center's coverage matrix id
+      in: path
+      name: id
+      required: true
+      schema:
+        type: number
+    RCLataOptional:
+      description: Rate center LATA
+      example: 951
+      in: query
+      name: lata
+      required: false
+      schema:
+        type: number
+    RCRegionOptional:
+      description: A rate center's state
+      example: AL
+      in: query
+      name: region
+      required: false
+      schema:
+        type: string
+    RCRegionRequired:
+      description: A rate center's state
+      example: NC
+      in: query
+      name: region
+      required: true
+      schema:
+        type: string
+    RCVendorOptional:
+      description: Vendor id
+      example: 49
+      in: query
+      name: vendor
+      required: false
+      schema:
+        type: number
+    RCVendorRequired:
+      description: Vendor id
+      example: 49
+      in: query
+      name: vendor
+      required: true
+      schema:
+        type: number
     RoleIdPathParam:
       description: Role Id
       example: testRole
@@ -1091,6 +1233,121 @@ components:
         associated with the order, the state of the order, and a list of the
         successfully imported Telephone Numbers, and descriptions of any
         encountered errors.
+    rateCenter401Error:
+      content:
+        application/json:
+          examples:
+            example:
+              value:
+                description: Client is providing incorrect or invalid credentials.
+                type: unauthorized
+          schema:
+            $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse'
+      description: Client is providing incorrect or invalid credentials.
+    rateCenter403Error:
+      content:
+        application/json:
+          examples:
+            example:
+              value:
+                description: Client does not have access rights to the content.
+                type: forbidden
+          schema:
+            $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse'
+      description: Client is providing incorrect or invalid credentials.
+    rateCenter429Error:
+      content:
+        application/json:
+          examples:
+            example:
+              value:
+                description: Too many requests.
+                type: too many requests
+          schema:
+            $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse'
+      description: Too many requests.
+    rateCenter500Error:
+      content:
+        application/json:
+          examples:
+            example:
+              value:
+                description: The server has encountered an internal error.
+                type: internal server error
+          schema:
+            $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse'
+      description: The server has encountered an internal error.
+    rateCenterFindCoverageResponse404Error:
+      content:
+        application/xml:
+          examples:
+            unsuccessful404ErrorFindCoverageResponseExample:
+              $ref: '#/components/examples/RateCenterFindCoverage404Error'
+          schema:
+            $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse'
+      description: >-
+        Unsuccessful response because the rate center coverage entry could not
+        be found.
+    rateCenterGetCoverageResponse:
+      content:
+        application/xml:
+          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.
+    rateCenterPostCoverageResponse:
+      content:
+        application/xml:
+          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.
+    rateCenterPostCoverageResponse409Error:
+      content:
+        application/xml:
+          examples:
+            unsuccessful409ErrorPostCoverageResponseExample:
+              $ref: '#/components/examples/RateCenterPostCoverage409Error'
+          schema:
+            $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse'
+      description: >-
+        Unsuccessful response due to a validation error. This rate center
+        already exists.
+    rateCenterPutCoverageResponse:
+      content:
+        application/xml:
+          examples:
+            successfulPutCoverageResponseExample:
+              $ref: '#/components/examples/RateCenterPutCoverageResponseExample'
+          schema:
+            $ref: '#/components/schemas/CoverageMatrixEntry'
+      description: Successful response for the update of a coverage matrix entry.
     removeImportedVoiceTnOrdersResponse:
       content:
         application/xml:
@@ -3990,6 +4247,43 @@ components:
                 type: object
               type: array
           type: object
+    CoverageMatrixEntry:
+      properties:
+        Abbreviation:
+          description: A rate center's abbreviation.
+          example: FARMVILLE
+          type: string
+        Lata:
+          description: A rate center's LATA.
+          example: 951
+          type: number
+        Lrn:
+          description: A rate center's LRN.
+          example: '2529690000'
+          type: string
+        Region:
+          description: A rate center's state.
+          example: NC
+          type: string
+        SupportsLnp:
+          description: Whether a rate center supports LNP.
+          example: true
+          type: boolean
+        SupportsNewTns:
+          description: Whether a rate center supports new TNs.
+          example: true
+          type: boolean
+        TierId:
+          description: A rate center's tier ID.
+          example: 1
+          maximum: 6
+          minimum: 0
+          type: number
+        VendorId:
+          description: A rate center's vendor ID.
+          example: 49
+          type: number
+      type: object
     CoveredRateCenter:
       properties:
         Abbreviation:
@@ -9593,6 +9887,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: 3900
+          type: number
+      type: object
     RateCenterGroup:
       properties:
         City: