From c2767c7c82f2a274b1a4bb6caee61ab619bcb524 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Thu, 10 Nov 2022 21:30:07 +0000 Subject: [PATCH 01/12] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 377 +++++++++++++++++++++++++++++++++-------- 1 file changed, 303 insertions(+), 74 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 48e1f6634..76fe9732c 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -5103,6 +5103,19 @@ components: description: May be included in the PUT payload as is, but cannot be changed. type: boolean type: object + LnpOrderPhase1TollFreeFields: + 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 + type: string + required: + - TargetRespOrgId + type: object LnpOrderPortoutResponse: properties: LnpOrderResponse: @@ -5203,6 +5216,13 @@ 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 @@ -5303,6 +5323,94 @@ components: $ref: '#/components/schemas/WirelessInfo' type: object type: object + LnpOrderResponsePhase1TollFree: + 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 + type: object LnpOrderSuppAutomatedOffNet: allOf: - $ref: '#/components/schemas/LnpOrderBasicModifiableFields' @@ -5388,6 +5496,32 @@ components: title: LnpOrderSupp type: object LnpOrderSuppManualTollFree: + allOf: + - $ref: '#/components/schemas/LnpOrderBasicModifiableFields' + properties: + ListOfPhoneNumbers: + description: May be SUPPed only in DRAFT state + items: + $ref: '#/components/schemas/PhoneNumber' + type: array + LoaAuthorizingPerson: + type: string + Subscriber: + properties: + BusinessName: + maxLength: 25 + type: string + ServiceAddress: + $ref: '#/components/schemas/PortinSubscriberBasicServiceAddress' + SubscriberType: + enum: + - BUSINESS + type: string + title: Subscriber + type: object + title: LnpOrderSupp + type: object + LnpOrderSuppPhase1TollFree: allOf: - $ref: '#/components/schemas/LnpOrderBasicModifiableFields' properties: @@ -5416,19 +5550,17 @@ components: included in the request, but is not included in subsequent GET requests for the order. type: boolean - Subscriber: - properties: - BusinessName: - maxLength: 25 - type: string - ServiceAddress: - $ref: '#/components/schemas/PortinSubscriberBasicServiceAddress' - SubscriberType: - enum: - - BUSINESS - type: string - title: Subscriber - 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. 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 + type: string title: LnpOrderSupp type: object LongCodeImportCampaignErrorResponse: @@ -6729,6 +6861,19 @@ components: type: string title: Links type: object + Phase1TollFreeLnpOrderRequest: + 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/LnpOrderPhase1TollFreeFields' + title: Phase 1 toll free + type: object PhoneNumber: properties: PhoneNumber: @@ -10940,6 +11085,20 @@ info: [v2.dev.bandwidth.com](https://v2.dev.bandwidth.com/numbers/apiReference.html). + ### Disclaimer + + + This OpenAPI Specification is a work in progress as we work to finalize our + conversion from RAML to OpenAPI. It is not yet intended for use with open + source tools such as Swagger or OpenAPI Generator, and is meant for + documentation purposes only at this stage. + + + If you find any errors within the specification file itself - please [open + an issue on GitHub](https://github.com/Bandwidth/api-docs/issues) or reach + out via [support ticket](https://support.bandwidth.com). + + ## Base Path https://dashboard.bandwidth.com/api/ @@ -24570,14 +24729,15 @@ paths: content: application/xml: examples: - Simple response: + Phase 1 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" + Simple Request: 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/TollFreeLnpOrderRequest' + - $ref: '#/components/schemas/Phase1TollFreeLnpOrderRequest' - $ref: '#/components/schemas/OffNetLnpOrderRequest' - $ref: '#/components/schemas/InternalLnpOrderRequest' responses: @@ -24585,10 +24745,10 @@ paths: content: application/xml: examples: + Phase 1 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\tJYT01\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: >- @@ -24606,53 +24766,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' @@ -24836,9 +24996,39 @@ paths: 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: "\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" + 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 + schema: - $ref: '#/components/schemas/LnpOrderResponse' + oneOf: + - $ref: '#/components/schemas/LnpOrderResponse' + - $ref: '#/components/schemas/LnpOrderResponsePhase1TollFree' description: >- The information has been successfully retrieved and displayed in the payload. @@ -24881,8 +25071,22 @@ paths: content: application/xml: examples: - example: - description: example + Phase 1 Toll-Free Request: + value: |- + + + SJM00002 + 2022-12-04T11:30:00-04:00 + 743 + 28845 + + 2019721004 + 2019721005 + + TestName TestLastName + JYT01 + + Simple Request: value: |- @@ -24904,10 +25108,10 @@ paths: TestName TestLastName - - true + true 115 Monarch Way Cary @@ -24934,7 +25138,12 @@ paths: - properties: LnpOrderSupp: $ref: '#/components/schemas/LnpOrderSuppManualTollFree' - title: Toll-Free + title: Manual Toll-Free + type: object + - properties: + LnpOrderSupp: + $ref: '#/components/schemas/LnpOrderSuppPhase1TollFree' + title: Phase 1 Toll-Free type: object - properties: LnpOrderSupp: @@ -24961,8 +25170,28 @@ paths: content: application/xml: examples: - example: - description: example + Phase 1 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: value: |- From f96ed3947c0e1483e4115d02d8f9d76ffd1e8c82 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Thu, 10 Nov 2022 21:48:21 +0000 Subject: [PATCH 02/12] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 74 +++++++++++++++++++++--------------------- 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 76fe9732c..47095f782 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -25090,43 +25090,43 @@ paths: 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: From 9ea5e8f9e637dd15e105c4b0702d1ce6b5d00cd8 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Thu, 10 Nov 2022 21:51:07 +0000 Subject: [PATCH 03/12] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 47095f782..8b7a3708b 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -5112,6 +5112,7 @@ components: 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 @@ -5560,6 +5561,7 @@ components: 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 From 3d11b1ef5c46b6894ef323af0845e42745be4aae Mon Sep 17 00:00:00 2001 From: Joshua Dunster Date: Thu, 10 Nov 2022 16:51:59 -0500 Subject: [PATCH 04/12] BWDB-14315: Add new error codes. --- site/docs/numbers/errors.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/site/docs/numbers/errors.mdx b/site/docs/numbers/errors.mdx index 500303a27..6046d38be 100644 --- a/site/docs/numbers/errors.mdx +++ b/site/docs/numbers/errors.mdx @@ -560,6 +560,14 @@ image: '@site/static/img/bw-icon.svg' | 7524 | Retry Validation can only be performed on orders that are in an invalid telephone numbers state. | | 7525 | Retry Validation can only be performed if the prior attempt to validate telephone numbers resulted in a communication failure with our vendor. | | 7526 | Retry Validation is only valid for orders that have a non-empty list of TNs. | +| 7527 | Target RespOrg IDs must be 5 characters in length. | +| 7528 | Target RespOrg IDs must consist of letters (a-z, A-Z) and digits (0-9). | +| 7529 | The specified Target RespOrg ID is not a Bandwidth RespOrg ID, and your account is not configured for RespOrg Exception. | +| 7530 | The specified Target RespOrg ID is neither a Bandwidth RespOrg ID, nor one of the RespOrg Exception RespOrg IDs configured for your account. | +| 7531 | The specified Target RespOrg ID is not a valid Bandwidth RespOrg ID. | +| 7532 | The TargetRespOrgId is mandatory for toll free port-ins. | +| 7533 | A toll free port-in cannot be submitted without a TargetRespOrgId. | +| 7534 | The TargetRespOrgId cannot be changed for a port-in that has reached the Submitted state. | | 7598 | Invalid Request | | 7599 | Fatal Error in Processing | | 7600 | External telephone number(s) cannot be used: %s | From 2732a14a5e62c8f8c553cb5a38fc2cfe55f76978 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Thu, 10 Nov 2022 22:17:26 +0000 Subject: [PATCH 05/12] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 144 +++++++++++++++++++++-------------------- 1 file changed, 73 insertions(+), 71 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 8b7a3708b..66c7bd98b 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -5323,6 +5323,7 @@ components: WirelessInfo: $ref: '#/components/schemas/WirelessInfo' type: object + title: LNP Order Response type: object LnpOrderResponsePhase1TollFree: properties: @@ -5411,6 +5412,7 @@ components: only applicable to automated toll free port-ins. type: string type: object + title: Phase 1 Toll-Free LNP Order Response type: object LnpOrderSuppAutomatedOffNet: allOf: @@ -6874,7 +6876,7 @@ components: allOf: - $ref: '#/components/schemas/LnpOrderBasic' - $ref: '#/components/schemas/LnpOrderPhase1TollFreeFields' - title: Phase 1 toll free + title: Phase 1 Toll-Free type: object PhoneNumber: properties: @@ -10664,7 +10666,7 @@ components: - $ref: '#/components/schemas/SubscriberBusiness' type: object type: object - title: Toll free + title: Manual Toll-Free type: object TollFreeNumber: properties: @@ -25197,16 +25199,16 @@ paths: 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' @@ -25233,29 +25235,29 @@ 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/LnpOrderResponse' @@ -25271,42 +25273,42 @@ 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 - PORTIN + 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/LnpOrderResponse' From 7429f80e0b9782009b21418e2708fef4b91a301f Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Fri, 11 Nov 2022 14:54:40 +0000 Subject: [PATCH 06/12] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 66c7bd98b..a2f14d3eb 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -4974,6 +4974,14 @@ 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 LnpOrderBasic: properties: @@ -5094,14 +5102,6 @@ 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 LnpOrderPhase1TollFreeFields: properties: @@ -24735,7 +24735,7 @@ paths: examples: Phase 1 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" - Simple Request: + 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\tfalse\n\tDRAFT\n" schema: oneOf: @@ -24751,7 +24751,7 @@ paths: examples: Phase 1 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\tJYT01\n" - Simple Order Response: + 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\ttrue\n" schema: $ref: '#/components/schemas/LnpOrderResponse' @@ -25090,7 +25090,7 @@ paths: TestName TestLastName JYT01 - Simple Request: + Regular Request: value: |- From 6c8b6f028353e693ff20fd33813d309b981d11eb Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Fri, 11 Nov 2022 15:50:16 +0000 Subject: [PATCH 07/12] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index a2f14d3eb..31f7946dd 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -25260,7 +25260,7 @@ paths: 4352154438 schema: - $ref: '#/components/schemas/LnpOrderResponse' + $ref: '#/components/schemas/LnpOrderPutResponse' description: >- List of telephone numbers cannot be changed due to validation errors. From 50ae04600f5ff29c7ef3263db03dfa6fa1a6bdf7 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Fri, 11 Nov 2022 17:05:16 +0000 Subject: [PATCH 08/12] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 31f7946dd..a2368c9c8 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -25311,7 +25311,7 @@ paths: PORTIN schema: - $ref: '#/components/schemas/LnpOrderResponse' + $ref: '#/components/schemas/LnpOrderPutResponse' 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. From 010e648093d1b9a8e243aff1e01d9a154a98cd75 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Fri, 11 Nov 2022 20:44:09 +0000 Subject: [PATCH 09/12] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 182 ++++++++++++++++++++--------------------- 1 file changed, 91 insertions(+), 91 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index a2368c9c8..7dab99d3a 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -5325,95 +5325,6 @@ components: type: object title: LNP Order Response type: object - LnpOrderResponsePhase1TollFree: - 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: Phase 1 Toll-Free LNP Order Response - type: object LnpOrderSuppAutomatedOffNet: allOf: - $ref: '#/components/schemas/LnpOrderBasicModifiableFields' @@ -10996,6 +10907,95 @@ components: type: string type: object type: object + lnpOrderResponsePhase1TollFree: + 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: Phase 1 Toll-Free LNP Order Response + type: object lnpPortInfoForGivenStatus: properties: ActualFOCDate: @@ -25032,7 +25032,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/LnpOrderResponse' - - $ref: '#/components/schemas/LnpOrderResponsePhase1TollFree' + - $ref: '#/components/schemas/lnpOrderResponsePhase1TollFree' description: >- The information has been successfully retrieved and displayed in the payload. @@ -29206,7 +29206,7 @@ paths: Ready - 2016-06-15 + 2015-06-15 From a0d586f6c2c13c707cdca3f577e4f4652ffe1157 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Fri, 11 Nov 2022 20:56:25 +0000 Subject: [PATCH 10/12] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 180 ++++++++++++++++++++--------------------- 1 file changed, 90 insertions(+), 90 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 7dab99d3a..6b6d92d99 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -5325,6 +5325,95 @@ components: type: object title: LNP Order Response type: object + LnpOrderResponsePhase1TollFree: + 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: Phase 1 Toll-Free LNP Order Response + type: object LnpOrderSuppAutomatedOffNet: allOf: - $ref: '#/components/schemas/LnpOrderBasicModifiableFields' @@ -10907,95 +10996,6 @@ components: type: string type: object type: object - lnpOrderResponsePhase1TollFree: - 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: Phase 1 Toll-Free LNP Order Response - type: object lnpPortInfoForGivenStatus: properties: ActualFOCDate: @@ -25032,7 +25032,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/LnpOrderResponse' - - $ref: '#/components/schemas/lnpOrderResponsePhase1TollFree' + - $ref: '#/components/schemas/LnpOrderResponsePhase1TollFree' description: >- The information has been successfully retrieved and displayed in the payload. From 00210ac4a689911edadf01da4dd556910543818d Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Tue, 15 Nov 2022 16:14:43 +0000 Subject: [PATCH 11/12] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 392 +++++++++++++++++++---------------------- 1 file changed, 182 insertions(+), 210 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 6b6d92d99..962951738 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -792,6 +792,19 @@ 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: @@ -2152,15 +2165,6 @@ components: uniqueItems: true xml: wrapped: true - Vendors: - items: - type: string - xml: - name: Vendor - type: array - uniqueItems: true - xml: - wrapped: true ZipCodes: items: type: string @@ -4983,6 +4987,20 @@ components: 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: CustomerOrderId: @@ -5103,20 +5121,6 @@ components: format: int32 type: integer type: object - LnpOrderPhase1TollFreeFields: - 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 LnpOrderPortoutResponse: properties: LnpOrderResponse: @@ -5325,7 +5329,7 @@ components: type: object title: LNP Order Response type: object - LnpOrderResponsePhase1TollFree: + LnpOrderResponseAutomatedTollFree: properties: LnpOrderResponse: properties: @@ -5412,7 +5416,7 @@ components: only applicable to automated toll free port-ins. type: string type: object - title: Phase 1 Toll-Free LNP Order Response + title: Automated Toll-Free LNP Order Response type: object LnpOrderSuppAutomatedOffNet: allOf: @@ -5459,6 +5463,49 @@ 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' @@ -5524,49 +5571,6 @@ components: type: object title: LnpOrderSupp type: object - LnpOrderSuppPhase1TollFree: - 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 LongCodeImportCampaignErrorResponse: properties: LongCodeImportCampaignResponse: @@ -6027,6 +6031,25 @@ 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: @@ -6831,6 +6854,10 @@ 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: @@ -6865,19 +6892,6 @@ components: type: string title: Links type: object - Phase1TollFreeLnpOrderRequest: - 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/LnpOrderPhase1TollFreeFields' - title: Phase 1 Toll-Free - type: object PhoneNumber: properties: PhoneNumber: @@ -8508,6 +8522,8 @@ components: type: string IsDefaultPeer: type: boolean + OriginationRoutePlan: + $ref: '#/components/schemas/OriginationRoutePlan' PeerId: format: int32 type: integer @@ -8706,6 +8722,8 @@ components: type: string IsDefaultPeer: type: boolean + OriginationRoutePlan: + $ref: '#/components/schemas/OriginationRoutePlan' PeerName: type: string PremiseTrunks: @@ -10649,25 +10667,6 @@ 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: Manual Toll-Free - type: object TollFreeNumber: properties: TollFreeNumber: @@ -15142,8 +15141,8 @@ paths: required: true schema: default: 300 - max: 5000 - min: 1 + maximum: 5000 + minimum: 1 type: integer - description: >- The starting date of a search in yy-mm-dd format. startdate and @@ -15254,8 +15253,8 @@ paths: required: false schema: default: 300 - max: 5000 - min: 1 + maximum: 5000 + minimum: 1 type: integer - description: The user ID associated with disconnected phone numbers example: jbm @@ -24733,15 +24732,15 @@ paths: content: application/xml: examples: - Phase 1 Toll-Free Port-in: + 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\tfalse\n\tDRAFT\n" schema: oneOf: - $ref: '#/components/schemas/OnNetLnpOrderRequest' - - $ref: '#/components/schemas/TollFreeLnpOrderRequest' - - $ref: '#/components/schemas/Phase1TollFreeLnpOrderRequest' + - $ref: '#/components/schemas/ManualTollFreeLnpOrderRequest' + - $ref: '#/components/schemas/AutomatedTollFreeLnpOrderRequest' - $ref: '#/components/schemas/OffNetLnpOrderRequest' - $ref: '#/components/schemas/InternalLnpOrderRequest' responses: @@ -24749,8 +24748,8 @@ paths: content: application/xml: examples: - Phase 1 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\tJYT01\n" + 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\ttrue\n" schema: @@ -25032,7 +25031,7 @@ paths: schema: oneOf: - $ref: '#/components/schemas/LnpOrderResponse' - - $ref: '#/components/schemas/LnpOrderResponsePhase1TollFree' + - $ref: '#/components/schemas/LnpOrderResponseAutomatedTollFree' description: >- The information has been successfully retrieved and displayed in the payload. @@ -25075,7 +25074,7 @@ paths: content: application/xml: examples: - Phase 1 Toll-Free Request: + Automated Toll-Free Request: value: |- @@ -25146,8 +25145,8 @@ paths: type: object - properties: LnpOrderSupp: - $ref: '#/components/schemas/LnpOrderSuppPhase1TollFree' - title: Phase 1 Toll-Free + $ref: '#/components/schemas/LnpOrderSuppAutomatedTollFree' + title: Automated Toll-Free type: object - properties: LnpOrderSupp: @@ -25174,7 +25173,7 @@ paths: content: application/xml: examples: - Phase 1 Toll-Free Response: + Automated Toll-Free Response: value: |- @@ -31495,19 +31494,6 @@ 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 @@ -31597,47 +31583,41 @@ paths: schema: $ref: '#/components/schemas/SipPeerResponseBadRequest' - description: >- + description: |- Bad Request. Possible errors in response: - -
  • 12113 - The provided street address could not be verified. - Please submit a valid street address.
  • 13569 - A termination - host with HostName = 2.1.1.9 is already in use
  • 13509 - - 'wrong.ip' is not a valid host. Provide valid IP or domain - name
  • 13553 - Duplicate host (and port) in - VoiceHosts
  • 13510 - 'wrong.url' is not a valid Destination - URI
  • 13522 - IsDefaultPeer cannot be false right now. The - account requires at least one Default Sip Peer
  • 13552 - A - termination host with HostName = %s and Port = %s is already in - use
  • 12024 - Region with state '%s' and country '%s' does not - exist
  • 13576 - Account 9999999 has no CNAM product - feature
  • 13581 - Display option is missing
  • 13582 - - Enforce option is missing
  • 13590 - The supplied - CustomerTrafficAllowed value on host %s:%s are not allowed for this - sippeer
  • 13591 - Termination Settings at the SIP Peer level - are not allowed for accounts with the - 'DedicatedPrivateNetworkTopology' product.
  • 13592 - Calling - name 'Display' and 'Enforced' values can't be updated for - 'DedicatedPrivateNetworkTopology' account.
  • 13593 - %s has - invalid mask. Valid mask values: 20-32
  • 13594 - %s is not - valid host
  • 13595 - The IP address provided: %s contains a - non zero subnet portion. An equivalent IP address such as %s with a - zero subnet value must be provided.
    • -
  • 13685 "Origination route plan action cannot be 'unchanged' when creating a new SIP peer"
    • -
  • 13686 "Origination route plan action cannot be 'off' when creating a new SIP peer"
    • -
  • 13687 "Voice hosts and host groups are not supported on this account, please add your hosts to the origination route plan for this SIP peer"
    • -
  • 13688 "FinalDestinationUri is not supported on this account, to acheive the same thing, please add this URI to a fail-over group in the origination route plan for this SIP peer"
    • -
  • 5200 "Origination route plan is not enabled for the account"
    • -
  • 5207 "Specified Route Plan Action was invalid, must be one of 'asSpecified', 'unchanged' or 'off'"
    • -
  • 5218 "Origination route cannot have private IP endpoint: %s"
    • -
  • 5219 "Origination route sip endpoint %s cannot have invalid sip host %s"
    • -
  • 5220 "Origination route sip endpoint %s cannot have private ipv4 %s as sip host"
    • -
  • 5221 "Origination route priority %s cannot exceed maximum priority value %s"
    • -
  • 5222 "Origination route weight %s cannot exceed maximum weight value %s"
    • -
  • 5223 "Origination route priority should be a contiguous sequence of numbers starting with 1. Priority %d is missing."
    • -
  • 5251 "One of the provided origination route plan route names is too long, please ensure all names are less than 256 characters."
    • -
  • 5252 "The origination route name %s is invalid, please use only alphanumeric, whitespace, underscore, and/or dash characters"
    • -
  • 5253 "Telephone number endpoints are not allowed on this account. Please contact Bandwidth support if you wish to add this feature to your account."
    • +
      +
    • 12113 - The provided street address could not be verified. Please submit a valid street address.
      • +
    • 13569 - A termination host with HostName = 2.1.1.9 is already in use
      • +
    • 13509 - 'wrong.ip' is not a valid host. Provide valid IP or domain name
      • +
    • 13553 - Duplicate host (and port) in VoiceHosts
      • +
    • 13510 - 'wrong.url' is not a valid Destination URI
      • +
    • 13522 - IsDefaultPeer cannot be false right now. The account requires at least one Default Sip Peer
      • +
    • 13552 - A termination host with HostName = %s and Port = %s is already in use
      • +
    • 12024 - Region with state '%s' and country '%s' does not exist
      • +
    • 13576 - Account 9999999 has no CNAM product feature
      • +
    • 13581 - Display option is missing
      • +
    • 13582 - Enforce option is missing
      • +
    • 13590 - The supplied CustomerTrafficAllowed value on host %s:%s are not allowed for this sippeer
      • +
    • 13591 - Termination Settings at the SIP Peer level are not allowed for accounts with the 'DedicatedPrivateNetworkTopology' product.
      • +
    • 13592 - Calling name 'Display' and 'Enforced' values can't be updated for 'DedicatedPrivateNetworkTopology' account.
      • +
    • 13593 - %s has invalid mask. Valid mask values: 20-32
      • +
    • 13594 - %s is not valid host
      • +
    • 13595 - The IP address provided: %s contains a non zero subnet portion. An equivalent IP address such as %s with a zero subnet value must be provided.
      • +
    • 13685 - Origination route plan action cannot be 'unchanged' when creating a new SIP peer
      • +
    • 13686 - Origination route plan action cannot be 'off' when creating a new SIP peer
      • +
    • 13687 - Voice hosts and host groups are not supported on this account, please add your hosts to the origination route plan for this SIP peer
      • +
    • 13688 - FinalDestinationUri is not supported on this account, to acheive the same thing, please add this URI to a fail-over group in the origination route plan for this SIP peer
      • +
    • 5200 - Origination route plan is not enabled for the account
      • +
    • 5207 - Specified Route Plan Action was invalid, must be one of 'asSpecified', 'unchanged' or 'off'
      • +
    • 5218 - Origination route cannot have private IP endpoint: %s
      • +
    • 5219 - Origination route sip endpoint %s cannot have invalid sip host %s
      • +
    • 5220 - Origination route sip endpoint %s cannot have private ipv4 %s as sip host
      • +
    • 5221 - Origination route priority %s cannot exceed maximum priority value %s
      • +
    • 5222 - Origination route weight %s cannot exceed maximum weight value %s
      • +
    • 5223 - Origination route priority should be a contiguous sequence of numbers starting with 1. Priority %d is missing.
      • +
    • 5251 - One of the provided origination route plan route names is too long, please ensure all names are less than 256 characters.
      • +
    • 5252 - The origination route name %s is invalid, please use only alphanumeric, whitespace, underscore, and/or dash characters
      • +
    • 5253 - Telephone number endpoints are not allowed on this account. Please contact Bandwidth support if you wish to add this feature to your account.
    '409': content: @@ -31937,50 +31917,42 @@ paths: schema: $ref: '#/components/schemas/SipPeerResponseBadRequest' - description: >- + description: |- Bad Request. Possible errors in response: - -
    • 12113 - The provided street address could not be verified. - Please submit a valid street address.
    • 13569 - A termination - host with HostName = 2.1.1.9 is already in use
    • 13509 - - 'wrong.ip' is not a valid host. Provide valid IP or domain - name
    • 13553 - Duplicate host (and port) in - VoiceHosts
    • 13510 - 'wrong.url' is not a valid Destination - URI
    • 13522 - IsDefaultPeer cannot be false right now. The - account requires at least one Default Sip Peer
    • 13552 - A - termination host with HostName = %s and Port = %s is already in - use
    • 12024 - Region with state '%s' and country '%s' does not - exist
    • 13576 - Account 9999999 has no CNAM product - feature
    • 13581 - Display option is missing
    • 13582 - - Enforce option is missing
    • 13563 - Sip Peer '316167' account - '9999999' and site '45' does not exist
    • 13590 - The supplied - CustomerTrafficAllowed value on host %s:%s are not allowed for this - sippeer
    • 13591 - Termination Settings at the SIP Peer level - are not allowed for accounts with the - 'DedicatedPrivateNetworkTopology' product.
    • 13592 - Calling - name 'Display' and 'Enforced' values can't be updated for - 'DedicatedPrivateNetworkTopology' account.
    • 13593 - %s has - invalid mask. Valid mask values: 24-32
    • 13594 - %s is not - valid host
    • 13595 - The IP address provided: %s contains a - non zero subnet portion. An equivalent IP address such as %s with a - zero subnet value must be provided.
      • - -
    • 13685 "Origination route plan action cannot be 'unchanged' when - creating a new SIP peer"
      • -
    • 13686 "Origination route plan action cannot be 'off' when creating a new SIP peer"
      • -
    • 13687 "Voice hosts and host groups are not supported on this account, please add your hosts to the origination route plan for this SIP peer"
      • -
    • 13688 "FinalDestinationUri is not supported on this account, to acheive the same thing, please add this URI to a fail-over group in the origination route plan for this SIP peer"
      • -
    • 5200 "Origination route plan is not enabled for the account"
      • -
    • 5207 "Specified Route Plan Action was invalid, must be one of 'asSpecified', 'unchanged' or 'off'"
      • -
    • 5218 "Origination route cannot have private IP endpoint: %s"
      • -
    • 5219 "Origination route sip endpoint %s cannot have invalid sip host %s"
      • -
    • 5220 "Origination route sip endpoint %s cannot have private ipv4 %s as sip host"
      • -
    • 5221 "Origination route priority %s cannot exceed maximum priority value %s"
      • -
    • 5222 "Origination route weight %s cannot exceed maximum weight value %s"
      • -
    • 5223 "Origination route priority should be a contiguous sequence of numbers starting with 1. Priority %d is missing."
      • -
    • 5251 "One of the provided origination route plan route names is too long, please ensure all names are less than 256 characters."
      • -
    • 5252 "The origination route name %s is invalid, please use only alphanumeric, whitespace, underscore, and/or dash characters"
      • -
    • 5253 "Telephone number endpoints are not allowed on this account. Please contact Bandwidth support if you wish to add this feature to your account."
      • +
        +
      • 12113 - The provided street address could not be verified. Please submit a valid street address.
        • +
      • 13569 - A termination host with HostName = 2.1.1.9 is already in use
        • +
      • 13509 - 'wrong.ip' is not a valid host. Provide valid IP or domain name
        • +
      • 13553 - Duplicate host (and port) in VoiceHosts
        • +
      • 13510 - 'wrong.url' is not a valid Destination URI
        • +
      • 13522 - IsDefaultPeer cannot be false right now. The account requires at least one Default Sip Peer
        • +
      • 13552 - A termination host with HostName = %s and Port = %s is already in use
        • +
      • 12024 - Region with state '%s' and country '%s' does not exist
        • +
      • 13576 - Account 9999999 has no CNAM product feature
        • +
      • 13581 - Display option is missing
        • +
      • 13582 - Enforce option is missing
        • +
      • 13563 - Sip Peer '316167' account '9999999' and site '45' does not exist
        • +
      • 13590 - The supplied CustomerTrafficAllowed value on host %s:%s are not allowed for this sippeer
        • +
      • 13591 - Termination Settings at the SIP Peer level are not allowed for accounts with the 'DedicatedPrivateNetworkTopology' product.
        • +
      • 13592 - Calling name 'Display' and 'Enforced' values can't be updated for 'DedicatedPrivateNetworkTopology' account.
        • +
      • 13593 - %s has invalid mask. Valid mask values: 24-32
        • +
      • 13594 - %s is not valid host
        • +
      • 13595 - The IP address provided: %s contains a non zero subnet portion. An equivalent IP address such as %s with a zero subnet value must be provided.
        • +
      • 13685 - Origination route plan action cannot be 'unchanged' when creating a new SIP peer
        • +
      • 13686 - Origination route plan action cannot be 'off' when creating a new SIP peer
        • +
      • 13687 - Voice hosts and host groups are not supported on this account, please add your hosts to the origination route plan for this SIP peer
        • +
      • 13688 - FinalDestinationUri is not supported on this account, to acheive the same thing, please add this URI to a fail-over group in the origination route plan for this SIP peer
        • +
      • 5200 - Origination route plan is not enabled for the account
        • +
      • 5207 - Specified Route Plan Action was invalid, must be one of 'asSpecified', 'unchanged' or 'off'
        • +
      • 5218 - Origination route cannot have private IP endpoint: %s
        • +
      • 5219 - Origination route sip endpoint %s cannot have invalid sip host %s
        • +
      • 5220 - Origination route sip endpoint %s cannot have private ipv4 %s as sip host
        • +
      • 5221 - Origination route priority %s cannot exceed maximum priority value %s
        • +
      • 5222 - Origination route weight %s cannot exceed maximum weight value %s
        • +
      • 5223 - Origination route priority should be a contiguous sequence of numbers starting with 1. Priority %d is missing.
        • +
      • 5251 - One of the provided origination route plan route names is too long, please ensure all names are less than 256 characters.
        • +
      • 5252 - The origination route name %s is invalid, please use only alphanumeric, whitespace, underscore, and/or dash characters
        • +
      • 5253 - Telephone number endpoints are not allowed on this account. Please contact Bandwidth support if you wish to add this feature to your account.
      '409': content: From aea34575353b90772ad9f649bb529818e43083ca Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Thu, 8 Dec 2022 19:18:45 +0000 Subject: [PATCH 12/12] Add Code Snippets to Spec Files --- site/specs/numbers.yml | 418 +++++++++++++++++++++++++++++------------ 1 file changed, 300 insertions(+), 118 deletions(-) diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 1fade62a8..c91b56b6c 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -4750,14 +4750,6 @@ 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 @@ -5270,7 +5262,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: @@ -5672,19 +5664,10 @@ components: - $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: @@ -5896,7 +5879,7 @@ components: BillingTelephoneNumber: description: >- The billing telephone number associated with the phone numbers that - are being ported. + are being ported. Non-toll-free. format: Numeric maxLength: 10 type: string @@ -5911,6 +5894,7 @@ components: maxLength: 40 type: string ListOfTelephoneNumbers: + description: Toll-free number not allowed items: $ref: '#/components/schemas/TelephoneNumber' type: array @@ -5918,12 +5902,6 @@ 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 @@ -5952,12 +5930,12 @@ components: RequestedFocDate: description: >- This is the FOC (Firm Order Commitment) date requested when creating - the LSR order. + the LSR order (not past, default next day). type: string SPID: description: >- The NPAC SPID corresponding to the carrier that the phone numbers - are porting to. + are porting to (required if account value 'mult'). maxLength: 4 type: string SiteId: @@ -6818,9 +6796,6 @@ components: AutoActivation: description: '' type: string - BillingType: - description: '' - type: string NewBillingTelephoneNumber: description: >- This field is used to specify a new billing telephone number @@ -7597,29 +7572,6 @@ 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: @@ -14692,6 +14644,213 @@ 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 @@ -22618,46 +22777,31 @@ 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' @@ -25192,7 +25336,7 @@ paths: 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\tfalse\n\tDRAFT\n" + 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" schema: oneOf: - $ref: '#/components/schemas/OnNetLnpOrderRequest' @@ -25208,7 +25352,7 @@ paths: 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\ttrue\n" + 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" schema: $ref: '#/components/schemas/LnpOrderResponse' description: >- @@ -25429,7 +25573,65 @@ paths: application/xml: examples: Port-in in CANCELLED state: - 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" + 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 + 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: @@ -25565,6 +25767,7 @@ paths: 2019721005 TestName TestLastName + Foo schema: @@ -25743,7 +25946,6 @@ paths: 2019721103 false - PORTIN schema: $ref: '#/components/schemas/LnpOrderPutResponse' @@ -26452,27 +26654,6 @@ paths: summary: Update port-in loa file metadata tags: - Porting - /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}/notes: get: description: Retrieve all notes associated with the order.
      @@ -38938,3 +39119,4 @@ tags: - name: Tn Option - name: Tn Reservation - name: Tns + - name: Admin