From 4458e8f81ea92d113edc038b92cfbf21b2f973cc Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Wed, 14 Dec 2022 16:25:24 +0000 Subject: [PATCH 1/5] Add Code Snippets to Spec Files --- site/specs/global-v3.yml | 2 +- site/specs/global.yml | 215 +-- site/specs/insights.yml | 32 - site/specs/messaging.yml | 397 +---- site/specs/numbers.yml | 2126 +++++++----------------- site/specs/one-identity-management.yml | 30 +- 6 files changed, 771 insertions(+), 2031 deletions(-) diff --git a/site/specs/global-v3.yml b/site/specs/global-v3.yml index 880bb6c0e..096340594 100644 --- a/site/specs/global-v3.yml +++ b/site/specs/global-v3.yml @@ -2176,7 +2176,7 @@ security: - Token: [] - ApiKey: [] tags: - - name: Portability Checker - name: Port-In Orders - name: Port-In Order Document + - name: Portability Checker - name: Coming soon diff --git a/site/specs/global.yml b/site/specs/global.yml index 6280ce956..b64b4b4ef 100644 --- a/site/specs/global.yml +++ b/site/specs/global.yml @@ -732,29 +732,6 @@ info: |`TEST_DID_NOT_CANCELLABLE`|`418`|Dids that have been assigned to you in test cannot be cancelled using this operation. Please contact your account manager to cancel test dids.| - - |`EXCEEDED_MAX_ALLOWED_QUANTITY`|`419`|Exceeded maximum allowed quantity for - number ordering.| - - |`ORDERING_FORBIDDEN_FOR_NON_VALID_ACCOUNTS`|`420`|Sorry, DID is not - available for cancellation yet. Please check Cancellation Available dates.| - - |`INVALID_CANCELLATION_NOT_AVAILABLE_CAPACITY_CUSTOMER`|`421`|Sorry, DID is - not available for cancellation yet. Please check Cancellation Available - dates.| - - |`BOTH_PARAMS_CANNOT_BE_SELECTED`|`422`|Quantity and phoneNumbers cannot be - selected for removal at the same time. Please select only one option.| - - |`ONE_PARAM_MUST_BE_SELECTED`|`423`|Either quantity or phoneNumbers must be - provided.| - - |`INVALID_PHONE_NUMBERS`|`424`|The selected phoneNumbers do not exist in - your cart: | - - |`QUANTITY_RELATED_NUMBERS_CANNOT_RELATE_TO_PHONE_NUMBERS`|`425`|Invalid DID - Request. The user has to indicate the phoneNumbers if the numbers being - removed were added via Number Selection.| contact: name: Bandwidth version: '1.0' @@ -794,7 +771,7 @@ tags: 2. To buy numbers, you can either: * Get the associated didGroupId for a country/area code from listDidGroup method (Inventory module), and add a certain quantity of DIDs (didCartItem) from a didGroupId to the CartIdentifier using addToCart - * Provide a list of telephone numbers you've searched and found in the Bandwidth inventory, for sale. + * Coming Q2 2022: Provide a list of telephone numbers you've searched and found in the Voxbone inventory, for sale. 3. Check your funds with accountBalance @@ -813,6 +790,10 @@ tags: operation, the response contains a list of productCheckout elements. These elements give you an orderReference for each product type contained in your cart, which can be used as a filter for the listDid operation + + + + Coming Q3 2022: Review the Number(s) and number information of the order - name: Service Activation description: > Service activation module contains a list of operations that allow you to @@ -1100,6 +1081,14 @@ paths: in the query parameter. - Response can return a maximum of 5000 numbers + + - The ability to submit selected numbers available to your cart to + purchase will be available August 2022. + + + Coming Q3 2022: + + - Ability to vanity search for a number in the Voxbone inventory operationId: listDidGroup parameters: - name: countryCodeA3 @@ -1261,9 +1250,9 @@ paths: name: VoxOUT National description: Used to build the coverage pages in the public website phoneNumbers: - - phoneNumber: '+31208908115' - - phoneNumber: '+31208908116' - - phoneNumber: '+31208908117' + - '+31208908115' + - '+31208908116' + - '+31208908117' resultCount: 1 x-internal: false x-summary: >- @@ -1411,9 +1400,7 @@ paths: always need to create at least one cart to place an order (checkoutCart). You can place multiple orders per cart or you can create separate carts for each order. Note that different product types (DID, - Capacity or prepaid credits) can be added into one single cart. You - cannot add a didGroup and quantity, and a list of phoneNumbers of the - same didGroup in the same cart. + Capacity or prepaid credits) can be added into one single cart. operationId: createCart requestBody: content: @@ -1429,6 +1416,7 @@ paths: text/xml: schema: $ref: '#/components/schemas/CreateCartResponse' + examples: {} application/json: schema: $ref: '#/components/schemas/CreateCartResponse' @@ -1447,9 +1435,10 @@ paths: Set quantity to 0 if you want to remove the product from the cart. - If phoneNumbers exist in the cart - you will need to submit the E164 of - the phoneNumber to remove the number(s). Quantity of an OrderProductId - will not remove phoneNumbers, only a didGroup and quantity. + At present, you are able to see a list of numbers available (BETA). The + ability to submit selected numbers available to your cart to purchase + will be available August 2022. The ability to remove selected numbers in + your cart to purchase will be available August 2022. operationId: removeFromCart parameters: - name: cartIdentifier @@ -1468,11 +1457,9 @@ paths: format: int32 requestBody: content: - application/json: + '*/*': schema: - oneOf: - - $ref: '#/components/schemas/RemoveQuantityFromCartRequest' - - $ref: '#/components/schemas/RemovePhoneNumbersFromCartRequest' + $ref: '#/components/schemas/RemoveFromCartRequest' required: true responses: '200': @@ -1558,20 +1545,13 @@ paths: team. - When adding numbers to your cart (to purchase) you will need to either: - - - Request the didGroupId and quantity of. - - - Request the phoneNumbers to place in the cart via the phoneNumbers - object. - + When adding numbers to your cart (to purchase) you will need to request + the didGroupId and quantity of. - Numbers selected (not quantity and didGroup) will remain in cart for a - maximum of 10 minutes, holding. No other customer will be able to see - the number(s) you are holding in cart. - You cannot add a didGroup and quantity, and a list of phoneNumbers of - the same didGroup in the same cart. + At present, you are able to see a list of numbers available (BETA). The + ability to submit selected numbers available to your cart to purchase + will be available August 2022. operationId: addToCart parameters: - name: cartIdentifier @@ -1588,10 +1568,15 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/AddCreditPackageToCartRequest' - - $ref: '#/components/schemas/AddCapacityToCartRequest' - - $ref: '#/components/schemas/AddDidToCartRequest' - - $ref: '#/components/schemas/AddPhoneNumbersToCartRequest' + - allOf: + - $ref: '#/components/schemas/AddToCartRequest' + - type: object + properties: + didCartItem: + $ref: '#/components/schemas/DidCartItem' + - allOf: + - $ref: '#/components/schemas/AddToCartRequest' + - $ref: '#/components/schemas/PhoneNumberCartItem' required: false description: '' responses: @@ -5033,26 +5018,6 @@ components: description: Zones configured in your account. items: type: string - phoneNumber: - type: object - properties: - phoneNumber: - type: string - description: The phone number digits in E.164 format - example: '+31208908115' - phoneNumberInCart: - type: object - properties: - digits: - type: string - description: The phone number digits in E.164 format - example: '+31208908115' - holdingUntil: - type: string - description: >- - The timestamp of the time until the phone number will be held in - cart in format "YYYY-MM-DD HH:MM:SS Z" - example: 2022-07-04 15:10:26 UTC DidGroup: type: object x-examples: @@ -5076,18 +5041,13 @@ components: name: string description: string phoneNumbers: - - phoneNumber: '+31208908115' - - phoneNumber: '+31208908116' - - phoneNumber: '+31208908117' - - phoneNumber: '+31208908118' - - phoneNumber: '+31208908119' - - phoneNumber: '+31208908120' - - phoneNumber: '+31208908121' - - phoneNumber: '+31208908122' - - phoneNumber: '+31208908123' - - phoneNumber: '+31208908124' - - phoneNumber: '+31208908125' - - phoneNumber: '+31208908126' + - >- + [{phoneNumber: "+31208908115"}, {phoneNumber: "+31208908116"}, + {phoneNumber: "+31208908117"}, {phoneNumber: "+31208908118"}, + {phoneNumber: "+31208908119"}, {phoneNumber: "+31208908120"}, + {phoneNumber: "+31208908121"}, {phoneNumber: "+31208908122"}, + {phoneNumber: "+31208908123"}, {phoneNumber: "+31208908124"}, + {phoneNumber: "+31208908125"}, {phoneNumber: "+31208908126"}] x-internal: false properties: didGroupId: @@ -5172,7 +5132,14 @@ components: phoneNumbers: type: array items: - $ref: '#/components/schemas/phoneNumber' + type: string + example: >- + [{phoneNumber: "+31208908115"}, {phoneNumber: "+31208908116"}, + {phoneNumber: "+31208908117"}, {phoneNumber: "+31208908118"}, + {phoneNumber: "+31208908119"}, {phoneNumber: "+31208908120"}, + {phoneNumber: "+31208908121"}, {phoneNumber: "+31208908122"}, + {phoneNumber: "+31208908123"}, {phoneNumber: "+31208908124"}, + {phoneNumber: "+31208908125"}, {phoneNumber: "+31208908126"}] Feature: type: object properties: @@ -5452,26 +5419,20 @@ components: - WARNING - ERROR x-examples: {} - AddCapacityToCartRequest: + AddToCartRequest: type: object properties: + cartIdentifier: + type: integer + description: >- + Identifies the cart and is returned by the createCart method or can + be retrieved with the listCart method. + format: int32 capacityCartItem: $ref: '#/components/schemas/CapacityCartItem' - AddCreditPackageToCartRequest: - type: object - properties: creditPackageCartItem: $ref: '#/components/schemas/CreditPackageCartItem' - AddDidToCartRequest: - type: object - properties: - didCartItem: - $ref: '#/components/schemas/DidCartItem' - AddPhoneNumbersToCartRequest: - type: object - properties: - phoneNumbers: - $ref: '#/components/schemas/PhoneNumberCartItem' + x-examples: {} CapacityCartItem: type: object properties: @@ -5522,10 +5483,14 @@ components: format: int32 example: 0 PhoneNumberCartItem: - type: array + type: object description: Corresponds to a list of Phone Numbers in a cart - items: - $ref: '#/components/schemas/phoneNumber' + properties: + phoneNumbers: + type: array + items: + type: string + example: '+19191234567' RemoveFromCartResponse: type: object properties: @@ -5540,12 +5505,25 @@ components: - WARNING - ERROR x-examples: {} - RemoveQuantityFromCartRequest: + RemoveFromCartRequest: type: object x-examples: example-1: + cartIdentifier: -2147483648 + orderProductId: -2147483648 quantity: -2147483648 + phoneNumbers: + phoneNumber: + - null properties: + cartIdentifier: + type: integer + description: The identifier of the cart. + format: int32 + orderProductId: + type: integer + description: The identifier of the product. + format: int32 quantity: type: integer description: >- @@ -5554,28 +5532,13 @@ components: orderProductId will be removed from the Cart. Note that capacity must be removed in multiple of 10. format: int32 - required: - - quantity - RemovePhoneNumbersFromCartRequest: - type: object - x-examples: - example-1: - phoneNumbers: - - '+31208908115' - - '+31208908116' - - '+31208908117' - properties: phoneNumbers: type: array items: type: string - description: The phone number digits in E.164 format - example: - - '+31208908115' - - '+31208908116' - - '+31208908117' required: - - phoneNumbers + - cartIdentifier + - orderProductId AccountBalance: type: object properties: @@ -5671,9 +5634,7 @@ components: productDescription: string quantity: 0 didgroupId: 0 - phoneNumbers: - - digits: '+31208908115' - holdingUntil: 2022-07-04 15:10:26 UTC + phoneNumbers: null ListCartResponse: type: object properties: @@ -5697,9 +5658,7 @@ components: productDescription: string quantity: -2147483648 didgroupId: -2147483648 - phoneNumbers: - - digits: '+31208908115' - holdingUntil: 2022-07-04 15:10:26 UTC + phoneNumbers: null properties: orderProductId: type: integer @@ -5728,7 +5687,7 @@ components: phoneNumbers: type: array items: - $ref: '#/components/schemas/phoneNumberInCart' + type: string ListOrderResponse: type: object properties: diff --git a/site/specs/insights.yml b/site/specs/insights.yml index e1fc6e683..b88786bac 100644 --- a/site/specs/insights.yml +++ b/site/specs/insights.yml @@ -32,7 +32,6 @@ paths: - $ref: '#/components/parameters/callDirection' - $ref: '#/components/parameters/callType' - $ref: '#/components/parameters/callResult' - - $ref: '#/components/parameters/hangUpSource' - $ref: '#/components/parameters/sipResponseCode' - $ref: '#/components/parameters/subAccount' - $ref: '#/components/parameters/sort' @@ -133,10 +132,6 @@ components: Message generated by a user agent server (UAS) or SIP server to reply to a request generated by a client. example: 200 - sipResponseDescription: - type: string - description: A short description of the SIP response. - example: OK cost: format: double type: number @@ -150,10 +145,6 @@ components: type: string description: Sub-Account ID. example: '1234' - attestationIndicator: - $ref: '#/components/schemas/attestationIndicator' - hangUpSource: - $ref: '#/components/schemas/hangUpSource' genericError: title: Generic Error type: object @@ -213,23 +204,6 @@ components: - COMPLETE - INCOMPLETE example: COMPLETE - attestationIndicator: - type: string - description: STIR/SHAKEN attestation. - nullable: true - enum: - - A - - B - - C - example: A - hangUpSource: - type: string - description: Hang up source. - enum: - - BANDWIDTH_INTERNAL - - CALLED_PARTY - - CALLING_PARTY - example: CALLED_PARTY link: title: Link type: object @@ -354,12 +328,6 @@ components: description: 'Filter Type: Exact Match, any valid call result type.' schema: $ref: '#/components/schemas/callResult' - hangUpSource: - name: hangUpSource - in: query - description: 'Filter Type: Exact Match, any valid hang up source.' - schema: - $ref: '#/components/schemas/hangUpSource' sipResponseCode: name: sipResponseCode in: query diff --git a/site/specs/messaging.yml b/site/specs/messaging.yml index d35c5bbda..51cfbd79e 100644 --- a/site/specs/messaging.yml +++ b/site/specs/messaging.yml @@ -409,10 +409,6 @@ paths: some control to your media file. - If a file is uploaded with the same name as a file that already exists - under this account, the previous file will be overwritten. - - A list of supported media types can be found [here](https://support.bandwidth.com/hc/en-us/articles/360014128994-What-MMS-file-types-are-supported-). operationId: uploadMedia @@ -1095,11 +1091,6 @@ paths: $ref: '#/components/responses/messagingTooManyRequestsError' '500': $ref: '#/components/responses/messagingInternalServerError' - callbacks: - inboundCallback: - $ref: '#/components/callbacks/inboundCallback' - statusCallback: - $ref: '#/components/callbacks/statusCallback' x-codeSamples: - lang: cURL source: | @@ -1732,7 +1723,7 @@ components: type: object setOrExpired: type: boolean - message: + messageResponse: title: Message type: object properties: @@ -1792,8 +1783,28 @@ components: type: string description: The custom string set by the user. example: custom tag + expiration: + type: string + description: >- + A string with the date/time value that the message will + automatically expire by. This must be a valid RFC-3339 value, e.g., + 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. + example: '2021-02-01T11:29:18-05:00' priority: $ref: '#/components/schemas/priorityEnum' + queueInfo: + $ref: '#/components/schemas/queueInfo' + queueInfo: + title: QueueInfo + type: object + required: scheduledDequeueTime + properties: + scheduledDequeueTime: + type: string + description: >- + The time that the message is scheduled to leave the queue associated + the with sending account. + example: 2022-09-14T18:20:16.000Z messageRequest: title: MessageRequest type: object @@ -1836,6 +1847,8 @@ components: description: >- A list of URLs to include as media attachments as part of the message. + + The URL length must be less than 4096 characters. example: - https://dev.bandwidth.com/images/bandwidth-logo.png - https://dev.bandwidth.com/images/github_logo.png @@ -1854,335 +1867,6 @@ components: automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. example: '2021-02-01T11:29:18-05:00' - inboundMessageCallback: - description: Inbound Message Callback - type: object - properties: - time: - type: string - format: date-time - example: 2016-09-14T18:20:16.000Z - type: - type: string - example: message-received - to: - type: string - example: '+15552223333' - description: - type: string - example: Incoming message received - message: - type: object - properties: - id: - type: string - example: 1661365814859loidf7mcwd4qacn7 - owner: - type: string - example: '+15553332222' - applicationId: - type: string - example: 93de2206-9669-4e07-948d-329f4b722ee2 - time: - type: string - format: date-time - example: 2016-09-14T18:20:16.000Z - segmentCount: - type: integer - example: 1 - direction: - $ref: '#/components/schemas/messageDirectionEnum' - to: - uniqueItems: true - type: array - items: - type: string - example: - - '+15552223333' - from: - type: string - example: '+15553332222' - text: - type: string - example: Hello world - tag: - type: string - example: custom string - media: - type: array - items: - type: string - format: uri - example: - - https://dev.bandwidth.com/images/bandwidth-logo.png - - https://dev.bandwidth.com/images/github_logo.png - priority: - $ref: '#/components/schemas/priorityEnum' - required: - - id - - owner - - applicationId - - time - - segmentCount - - direction - - to - - from - - text - required: - - time - - type - - to - - description - - message - messageSendingCallback: - type: object - description: Message Sending Callback - properties: - time: - type: string - format: date-time - example: 2016-09-14T18:20:16.000Z - type: - type: string - example: message-sending - to: - type: string - example: '+15552223333' - description: - type: string - example: Message is sending to carrier - message: - type: object - properties: - id: - type: string - example: 1661365814859loidf7mcwd4qacn7 - owner: - type: string - example: '+15553332222' - applicationId: - type: string - example: 93de2206-9669-4e07-948d-329f4b722ee2 - time: - type: string - format: date-time - example: 2016-09-14T18:20:16.000Z - segmentCount: - type: integer - example: 1 - direction: - $ref: '#/components/schemas/messageDirectionEnum' - to: - uniqueItems: true - type: array - items: - type: string - example: - - '+15552223333' - from: - type: string - example: '+15553332222' - text: - type: string - example: '' - tag: - type: string - example: custom string - media: - type: array - items: - type: string - format: uri - example: - - https://dev.bandwidth.com/images/bandwidth-logo.png - - https://dev.bandwidth.com/images/github_logo.png - priority: - $ref: '#/components/schemas/priorityEnum' - required: - - id - - owner - - applicationId - - time - - segmentCount - - direction - - to - - from - - text - - media - - priority - required: - - time - - type - - to - - description - - message - messageDeliveredCallback: - description: Message Delivered Callback - type: object - properties: - time: - type: string - format: date-time - example: 2016-09-14T18:20:16.000Z - type: - type: string - example: message-delivered - to: - type: string - example: '+15552223333' - description: - type: string - example: Message delivered to carrier. - message: - type: object - properties: - id: - type: string - example: 1661365814859loidf7mcwd4qacn7 - owner: - type: string - example: '+15553332222' - applicationId: - type: string - example: 93de2206-9669-4e07-948d-329f4b722ee2 - time: - type: string - format: date-time - example: 2016-09-14T18:20:16.000Z - segmentCount: - type: integer - example: 1 - direction: - $ref: '#/components/schemas/messageDirectionEnum' - to: - uniqueItems: true - type: array - items: - type: string - example: - - '+15552223333' - from: - type: string - example: '+15553332222' - text: - type: string - example: '' - tag: - type: string - example: custom string - media: - type: array - items: - type: string - format: uri - example: - - https://dev.bandwidth.com/images/bandwidth-logo.png - - https://dev.bandwidth.com/images/github_logo.png - priority: - $ref: '#/components/schemas/priorityEnum' - required: - - id - - owner - - applicationId - - time - - segmentCount - - direction - - to - - from - - text - - tag - required: - - time - - type - - to - - description - - message - messageFailedCallback: - description: Message Failed Callback - type: object - properties: - time: - type: string - format: date-time - example: 2016-09-14T18:20:16.000Z - type: - type: string - example: message-failed - to: - type: string - example: '+15552223333' - description: - type: string - example: rejected-unallocated-from-number - message: - type: object - properties: - id: - type: string - example: 1661365814859loidf7mcwd4qacn7 - owner: - type: string - example: '+15553332222' - applicationId: - type: string - example: 93de2206-9669-4e07-948d-329f4b722ee2 - time: - type: string - format: date-time - example: 2016-09-14T18:20:16.000Z - segmentCount: - type: integer - example: 1 - direction: - $ref: '#/components/schemas/messageDirectionEnum' - to: - uniqueItems: true - type: array - items: - type: string - example: - - '+15552223333' - from: - type: string - example: '+15553332222' - text: - type: string - example: '' - tag: - type: string - example: custom string - media: - type: array - items: - type: string - format: uri - example: - - https://dev.bandwidth.com/images/bandwidth-logo.png - - https://dev.bandwidth.com/images/github_logo.png - priority: - $ref: '#/components/schemas/priorityEnum' - required: - - id - - owner - - applicationId - - time - - segmentCount - - direction - - to - - from - - text - - tag - - priority - errorCode: - type: integer - example: 9902 - required: - - time - - type - - to - - description - - message - - errorCode requestBodies: createMessageRequest: content: @@ -2375,7 +2059,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/message' + $ref: '#/components/schemas/messageResponse' listMessagesResponse: description: OK content: @@ -2414,7 +2098,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/createMessageRequestError' + $ref: '#/components/schemas/questError' messagingUnauthorizedError: description: Unauthorized content: @@ -2451,37 +2135,6 @@ components: application/json: schema: $ref: '#/components/schemas/messagingRequestError' - callbacks: - inboundCallback: - '{inboundCallbackUrl}': - post: - requestBody: - required: true - description: Inbound Message Callback Payload - content: - application/json: - schema: - $ref: '#/components/schemas/inboundMessageCallback' - responses: - '200': - description: OK - statusCallback: - '{statusCallbackUrl}': - post: - requestBody: - required: true - description: Status Callback Payload - content: - application/json: - schema: - type: object - oneOf: - - $ref: '#/components/schemas/messageSendingCallback' - - $ref: '#/components/schemas/messageDeliveredCallback' - - $ref: '#/components/schemas/messageFailedCallback' - responses: - '200': - description: OK securitySchemes: Basic: type: http diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index c91b56b6c..58055da1a 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -754,36 +754,6 @@ components: ApplicationsSettings: $ref: '#/components/schemas/ApplicationsSettings' type: object - AreaCodeSearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - AreaCodeSearchAndOrderType: - $ref: '#/components/schemas/AreaCodeSearchAndOrderType' - type: object - xml: - name: Order - AreaCodeSearchAndOrderResponse: - properties: - order: - properties: - allOf: - - $ref: '#/components/schemas/orderResponseMetadata' - - properties: - AreaCodeSearchAndOrderType: - $ref: '#/components/schemas/AreaCodeSearchAndOrderType' - type: object - type: object - xml: - name: Order - orderStatus: - example: RECEIVED - type: string - xml: - name: OrderStatus - type: object - xml: - name: OrderResponse AreaCodeSearchAndOrderType: properties: AreaCode: @@ -792,8 +762,6 @@ components: format: int32 type: integer type: object - xml: - name: AreaCodeSearchAndOrderType AssociatedSipPeer: properties: PeerId: @@ -824,19 +792,6 @@ components: AssociatedSipPeersResponse: $ref: '#/components/schemas/AssociatedSipPeersResponse' type: object - AutomatedTollFreeLnpOrderRequest: - description: >- - Indicates that the port-in contains toll-free numbers and that Toll-Free - Automation is enabled. The numbers will be automatically validated and - submitted to our toll-free porting vendor, then the port will be - processed manually by Bandwidth’s Local Number Portability team. - properties: - LnpOrder: - allOf: - - $ref: '#/components/schemas/LnpOrderBasic' - - $ref: '#/components/schemas/LnpOrderAutomatedTollFreeFields' - title: Automated Toll-Free - type: object AvailableNpaNxx: properties: City: @@ -1957,36 +1912,6 @@ components: maxLength: 50 title: CallerName type: string - CitySearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - CitySearchAndOrderType: - $ref: '#/components/schemas/CitySearchAndOrderType' - type: object - xml: - name: Order - CitySearchAndOrderResponse: - properties: - order: - properties: - allOf: - - $ref: '#/components/schemas/orderResponseMetadata' - - properties: - CitySearchAndOrderType: - $ref: '#/components/schemas/CitySearchAndOrderType' - type: object - type: object - xml: - name: Order - orderStatus: - example: RECEIVED - type: string - xml: - name: OrderStatus - type: object - xml: - name: OrderResponse CitySearchAndOrderType: properties: City: @@ -1997,8 +1922,6 @@ components: State: type: string type: object - xml: - name: CitySearchAndOrderType CitySearchResult: properties: AvailableTelephoneNumberCount: @@ -2030,36 +1953,6 @@ components: Count: type: integer type: object - CombinedSearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - CombinedSearchAndOrderType: - $ref: '#/components/schemas/CombinedSearchAndOrderType' - type: object - xml: - name: Order - CombinedSearchAndOrderResponse: - properties: - order: - properties: - allOf: - - $ref: '#/components/schemas/orderResponseMetadata' - - properties: - CombinedSearchAndOrderType: - $ref: '#/components/schemas/CombinedSearchAndOrderType' - type: object - type: object - xml: - name: Order - orderStatus: - example: RECEIVED - type: string - xml: - name: OrderStatus - type: object - xml: - name: OrderResponse CombinedSearchAndOrderType: properties: AreaCode: @@ -2088,8 +1981,6 @@ components: Zip: type: string type: object - xml: - name: CombinedSearchAndOrderType Contact: properties: Email: @@ -2261,6 +2152,15 @@ components: uniqueItems: true xml: wrapped: true + Vendors: + items: + type: string + xml: + name: Vendor + type: array + uniqueItems: true + xml: + wrapped: true ZipCodes: items: type: string @@ -3865,36 +3765,6 @@ components: ErrorResponse: $ref: '#/components/schemas/ResponseStatus' type: object - ExistingTelephoneNumberOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - ExistingTelephoneNumberOrderType: - $ref: '#/components/schemas/ExistingTelephoneNumberOrderType' - type: object - xml: - name: Order - ExistingTelephoneNumberOrderResponse: - properties: - order: - properties: - allOf: - - $ref: '#/components/schemas/orderResponseMetadata' - - properties: - ExistingTelephoneNumberOrderType: - $ref: '#/components/schemas/ExistingTelephoneNumberOrderType' - type: object - type: object - xml: - name: Order - orderStatus: - example: RECEIVED - type: string - xml: - name: OrderStatus - type: object - xml: - name: OrderResponse ExistingTelephoneNumberOrderType: properties: ReservationIdList: @@ -3910,8 +3780,6 @@ components: name: TelephoneNumber type: array type: object - xml: - name: ExistingTelephoneNumberOrderType ExternalTnsOrder: properties: AccountId: @@ -3969,6 +3837,7 @@ components: enum: - IMPORT - REMOVE + required: true type: string CustomerOrderId: description: An order ID created by the customer for their tracking purposes @@ -3981,26 +3850,26 @@ components: enum: - CARRIER - SUBSCRIBER + required: false type: string SipPeerId: description: >- The ID of the SIP Peer that the Telephone Numbers are to be provisioned to format: int32 + required: false type: integer SiteId: description: >- The ID of the Site that the Telephone Numbers are to be provisioned to format: int32 + required: true type: integer TelephoneNumbers: items: $ref: '#/components/schemas/TelephoneNumber' type: array - required: - - SiteId - - Action type: object type: object ExternalTnsOrderResponse: @@ -4105,12 +3974,14 @@ components: RequestAddress: properties: AddressLine1: + required: true type: string AddressLine2: type: string AddressType: type: string City: + required: true type: string Country: type: string @@ -4131,6 +4002,7 @@ components: ResetAddressFields: type: boolean StateCode: + required: true type: string StreetName: type: string @@ -4138,10 +4010,6 @@ components: type: string Zip: type: string - required: - - AddressLine1 - - City - - StateCode type: object type: object GeocodeRequestConflictResponse: @@ -4703,9 +4571,8 @@ components: CampaignId: description: Campaign ID generated by TCR maximum: 12 + required: true type: string - required: - - CampaignId type: object type: object ImportedTelephoneNumberDetailList: @@ -4750,6 +4617,14 @@ components: - $ref: '#/components/schemas/LnpOrderBasic' - $ref: '#/components/schemas/LnpOrderAdditionalFields' - properties: + Immediately: + description: >- + Including `Immediately` with a value of `true` will cause an + Internal port-in to complete as soon as possible, without + requiring a scheduled activation + time.

