diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 833ca10a1..37ea261f0 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -748,6 +748,18 @@ components: required: true schema: type: string + CountryCodeA3QueryParam: + description: >- + Country code of the country in its ISO 3166-1 alpha-3 format. Note that + only one country code (i.e. USA, CAN, GBR etc.) is allowed when + configured by the user. The system defaults country code to search for + restrictions in all countries we have coverage. + example: BEL + in: query + name: countryCodeA3 + required: false + schema: + type: string CreatedDateFromQueryParam: description: >- Checks the order's creation date against this value. Orders that have a @@ -9947,6 +9959,35 @@ components: type: integer type: object type: object + Restriction: + properties: + CountryCodeA3: + type: string + RestrictionCategory: + type: string + RestrictionDescription: + type: string + RestrictionType: + $ref: '#/components/schemas/RestrictionType' + type: object + RestrictionResponse: + properties: + RestrictionResponse: + properties: + Restrictions: + items: + $ref: '#/components/schemas/Restriction' + type: array + type: object + type: object + RestrictionType: + enum: + - LEGAL + - PURCHASE + - SERVICE + - NRA + example: LEGAL + type: string RogerTerminationSettings: properties: SubnetAddressingAllowed: @@ -40945,6 +40986,55 @@ paths: summary: List Rate Centers tags: - Rate Centers + /restrictions: + get: + description: >- + Information about how services work in various countries and which + restrictions and rules apply. Please consult this information before + buying and configuring your numbers. + operationId: ListRestrictions + parameters: + - $ref: '#/components/parameters/CountryCodeA3QueryParam' + responses: + '200': + content: + application/xml: + examples: + example: + value: |- + + + + + BEL + LEGAL + Number portability + Lorem ipsum + + + BEL + PURCHASE + Address or identification requirements + Lorem ipsum + + + BEL + SERVICE + Compatibility issues + Lorem ipsum + + + + schema: + $ref: '#/components/schemas/RestrictionResponse' + description: >- + This response returns the list of cities, along with the Rate + Centers that serve those Restrictions. If 'available' is specified + then the number of TNs available in that city / RC combination is + also included. + summary: List Restrictions + tags: + - Compliance /tns: get: description: >- @@ -42101,6 +42191,7 @@ tags: name: Bulk Port-In - name: Callbacks - name: Cities + - name: Compliance - description: >- DLDA = Directory Listing and Directory Assistance. A DLDA resource associates a TN with a Street Address. This gets updated in a Network