From f462a75efacb8b2021361aa66d0d2b8b2cb9687b Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Fri, 13 Oct 2023 09:46:38 +0000 Subject: [PATCH 1/3] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 199 +++------------------- site/specs/numbers_v2.yml | 350 +++++++++++++++++++------------------- 2 files changed, 203 insertions(+), 346 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 611700f55..677c84956 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -3938,59 +3938,6 @@ components: type: integer type: object type: object - BulkPortout: - properties: - AccountNumber: - type: string - CallbackUrl: - type: string - FocDate: - format: date-time - type: string - Immediately: - type: boolean - InternalPort: - type: boolean - NewNetworkSPID: - description: >- - The Service Provider ID of the carrier that the number is being - ported to. - type: string - OverrideValidation: - type: boolean - PON: - description: >- - This Bandwidth internal identifier associates the port-out order - with either an internal port-in or an LSR order, whichever caused - the port-out order to be created. - type: string - Pin: - description: >- - The personal identifier number the subscriber has associated with - his or her account with the carrier the number is being ported away - from. - type: string - SkipPortPsCheck: - type: boolean - SubscriberName: - type: string - Supplemental: - enum: - - NONE - - CANCEL - - UPDATE - - OTHER - type: string - TelephoneNumberList: - description: The list of telephone numbers to port-out. - items: - type: string - xml: - name: TelephoneNumberToPort - type: array - ZipCode: - type: string - type: object BulkRateCenterPayload: description: >- Payload returned when a new bulk coverage matrix task is created, @@ -7175,6 +7122,9 @@ components: properties: ImportToAccountNumberOrderType: $ref: '#/components/schemas/ImportToAccountNumberOrderType' + OverrideFeatureRestrictions: + description: Used to override the purchase restrictions + type: boolean PeerId: description: >- A sippeer id of provided site to which telephone number will be @@ -7186,6 +7136,7 @@ components: required: - ImportToAccountNumberOrderType - SiteId + - OverrideFeatureRestrictions type: object title: ImportTnAccountOrder ImportToAccountOrderResponseOrderRequest: @@ -8837,29 +8788,44 @@ components: type: object ManualPortOutRequest: properties: - BulkPortOut: - $ref: '#/components/schemas/BulkPortout' + AccountNumber: + type: string FocDate: + format: date-time type: string + Immediately: + type: boolean + InternalPort: + type: boolean NewNetworkSPID: description: >- The Service Provider ID of the carrier that the number is being ported to. type: string + OverrideValidation: + type: boolean + PON: + description: >- + This Bandwidth internal identifier associates the port-out order + with either an internal port-in or an LSR order, whichever caused + the port-out order to be created. + type: string Pin: description: >- The personal identifier number the subscriber has associated with his or her account with the carrier the number is being ported away from. type: string - PortOutAction: - enum: - - NEW - - SUPP - - MODIFY - - CANCEL + SubscriberName: type: string - TelephoneNumberToPort: + TelephoneNumberList: + description: The list of telephone numbers to port-out. + items: + type: string + xml: + name: TelephoneNumberToPort + type: array + ZipCode: type: string type: object ManuallyPortableTollFreeNumberList: @@ -31322,46 +31288,6 @@ paths: summary: List port-out requests tags: - Porting - post: - description: >- - Creates a port-out request.
In the payload, CallbackUrl and - InternalPort are optional.
There are also multiple options for the - following: - - - - - -
OptionChoices
SupplementalNONE
CANCEL
UPDATE
OTHER
PortOutActionNEW
SUPP
MODIFY
CANCEL
InternalPorttrue or false
- operationId: CreatePortOut - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - requestBody: - content: - application/xml: - schema: - $ref: '#/components/schemas/PortOutRequest' - responses: - '200': - content: - application/xml: - examples: - example: - description: example - value: |- - - - - 200 - Request is complete and results returned. - - - schema: - $ref: '#/components/schemas/PortOutResponse' - description: The port-out request has been successfully received. - summary: Create port-out request - tags: - - Porting /accounts/{accountId}/portouts/status: get: description: >- @@ -31452,28 +31378,6 @@ paths: tags: - Porting /accounts/{accountId}/portouts/{orderId}: - delete: - description: Cancel port-out request. - operationId: CancelPortOut - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: Port-out order id - example: ca8065d1-ec1a-43da-af40-1dcee43becb5 - in: path - name: orderId - required: true - schema: - type: string - responses: - '200': - content: - application/xml: - schema: - $ref: '#/components/schemas/PortOutResponse' - description: '' - summary: Cancel port-out request - tags: - - Porting get: description: >- Retrieves the information associated with the specified port-out ID @@ -31517,53 +31421,6 @@ paths: summary: Fetch port-out request status tags: - Porting - put: - description: >- - Updates or cancels a port-out ID. The payload to this method is similar - to the GET on /accounts/{accountid}/portouts.
In the payload, - CallbackUrl and InternalPort are optional additives.
There are also - multiple options for the following: - - - - -
Option Choices
SupplementalNONE
CANCEL
UPDATE
OTHER
PortOutActionNEW
SUPP
MODIFY
CANCEL
- operationId: UpdatePortOut - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: Port-out order id - example: ca8065d1-ec1a-43da-af40-1dcee43becb5 - in: path - name: orderId - required: true - schema: - type: string - requestBody: - content: - application/xml: - schema: - $ref: '#/components/schemas/PortOutRequest' - responses: - '200': - content: - application/xml: - examples: - example: - description: example - value: |- - - - - 200 - Request is complete and results returned. - - - schema: - $ref: '#/components/schemas/PortOutResponse' - description: The update or cancellation was successful. - summary: Update/cancel port-out request - tags: - - Porting /accounts/{accountId}/products: get: description: | diff --git a/site/specs/numbers_v2.yml b/site/specs/numbers_v2.yml index ddeb1a975..b3a5388f4 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: @@ -4224,59 +4230,6 @@ components: type: integer type: object type: object - BulkPortout: - properties: - AccountNumber: - type: string - CallbackUrl: - type: string - FocDate: - format: date-time - type: string - Immediately: - type: boolean - InternalPort: - type: boolean - NewNetworkSPID: - description: >- - The Service Provider ID of the carrier that the number is being - ported to. - type: string - OverrideValidation: - type: boolean - PON: - description: >- - This Bandwidth internal identifier associates the port-out order - with either an internal port-in or an LSR order, whichever caused - the port-out order to be created. - type: string - Pin: - description: >- - The personal identifier number the subscriber has associated with - his or her account with the carrier the number is being ported away - from. - type: string - SkipPortPsCheck: - type: boolean - SubscriberName: - type: string - Supplemental: - enum: - - NONE - - CANCEL - - UPDATE - - OTHER - type: string - TelephoneNumberList: - description: The list of telephone numbers to port-out. - items: - type: string - xml: - name: TelephoneNumberToPort - type: array - ZipCode: - type: string - type: object BulkRateCenterPayload: description: >- Payload returned when a new bulk coverage matrix task is created, @@ -7352,6 +7305,9 @@ components: properties: ImportToAccountNumberOrderType: $ref: '#/components/schemas/ImportToAccountNumberOrderType' + OverrideFeatureRestrictions: + description: Used to override the purchase restrictions + type: boolean PeerId: description: >- A sippeer id of provided site to which telephone number will be @@ -7363,6 +7319,7 @@ components: required: - ImportToAccountNumberOrderType - SiteId + - OverrideFeatureRestrictions type: object title: ImportTnAccountOrder ImportToAccountOrderResponseOrderRequest: @@ -9258,31 +9215,69 @@ components: type: object title: Manual NANP Toll-Free LNP Order Request type: object - ManualPortOutRequest: + ManualPortOutRequestGlobal: properties: - BulkPortOut: - $ref: '#/components/schemas/BulkPortout' FocDate: + format: date-time type: string + Immediately: + type: boolean + InternalPort: + type: boolean + PON: + description: >- + Optional, This Bandwidth internal identifier associates the port-out + order with either an internal port-in or an LSR order, whichever + caused the port-out order to be created. + type: string + TelephoneNumberList: + description: The list of telephone numbers to port-out. + items: + type: string + xml: + name: TelephoneNumberToPort + type: array + type: object + ManualPortOutRequestNanp: + properties: + AccountNumber: + type: string + FocDate: + format: date-time + type: string + Immediately: + type: boolean + InternalPort: + type: boolean NewNetworkSPID: description: >- The Service Provider ID of the carrier that the number is being ported to. type: string + OverrideValidation: + type: boolean + PON: + description: >- + This Bandwidth internal identifier associates the port-out order + with either an internal port-in or an LSR order, whichever caused + the port-out order to be created. + type: string Pin: description: >- The personal identifier number the subscriber has associated with his or her account with the carrier the number is being ported away from. type: string - PortOutAction: - enum: - - NEW - - SUPP - - MODIFY - - CANCEL + SubscriberName: type: string - TelephoneNumberToPort: + TelephoneNumberList: + description: The list of telephone numbers to port-out. + items: + type: string + xml: + name: TelephoneNumberToPort + type: array + ZipCode: type: string type: object ManuallyPortableTollFreeNumberList: @@ -10597,10 +10592,15 @@ components: PIDF-LO and SIMPLE AEUI. Mixed PIDF-LO AEUI and Non-PIDF-LO AEUI endpoint-provisioning order type: object - PortOutRequest: + PortOutRequestGlobal: properties: PortOutRequest: - $ref: '#/components/schemas/ManualPortOutRequest' + $ref: '#/components/schemas/ManualPortOutRequestGlobal' + type: object + PortOutRequestNanp: + properties: + PortOutRequest: + $ref: '#/components/schemas/ManualPortOutRequestNanp' type: object PortOutResponse: properties: @@ -10615,7 +10615,7 @@ components: POST. type: string PortOutRequest: - $ref: '#/components/schemas/ManualPortOutRequest' + $ref: '#/components/schemas/ManualPortOutRequestGlobal' ProcessingStatus: enum: - NEW @@ -10629,6 +10629,7 @@ components: - EXCEPTION - SOA_PENDING - SOA_CONFLICT + - FOC type: string Status: $ref: '#/components/schemas/IrisStatus' @@ -15369,6 +15370,9 @@ components: CountOfTNs: description: Total count of telephone numbers in order. type: integer + CountryCodeA3: + description: The country to which the telephone number belongs. + type: string LNPLosingCarrierId: description: Internal use only type: string @@ -15531,6 +15535,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' @@ -32359,6 +32446,7 @@ paths: NEW 2014-08-02T12:34:37.000Z 512E + GBR schema: @@ -32370,46 +32458,6 @@ paths: summary: List port-out requests tags: - Porting - post: - description: >- - Creates a port-out request.
In the payload, CallbackUrl and - InternalPort are optional.
There are also multiple options for the - following: - - - - - -
OptionChoices
SupplementalNONE
CANCEL
UPDATE
OTHER
PortOutActionNEW
SUPP
MODIFY
CANCEL
InternalPorttrue or false
- operationId: CreatePortOut - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - requestBody: - content: - application/xml: - schema: - $ref: '#/components/schemas/PortOutRequest' - responses: - '200': - content: - application/xml: - examples: - example: - description: example - value: |- - - - - 200 - Request is complete and results returned. - - - schema: - $ref: '#/components/schemas/PortOutResponse' - description: The port-out request has been successfully received. - summary: Create port-out request - tags: - - Porting /accounts/{accountId}/portouts/status: get: description: >- @@ -32500,28 +32548,6 @@ paths: tags: - Porting /accounts/{accountId}/portouts/{orderId}: - delete: - description: Cancel port-out request. - operationId: CancelPortOut - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: Port-out order id - example: ca8065d1-ec1a-43da-af40-1dcee43becb5 - in: path - name: orderId - required: true - schema: - type: string - responses: - '200': - content: - application/xml: - schema: - $ref: '#/components/schemas/PortOutResponse' - description: '' - summary: Cancel port-out request - tags: - - Porting get: description: >- Retrieves the information associated with the specified port-out ID @@ -32565,53 +32591,6 @@ paths: summary: Fetch port-out request status tags: - Porting - put: - description: >- - Updates or cancels a port-out ID. The payload to this method is similar - to the GET on /accounts/{accountid}/portouts.
In the payload, - CallbackUrl and InternalPort are optional additives.
There are also - multiple options for the following: - - - - -
Option Choices
SupplementalNONE
CANCEL
UPDATE
OTHER
PortOutActionNEW
SUPP
MODIFY
CANCEL
- operationId: UpdatePortOut - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: Port-out order id - example: ca8065d1-ec1a-43da-af40-1dcee43becb5 - in: path - name: orderId - required: true - schema: - type: string - requestBody: - content: - application/xml: - schema: - $ref: '#/components/schemas/PortOutRequest' - responses: - '200': - content: - application/xml: - examples: - example: - description: example - value: |- - - - - 200 - Request is complete and results returned. - - - schema: - $ref: '#/components/schemas/PortOutResponse' - description: The update or cancellation was successful. - summary: Update/cancel port-out request - tags: - - Porting /accounts/{accountId}/products: get: description: | @@ -43895,6 +43874,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: >- From d6d27d27315b5007726f4e995b7c5bb3e057fd6b Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Mon, 16 Oct 2023 05:10:45 +0000 Subject: [PATCH 2/3] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 5 +++-- site/specs/numbers_v2.yml | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 677c84956..70bcaa627 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -7123,7 +7123,9 @@ components: ImportToAccountNumberOrderType: $ref: '#/components/schemas/ImportToAccountNumberOrderType' OverrideFeatureRestrictions: - description: Used to override the purchase restrictions + default: false + description: Used to override the account's purchase restrictions + required: false type: boolean PeerId: description: >- @@ -7136,7 +7138,6 @@ components: required: - ImportToAccountNumberOrderType - SiteId - - OverrideFeatureRestrictions type: object title: ImportTnAccountOrder ImportToAccountOrderResponseOrderRequest: diff --git a/site/specs/numbers_v2.yml b/site/specs/numbers_v2.yml index b3a5388f4..bf1e1e72b 100644 --- a/site/specs/numbers_v2.yml +++ b/site/specs/numbers_v2.yml @@ -7306,7 +7306,9 @@ components: ImportToAccountNumberOrderType: $ref: '#/components/schemas/ImportToAccountNumberOrderType' OverrideFeatureRestrictions: - description: Used to override the purchase restrictions + default: false + description: Used to override the account's purchase restrictions + required: false type: boolean PeerId: description: >- @@ -7319,7 +7321,6 @@ components: required: - ImportToAccountNumberOrderType - SiteId - - OverrideFeatureRestrictions type: object title: ImportTnAccountOrder ImportToAccountOrderResponseOrderRequest: From 088114fed09f0e90b0f86da66d38d03437c78eac Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Mon, 16 Oct 2023 14:55:42 +0000 Subject: [PATCH 3/3] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 1 - site/specs/numbers_v2.yml | 1 - 2 files changed, 2 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 70bcaa627..5f175a529 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -7125,7 +7125,6 @@ components: OverrideFeatureRestrictions: default: false description: Used to override the account's purchase restrictions - required: false type: boolean PeerId: description: >- diff --git a/site/specs/numbers_v2.yml b/site/specs/numbers_v2.yml index bf1e1e72b..175ba9060 100644 --- a/site/specs/numbers_v2.yml +++ b/site/specs/numbers_v2.yml @@ -7308,7 +7308,6 @@ components: OverrideFeatureRestrictions: default: false description: Used to override the account's purchase restrictions - required: false type: boolean PeerId: description: >-