`Immediately` has no meaning for port types + other than Internal. + type: boolean NewBillingTelephoneNumber: description: >- This field is used to specify a new billing telephone number @@ -4787,36 +4662,6 @@ components: Description: type: string type: object - LATASearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - LATASearchAndOrderType: - $ref: '#/components/schemas/LATASearchAndOrderType' - type: object - xml: - name: Order - LATASearchAndOrderResponse: - properties: - order: - properties: - allOf: - - $ref: '#/components/schemas/orderResponseMetadata' - - properties: - LATASearchAndOrderType: - $ref: '#/components/schemas/LATASearchAndOrderType' - type: object - type: object - xml: - name: Order - orderStatus: - example: RECEIVED - type: string - xml: - name: OrderStatus - type: object - xml: - name: OrderResponse LATASearchAndOrderType: properties: LATA: @@ -4825,8 +4670,6 @@ components: format: int32 type: integer type: object - xml: - name: LATASearchAndOrderType LNPResponseWrapper: properties: LNPResponseWrapper: @@ -5131,28 +4974,6 @@ components: type: string Subscriber: $ref: '#/components/schemas/PortinSubscriberSupp' - TnAttributes: - description: Can be SUPPed prior to completion of the port-in request. - items: - $ref: '#/components/schemas/TnAttribute' - type: array - Triggered: - description: May be included in the PUT payload as is, but cannot be changed. - type: boolean - type: object - LnpOrderAutomatedTollFreeFields: - properties: - TargetRespOrgId: - description: >- - This is the RespOrg ID that you want the toll free numbers ported - to. Normally it will specify a Bandwidth RespOrg ID like JYT01, but - it could be something else for RespOrg Exception customers. This - field is mandatory for non-draft toll free port-in orders. - maxLength: 5 - minLength: 5 - type: string - required: - - TargetRespOrgId type: object LnpOrderBasic: properties: @@ -5262,7 +5083,7 @@ components: type: string ProcessingStatus: description: >- - May only be SUPPed for port-in orders in DRAFT state. The only valid + May only be SUPPed for port-in orders in draft state. The only valid value is “SUBMITTED” (not case sensitive). type: string RequestedFocDate: @@ -5273,6 +5094,14 @@ components: SiteId: format: int32 type: integer + TnAttributes: + description: Can be SUPPed prior to completion of the port-in request. + items: + $ref: '#/components/schemas/TnAttribute' + type: array + Triggered: + description: May be included in the PUT payload as is, but cannot be changed. + type: boolean type: object LnpOrderPortoutResponse: properties: @@ -5374,13 +5203,6 @@ components: Description: type: string type: object - TargetRespOrgId: - description: >- - This is the RespOrg ID that you want the toll free numbers - ported to. Normally it will specify a Bandwidth RespOrg ID like - JYT01, but it could be something else for RespOrg Exception - customers. - type: string Triggered: description: >- The Triggered field must be set to true if you want an @@ -5480,96 +5302,6 @@ components: WirelessInfo: $ref: '#/components/schemas/WirelessInfo' type: object - title: LNP Order Response - type: object - LnpOrderResponseAutomatedTollFree: - properties: - LnpOrderResponse: - properties: - Errors: - properties: - Code: - description: Numeric designation of corresponding error. - type: integer - Description: - description: Detailed explanation about error. - type: string - type: object - Internal: - description: >- - This is set to true if the port-in is porting a toll free number - that is already in service on a Bandwidth account. This value is - only applicable to automated toll free port-ins. - type: boolean - ListOfPhoneNumbers: - description: >- - ListOfPhoneNumbers is an array of PhoneNumber. At least one - PhoneNumber must be provided for all port-types. - items: - $ref: '#/components/schemas/PhoneNumber' - type: array - LoaAuthorizingPerson: - description: >- - The LoaAuthorizingPerson is mandatory for all port-types. This - is the first and last names of the person that has authorized - the port. The LoaAuthorizingPerson value may be up to 15 - characters in length. - type: string - OrderId: - description: Unique orderId that is used to manage the order. - type: string - PeerId: - description: >- - The numeric designation for the Location or SIP PEER ID that - applied to the Port-in Order. The SIP Peer ID is used to provide - a home within the location for the TN(s) that were ported in by - the Port-in Order - type: string - ProcessingStatus: - description: >- - The processing status of this order. Values may be: PROCESSING, - COMPLETED, FAILED. PROCESSING means that the system is still - processing the order. COMPLETED means that the order has been - successfully completed. FAILED means that errors occurred while - processing the order, and that the order did not make any - changes to the system. - enum: - - PENDING_DOCUMENTS - type: string - RespOrgException: - description: >- - This is set to true if the port-in is requesting the toll free - numbers to be ported to a RespOrg ID that does not belong to - Bandwidth. This value is only applicable to automated toll free - port-ins. - type: boolean - RocRequired: - description: >- - This is set to true if the port-in is getting ported from one - RespOrg to another, and can be used to tell when a LOA document - will be required for the port-in. This value is only applicable - to automated toll free port-ins. - type: boolean - SiteId: - description: >- - The numeric designation for the Site ID that applied to the - Port-in Order. The SiteId is used to provide a home within the - account for the TN(s) that were ported in by the Port-in Order - type: string - Status: - properties: - Code: - type: integer - Description: - type: string - type: object - TargetRespOrgId: - description: >- - The RespOrg ID that you are porting numbers to. This value is - only applicable to automated toll free port-ins. - type: string - type: object - title: Automated Toll-Free LNP Order Response type: object LnpOrderSuppAutomatedOffNet: allOf: @@ -5616,58 +5348,24 @@ components: $ref: '#/components/schemas/WirelessInfoSupp' title: LnpOrderSupp type: object - LnpOrderSuppAutomatedTollFree: - allOf: - - $ref: '#/components/schemas/LnpOrderBasicModifiableFields' - properties: - ListOfPhoneNumbers: - description: >- - May be SUPPed only in draft states (i.e. DRAFT, VALIDATE_DRAFT_TFNS, - VALID_DRAFT_TFNS, or INVALID_DRAFT_TFNS) - items: - $ref: '#/components/schemas/PhoneNumber' - type: array - LoaAuthorizingPerson: - type: string - RetryValidation: - description: >- - If 'TOLL_FREE_PORT_INS_PHASE_1' feature is enabled for account, - Bandwidth accesses a vendor to determine if the numbers are - portable, and if so, from which RespOrg. In the event that we do not - receive a response from our vendor after a number of retries, we - give up and place the order in the INVALID_TFNS or - INVALID_DRAFT_TFNS state. This scenario can occur if our toll free - porting vendor is performing maintenance, for example. Including - RetryValidation with a value of true will cause the order to return - to VALIDATE_TFNS or VALIDATE_DRAFT_TFNS and we will repeat our - attempts to retrieve the portability data from the vendor. This - element is included in the synchronous response to the PUT, when - included in the request, but is not included in subsequent GET - requests for the order. - type: boolean - TargetRespOrgId: - description: >- - This is the RespOrg ID that you want the toll free numbers ported - to. Normally it will specify a Bandwidth RespOrg ID like JYT01, but - it could be something else for RespOrg Exception customers. Because - the TargetRespOrgId is mandatory for the toll free port-in order - (but not mandatory for the PUT operation), omitting it in the PUT - leaves the TargetRespOrgId unchanged. This field must be populated - when a draft toll free port-in is submitted. - maxLength: 5 - minLength: 5 - type: string - title: LnpOrderSupp - type: object LnpOrderSuppInternal: allOf: - $ref: '#/components/schemas/LnpOrderBasicModifiableFields' - $ref: '#/components/schemas/LnpOrderAdditionalModifiableFields' properties: + Immediately: + description: May be included in the PUT payload as is, but cannot be changed. + type: boolean LoaAuthorizingPerson: type: string NewBillingTelephoneNumber: type: string + OverrideValidation: + description: >- + This Bandwidth internal flag forces port-out to bypass validity + checking (if there are no terminal errors). This flag can be SUPPed + only for orders in EXCEPTION status. + type: boolean PartialPort: type: string WirelessInfo: @@ -5694,12 +5392,30 @@ components: - $ref: '#/components/schemas/LnpOrderBasicModifiableFields' properties: ListOfPhoneNumbers: - description: May be SUPPed only in DRAFT state + description: >- + May be SUPPed only in draft states (i.e. DRAFT, VALIDATE_DRAFT_TFNS, + VALID_DRAFT_TFNS, or INVALID_DRAFT_TFNS) items: $ref: '#/components/schemas/PhoneNumber' type: array LoaAuthorizingPerson: type: string + RetryValidation: + description: >- + If 'TOLL_FREE_PORT_INS_PHASE_1' feature is enabled for account, + Bandwidth accesses a vendor to determine if the numbers are + portable, and if so, from which RespOrg. In the event that we do not + receive a response from our vendor after a number of retries, we + give up and place the order in the INVALID_TFNS or + INVALID_DRAFT_TFNS state. This scenario can occur if our toll free + porting vendor is performing maintenance, for example. Including + RetryValidation with a value of true will cause the order to return + to VALIDATE_TFNS or VALIDATE_DRAFT_TFNS and we will repeat our + attempts to retrieve the portability data from the vendor. This + element is included in the synchronous response to the PUT, when + included in the request, but is not included in subsequent GET + requests for the order. + type: boolean Subscriber: properties: BusinessName: @@ -5879,7 +5595,7 @@ components: BillingTelephoneNumber: description: >- The billing telephone number associated with the phone numbers that - are being ported. Non-toll-free. + are being ported. format: Numeric maxLength: 10 type: string @@ -5894,7 +5610,6 @@ components: maxLength: 40 type: string ListOfTelephoneNumbers: - description: Toll-free number not allowed items: $ref: '#/components/schemas/TelephoneNumber' type: array @@ -5902,6 +5617,12 @@ components: items: $ref: '#/components/schemas/LsrOrderError' type: array + OverrideValidation: + description: >- + This Bandwidth internal field is applicable only to Internal orders + that are in Exception state. A value of true bypasses all port-out + validation checking. + type: boolean PartialPort: description: >- The PartialPort must be set to true if the intent is to NOT port all @@ -5930,12 +5651,12 @@ components: RequestedFocDate: description: >- This is the FOC (Firm Order Commitment) date requested when creating - the LSR order (not past, default next day). + the LSR order. type: string SPID: description: >- The NPAC SPID corresponding to the carrier that the phone numbers - are porting to (required if account value 'mult'). + are porting to. maxLength: 4 type: string SiteId: @@ -6170,25 +5891,6 @@ components: TelephoneNumberToPort: type: string type: object - ManualTollFreeLnpOrderRequest: - description: >- - Manual indicates that the port-in will be processed manually by - Bandwidth’s Local Number Portability team. Currently all toll free - port-ins are handled manually by Bandwidth’s Local Number Portability - team. But Bandwidth is in the process of automating portions of toll - free porting, with a goal of eventually automating the entire process. - properties: - LnpOrder: - allOf: - - $ref: '#/components/schemas/LnpOrderBasic' - properties: - Subscriber: - allOf: - - $ref: '#/components/schemas/SubscriberBusiness' - type: object - type: object - title: Manual Toll-Free - type: object ManuallyPortableTollFreeNumberList: properties: DisconnectedTollFreeNumberList: @@ -6522,36 +6224,6 @@ components: trafficType: type: string type: object - NPANXXSearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - NPANXXSearchAndOrderType: - $ref: '#/components/schemas/NPANXXSearchAndOrderType' - type: object - xml: - name: Order - NPANXXSearchAndOrderResponse: - properties: - order: - properties: - allOf: - - $ref: '#/components/schemas/orderResponseMetadata' - - properties: - NPANXXSearchAndOrderType: - $ref: '#/components/schemas/NPANXXSearchAndOrderType' - type: object - type: object - xml: - name: Order - orderStatus: - example: RECEIVED - type: string - xml: - name: OrderStatus - type: object - xml: - name: OrderResponse NPANXXSearchAndOrderType: properties: EnableLCA: @@ -6562,8 +6234,6 @@ components: format: int32 type: integer type: object - xml: - name: NPANXXSearchAndOrderType NonPortableTollFreeNumberList: properties: DeniedTollFreeNumberList: @@ -6796,6 +6466,9 @@ components: AutoActivation: description: '' type: string + BillingType: + description: '' + type: string NewBillingTelephoneNumber: description: >- This field is used to specify a new billing telephone number @@ -6825,6 +6498,44 @@ components: type: object title: On-net type: object + Order: + properties: + BackOrderRequested: + type: boolean + CloseOrder: + type: boolean + CustomerOrderId: + type: string + Name: + type: string + OrderCreateDate: + type: string + PartialAllowed: + type: boolean + PeerId: + format: int32 + type: integer + SiteId: + format: int32 + type: integer + TnAttributes: + items: + $ref: '#/components/schemas/TnAttribute' + type: array + orderType: + oneOf: + - $ref: '#/components/schemas/ExistingTelephoneNumberOrderType' + - $ref: '#/components/schemas/RateCenterSearchAndOrderType' + - $ref: '#/components/schemas/AreaCodeSearchAndOrderType' + - $ref: '#/components/schemas/NPANXXSearchAndOrderType' + - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrderType' + - $ref: '#/components/schemas/TollFreeVanitySearchAndOrderType' + - $ref: '#/components/schemas/LATASearchAndOrderType' + - $ref: '#/components/schemas/ZIPSearchAndOrderType' + - $ref: '#/components/schemas/CitySearchAndOrderType' + - $ref: '#/components/schemas/StateSearchAndOrderType' + - $ref: '#/components/schemas/CombinedSearchAndOrderType' + type: object OrderCreatedDate: description: Creation date of the order. type: string @@ -6901,6 +6612,11 @@ components: type: object type: array type: object + OrderRequest: + properties: + Order: + $ref: '#/components/schemas/Order' + type: object OrderSummary: properties: CountOfTNs: @@ -6979,10 +6695,6 @@ components: type: integer type: object OriginationRoutePlan: - description: >- - The OriginationRoutePlan element consists of an action and a list of - prioritized and weighted routes that tell Bandwidth where to send phone - calls to phone numbers associated with the route plan. properties: Action: enum: @@ -7572,6 +7284,29 @@ components: type: array type: object type: object + PortinLosingCarrierInfo: + properties: + AccountNumberRequired: + type: boolean + MinimumPortingInterval: + format: int32 + type: integer + Name: + type: string + Spid: + type: string + Wireless: + type: boolean + title: LosingCarrier + type: object + PortinLosingCarrierResponse: + properties: + PortinLosingCarrierResponse: + properties: + LosingCarrier: + $ref: '#/components/schemas/PortinLosingCarrierInfo' + type: object + type: object PortinOrderId: properties: PortinOrderId: @@ -7778,36 +7513,6 @@ components: $ref: '#/components/schemas/LnpCheckerTnList' title: Rate Center information type: object - RateCenterSearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - RateCenterSearchAndOrderType: - $ref: '#/components/schemas/RateCenterSearchAndOrderType' - type: object - xml: - name: Order - RateCenterSearchAndOrderResponse: - properties: - order: - properties: - allOf: - - $ref: '#/components/schemas/orderResponseMetadata' - - properties: - RateCenterSearchAndOrderType: - $ref: '#/components/schemas/RateCenterSearchAndOrderType' - type: object - type: object - xml: - name: Order - orderStatus: - example: RECEIVED - type: string - xml: - name: OrderStatus - type: object - xml: - name: OrderResponse RateCenterSearchAndOrderType: properties: EnableLCA: @@ -7820,8 +7525,6 @@ components: State: type: string type: object - xml: - name: RateCenterSearchAndOrderType RateCenterSearchResult: properties: Abbreviation: @@ -8369,8 +8072,9 @@ components: type: string type: object SearchResult: - oneOf: - - properties: + properties: + SearchResult: + properties: ResultCount: format: int32 type: integer @@ -8379,21 +8083,7 @@ components: $ref: '#/components/schemas/TelephoneNumber' type: array type: object - - properties: - resultCount: - format: int32 - type: integer - telephoneNumberDetailList: - items: - $ref: '#/components/schemas/telephoneNumberDetail' - type: array - xml: - name: TelephoneNumberDetailList - xml: - name: ResultCount - type: object - xml: - name: SearchResult + type: object SearchResultError: properties: Error: @@ -8669,8 +8359,6 @@ components: type: string IsDefaultPeer: type: boolean - OriginationRoutePlan: - $ref: '#/components/schemas/OriginationRoutePlan' PeerId: format: int32 type: integer @@ -8869,8 +8557,6 @@ components: type: string IsDefaultPeer: type: boolean - OriginationRoutePlan: - $ref: '#/components/schemas/OriginationRoutePlan' PeerName: type: string PremiseTrunks: @@ -9401,36 +9087,6 @@ components: allOf: - $ref: '#/components/schemas/AbstractOriginationSmsTnHistory' type: object - StateSearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - StateSearchAndOrderType: - $ref: '#/components/schemas/StateSearchAndOrderType' - type: object - xml: - name: Order - StateSearchAndOrderResponse: - properties: - order: - properties: - allOf: - - $ref: '#/components/schemas/orderResponseMetadata' - - properties: - StateSearchAndOrderType: - $ref: '#/components/schemas/StateSearchAndOrderType' - type: object - type: object - xml: - name: Order - orderStatus: - example: RECEIVED - type: string - xml: - name: OrderStatus - type: object - xml: - name: OrderResponse StateSearchAndOrderType: properties: Quantity: @@ -9439,8 +9095,6 @@ components: State: type: string type: object - xml: - name: StateSearchAndOrderType StateWithCount: properties: Count: @@ -10023,29 +9677,32 @@ components: type: object TelephoneNumbersAssignmentOrderResponse: properties: - AccountId: - format: int32 - type: integer - CreatedByUser: - type: string - Errors: - items: - $ref: '#/components/schemas/TelephoneNumbersAssignmentError' - type: array - FailedQuantity: - format: int32 - type: integer - OrderCreateDate: - type: string - OrderId: - type: string - OrderStatus: - type: string - TelephoneNumbersAssignmentOrder: - $ref: '#/components/schemas/TelephoneNumbersAssignmentOrderPayload' - TotalQuantity: - format: int32 - type: integer + TelephoneNumbersAssignmentOrderResponse: + properties: + AccountId: + format: int32 + type: integer + CreatedByUser: + type: string + Errors: + items: + $ref: '#/components/schemas/TelephoneNumbersAssignmentError' + type: array + FailedQuantity: + format: int32 + type: integer + OrderCreateDate: + type: string + OrderId: + type: string + OrderStatus: + type: string + TelephoneNumbersAssignmentOrder: + $ref: '#/components/schemas/TelephoneNumbersAssignmentOrderPayload' + TotalQuantity: + format: int32 + type: integer + type: object type: object TelephoneNumbersAssignmentOrderSummary: properties: @@ -10710,38 +10367,12 @@ components: type: object type: array OrderResponse: - oneOf: - - $ref: '#/components/schemas/ExistingTelephoneNumberOrder' - - $ref: '#/components/schemas/RateCenterSearchAndOrder' - - $ref: '#/components/schemas/AreaCodeSearchAndOrder' - - $ref: '#/components/schemas/NPANXXSearchAndOrder' - - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrder' - - $ref: '#/components/schemas/TollFreeVanitySearchAndOrder' - - $ref: '#/components/schemas/LATASearchAndOrder' - - $ref: '#/components/schemas/ZIPSearchAndOrder' - - $ref: '#/components/schemas/CitySearchAndOrder' - - $ref: '#/components/schemas/StateSearchAndOrder' - - $ref: '#/components/schemas/CombinedSearchAndOrder' - xml: - name: OrderResponse + $ref: '#/components/schemas/Order' type: object TnOrderCreatedResponse: properties: OrderResponse: - oneOf: - - $ref: '#/components/schemas/ExistingTelephoneNumberOrderResponse' - - $ref: '#/components/schemas/RateCenterSearchAndOrderResponse' - - $ref: '#/components/schemas/AreaCodeSearchAndOrderResponse' - - $ref: '#/components/schemas/NPANXXSearchAndOrderResponse' - - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrderResponse' - - $ref: '#/components/schemas/TollFreeVanitySearchAndOrderResponse' - - $ref: '#/components/schemas/LATASearchAndOrderResponse' - - $ref: '#/components/schemas/ZIPSearchAndOrderResponse' - - $ref: '#/components/schemas/CitySearchAndOrderResponse' - - $ref: '#/components/schemas/StateSearchAndOrderResponse' - - $ref: '#/components/schemas/CombinedSearchAndOrderResponse' - xml: - name: OrderResponse + $ref: '#/components/schemas/Order' type: object TnOrderHistoryResponse: properties: @@ -10783,18 +10414,7 @@ components: LastModifiedDate: type: string Order: - oneOf: - - $ref: '#/components/schemas/ExistingTelephoneNumberOrder' - - $ref: '#/components/schemas/RateCenterSearchAndOrder' - - $ref: '#/components/schemas/AreaCodeSearchAndOrder' - - $ref: '#/components/schemas/NPANXXSearchAndOrder' - - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrder' - - $ref: '#/components/schemas/TollFreeVanitySearchAndOrder' - - $ref: '#/components/schemas/LATASearchAndOrder' - - $ref: '#/components/schemas/ZIPSearchAndOrder' - - $ref: '#/components/schemas/CitySearchAndOrder' - - $ref: '#/components/schemas/StateSearchAndOrder' - - $ref: '#/components/schemas/CombinedSearchAndOrder' + $ref: '#/components/schemas/Order' OrderCompleteDate: type: string OrderStatus: @@ -10880,6 +10500,25 @@ components: type: string type: object type: object + TollFreeLnpOrderRequest: + description: >- + Manual indicates that the port-in will be processed manually by + Bandwidth’s Local Number Portability team. Currently all toll free + port-ins are handled manually by Bandwidth’s Local Number Portability + team. But Bandwidth is in the process of automating portions of toll + free porting, with a goal of eventually automating the entire process. + properties: + LnpOrder: + allOf: + - $ref: '#/components/schemas/LnpOrderBasic' + properties: + Subscriber: + allOf: + - $ref: '#/components/schemas/SubscriberBusiness' + type: object + type: object + title: Toll free + type: object TollFreeNumber: properties: TollFreeNumber: @@ -11003,36 +10642,6 @@ components: TerminationSettings: $ref: '#/components/schemas/TollFreeSettings' type: object - TollFreeVanitySearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - TollFreeVanitySearchAndOrderType: - $ref: '#/components/schemas/TollFreeVanitySearchAndOrderType' - type: object - xml: - name: Order - TollFreeVanitySearchAndOrderResponse: - properties: - order: - properties: - allOf: - - $ref: '#/components/schemas/orderResponseMetadata' - - properties: - TollFreeVanitySearchAndOrderType: - $ref: '#/components/schemas/TollFreeVanitySearchAndOrderType' - type: object - type: object - xml: - name: Order - orderStatus: - example: RECEIVED - type: string - xml: - name: OrderStatus - type: object - xml: - name: OrderResponse TollFreeVanitySearchAndOrderType: properties: Quantity: @@ -11041,38 +10650,6 @@ components: TollFreeVanity: type: string type: object - xml: - name: TollFreeVanitySearchAndOrderType - TollFreeWildCharSearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - TollFreeWildCharSearchAndOrderType: - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrderType' - type: object - xml: - name: Order - TollFreeWildCharSearchAndOrderResponse: - properties: - order: - properties: - allOf: - - $ref: '#/components/schemas/orderResponseMetadata' - - properties: - TollFreeWildCharSearchAndOrderType: - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrderType' - type: object - type: object - xml: - name: Order - orderStatus: - example: RECEIVED - type: string - xml: - name: OrderStatus - type: object - xml: - name: OrderResponse TollFreeWildCharSearchAndOrderType: properties: Quantity: @@ -11081,8 +10658,6 @@ components: TollFreeWildCardPattern: type: string type: object - xml: - name: TollFreeWildCharSearchAndOrderType TollfreeTnHistory: properties: Tollfree: @@ -11220,36 +10795,6 @@ components: type: string title: WirelessInfo type: object - ZIPSearchAndOrder: - allOf: - - $ref: '#/components/schemas/orderMetadata' - - properties: - ZIPSearchAndOrderType: - $ref: '#/components/schemas/ZIPSearchAndOrderType' - type: object - xml: - name: Order - ZIPSearchAndOrderResponse: - properties: - order: - properties: - allOf: - - $ref: '#/components/schemas/orderResponseMetadata' - - properties: - ZIPSearchAndOrderType: - $ref: '#/components/schemas/ZIPSearchAndOrderType' - type: object - type: object - xml: - name: Order - orderStatus: - example: RECEIVED - type: string - xml: - name: OrderStatus - type: object - xml: - name: OrderResponse ZIPSearchAndOrderType: properties: Quantity: @@ -11258,8 +10803,6 @@ components: Zip: type: string type: object - xml: - name: ZIPSearchAndOrderType Zone: properties: Id: @@ -11373,33 +10916,6 @@ components: description: Bandwidth user ID. type: string type: object - orderMetadata: - properties: - BackOrderRequested: - type: boolean - CloseOrder: - type: boolean - CustomerOrderId: - type: string - Name: - type: string - OrderCreateDate: - type: string - PartialAllowed: - type: boolean - PeerId: - format: int32 - type: integer - SiteId: - format: int32 - type: integer - TnAttributes: - items: - $ref: '#/components/schemas/TnAttribute' - type: array - type: object - xml: - name: Order orderRequest: properties: CustomerOrderId: @@ -11411,69 +10927,6 @@ components: id: type: string type: object - orderResponseMetadata: - properties: - allOf: - - ref: '#/components/schemas/orderMetadata' - - properties: - id: - example: c1b34921-ed73-4732-8a08-168e815514ec - type: string - orderCreateDate: - example: '2022-11-14T18:39:04.505Z' - type: string - xml: - name: OrderCreateDate - type: object - type: object - xml: - name: Order - telephoneNumberDetail: - description: Returned when `enableTnDetail=True` - properties: - city: - example: MICCO - type: string - xml: - name: City - fullNumber: - example: 7722029845 - type: string - xml: - name: FullNumber - lata: - example: 46018 - type: number - xml: - name: LATA - rateCenter: - example: SEBASTIAN - type: string - xml: - name: RateCenter - state: - example: FL - type: string - xml: - name: State - tier: - example: 0 - type: number - xml: - name: Tier - vendorId: - example: 49 - type: number - xml: - name: VendorId - vendorName: - example: Bandwidth CLEC - type: string - xml: - name: VendorName - type: object - xml: - name: TelephoneNumberDetail securitySchemes: httpBasic: type: http @@ -12560,9 +12013,7 @@ paths: required: false schema: type: string - - description: >- -

