diff --git a/site/specs/numbers_v2.yml b/site/specs/numbers_v2.yml index ddeb1a975..1e6594d9a 100644 --- a/site/specs/numbers_v2.yml +++ b/site/specs/numbers_v2.yml @@ -1862,6 +1862,12 @@ components: schema: $ref: '#/components/schemas/portingLosingCarriersResponseSchema' description: A list of available carriers that can port out a phone number + listOfReferenceDocumentsResponse: + content: + application/json: + schema: + $ref: '#/components/schemas/portingReferenceDocumentsResponseSchema' + description: A list of required documents needed to port a set of numbers notAllowedError: content: application/json: @@ -15531,6 +15537,89 @@ components: $ref: '#/components/schemas/selfLink' title: List Addresses Response type: object + portingReferenceDocumentsResponseSchema: + properties: + data: + properties: + referenceDocuments: + items: + properties: + business: + items: + properties: + description: + description: Description of the document. + example: LOA Description + title: Description of the document + type: string + requiredDocument: + description: >- + Determines whether the document is required or + optional. + example: true + title: Document is required + type: boolean + supportedFileTypes: + description: Supported File Types. + example: '[pdf, jpeg]' + title: Support file types + type: array + type: + description: Type of the document. + example: LOA + title: Type of document + type: string + type: object + type: array + countryCodeA3: + description: Country A3 code. + example: GBR + title: Country A3 code + type: string + phoneNumberType: + description: Type of the phone number. + example: GEOGRAPHIC + title: Type of phone number + type: string + residential: + items: + properties: + description: + description: Description of the document. + example: Last Invoice description + title: Description of the document + type: string + requiredDocument: + description: >- + Determines whether the document is required or + optional. + example: true + title: Document is required + type: boolean + supportedFileTypes: + description: Supported File Types. + example: '[csv, xls]' + title: Support file types + type: array + type: + description: Type of the document. + example: COB + title: Type of document + type: string + type: object + type: array + type: object + type: array + type: object + errors: + example: [] + items: + $ref: '#/components/schemas/error' + type: array + links: + $ref: '#/components/schemas/selfLink' + title: List Reference Documents + type: object postalCode: description: The postal code of the address. example: '98072' @@ -43895,6 +43984,27 @@ paths: summary: List losing carriers tags: - Porting + /porting/referenceDocuments: + get: + description: > +
List reference documents needed to port a set of numbers given a + countryCodeA3 and phoneNumberType value.
+ operationdId: portingReferenceDocuments + parameters: + - $ref: '#/components/parameters/countryCodeA3QueryParam_eq' + - $ref: '#/components/parameters/phoneNumberTypeQueryParam_eq' + responses: + '200': + $ref: '#/components/responses/listOfReferenceDocumentsResponse' + '400': + $ref: '#/components/responses/badRequestError' + '429': + $ref: '#/components/responses/tooManyRequestsError' + '502': + $ref: '#/components/responses/internalServerError' + summary: List reference documents needed to port a set of numbers + tags: + - Porting /rateCenters: get: description: >-