Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

bwdb-15729 #1174

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
199 changes: 28 additions & 171 deletions site/specs/numbers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -7175,6 +7122,10 @@ components:
properties:
ImportToAccountNumberOrderType:
$ref: '#/components/schemas/ImportToAccountNumberOrderType'
OverrideFeatureRestrictions:
default: false
description: Used to override the account's purchase restrictions
type: boolean
PeerId:
description: >-
A sippeer id of provided site to which telephone number will be
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -31322,46 +31288,6 @@ paths:
summary: List port-out requests
tags:
- Porting
post:
description: >-
Creates a port-out request.<br>In the payload, CallbackUrl and
InternalPort are optional.<br>There are also multiple options for the
following:<table> <tr> <th>Option</th>
<th>Choices</th> </tr> <tr>
<td>Supplemental</td><td>NONE<br>CANCEL<br>UPDATE<br>OTHER<br></td>
</tr> <tr>
<td>PortOutAction</td><td>NEW<br>SUPP<br>MODIFY<br>CANCEL<br></td>
</tr> <tr> <td>InternalPort</td><td>true or false<br></td>
</tr></table>
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: |-
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PortOutResponse>
<Status>
<Code>200</Code>
<Description>Request is complete and results returned.</Description>
</Status>
</PortOutResponse>
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: >-
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.<br>In the payload,
CallbackUrl and InternalPort are optional additives.<br>There are also
multiple options for the following:<table> <tr>
<th>Option</th> <th>Choices</th> </tr> <tr>
<td>Supplemental</td><td>NONE<br>CANCEL<br>UPDATE<br>OTHER<br></td>
</tr> <tr>
<td>PortOutAction</td><td>NEW<br>SUPP<br>MODIFY<br>CANCEL<br></td>
</tr></table>
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: |-
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PortOutResponse>
<Status>
<Code>200</Code>
<Description>Request is complete and results returned.</Description>
</Status>
</PortOutResponse>
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: |
Expand Down
Loading
Loading