The name of the city. NOTE: `State` becomes a required - parameter when searching by `city`.

+ - description:

The name of the city.

example: RALEIGH in: query name: city @@ -13029,7 +12480,7 @@ paths: summary: Create billing report in range tags: - Reports - /accounts/{accountId}/billingreports/{reportId}: + /accounts/{accountId}/billingreports/{reportid}: get: description: >

The resource will query the status of the report that is being @@ -13037,9 +12488,9 @@ paths: operationId: GetBillingReportStatus parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: Unique Report ID + - description: '' in: path - name: reportId + name: bdrid required: true schema: type: string @@ -13106,7 +12557,7 @@ paths: summary: Retrieve billing report status or redirect to download tags: - Reports - /accounts/{accountId}/billingreports/{reportId}/file: + /accounts/{accountId}/billingreports/{reportid}/file: get: description: >

A GET on the /file resource subtending a report ID will cause the @@ -13115,9 +12566,9 @@ paths: operationId: DownloadBillingReport parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: Unique Report ID + - description: '' in: path - name: reportId + name: bdrid required: true schema: type: string @@ -13438,7 +12889,7 @@ paths: summary: Create bulk port-in order tags: - Bulk Port-In - /accounts/{accountId}/bulkPortins/{orderId}: + /accounts/{accountId}/bulkPortins/{orderid}: delete: description: >- Delete a bulk port-in order with child port-ins. Deleting a bulk @@ -13454,7 +12905,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -13498,7 +12949,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -13531,7 +12982,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -13619,7 +13070,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -13704,7 +13155,7 @@ paths: summary: Update bulk port-in order tags: - Bulk Port-In - /accounts/{accountId}/bulkPortins/{orderId}/history: + /accounts/{accountId}/bulkPortins/{orderid}/history: get: description: >- Retrieves the history of the specified bulk port-in order. Obtaining @@ -13716,7 +13167,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -13792,7 +13243,7 @@ paths: summary: Retrieve bulk port-in order history tags: - Bulk Port-In - /accounts/{accountId}/bulkPortins/{orderId}/loas: + /accounts/{accountId}/bulkPortins/{orderid}/loas: get: description: >- Retrieves the list of the loa (and other) files associated with the @@ -13802,7 +13253,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -13889,7 +13340,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -13936,7 +13387,7 @@ paths: summary: Upload bulk port-in order loa file tags: - Bulk Port-In - /accounts/{accountId}/bulkPortins/{orderId}/notes: + /accounts/{accountId}/bulkPortins/{orderid}/notes: get: description: >- Retrieve all notes associated with the order. Please visit - Update a specified note. Notes may only be updated, not deleted. Please @@ -14054,7 +13505,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -14100,7 +13551,7 @@ paths: summary: Update bulk port-in order note tags: - Bulk Port-In - /accounts/{accountId}/bulkPortins/{orderId}/portinList: + /accounts/{accountId}/bulkPortins/{orderid}/portinList: get: description: >- Retrieves a list of Port-in Orders that are all associated with the @@ -14113,7 +13564,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -14175,7 +13626,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -14225,7 +13676,7 @@ paths: summary: Update list of bulk port-in child orders tags: - Bulk Port-In - /accounts/{accountId}/bulkPortins/{orderId}/tnList: + /accounts/{accountId}/bulkPortins/{orderid}/tnList: get: description: >-

The information returned in the GET /tnList response payload depends @@ -14314,7 +13765,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -14387,7 +13838,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -14644,213 +14095,6 @@ paths: description: Error Response tags: - 10DLC - /accounts/{accountId}/campaignManagement/10dlc/brands/{brandId}: - delete: - description: Delete campaign registry brand - operationId: Delete Brand - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: Brand id. - example: B5DG4HH - in: path - name: brandId - required: true - schema: - type: string - responses: - '204': - content: - application/xml: {} - description: Successfully deleted - tags: - - 10DLC - get: - description: Retrieve a campaign registry brand for the Account - operationId: Retrieve Brand - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: Brand id. - example: B5DG4HH - in: path - name: brandId - required: true - schema: - type: string - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - - - - PUBLIC_PROFIT - 111111111 - DUNS - MEDIUM_ACCOUNT - Raleigh - Bandwidth - US - Bandwidth - 123456789 - user@mail.com - +19195551234 - 27616 - NC - 123 street - NASDAQ - BAND - TECHNOLOGY - www.my.website.com - false - - - schema: - $ref: '#/components/schemas/BrandResponse' - description: OK - '400': - content: - application/xml: - examples: - example: - value: |- - - - - 12055 - 'LONG_CODE' feature is not enabled on account 900000 - - - schema: - $ref: '#/components/schemas/BrandErrorResponse' - description: Error Response - tags: - - 10DLC - put: - description: Update campaign registry brand on the Account - operationId: Update brand - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: Brand id. - example: B5DG4HH - in: path - name: brandId - required: true - schema: - type: string - requestBody: - content: - application/xml: - examples: - Customer Brand: - summary: Customer Brand - value: |- - - - PUBLIC_PROFIT - 111111111 - DUNS - MEDIUM_ACCOUNT - Raleigh - Bandwidth - US - Bandwidth - 123456789 - user@mail.com - +19195551234 - 27616 - NC - 123 street - NASDAQ - BAND - TECHNOLOGY - www.my.website.com - false - - My Brand: - summary: My Brand - value: |- - - - PUBLIC_PROFIT - 111111111 - DUNS - MEDIUM_ACCOUNT - Raleigh - Bandwidth - US - Bandwidth - 123456789 - user@mail.com - +19195551234 - 27616 - NC - 123 street - NASDAQ - BAND - TECHNOLOGY - www.my.website.com - true - - schema: - $ref: '#/components/schemas/BrandRequest' - responses: - '200': - content: - application/xml: - examples: - example: - value: |- - - - - BJDHM3 - CMHSJ9 - PUBLIC_PROFIT - 111111111 - DUNS - MEDIUM_ACCOUNT - Raleigh - Bandwidth - US - Bandwidth - 123456789 - 111111111 - user@mail.com - +19195551234 - 27616 - NC - 123 street - NASDAQ - BAND - TECHNOLOGY - www.my.website.com - true - - - schema: - $ref: '#/components/schemas/BrandResponse' - description: OK - '400': - content: - application/xml: - examples: - example: - value: |- - - - - 1003 - CompanyName is required - - - schema: - $ref: '#/components/schemas/BrandErrorResponse' - description: Error Response - tags: - - 10DLC /accounts/{accountId}/campaignManagement/10dlc/brands/{brandId}/vetting: get: description: Retrieve brand external vetting records @@ -15671,10 +14915,10 @@ paths: operationId: UpdateCsrsOrderNote parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: CSR Order id - example: 34adcd9f-2c4a-4631-9dae-d1f318ed57bc + - description: CSRs Order ID + example: 59e69657-44d2-4e7e-90f8-777988be4aef in: path - name: orderId + name: csrsId required: true schema: type: string @@ -15749,8 +14993,8 @@ paths: required: true schema: default: 300 - maximum: 5000 - minimum: 1 + max: 5000 + min: 1 type: integer - description: >- The starting date of a search in yy-mm-dd format. startdate and @@ -15861,8 +15105,8 @@ paths: required: false schema: default: 300 - maximum: 5000 - minimum: 1 + max: 5000 + min: 1 type: integer - description: The user ID associated with disconnected phone numbers example: jbm @@ -16618,7 +15862,7 @@ paths: number. tags: - DLDA - /accounts/{accountId}/dldas/{orderId}: + /accounts/{accountId}/dldas/{orderid}: get: description: Retrieve information about a DLDA Order with specified ID. operationId: ReadDldaOrder @@ -16627,7 +15871,7 @@ paths: - description: DLDA order id example: ea9e90c2-77a4-4f82-ac47-e1c5bb1311f4 in: path - name: orderId + name: orderid required: true schema: type: string @@ -16734,7 +15978,7 @@ paths: - description: DLDA order id example: f179237b-c1cb-449d-9590-aaa9d0bf3ca4 in: path - name: orderId + name: orderid required: true schema: type: string @@ -16878,7 +16122,7 @@ paths: number tags: - DLDA - /accounts/{accountId}/dldas/{orderId}/history: + /accounts/{accountId}/dldas/{orderid}/history: get: description: >- Retrieve the history information associated with a named DLDA order. @@ -16890,7 +16134,7 @@ paths: - description: DLDA order id example: f179237b-c1cb-449d-9590-aaa9d0bf3ca4 in: path - name: orderId + name: orderid required: true schema: type: string @@ -17649,7 +16893,7 @@ paths: summary: Create E911 order - associate the address with the telephone number tags: - DLR - /accounts/{accountId}/e911s/{orderId}: + /accounts/{accountId}/e911s/{orderid}: get: description: >- Retrieve information about a E911 Order with specified ID. @@ -17661,7 +16905,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: E911 order id in: path - name: orderId + name: orderid required: true schema: type: string @@ -17804,7 +17048,7 @@ paths: summary: Fetch E911 order status tags: - DLR - /accounts/{accountId}/e911s/{orderId}/history: + /accounts/{accountId}/e911s/{orderid}/history: get: description: >- Retrieve the history information associated with an order. @@ -17817,7 +17061,7 @@ paths: - description: E911 order id example: 8578086b-f73d-4a0f-bba6-d20399c7de31 in: path - name: orderId + name: orderid required: true schema: type: string @@ -18002,6 +17246,7 @@ paths: name: page required: false schema: + default: now format: date-time type: string - description: >- @@ -18455,6 +17700,7 @@ paths: name: page required: false schema: + default: now format: date-time type: string - description: >- @@ -18943,6 +18189,7 @@ paths: name: page required: false schema: + default: now format: date-time type: string - description: >- @@ -19167,6 +18414,7 @@ paths: name: page required: false schema: + default: now format: date-time type: string - description: >- @@ -19981,7 +19229,7 @@ paths: summary: Create external tns order tags: - External Tn - /accounts/{accountId}/externalTns/{orderId}: + /accounts/{accountId}/externalTns/{orderid}: get: description:

Retrieve information about a externalTns order with specified ID.

operationId: GetExternalTnsOrder @@ -19989,7 +19237,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -20452,7 +19700,6 @@ paths: enum: - SUBSCRIBER - CARRIER - - ALL type: string responses: '200': @@ -21268,7 +20515,7 @@ paths: metadata at the same time you upload the file. - example: LOA + example: documentType=LOA in: query name: documentType required: false @@ -22777,31 +22024,46 @@ paths: value: |- - ATT-011515-324234 - FineCustomerid - 123C - 9192381468 - 2015-11-15 - Jim Hopkins - - BUSINESS - BusinessName - - 11 - Park - Ave - New York - NY - 90025 - - 123463 - 1231 - - - - 9192381468 - 9192381467 - + + ATT-011515-324234 + + FineCustomerid + + 123C + + 9192381468 + + 2015-11-15 + Jim Hopkins + + + BUSINESS + + BusinessName + + + 11 + + Park + + Ave + + New York + + NY + + 90025 + + + 123463 + + 1231 + + + + 9192381468 + 9192381467 + schema: $ref: '#/components/schemas/LsrOrder' @@ -22938,7 +22200,7 @@ paths: summary: Create LSR order - initiate a port-out action tags: - Porting - /accounts/{accountId}/lsrorders/{orderId}: + /accounts/{accountId}/lsrorders/{orderid}: get: description: >- Retrieves the information associated with the specified LSR ID number. @@ -22951,7 +22213,7 @@ paths: - description: '' example: 255bda29-fc57-44e8-a6c2-59b45388c6d0 in: path - name: orderId + name: orderid required: true schema: type: string @@ -23029,7 +22291,7 @@ paths: - description: LSR ID example: '1234567' in: path - name: orderId + name: orderid required: true schema: type: string @@ -23201,7 +22463,7 @@ paths: summary: Update LSR order tags: - Porting - /accounts/{accountId}/lsrorders/{orderId}/history: + /accounts/{accountId}/lsrorders/{orderid}/history: get: description: >- Retrieves the history of the specified LSR order. @@ -23214,7 +22476,7 @@ paths: - description: LSR ID example: 00cf7e08-cab0-4515-9a77-2d0a7da09415 in: path - name: orderId + name: orderid required: true schema: type: string @@ -23266,7 +22528,7 @@ paths: summary: Fetch LSR order history tags: - Porting - /accounts/{accountId}/lsrorders/{orderId}/notes: + /accounts/{accountId}/lsrorders/{orderid}/notes: get: description: >- Retrieve all notes associated with the order. @@ -23279,7 +22541,7 @@ paths: - description: LSR ID example: 59e69657-44d2-4e7e-90f8-777988be4aef in: path - name: orderId + name: orderid required: true schema: type: string @@ -23339,7 +22601,7 @@ paths: - description: LSR ID example: 59e69657-44d2-4e7e-90f8-777988be4aef in: path - name: orderId + name: orderid required: true schema: type: string @@ -23389,7 +22651,7 @@ paths: summary: Create LSR order note tags: - Porting - /accounts/{accountId}/lsrorders/{orderId}/notes/{noteId}: + /accounts/{accountId}/lsrorders/{orderid}/notes/{noteId}: put: description: >- Update a specified note. Notes may only be updated, not deleted. @@ -23402,7 +22664,7 @@ paths: - description: LSR ID example: 59e69657-44d2-4e7e-90f8-777988be4aef in: path - name: orderId + name: orderid required: true schema: type: string @@ -23965,7 +23227,7 @@ paths: summary: Telephone Numbers Assignment Order tags: - Numbers Assignment - /accounts/{accountId}/numbersAssignment/{orderId}: + /accounts/{accountId}/numbersAssignment/{orderid}: get: description: >- Retrieve information about a TelephoneNumbersAssignment order with @@ -24480,18 +23742,7 @@ paths: 743 schema: - oneOf: - - $ref: '#/components/schemas/ExistingTelephoneNumberOrder' - - $ref: '#/components/schemas/RateCenterSearchAndOrder' - - $ref: '#/components/schemas/AreaCodeSearchAndOrder' - - $ref: '#/components/schemas/NPANXXSearchAndOrder' - - $ref: '#/components/schemas/TollFreeWildCharSearchAndOrder' - - $ref: '#/components/schemas/TollFreeVanitySearchAndOrder' - - $ref: '#/components/schemas/LATASearchAndOrder' - - $ref: '#/components/schemas/ZIPSearchAndOrder' - - $ref: '#/components/schemas/CitySearchAndOrder' - - $ref: '#/components/schemas/StateSearchAndOrder' - - $ref: '#/components/schemas/CombinedSearchAndOrder' + $ref: '#/components/schemas/OrderRequest' responses: '201': content: @@ -24593,7 +23844,7 @@ paths: summary: Get New Number Order TN Count Totals tags: - Orders - /accounts/{accountId}/orders/{orderId}: + /accounts/{accountId}/orders/{orderid}: get: description: >- GET all of the details associated with an identified order.

Please @@ -24605,7 +23856,7 @@ paths: - description: Order id example: 34adcd9f-2c4a-4631-9dae-d1f318ed57bc in: path - name: orderId + name: orderid required: true schema: type: string @@ -24698,7 +23949,7 @@ paths: - description: Order id example: 34adcd9f-2c4a-4631-9dae-d1f318ed57bc in: path - name: orderId + name: orderid required: true schema: type: string @@ -24741,7 +23992,7 @@ paths: summary: Update Telephone Number order tags: - Orders - /accounts/{accountId}/orders/{orderId}/areaCodes: + /accounts/{accountId}/orders/{orderid}/areaCodes: get: description: >- Retrieves the area codes of the phone numbers from the specified order. @@ -24754,7 +24005,7 @@ paths: - description: Order id example: 34adcd9f-2c4a-4631-9dae-d1f318ed57bc in: path - name: orderId + name: orderid required: true schema: type: string @@ -24779,7 +24030,7 @@ paths: summary: List Telephone Number order area codes tags: - Orders - /accounts/{accountId}/orders/{orderId}/history: + /accounts/{accountId}/orders/{orderid}/history: get: description: >- Retrieve the history information associated with an order.

Please @@ -24791,7 +24042,7 @@ paths: - description: Order id example: 34adcd9f-2c4a-4631-9dae-d1f318ed57bc in: path - name: orderId + name: orderid required: true schema: type: string @@ -24860,7 +24111,7 @@ paths: summary: Retrieve Telephone Number order history tags: - Orders - /accounts/{accountId}/orders/{orderId}/notes: + /accounts/{accountId}/orders/{orderid}/notes: get: description: >- Retrieve all notes associated with the order.

Please visit - Update a specified note. Notes may only be updated, not deleted. @@ -24988,7 +24239,7 @@ paths: - description: Order id example: 34adcd9f-2c4a-4631-9dae-d1f318ed57bc in: path - name: orderId + name: orderid required: true schema: type: string @@ -25039,7 +24290,7 @@ paths: summary: Update Telephone Number order note tags: - Orders - /accounts/{accountId}/orders/{orderId}/npaNxx: + /accounts/{accountId}/orders/{orderid}/npaNxx: get: description: >- Retrieves the Npa-Nxx of the phone numbers from the specified order. @@ -25052,7 +24303,7 @@ paths: - description: Order id example: 34adcd9f-2c4a-4631-9dae-d1f318ed57bc in: path - name: orderId + name: orderid required: true schema: type: string @@ -25077,7 +24328,7 @@ paths: summary: List Telephone Number order Npa-Nxx tags: - Orders - /accounts/{accountId}/orders/{orderId}/tns: + /accounts/{accountId}/orders/{orderid}/tns: get: description: >- Returns a list of phone numbers associated with the ID of a given @@ -25090,7 +24341,7 @@ paths: - description: Order id example: 34adcd9f-2c4a-4631-9dae-d1f318ed57bc in: path - name: orderId + name: orderid required: true schema: type: string @@ -25113,7 +24364,7 @@ paths: summary: List Telephone Number order tns tags: - Orders - /accounts/{accountId}/orders/{orderId}/totals: + /accounts/{accountId}/orders/{orderid}/totals: get: description: >- Retrieves the total quantity of phone numbers from the specified @@ -25126,7 +24377,7 @@ paths: - description: Order id example: 34adcd9f-2c4a-4631-9dae-d1f318ed57bc in: path - name: orderId + name: orderid required: true schema: type: string @@ -25333,15 +24584,14 @@ paths: content: application/xml: examples: - Automated Toll-Free Port-in: - value: "\n\n\tMy order id\n\t2021-06-16Z\n\t2439\n\t23432\n\tThe Authgal\n\tJYT01\n\t\n\t\t8774809871\n\t\n" - Regular Port-in: - value: "\n\n\t2016-03-25T21:15:00.000Z\n\tX455\n\t9195551234\n\t9175131245\n\t SITE ID \n\t SIPPEER ID \n\t\n\t\tBUSINESS\n\t\tFirst\n\t\tLast\n\t\t\n\t\t\t11235\n\t\t\tBack\n\t\t\tDenver\n\t\t\tCO\n\t\t\t27541\n\t\t\tCanyon\n\t\t\n\t\n\tThe Authguy\n\t\n\t\t771297665AABC\n\t\t1234\n\t\n\t\n\t\tProtected\n\t\tExternal\n\t\tImported\n\t\n\t\n\t\t9194809871\n\t\n\tmyOrder\n\ttrue\n\ttrue\n\tDRAFT\n" + Simple response: + value: "\n\n\t2016-03-25T21:15:00.000Z\n\tX455\n\t9195551234\n\t9175131245\n\t SITE ID \n\t SIPPEER ID \n\t\n\t\tBUSINESS\n\t\tFirst\n\t\tLast\n\t\t\n\t\t\t11235\n\t\t\tBack\n\t\t\tDenver\n\t\t\tCO\n\t\t\t27541\n\t\t\tCanyon\n\t\t\n\t\n\tThe Authguy\n\t\n\t\t771297665AABC\n\t\t1234\n\t\n\t\n\t\tProtected\n\t\tExternal\n\t\tImported\n\t\n\t\n\t\t9194809871\n\t\n\tmyOrder\n\ttrue\n\ttrue\n\tfalse\n\tDRAFT\n" + Toll Free port-in: + value: "\n\n\tMy order id\n\t2021-06-16Z\n\t2439\n\t23432\n\tThe Authgal\n\t\n\t\t8774809871\n\t\n" schema: oneOf: - $ref: '#/components/schemas/OnNetLnpOrderRequest' - - $ref: '#/components/schemas/ManualTollFreeLnpOrderRequest' - - $ref: '#/components/schemas/AutomatedTollFreeLnpOrderRequest' + - $ref: '#/components/schemas/TollFreeLnpOrderRequest' - $ref: '#/components/schemas/OffNetLnpOrderRequest' - $ref: '#/components/schemas/InternalLnpOrderRequest' responses: @@ -25349,10 +24599,10 @@ paths: content: application/xml: examples: - Automated Toll-Free Order Response: - value: "\n\n\t03f194d5-3932-4e9f-8ba1-03ef767985e5\n\t\n\t\t201\n\t\tOrder request received. Please use the order id to check the status of your order later.\n\t\n\tVALIDATE_TFNS\n\t2016-03-25T21:15:00.000Z\n\tThe Authguy\n\t\n\t\t8774809871\n\t\n\tPROCESSING\n\tPHASE_1_TOLLFREE\n\tJYT01\n" - Regular Order Response: - value: "\n\n\t03f194d5-3932-4e9f-8ba1-03ef767985e5\n\t\n\t\t201\n\t\tOrder request received. Please use the order id to check the status of your order later.\n\t\n\tPENDING_DOCUMENTS\n\t2016-03-25T21:15:00.000Z\n\tThe Authguy\n\t\n\t\tBUSINESS\n\t\tFirst\n\t\tLast\n\t\t\n\t\t\t11235\n\t\t\tBack\n\t\t\tDenver\n\t\t\tCO\n\t\t\t27541\n\t\t\tCanyon\n\t\t\tUnited States\n\t\t\n\t\n\t\n\t\t771297665AABC\n\t\t1234\n\t\n\t\n\t\tProtected\n\t\tExternal\n\t\tImported\n\t\n\t9195551234\n\t9175131245\n\t SITE ID \n\t SIPPEER ID \n\t\n\t\t9194809871\n\t\n\tmyOrder\n\ttrue\n\ttrue\n" + Simple Order Response: + value: "\n\n\t03f194d5-3932-4e9f-8ba1-03ef767985e5\n\t\n\t\t201\n\t\tOrder request received. Please use the order id to check the status of your order later.\n\t\n\tPENDING_DOCUMENTS\n\t2016-03-25T21:15:00.000Z\n\tThe Authguy\n\t\n\t\tBUSINESS\n\t\tFirst\n\t\tLast\n\t\t\n\t\t\t11235\n\t\t\tBack\n\t\t\tDenver\n\t\t\tCO\n\t\t\t27541\n\t\t\tCanyon\n\t\t\tUnited States\n\t\t\n\t\n\t\n\t\t771297665AABC\n\t\t1234\n\t\n\t\n\t\tProtected\n\t\tExternal\n\t\tImported\n\t\n\t9195551234\n\t9175131245\n\t SITE ID \n\t SIPPEER ID \n\t\n\t\t9194809871\n\t\n\tmyOrder\n\ttrue\n\ttrue\n\ttrue\n" + Toll Free Order Response: + value: "\n\n\t03f194d5-3932-4e9f-8ba1-03ef767985e5\n\t\n\t\t201\n\t\tOrder request received. Please use the order id to check the status of your order later.\n\t\n\tVALIDATE_TFNS\n\t2016-03-25T21:15:00.000Z\n\tThe Authguy\n\t\n\t\t8774809871\n\t\n\tPROCESSING\n\tPhase1TollFree\n" schema: $ref: '#/components/schemas/LnpOrderResponse' description: >- @@ -25370,53 +24620,53 @@ paths: value: |- - - 400 - Validation Failed. Please check your input parameters. - - - 7309 - The site id was not supplied or is invalid. - - - 7312 - The sippeer id is invalid. - - - 7398 - Protected status is not available for numbers in off-net rate centers. - - EXCEPTION - The Authguy - - BUSINESS - First - Last - - 11235 - Back - Denver - CO - 27541 - Canyon - United States - - - - 771297665AABC - 1234 - - - Protected - External - Imported - - 9195551234 - 9175131245 - - 9194809871 - - true + + 400 + Validation Failed. Please check your input parameters. + + + 7309 + The site id was not supplied or is invalid. + + + 7312 + The sippeer id is invalid. + + + 7398 + Protected status is not available for numbers in off-net rate centers. + + EXCEPTION + The Authguy + + BUSINESS + First + Last + + 11235 + Back + Denver + CO + 27541 + Canyon + United States + + + + 771297665AABC + 1234 + + + Protected + External + Imported + + 9195551234 + 9175131245 + + 9194809871 + + true schema: $ref: '#/components/schemas/LnpOrderResponse' @@ -25496,7 +24746,28 @@ paths: summary: Retrieve total count of port-in orders tags: - Porting - /accounts/{accountId}/portins/{orderId}: + /accounts/{accountId}/portins/{orderId}/losingCarrier: + get: + description: >- + Retrieves the losing carrier information associated with the specified + port-in ID number + operationId: GetPortInLosingCarrierInfo + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - $ref: '#/components/parameters/OrderIdPathParam' + responses: + '200': + content: + application/xml: + schema: + $ref: '#/components/schemas/PortinLosingCarrierResponse' + description: >- + The information has been successfully retrieved and displayed in the + payload + summary: Get Port-in Losing Carrier Info + tags: + - Porting + /accounts/{accountId}/portins/{orderid}: delete: description: >- If port-in order is in DRAFT state the order will be deleted. Otherwise @@ -25517,7 +24788,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -25563,7 +24834,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -25573,103 +24844,15 @@ paths: application/xml: examples: Port-in in CANCELLED state: - value: |- - - - - 7205 - Telephone number is already being processed on another order - - CANCELLED - b4e227b3-2caf-4546-9af7-849c60dce942 - 2016-03-25T21:15:00.000Z - - 2016-03-25T21:15:00.000Z - SJM00002 - The Authguy - - BUSINESS - First - Last - - 11235 - Back - Denver - CO - 27541 - Canyon - United States - Service - - - - 771297665AABC - 1234 - - - Protected - External - Imported - - 9195551234 - 9175131245 - - 9194809871 - - Foo - 20 - 2857 - 317771 - 9998 - Mock Carrier - true - Bandwidth CLEC - 2014-08-04T13:37:06.323Z - 2014-08-04T13:37:08.676Z - jbm - jbm - false - false - AUTOMATED - + value: "\n\n\t\n\t\t7205\n\t\tTelephone number is already being processed on another order\n\t\n\tCANCELLED\n\tb4e227b3-2caf-4546-9af7-849c60dce942\n\t2016-03-25T21:15:00.000Z\n\t\n\t2016-03-25T21:15:00.000Z\n\tSJM00002\n\tThe Authguy\n\t\n\t\tBUSINESS\n\t\tFirst\n\t\tLast\n\t\t\n\t\t\t11235\n\t\t\tBack\n\t\t\tDenver\n\t\t\tCO\n\t\t\t27541\n\t\t\tCanyon\n\t\t\tUnited States\n\t\t\tService\n\t\t\n\t\n\t\n\t\t771297665AABC\n\t\t1234\n\t\n\t\n\t\tProtected\n\t\tExternal\n\t\tImported\n\t\n\t9195551234\n\t9175131245\n\t\n\t\t9194809871\n\t\n\tFoo\n\t20\n\t2857\n\t317771\n\t9998\n\tMock Carrier\n\ttrue\n\tBandwidth CLEC\n\t2014-08-04T13:37:06.323Z\n\t2014-08-04T13:37:08.676Z\n\tjbm\n\tjbm\n\tfalse\n\tfalse\n\tfalse\n\tAUTOMATED\n" Toll Free INVALID_DRAFT_TFNS state, non-portable TNs: value: "\n\n\tINVALID_DRAFT_TFNS\n\t2021-06-23T15:30:00Z\n\t2021-06-23T15:30:00Z\n\tJane Doe\n\t\n\t\t8336521001\n\t\t8336522001\n\t\n\t9900572\n\t14020\n\t521434\n\t2021-06-16T21:00:43.694Z\n\t2021-06-16T21:03:42.085Z\n\ttestuser\n\ttestuser\n\tMyTestOrder\n\tfalse\n\tMANUAL_TOLLFREE\n\tFAILED\n\t\n\t\t\n\t\t\t\n\t\t\t\t7642\n\t\t\t\tTN list contains at least one toll free number that cannot be ported due to spare status.\n\t\t\t\t\n\t\t\t\t\t8336521001\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t7643\n\t\t\t\tTN list contains at least one toll free number that cannot be ported due to unavailable status.\n\t\t\t\t\n\t\t\t\t\t8336522001\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\tPHASE_1_TOLLFREE\n" Toll Free INVALID_DRAFT_TFNS state, vendor error: value: "\n\n\tINVALID_DRAFT_TFNS\n\t2021-06-23T15:30:00Z\n\t2021-06-23T15:30:00Z\n\tJane Doe\n\t\n\t\t8336000001\n\t\n\t9900572\n\t14020\n\t521434\n\t2021-06-16T21:00:43.694Z\n\t2021-06-16T21:03:42.085Z\n\ttestuser\n\ttestuser\n\tMyTestOrder\n\tfalse\n\tMANUAL_TOLLFREE\n\tFAILED\n\t\n\t\t\n\t\t\t\n\t\t\t\t7617\n\t\t\t\tBatch Number Query received vendor error: Service unavailable. If this condition persists, please contact Bandwidth for support.\n\t\t\t\t\n\t\t\t\t\t8336000001\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\tPHASE_1_TOLLFREE\n" Toll Free VALID_DRAFT_TFNS state: - value: |- - - - VALID_DRAFT_TFNS - 2021-06-23T15:30:00Z - 2021-06-23T15:30:00Z - Jane Doe - - 8336532112 - 8336532113 - 8336532114 - - 9900572 - 14020 - 521434 - 2021-06-16T18:51:42.161Z - 2021-06-16T19:51:06.244Z - testuser - testuser - MyTestOrder - false - MANUAL_TOLLFREE - COMPLETE - PHASE_1_TOLLFREE - TST52 - true - false - false - + value: "\n\n\tVALID_DRAFT_TFNS\n\t2021-06-23T15:30:00Z\n\t2021-06-23T15:30:00Z\n\tJane Doe\n\t\n\t\t8336532112\n\t\t8336532113\n\t\t8336532114\n\t\n\t9900572\n\t14020\n\t521434\n\t2021-06-16T18:51:42.161Z\n\t2021-06-16T19:51:06.244Z\n\ttestuser\n\ttestuser\n\tMyTestOrder\n\tfalse\n\tMANUAL_TOLLFREE\n\tCOMPLETE\n\tPHASE_1_TOLLFREE\n !scope internal\n \n\tTST52\n !scope internal\n \n\tJYT01\n\ttrue\n\tfalse\n" schema: - oneOf: - - $ref: '#/components/schemas/LnpOrderResponse' - - $ref: '#/components/schemas/LnpOrderResponseAutomatedTollFree' + $ref: '#/components/schemas/LnpOrderResponse' description: >- The information has been successfully retrieved and displayed in the payload. @@ -25704,7 +24887,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -25712,63 +24895,48 @@ paths: content: application/xml: examples: - Automated Toll-Free Request: - value: |- - - - SJM00002 - 2022-12-04T11:30:00-04:00 - 743 - 28845 - - 2019721004 - 2019721005 - - TestName TestLastName - JYT01 - - Regular Request: + example: + description: example value: |- - SJM00002 - 2014-12-04T13:00:00.000Z - 8045030092 - 9175131245 - - 23453245 - 1111 - - - Protected - External - Imported - - - RESIDENTIAL - TestName - TestLastName - - - true - 115 - Monarch Way - Cary - NC - 27518 - - - 743 - true - - 2019721004 - 2019721005 - - TestName TestLastName - - Foo + SJM00002 + 2014-12-04T13:00:00.000Z + 8045030092 + 9175131245 + + 23453245 + 1111 + + + Protected + External + Imported + + + RESIDENTIAL + TestName + TestLastName + + + true + 115 + Monarch Way + Cary + NC + 27518 + + + 743 + true + + 2019721004 + 2019721005 + + TestName TestLastName + Foo schema: oneOf: @@ -25780,12 +24948,7 @@ paths: - properties: LnpOrderSupp: $ref: '#/components/schemas/LnpOrderSuppManualTollFree' - title: Manual Toll-Free - type: object - - properties: - LnpOrderSupp: - $ref: '#/components/schemas/LnpOrderSuppAutomatedTollFree' - title: Automated Toll-Free + title: Toll-Free type: object - properties: LnpOrderSupp: @@ -25812,41 +24975,21 @@ paths: content: application/xml: examples: - Automated Toll-Free Response: - value: |- - - - b6080e4c-7ddf-4faa-bbd8-328a72de9297 - - 200 - Supp request received. Please use the order id to check the status of your order later. - - REQUESTED_SUPP - SJM00002 - 2022-12-04T11:30:00-04:00 - 743 - 28845 - - 2019721004 - 2019721005 - - TestName TestLastName - JYT01 - - Simple Order Response: + example: + description: example value: |- - b6080e4c-7ddf-4faa-bbd8-328a72de9297 - - 200 - Supp request received. Please use the order id to check the status of your order later. - - REQUESTED_SUPP - 2014-12-04T13:00:00Z - 8045030092 - 9175131245 - false + b6080e4c-7ddf-4faa-bbd8-328a72de9297 + + 200 + Supp request received. Please use the order id to check the status of your order later. + + REQUESTED_SUPP + 2014-12-04T13:00:00Z + 8045030092 + 9175131245 + false schema: $ref: '#/components/schemas/LnpOrderPutResponse' @@ -25873,32 +25016,32 @@ paths: value: |- - c58fed09-a3fc-49b8-b461-2286146b73c1 - - 400 - Validation Failed. Please check your input parameters. - - - 7331 - Rate Center Not Present in Bandwidth Dashboard - - 7138391156 - - - - 7495 - Unable to change the TNs on this port. Please ensure that the new TNs are from the same losing carrier as the current TNs. - - 2024551000 - 2018391156 - 2018391157 - - - EXCEPTION - 4352154438 + c58fed09-a3fc-49b8-b461-2286146b73c1 + + 400 + Validation Failed. Please check your input parameters. + + + 7331 + Rate Center Not Present in Bandwidth Dashboard + + 7138391156 + + + + 7495 + Unable to change the TNs on this port. Please ensure that the new TNs are from the same losing carrier as the current TNs. + + 2024551000 + 2018391156 + 2018391157 + + + EXCEPTION + 4352154438 schema: - $ref: '#/components/schemas/LnpOrderPutResponse' + $ref: '#/components/schemas/LnpOrderResponse' description: >- List of telephone numbers cannot be changed due to validation errors. @@ -25911,51 +25054,52 @@ paths: value: |- - 969a26eb-3bc4-4db3-ab77-56808accb9b2 - - 409 - Validation Failed. Please check your input parameters. - - - 7717 - This port-in order is associated with a draft bulk port-in order. Either submit the bulk port-in order, or detach this order from the bulk port-in prior to submitting it. - - EXCEPTION - 1234 - Super Man - - RESIDENTIAL - John - Doe - - 10 - Awesome Lane - NewBern - NC - 99999 - United States - Service - - - - 771297665AABC - 1234ab - - 2019721103 - - 2019721103 - - false + 969a26eb-3bc4-4db3-ab77-56808accb9b2 + + 409 + Validation Failed. Please check your input parameters. + + + 7717 + This port-in order is associated with a draft bulk port-in order. Either submit the bulk port-in order, or detach this order from the bulk port-in prior to submitting it. + + EXCEPTION + 1234 + Super Man + + RESIDENTIAL + John + Doe + + 10 + Awesome Lane + NewBern + NC + 99999 + United States + Service + + + + 771297665AABC + 1234ab + + 2019721103 + + 2019721103 + + false + PORTIN schema: - $ref: '#/components/schemas/LnpOrderPutResponse' + $ref: '#/components/schemas/LnpOrderResponse' description: >- The port-in is associated with a bulk port-in in DRAFT state. To submit this port-in detach it from the parent bulk port-in. summary: Update port-in order tags: - Porting - /accounts/{accountId}/portins/{orderId}/activationStatus: + /accounts/{accountId}/portins/{orderid}/activationStatus: get: description: >- Retrieve the status (activated or not activated) of TNs associated with @@ -25968,7 +25112,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26058,7 +25202,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26123,7 +25267,7 @@ paths: summary: Update port-in order activation status tags: - Porting - /accounts/{accountId}/portins/{orderId}/areaCodes: + /accounts/{accountId}/portins/{orderid}/areaCodes: get: description: >- Retrieves a list of area codes associated with the specified port-in @@ -26133,7 +25277,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26160,7 +25304,7 @@ paths: summary: List port-in area codes tags: - Porting - /accounts/{accountId}/portins/{orderId}/history: + /accounts/{accountId}/portins/{orderid}/history: get: description: >- Retrieves the history of the specified port-in order. Obtaining history @@ -26174,7 +25318,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26238,7 +25382,7 @@ paths: summary: Retrieve port-in order history tags: - Porting - /accounts/{accountId}/portins/{orderId}/loas: + /accounts/{accountId}/portins/{orderid}/loas: get: description: >- Retrieves the list of the loa (and other) files associated with the @@ -26248,7 +25392,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26335,7 +25479,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26384,7 +25528,7 @@ paths: summary: Upload port-in loa file tags: - Porting - /accounts/{accountId}/portins/{orderId}/loas/{fileid}: + /accounts/{accountId}/portins/{orderid}/loas/{fileid}: delete: description: Deletes the file associated with the order operationId: DeletePortinLoaFile @@ -26392,7 +25536,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26419,7 +25563,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26501,7 +25645,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26540,7 +25684,7 @@ paths: summary: Update port-in loa file tags: - Porting - /accounts/{accountId}/portins/{orderId}/loas/{fileid}/metadata: + /accounts/{accountId}/portins/{orderid}/loas/{fileid}/metadata: delete: description: Deletes the metadata previously associated with the identified file. operationId: DeletePortinLoaMetadata @@ -26548,7 +25692,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26577,7 +25721,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26620,7 +25764,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26654,7 +25798,7 @@ paths: summary: Update port-in loa file metadata tags: - Porting - /accounts/{accountId}/portins/{orderId}/notes: + /accounts/{accountId}/portins/{orderid}/notes: get: description: Retrieve all notes associated with the order.
operationId: GetPortinNotes @@ -26662,7 +25806,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26717,7 +25861,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26761,7 +25905,7 @@ paths: summary: Create port-in order note tags: - Porting - /accounts/{accountId}/portins/{orderId}/notes/{noteId}: + /accounts/{accountId}/portins/{orderid}/notes/{noteId}: put: description: Update a specified note. Notes may only be updated, not deleted. operationId: UpdatePortinNote @@ -26769,7 +25913,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26815,7 +25959,7 @@ paths: summary: Update port-in order note tags: - Porting - /accounts/{accountId}/portins/{orderId}/npaNxx: + /accounts/{accountId}/portins/{orderid}/npaNxx: get: description: >- Retrieves a list of Npa-Nxx associated with the specified port-in number @@ -26825,7 +25969,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26852,7 +25996,7 @@ paths: summary: List port-in npaNxx tags: - Porting - /accounts/{accountId}/portins/{orderId}/tns: + /accounts/{accountId}/portins/{orderid}/tns: get: description: >- Retrieves a list of telephone numbers associated with the specified @@ -26862,7 +26006,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -26887,7 +26031,7 @@ paths: summary: List port-in tns tags: - Porting - /accounts/{accountId}/portins/{orderId}/totals: + /accounts/{accountId}/portins/{orderid}/totals: get: description: >- Retrieves a total count of telephone numbers associated with the @@ -26897,7 +26041,7 @@ paths: - $ref: '#/components/parameters/AccountIdPathParam' - description: '' in: path - name: orderId + name: orderid required: true schema: type: string @@ -27145,19 +26289,12 @@ paths: summary: Retrieve total count of port-in orders tags: - Porting - /accounts/{accountId}/portouts/{orderId}: + /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: @@ -27178,7 +26315,7 @@ paths: - description: Port-out order id example: ca8065d1-ec1a-43da-af40-1dcee43becb5 in: path - name: orderId + name: orderid required: true schema: type: string @@ -27228,7 +26365,7 @@ paths: - description: Port-out order id example: ca8065d1-ec1a-43da-af40-1dcee43becb5 in: path - name: orderId + name: orderid required: true schema: type: string @@ -31740,7 +30877,7 @@ paths: summary: Retrieve Site Order tags: - Orders - /accounts/{accountId}/sites/{siteId}/orders/{orderId}/tns: + /accounts/{accountId}/sites/{siteId}/orders/{orderid}/tns: get: description: Retrieves order TNs associated with the given Site operationId: RetrieveSiteOrderTns @@ -32139,6 +31276,19 @@ paths: type: boolean OriginationRoutePlan: $ref: '#/components/schemas/OriginationRoutePlan' + description: >- + The OriginationRoutePlan element consists of an action and a + list of prioritized and weighted routes that tell Bandwidth + where to send phone calls to phone numbers associated with a + SIP peer. Priority determines the order in which the + specified routes are attempted, with lower priority + endpoints being attempted first. When there are multiple + endpoints with the same priority, weight is used to + determine the percentage of phone calls that appear first in + the routing list for that priority. This field is intended + to replace the functionality of VoiceHosts, VoiceHostGroups, + and FinalDestinationUri and should not be used in + conjunction with these fields. PeerName: description: Mandatory name for the SIP Peer maxLength: 10 @@ -32228,41 +31378,47 @@ paths: schema: $ref: '#/components/schemas/SipPeerResponseBadRequest' - description: |- + description: >- Bad Request. Possible errors in response: -