From 723277c84251f199bbded0f2be5855ea9d26e9ee Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Tue, 11 Jul 2023 18:11:38 +0000 Subject: [PATCH 1/3] Add Code Snippets to Spec Files --- site/specs/messaging.yml | 20 +- site/specs/numbers.yml | 1016 +++++++++++++------------------------- site/specs/voice.yml | 1 + 3 files changed, 350 insertions(+), 687 deletions(-) diff --git a/site/specs/messaging.yml b/site/specs/messaging.yml index faa95f274..c99e2055c 100644 --- a/site/specs/messaging.yml +++ b/site/specs/messaging.yml @@ -887,7 +887,6 @@ paths: - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/limitTotalCount' responses: '200': $ref: '#/components/responses/listMessagesResponse' @@ -1530,19 +1529,6 @@ components: schema: type: integer example: 50 - limitTotalCount: - in: query - name: limitTotalCount - required: false - description: >- - When set to true, the response's totalCount field will have a maximum - value of 10,000. When set to false, or excluded, this will give an - accurate totalCount of all messages that match the provided filters. If - you are experiencing latency, try using this parameter to limit your - results. - example: true - schema: - type: boolean schemas: priorityEnum: type: string @@ -1607,9 +1593,7 @@ components: properties: totalCount: type: integer - description: >- - The total number of messages matched by the search. When the request - has limitTotalCount set to true this value is limited to 10,000. + description: Total number of messages matched by the search. example: 100 pageInfo: $ref: '#/components/schemas/pageInfo' @@ -1653,6 +1637,7 @@ components: example: 9902 receiveTime: type: string + format: date-time description: The ISO 8601 datetime of the message. example: 2020-04-07T14:03:07.000Z carrierName: @@ -1783,6 +1768,7 @@ components: example: 93de2206-9669-4e07-948d-329f4b722ee2 time: type: string + format: date-time description: The datetime stamp of the message in ISO 8601 example: 2022-09-14T18:20:16.000Z segmentCount: diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 1d0b427bb..00691e029 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -187,106 +187,6 @@ components: PENDING - BulkRateCenterGetCoverage404Error: - value: |- - - - - The resource does not exist - - - BulkRateCenterGetResponseExample: - value: |- - - - - 2021-06-08 06:45:13.0 - 2021-06-08 06:45:13.0 - PARTIAL - b05de7e6-0cab-4c83-81bb-9379cba8efd0 - 2 - 1 - 1 - - - 99 - 49 - AHOSKIE - NC - 1 - false - true - 2529690000 - 951 - - - - - 3909 - The specified vendor ID is not valid: 55 - - 100 - 55 - FARMVILLE - NC - 1 - false - true - 2529690000 - 951 - - - - - - BulkRateCenterPostCoverage400Error: - value: |- - - - - Payload cannot contain duplicate RateCenterCoverage. - 3928 - - - BulkRateCenterPostCoverage409Error: - value: |- - - - - Another bulk task is currently in processing. Task id = 4d06566e-9c99-44b7-8d9b-20e2e20dea15 - - - BulkRateCenterPostResponseExample: - value: |- - - - - PROCESSING - b05de7e6-0cab-4c83-81bb-9379cba8efd0 - - - 49 - AHOSKIE - NC - 1 - false - true - 2529690000 - 951 - - - 49 - FARMVILLE - NC - 1 - false - true - 2529690000 - 951 - - - - BulkTnVendorAssignmentPayload: value: |- @@ -794,22 +694,6 @@ components: www.my.website.com true - RateCenterCoverageResponseExample: - value: |- - - - - 123 - 49 - FARMVILLE - NC - 1 - false - true - 2529690000 - 951 - - RateCenterFindCoverage404Error: value: |- @@ -828,6 +712,19 @@ components: 3924 + RateCenterGetCoverageResponseExample: + value: |- + + + + 49 + ALABASTER + AL + 1 + true + true + + RateCenterPostCoverage400Error: value: |- @@ -846,32 +743,35 @@ components: 3923 - RegionsFindCoverage404Error: + RateCenterPostCoverageResponseExample: value: |- - - Rate center FARMVILLE.NC was not found. - 3917 - - - RegionsFindCoverageWithVendor404Error: - value: |- - - - - Rate center coverage FARMVILLE.NC with vendor ID 49 was not found. - 3918 - - - RegionsUpdateRateCenterCoverage400Error: + + 49 + FARMVILLE + NC + 1 + false + true + 2529690000 + 951 + + + RateCenterPutCoverageResponseExample: value: |- - - The specified rate center / region combination is not valid: FARMVILLE.NC - 3908 - + + 49 + FARMVILLE + NC + 1 + false + true + 2529690000 + 951 + RemoveImportedVoiceTnOrders: description: List all remove imported voice tn orders response @@ -967,22 +867,6 @@ components: required: true schema: type: string - BulkCoverageMatrixTaskId: - description: Task id for a bulk coverage matrix update. - in: path - name: taskId - required: true - schema: - type: string - BypassRateCenterRegionValidation: - description: >- - Whether to bypass the validation that a rate center exists when updating - the coverage matrix. - in: query - name: bypassRateCenterRegionValidation - required: false - schema: - type: boolean CampaignIdPathParam: description: User's campaign ID example: CBA001 @@ -1087,14 +971,6 @@ components: required: true schema: type: string - RCAbbreviationInPath: - description: A rate center's abbreviation - example: ALABASTER - in: path - name: abbreviation - required: true - schema: - type: string RCAbbreviationOptional: description: A rate center's abbreviation example: ALABASTER @@ -1126,14 +1002,6 @@ components: required: false schema: type: number - RCRegionInPath: - description: A rate center's state - example: AL - in: path - name: region - required: true - schema: - type: string RCRegionOptional: description: A rate center's state example: AL @@ -1150,14 +1018,6 @@ components: required: true schema: type: string - RCVendorInPath: - description: A rate center's vendor ID - example: 49 - in: path - name: vendor - required: true - schema: - type: number RCVendorOptional: description: Vendor id example: 49 @@ -1396,57 +1256,6 @@ components: associated with the order, the state of the order, and a list of the successfully imported Telephone Numbers, and descriptions of any encountered errors. - bulkRateCenterGetResponse404Error: - content: - application/xml: - examples: - successfulPostBulkCoverageMatrix: - $ref: '#/components/examples/BulkRateCenterGetCoverage404Error' - schema: - $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' - description: Unsuccessful response because the bulk task details could not be found. - bulkRateCenterPostResponse400Error: - content: - application/xml: - examples: - successfulPostBulkCoverageMatrix: - $ref: '#/components/examples/BulkRateCenterPostCoverage400Error' - schema: - $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' - description: Unsuccessful response due to a valiation error. - bulkRateCenterPostResponse409Error: - content: - application/xml: - examples: - successfulPostBulkCoverageMatrix: - $ref: '#/components/examples/BulkRateCenterPostCoverage409Error' - schema: - $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' - description: >- - Unsuccessful response due to a Resource Conflict Exception. The previous - task hasn't finished yet. - bulkRateCenterSuccessfulGetResponse: - content: - application/xml: - examples: - successfulPostBulkCoverageMatrix: - $ref: '#/components/examples/BulkRateCenterGetResponseExample' - schema: - $ref: '#/components/schemas/BulkRateCenterTaskPayload' - description: >- - Successful response which retrieves information about bulk upsert task - with specified ID. - bulkRateCenterSuccessfulPostResponse: - content: - application/xml: - examples: - successfulPostBulkCoverageMatrix: - $ref: '#/components/examples/BulkRateCenterPostResponseExample' - schema: - $ref: '#/components/schemas/BulkRateCenterPayload' - description: >- - Successful response which starts the bulk upsert for provided rate - centers. rateCenter401Error: content: application/json: @@ -1468,7 +1277,7 @@ components: type: forbidden schema: $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' - description: Client does not have access rights to the content. + description: Client is providing incorrect or invalid credentials. rateCenter429Error: content: application/json: @@ -1507,9 +1316,9 @@ components: application/xml: examples: successfulGetCoverageResponseExample: - $ref: '#/components/examples/RateCenterCoverageResponseExample' + $ref: '#/components/examples/RateCenterGetCoverageResponseExample' schema: - $ref: '#/components/schemas/RateCenterCoverageList' + $ref: '#/components/schemas/RateCenterCoverageSuccessfulResponseList' description: Successful response with a rate center's coverage. rateCenterGetCoverageResponse400Error: content: @@ -1527,7 +1336,7 @@ components: application/xml: examples: successfulPostCoverageResponseExample: - $ref: '#/components/examples/RateCenterCoverageResponseExample' + $ref: '#/components/examples/RateCenterPostCoverageResponseExample' schema: $ref: '#/components/schemas/CoverageMatrixEntry' description: Successful response with the generating matrix entry. @@ -1539,7 +1348,9 @@ components: $ref: '#/components/examples/RateCenterPostCoverage400Error' schema: $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' - description: Unsuccessful response due to a validation error. + description: >- + Unsuccessful response due to a validation error. A LRN was provided for + offnet coverage. rateCenterPostCoverageResponse409Error: content: application/xml: @@ -1556,50 +1367,10 @@ components: application/xml: examples: successfulPutCoverageResponseExample: - $ref: '#/components/examples/RateCenterCoverageResponseExample' + $ref: '#/components/examples/RateCenterPutCoverageResponseExample' schema: $ref: '#/components/schemas/CoverageMatrixEntry' description: Successful response for the update of a coverage matrix entry. - regionsFindCoverageResponse404Error: - content: - application/xml: - examples: - unsuccessfulUpdateRateCenterCoverage: - $ref: '#/components/examples/RegionsFindCoverage404Error' - schema: - $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' - description: >- - Unsuccessful response due to an invalid rate center region and - abbreviation combination. - regionsFindCoverageWithVendorResponse404Error: - content: - application/xml: - examples: - unsuccessfulUpdateRateCenterCoverage: - $ref: '#/components/examples/RegionsFindCoverageWithVendor404Error' - schema: - $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' - description: >- - Unsuccessful response due to an invalid rate center region, - abbreviation, and vendor combination. - regionsRateCenterCoverageSuccessfulResponseExample: - content: - application/xml: - examples: - successfulRateCenterCoverageExample: - $ref: '#/components/examples/RateCenterCoverageResponseExample' - schema: - $ref: '#/components/schemas/CoverageMatrixEntry' - description: Successful response that returns the selected rate center coverage. - regionsUpdateRateCenterCoverageResponse400Error: - content: - application/xml: - examples: - unsuccessfulUpdateRateCenterCoverage: - $ref: '#/components/examples/RegionsUpdateRateCenterCoverage400Error' - schema: - $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' - description: Unsuccessful update of rate center coverage due to a validation error. removeImportedVoiceTnOrdersResponse: content: application/xml: @@ -3825,80 +3596,6 @@ components: ZipCode: type: string type: object - BulkRateCenterPayload: - description: >- - Payload returned when a new bulk coverage matrix task is created, - containing basic task information and rate center coverage data. - properties: - coverageList: - $ref: '#/components/schemas/RateCenterCoverageList' - status: - description: The current status of the bulk coverage matrix update task. - enum: - - PROCESSING - - PARTIAL - - COMPLETE - - FAILED - type: string - taskId: - description: The bulk coverage matrix update task id. - example: b05de7e6-0cab-4c83-81bb-9379cba8efd0 - type: string - type: object - BulkRateCenterTaskPayload: - description: >- - Full bulk coverage matrix task information with complete task details - and statuses of individual rate center coverages. - properties: - endTime: - description: Timestamp of bulk rate center task completion. - example: '2021-06-08 06:46:13.0' - format: date-time - type: string - errorList: - $ref: '#/components/schemas/RateCenterCoverageErrorList' - failedRateCenterCoverageCount: - description: >- - The number of unsuccessfully created/updated rate center coverages - during the task. - example: 1 - maximum: 5000 - minimum: 0 - type: number - startTime: - description: Timestamp of bulk rate center task creation. - example: '2021-06-08 06:45:13.0' - format: date-time - type: string - status: - description: The current status of the bulk coverage matrix update task. - enum: - - PROCESSING - - PARTIAL - - COMPLETE - - FAILED - type: string - successList: - $ref: '#/components/schemas/RateCenterCoverageList' - successfulRateCenterCoverageCount: - description: >- - The number of successfully created/updated rate center coverages - during the task. - example: 3 - maximum: 5000 - minimum: 0 - type: number - taskId: - description: The bulk coverage matrix update task id. - example: b05de7e6-0cab-4c83-81bb-9379cba8efd0 - type: string - totalRateCenterCoverageCount: - description: The total number of rate center coverages included for the task. - example: 4 - maximum: 5000 - minimum: 1 - type: number - type: object BwspidSystemValue: properties: Alias: @@ -4606,10 +4303,6 @@ components: description: A rate center's abbreviation. example: FARMVILLE type: string - Id: - description: A rate center coverage matrix id. - example: 123 - type: number Lata: description: A rate center's LATA. example: 951 @@ -10244,29 +9937,12 @@ components: type: integer type: object type: object - RateCenterCoverageErrorList: - description: >- - A list of coverage matrix entries along with the errors when updating - them. - items: - description: Each data item, which includes a rate center coverage with an error. - maxItems: 5000 - minItems: 0 - properties: - coverage: - $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' - error: - $ref: '#/components/schemas/CoverageMatrixEntry' - type: object - type: array - RateCenterCoverageList: - description: A list of coverage matrix entries. + RateCenterCoverageSuccessfulResponseList: + description: A list of all coverage matrix entries returned by a GET endpoint. properties: data: items: $ref: '#/components/schemas/CoverageMatrixEntry' - maxItems: 5000 - minItems: 1 type: array required: - data @@ -16890,7 +16566,7 @@ paths: A maximum of 1,000 orders can be retrieved per request. If no date range or specific query parameter is provided, the order results will be limited to the last two years. Please visit Guides and + href='/docs/numbers/guides/porting/createBulkPortins'>Guides and Tutorials operationId: ListBulkPortins parameters: @@ -17064,7 +16740,7 @@ paths: of required fields in the child port-ins occurs when the bulk port-in is submitted (i.e. changed from a DRAFT status to IN_PROGRESS).

Please visit Guides and + href='/docs/numbers/guides/porting/createBulkPortins'>Guides and Tutorials

operationId: CreateBulkPortin parameters: @@ -17198,278 +16874,12 @@ paths: summary: Create bulk port-in order tags: - Bulk Port-In - /accounts/{accountId}/bulkPortins/{orderId}: - delete: - description: >- - Delete a bulk port-in order with child port-ins. Deleting a bulk - port-in is allowed for 'DRAFT' state only. Deleting a bulk port-in will - delete all DRAFT child port-ins associated with the bulk port-in. When - the bulk port-in is deleted, any child port-in orders that are not in a - draft status are dissociated from the bulk port-in, but not deleted. - Please visit Guides - and Tutorials - operationId: DeleteBulkOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: '' - in: path - name: orderId - required: true - schema: - type: string - responses: - '200': - description: Bulk Port-in order has been successfully deleted. - '400': - content: - application/xml: - examples: - example: - description: example - value: |- - - - - - 7709 - Bulk port-in with id d88763f4-8914-4301-bdca-6f409e4cd811 cannot be deleted since it is not in - draft status. - - - - - schema: - $ref: '#/components/schemas/BulkPortinErrorResponse' - description: Bad request. Bulk Port-in order not in DRAFT state. - '404': - description: The indicated Bulk Port-in order could not be found. - summary: Delete bulk port-in order - tags: - - Bulk Port-In - get: - description: >- - Retrieves information associated with the bulk port-in order specified - by the orderId URI parameter. Please visit Guides and - Tutorials - operationId: RetrieveBulkOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: '' - in: path - name: orderId - required: true - schema: - type: string - responses: - '200': - content: - application/xml: - examples: - example: - description: example - value: "\n \n\t \n\t\tOrder Id for all child orders\n\t\t2021-06-30T00:00:00.000Z\n\t\t14020 \n\t\t521434 \n\t\tDRAFT \n\t\t9900572 \n\t\tJYT01 \n\t\ttestuser \n\t\ttestuser \n\t\t2021-06-21T19:42:34.760Z\n\t\t2021-06-21T19:42:34.760Z \n\t \n" - schema: - $ref: '#/components/schemas/BulkPortinResponse' - description: >- - The information has been successfully retrieved and displayed in the - payload. - '404': - description: The indicated Bulk Port-in order could not be found. - summary: Retrieve bulk port-in order - tags: - - Bulk Port-In - patch: - description: >- -

It is possible to change ("SUPP" in LNP terms) an existing Bulk - Port-in order. This is done via a PUT or PATCH on the existing - order-id. Since the Bulk Port-in - order acts as a template for port-in orders in DRAFT status, any record can be changed at any time. The PATCH replaces elements of the referenced Bulk Portin order, but it replaces only the records included in the request payload. Other elements will remain untouched.

Changing the fields in a Bulk Port-in order causes the system to reapply all changed values to the child port-ins contained in the list of subtending port-in orders. Note that if the port-in orders contained within the Bulk Port are in DRAFT state, any field can be modified. If any child port-in order in the Bulk Port-in is in any other state, normal SUPP rules apply, and the list of appropriate fields is smaller.

Changing the ProcessingStatus to 'IN_PROGRESS' causes all child port-ins to begin processing. This is only valid if child port-ins exist for the bulk port-in.

Please visit Guides and Tutorials

- operationId: PatchBulkOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: '' - in: path - name: orderId - required: true - schema: - type: string - requestBody: - content: - application/xml: - examples: - In progress: - value: "\n\n\tIN_PROGRESS\n" - Simple Request: - value: "\n\n\tOrder Id for all child orders\n\t2021-06-30Z\n\tJYT99\n\t14020\n\t\n" - Updated requested FOC date: - value: "\n\n\t2021-06-22T11:30:00-04:00\n" - schema: - $ref: '#/components/schemas/BulkPortinPatchRequest' - responses: - '200': - content: - application/xml: - examples: - example: - description: example - value: "\n\n\t\n\t\tOrder Id for all child orders\n\t\t2021-06-30T00:00:00.000Z\n\t\t\n\t\t\tBUSINESS\n\t\t\tGoina B Rich\n\t\t\t\n\t\t\t\t123\n\t\t\t\tMaple Ave\n\t\t\t\tHometown\n\t\t\t\tMO\n\t\t\t\t54923\n\t\t\t\tUnited States\n\t\t\t\tService\n\t\t\t\n\t\t\n\t\t14020\n\t\tJYT01\n\t\t521434\n\t\tDRAFT\n\t\t9900572\n\t\ttestuser\n\t\ttestuser\n\t\t2021-06-22T14:25:24.487Z\n\t\t2021-06-21T19:42:34.760Z\n\t\n" - schema: - $ref: '#/components/schemas/BulkPortinResponse' - description: >- - The information has been successfully retrieved and displayed in the - payload. - '400': - content: - application/xml: - examples: - example: - description: example - value: |- - - - - Please check your input parameters. - - - - c358cb90-f1e6-4d72-92be-435411d50609 - - - The order cannot be modified because the order is awaiting a response from the losing carrier - 7300 - - - - - cb57e5a0-c70d-4f24-a450-bab62e908cc6 - - - Unable to modify processing status for AUTOMATED port type - 7367 - - - - - - schema: - $ref: '#/components/schemas/BulkPortinPatchErrorResponse' - description: Bad request. Invalid input. - '404': - description: The indicated Bulk Port-in order could not be found. - summary: Patch bulk port-in order - tags: - - Bulk Port-In - put: - description: >- - The PUT operation is available only for bulk port-in orders that are not - yet associated with subtending orders. Since this only occurs for bulk - port-in orders that are in one of the draft states, there are few - restrictions on what may be included. As with the POST, any data - associated with the bulk port-in will cascade to subtending orders when - they are created. (Subtending orders are created after telephone numbers - are added to the bulk port-in using the /tnList endpoint.) The PUT - completely replaces the existing Bulk Portin order with the payload of - the PUT. Please visit Guides and - Tutorials. - operationId: PutBulkOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: '' - in: path - name: orderId - required: true - schema: - type: string - requestBody: - content: - application/xml: - examples: - example: - description: example - value: |- - - - Order Id for all child orders - 2021-06-30Z - - BUSINESS - Goina B Rich - - 123 - Maple Ave - Hometown - MO - 54923 - - - JYT01 - 14020 - 521434 - - schema: - $ref: '#/components/schemas/BulkPortinRequest' - responses: - '200': - content: - application/xml: - examples: - example: - description: example - value: "\n \n\t \n\t\tOrder Id for all child orders \n\t\t2021-06-30T00:00:00.000Z \n\t\t \n\t\t\tBUSINESS \n\t\t\tGoina B Rich \n\t\t\t \n\t\t\t\t123 \n\t\t\t\tMaple Ave \n\t\t\t\tHometown \n\t\t\t\tMO \n\t\t\t\t54923 \n\t\t\t\tUnited States \n\t\t\t\tService \n\t\t\t \n\t\t \n\t\t14020 \n\t\t521434 \n\t\tDRAFT \n\t\t9900572 \n\t\tJYT01 \n\t\ttestuser \n\t\ttestuser \n\t\t2021-06-21T20:24:36.616Z\n\t\t2021-06-21T19:42:34.760Z \n\t \n" - schema: - $ref: '#/components/schemas/BulkPortinResponse' - description: >- - The information has been successfully retrieved and displayed in the - payload. - '400': - content: - application/xml: - examples: - example: - description: example - value: |- - - - - Please check your input parameters. - - - - c358cb90-f1e6-4d72-92be-435411d50609 - - - The order cannot be modified because the order is awaiting a response from the losing carrier - 7300 - - - - - cb57e5a0-c70d-4f24-a450-bab62e908cc6 - - - Unable to modify processing status for AUTOMATED port type - 7367 - - - - - - schema: - $ref: '#/components/schemas/BulkPortinPatchErrorResponse' - description: Bad request. Invalid input. - '404': - description: The indicated Bulk Port-in order could not be found. - summary: Update bulk port-in order - tags: - - Bulk Port-In /accounts/{accountId}/bulkPortins/{orderId}/history: get: description: >- Retrieves the history of the specified bulk port-in order. Obtaining history for a draft bulk port-in is not supported.

Please visit Guides and + href='/docs/numbers/guides/porting/createBulkPortins'>Guides and Tutorials

operationId: GetBulkHistory parameters: @@ -17770,7 +17180,7 @@ paths: get: description: >- Retrieve all notes associated with the order. Please visit Guides and + href='/docs/numbers/guides/porting/createBulkPortins'>Guides and Tutorials operationId: ListBulkNotes parameters: @@ -17824,7 +17234,7 @@ paths: order causes a notification to be sent to Bandwidth Operations, so that they may assist as necessary. A note may be up to 500 characters in length. Please visit Guides and + href='/docs/numbers/guides/porting/createBulkPortins'>Guides and Tutorials operationId: CreateBulkNote parameters: @@ -17877,8 +17287,8 @@ paths: put: description: >- Update a specified note. Notes may only be updated, not deleted. Please - visit Guides and - Tutorials + visit Guides + and Tutorials operationId: UpdateBulkNote parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -17936,7 +17346,7 @@ paths: Retrieves a list of Port-in Orders that are all associated with the identified Bulk Port-in. This response is not paginated due to its inherently limited size. Please visit Guides and + href='/docs/numbers/guides/porting/createBulkPortins'>Guides and Tutorials operationId: ListBulkChildOrders parameters: @@ -17998,7 +17408,7 @@ paths: orders may only be added to a bulk port-in order while that bulk port-in order is still in a draft state.

Child port-in orders may be dissociated from the bulk port-in at any time.

Please visit Guides and + href='/docs/numbers/guides/porting/createBulkPortins'>Guides and Tutorials

operationId: UpdateBulkChildList parameters: @@ -18138,7 +17548,7 @@ paths: -

Please visit Guides and Tutorials

+

Please visit Guides and Tutorials

operationId: ListBulkTns parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -18211,7 +17621,7 @@ paths: non-portable telephone numbers and PUT the tnList again to restart the validation step. The goal is to get to the VALID_DRAFT_TNS state, from which you can submit the bulk port-in order. -

Please visit Guides and Tutorials

+

Please visit Guides and Tutorials

operationId: UpdateBulkTnList parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -18272,6 +17682,273 @@ paths: summary: Update bulk port-in order tn list tags: - Bulk Port-In + /accounts/{accountId}/bulkPortins/{orderid}: + delete: + description: >- + Delete a bulk port-in order with child port-ins. Deleting a bulk + port-in is allowed for 'DRAFT' state only. Deleting a bulk port-in will + delete all DRAFT child port-ins associated with the bulk port-in. When + the bulk port-in is deleted, any child port-in orders that are not in a + draft status are dissociated from the bulk port-in, but not deleted. + Please visit Guides and + Tutorials + operationId: DeleteBulkOrder + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: '' + in: path + name: orderId + required: true + schema: + type: string + responses: + '200': + description: Bulk Port-in order has been successfully deleted. + '400': + content: + application/xml: + examples: + example: + description: example + value: |- + + + + + 7709 + Bulk port-in with id d88763f4-8914-4301-bdca-6f409e4cd811 cannot be deleted since it is not in + draft status. + + + + + schema: + $ref: '#/components/schemas/BulkPortinErrorResponse' + description: Bad request. Bulk Port-in order not in DRAFT state. + '404': + description: The indicated Bulk Port-in order could not be found. + summary: Delete bulk port-in order + tags: + - Bulk Port-In + get: + description: >- + Retrieves information associated with the bulk port-in order specified + by the orderId URI parameter. Please visit Guides and + Tutorials + operationId: RetrieveBulkOrder + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: '' + in: path + name: orderId + required: true + schema: + type: string + responses: + '200': + content: + application/xml: + examples: + example: + description: example + value: "\n \n\t \n\t\tOrder Id for all child orders\n\t\t2021-06-30T00:00:00.000Z\n\t\t14020 \n\t\t521434 \n\t\tDRAFT \n\t\t9900572 \n\t\tJYT01 \n\t\ttestuser \n\t\ttestuser \n\t\t2021-06-21T19:42:34.760Z\n\t\t2021-06-21T19:42:34.760Z \n\t \n" + schema: + $ref: '#/components/schemas/BulkPortinResponse' + description: >- + The information has been successfully retrieved and displayed in the + payload. + '404': + description: The indicated Bulk Port-in order could not be found. + summary: Retrieve bulk port-in order + tags: + - Bulk Port-In + patch: + description: >- +

It is possible to change ("SUPP" in LNP terms) an existing Bulk + Port-in order. This is done via a PUT or PATCH on the existing + order-id. Since the Bulk Port-in + order acts as a template for port-in orders in DRAFT status, any record can be changed at any time. The PATCH replaces elements of the referenced Bulk Portin order, but it replaces only the records included in the request payload. Other elements will remain untouched.

Changing the fields in a Bulk Port-in order causes the system to reapply all changed values to the child port-ins contained in the list of subtending port-in orders. Note that if the port-in orders contained within the Bulk Port are in DRAFT state, any field can be modified. If any child port-in order in the Bulk Port-in is in any other state, normal SUPP rules apply, and the list of appropriate fields is smaller.

Changing the ProcessingStatus to 'IN_PROGRESS' causes all child port-ins to begin processing. This is only valid if child port-ins exist for the bulk port-in.

Please visit Guides and Tutorials

+ operationId: PatchBulkOrder + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: '' + in: path + name: orderId + required: true + schema: + type: string + requestBody: + content: + application/xml: + examples: + In progress: + value: "\n\n\tIN_PROGRESS\n" + Simple Request: + value: "\n\n\tOrder Id for all child orders\n\t2021-06-30Z\n\tJYT99\n\t14020\n\t\n" + Updated requested FOC date: + value: "\n\n\t2021-06-22T11:30:00-04:00\n" + schema: + $ref: '#/components/schemas/BulkPortinPatchRequest' + responses: + '200': + content: + application/xml: + examples: + example: + description: example + value: "\n\n\t\n\t\tOrder Id for all child orders\n\t\t2021-06-30T00:00:00.000Z\n\t\t\n\t\t\tBUSINESS\n\t\t\tGoina B Rich\n\t\t\t\n\t\t\t\t123\n\t\t\t\tMaple Ave\n\t\t\t\tHometown\n\t\t\t\tMO\n\t\t\t\t54923\n\t\t\t\tUnited States\n\t\t\t\tService\n\t\t\t\n\t\t\n\t\t14020\n\t\tJYT01\n\t\t521434\n\t\tDRAFT\n\t\t9900572\n\t\ttestuser\n\t\ttestuser\n\t\t2021-06-22T14:25:24.487Z\n\t\t2021-06-21T19:42:34.760Z\n\t\n" + schema: + $ref: '#/components/schemas/BulkPortinResponse' + description: >- + The information has been successfully retrieved and displayed in the + payload. + '400': + content: + application/xml: + examples: + example: + description: example + value: |- + + + + Please check your input parameters. + + + + c358cb90-f1e6-4d72-92be-435411d50609 + + + The order cannot be modified because the order is awaiting a response from the losing carrier + 7300 + + + + + cb57e5a0-c70d-4f24-a450-bab62e908cc6 + + + Unable to modify processing status for AUTOMATED port type + 7367 + + + + + + schema: + $ref: '#/components/schemas/BulkPortinPatchErrorResponse' + description: Bad request. Invalid input. + '404': + description: The indicated Bulk Port-in order could not be found. + summary: Patch bulk port-in order + tags: + - Bulk Port-In + put: + description: >- + The PUT operation is available only for bulk port-in orders that are not + yet associated with subtending orders. Since this only occurs for bulk + port-in orders that are in one of the draft states, there are few + restrictions on what may be included. As with the POST, any data + associated with the bulk port-in will cascade to subtending orders when + they are created. (Subtending orders are created after telephone numbers + are added to the bulk port-in using the /tnList endpoint.) The PUT + completely replaces the existing Bulk Portin order with the payload of + the PUT. Please visit Guides and + Tutorials. + operationId: PutBulkOrder + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: '' + in: path + name: orderId + required: true + schema: + type: string + requestBody: + content: + application/xml: + examples: + example: + description: example + value: |- + + + Order Id for all child orders + 2021-06-30Z + + BUSINESS + Goina B Rich + + 123 + Maple Ave + Hometown + MO + 54923 + + + JYT01 + 14020 + 521434 + + schema: + $ref: '#/components/schemas/BulkPortinRequest' + responses: + '200': + content: + application/xml: + examples: + example: + description: example + value: "\n \n\t \n\t\tOrder Id for all child orders \n\t\t2021-06-30T00:00:00.000Z \n\t\t \n\t\t\tBUSINESS \n\t\t\tGoina B Rich \n\t\t\t \n\t\t\t\t123 \n\t\t\t\tMaple Ave \n\t\t\t\tHometown \n\t\t\t\tMO \n\t\t\t\t54923 \n\t\t\t\tUnited States \n\t\t\t\tService \n\t\t\t \n\t\t \n\t\t14020 \n\t\t521434 \n\t\tDRAFT \n\t\t9900572 \n\t\tJYT01 \n\t\ttestuser \n\t\ttestuser \n\t\t2021-06-21T20:24:36.616Z\n\t\t2021-06-21T19:42:34.760Z \n\t \n" + schema: + $ref: '#/components/schemas/BulkPortinResponse' + description: >- + The information has been successfully retrieved and displayed in the + payload. + '400': + content: + application/xml: + examples: + example: + description: example + value: |- + + + + Please check your input parameters. + + + + c358cb90-f1e6-4d72-92be-435411d50609 + + + The order cannot be modified because the order is awaiting a response from the losing carrier + 7300 + + + + + cb57e5a0-c70d-4f24-a450-bab62e908cc6 + + + Unable to modify processing status for AUTOMATED port type + 7367 + + + + + + schema: + $ref: '#/components/schemas/BulkPortinPatchErrorResponse' + description: Bad request. Invalid input. + '404': + description: The indicated Bulk Port-in order could not be found. + summary: Update bulk port-in order + tags: + - Bulk Port-In /accounts/{accountId}/campaignManagement/10dlc: get: description: >- @@ -19201,7 +18878,7 @@ paths: description: >- Retrieves the csr orders for the given account ID. - Please visit Guides and + Please visit Guides and Tutorials operationId: ReadCsrOrders parameters: @@ -26302,8 +25979,7 @@ paths: The fullcheck query parameter values control the components of the response payload that is returned. -

Please visit Guides +

Please visit Guides and Tutorials to learn more.

operationId: RequestPortabilityInfo parameters: @@ -26515,7 +26191,7 @@ paths: parameter (marked by * below) is provided, the order results will be limited to the last two years. - Please visit Guides and + Please visit Guides and Tutorials operationId: ListLsrOrders parameters: @@ -26676,7 +26352,7 @@ paths: description: >- A POST creates a LSR order request to initiate a port-out action. - Please visit Guides and + Please visit Guides and Tutorials operationId: CreateLsrOrder parameters: @@ -26856,7 +26532,7 @@ paths: description: >- Retrieves the information associated with the specified LSR ID number. - Please visit Guides and + Please visit Guides and Tutorials operationId: ReadLsrOrder parameters: @@ -26931,7 +26607,7 @@ paths: description: >- Updates the information associated with the specified LSR. - Please visit Guides and + Please visit Guides and Tutorials. This is also used to cancel an order, by changing the order status field to cancelled. This is the only case where the status can be changed, and when this is done, all other fields are left as they @@ -27119,7 +26795,7 @@ paths: description: >- Retrieves the history of the specified LSR order. - Please visit Guides and + Please visit Guides and Tutorials operationId: ReadLsrOrderHistory parameters: @@ -27184,7 +26860,7 @@ paths: description: >- Retrieve all notes associated with the order. - Please visit Guides and + Please visit Guides and Tutorials operationId: ListLsrOrderNotes parameters: @@ -27244,7 +26920,7 @@ paths: they may nassist as necessary. A note may be up to 500 characters in length. - Please visit Guides and + Please visit Guides and Tutorials operationId: CreateLsrOrderNote parameters: @@ -27307,7 +26983,7 @@ paths: description: >- Update a specified note. Notes may only be updated, not deleted. - Please visit Guides and + Please visit Guides and Tutorials operationId: UpdateLsrOrderNote parameters: @@ -29286,11 +28962,11 @@ paths: description: >- Creates a port-in order for the specified telephone number(s) and account number.
Please visit How to Create - Port in guide. Also you can find more information about port types - and numbers portability on How - to check numbers portability guide + href='/docs/numbers/guides/porting/portingNumbers'>How to Create Port + in guide. Also you can find more information about port types and + numbers portability on How to check numbers + portability guide operationId: CreatePortin parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -29660,11 +29336,10 @@ paths: validation of the ListOfPhoneNumbers, if at least 1 PhoneNumber is provided.
  • Submitting the parent bulk port-in will trigger the submission of child port-in orders.

    • Please visit How to Manage - Port in guide. Also you can find more information about port types - on Port - Types section of this guide + href='/docs/numbers/guides/porting/updatePortin'>How to Manage Port + in guide. Also you can find more information about port types on Port Types section of + this guide operationId: UpdatePortin parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -43879,7 +43554,7 @@ tags: - description: Manage bulk port-in orders externalDocs: description: Bulk port-in guide - url: /docs/numbers/porting/port-ins/bulkPortIns + url: /docs/numbers/guides/porting/createBulkPortins name: Bulk Port-In - name: Callbacks - name: Cities @@ -43930,7 +43605,7 @@ tags: - description: '' externalDocs: description: Porting guide - url: /docs/numbers/porting/ + url: /docs/numbers/guides/portingNumbers/ name: Porting - name: Rate Centers - externalDocs: @@ -43952,5 +43627,6 @@ tags: - name: Tn Reservation - name: Tns - name: Admin Data + - name: Tn Vendor Assignment - description: Toll-Free Verification API guide name: Toll-Free Verification diff --git a/site/specs/voice.yml b/site/specs/voice.yml index 808ecea61..953ea507c 100644 --- a/site/specs/voice.yml +++ b/site/specs/voice.yml @@ -6912,6 +6912,7 @@ components: example: bridgeComplete eventTime: type: string + format: date-time description: >- The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time From f2d71c262ae5c87e675374fd78e56e1146891f70 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Mon, 17 Jul 2023 14:27:02 +0000 Subject: [PATCH 2/3] Add Code Snippets to Spec Files --- site/specs/messaging.yml | 18 +- site/specs/numbers.yml | 1038 +++++++++++++++++++++++++------------- 2 files changed, 709 insertions(+), 347 deletions(-) diff --git a/site/specs/messaging.yml b/site/specs/messaging.yml index c99e2055c..07957c12b 100644 --- a/site/specs/messaging.yml +++ b/site/specs/messaging.yml @@ -887,6 +887,7 @@ paths: - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/limitTotalCount' responses: '200': $ref: '#/components/responses/listMessagesResponse' @@ -1529,6 +1530,19 @@ components: schema: type: integer example: 50 + limitTotalCount: + in: query + name: limitTotalCount + required: false + description: >- + When set to true, the response's totalCount field will have a maximum + value of 10,000. When set to false, or excluded, this will give an + accurate totalCount of all messages that match the provided filters. If + you are experiencing latency, try using this parameter to limit your + results. + example: true + schema: + type: boolean schemas: priorityEnum: type: string @@ -1593,7 +1607,9 @@ components: properties: totalCount: type: integer - description: Total number of messages matched by the search. + description: >- + The total number of messages matched by the search. When the request + has limitTotalCount set to true this value is limited to 10,000. example: 100 pageInfo: $ref: '#/components/schemas/pageInfo' diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index 00691e029..f6f9199ea 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -187,6 +187,106 @@ components: PENDING + BulkRateCenterGetCoverage404Error: + value: |- + + + + The resource does not exist + + + BulkRateCenterGetResponseExample: + value: |- + + + + 2021-06-08 06:45:13.0 + 2021-06-08 06:45:13.0 + PARTIAL + b05de7e6-0cab-4c83-81bb-9379cba8efd0 + 2 + 1 + 1 + + + 99 + 49 + AHOSKIE + NC + 1 + false + true + 2529690000 + 951 + + + + + 3909 + The specified vendor ID is not valid: 55 + + 100 + 55 + FARMVILLE + NC + 1 + false + true + 2529690000 + 951 + + + + + + BulkRateCenterPostCoverage400Error: + value: |- + + + + Payload cannot contain duplicate RateCenterCoverage. + 3928 + + + BulkRateCenterPostCoverage409Error: + value: |- + + + + Another bulk task is currently in processing. Task id = 4d06566e-9c99-44b7-8d9b-20e2e20dea15 + + + BulkRateCenterPostResponseExample: + value: |- + + + + PROCESSING + b05de7e6-0cab-4c83-81bb-9379cba8efd0 + + + 49 + AHOSKIE + NC + 1 + false + true + 2529690000 + 951 + + + 49 + FARMVILLE + NC + 1 + false + true + 2529690000 + 951 + + + + BulkTnVendorAssignmentPayload: value: |- @@ -694,6 +794,22 @@ components: www.my.website.com true + RateCenterCoverageResponseExample: + value: |- + + + + 123 + 49 + FARMVILLE + NC + 1 + false + true + 2529690000 + 951 + + RateCenterFindCoverage404Error: value: |- @@ -712,19 +828,6 @@ components: 3924 - RateCenterGetCoverageResponseExample: - value: |- - - - - 49 - ALABASTER - AL - 1 - true - true - - RateCenterPostCoverage400Error: value: |- @@ -743,35 +846,32 @@ components: 3923 - RateCenterPostCoverageResponseExample: + RegionsFindCoverage404Error: value: |- - - 49 - FARMVILLE - NC - 1 - false - true - 2529690000 - 951 - - - RateCenterPutCoverageResponseExample: + + Rate center FARMVILLE.NC was not found. + 3917 + + + RegionsFindCoverageWithVendor404Error: value: |- - - 49 - FARMVILLE - NC - 1 - false - true - 2529690000 - 951 - + + Rate center coverage FARMVILLE.NC with vendor ID 49 was not found. + 3918 + + + RegionsUpdateRateCenterCoverage400Error: + value: |- + + + + The specified rate center / region combination is not valid: FARMVILLE.NC + 3908 + RemoveImportedVoiceTnOrders: description: List all remove imported voice tn orders response @@ -867,6 +967,22 @@ components: required: true schema: type: string + BulkCoverageMatrixTaskId: + description: Task id for a bulk coverage matrix update. + in: path + name: taskId + required: true + schema: + type: string + BypassRateCenterRegionValidation: + description: >- + Whether to bypass the validation that a rate center exists when updating + the coverage matrix. + in: query + name: bypassRateCenterRegionValidation + required: false + schema: + type: boolean CampaignIdPathParam: description: User's campaign ID example: CBA001 @@ -971,6 +1087,14 @@ components: required: true schema: type: string + RCAbbreviationInPath: + description: A rate center's abbreviation + example: ALABASTER + in: path + name: abbreviation + required: true + schema: + type: string RCAbbreviationOptional: description: A rate center's abbreviation example: ALABASTER @@ -1002,6 +1126,14 @@ components: required: false schema: type: number + RCRegionInPath: + description: A rate center's state + example: AL + in: path + name: region + required: true + schema: + type: string RCRegionOptional: description: A rate center's state example: AL @@ -1018,6 +1150,14 @@ components: required: true schema: type: string + RCVendorInPath: + description: A rate center's vendor ID + example: 49 + in: path + name: vendor + required: true + schema: + type: number RCVendorOptional: description: Vendor id example: 49 @@ -1256,6 +1396,57 @@ components: associated with the order, the state of the order, and a list of the successfully imported Telephone Numbers, and descriptions of any encountered errors. + bulkRateCenterGetResponse404Error: + content: + application/xml: + examples: + successfulPostBulkCoverageMatrix: + $ref: '#/components/examples/BulkRateCenterGetCoverage404Error' + schema: + $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' + description: Unsuccessful response because the bulk task details could not be found. + bulkRateCenterPostResponse400Error: + content: + application/xml: + examples: + successfulPostBulkCoverageMatrix: + $ref: '#/components/examples/BulkRateCenterPostCoverage400Error' + schema: + $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' + description: Unsuccessful response due to a valiation error. + bulkRateCenterPostResponse409Error: + content: + application/xml: + examples: + successfulPostBulkCoverageMatrix: + $ref: '#/components/examples/BulkRateCenterPostCoverage409Error' + schema: + $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' + description: >- + Unsuccessful response due to a Resource Conflict Exception. The previous + task hasn't finished yet. + bulkRateCenterSuccessfulGetResponse: + content: + application/xml: + examples: + successfulPostBulkCoverageMatrix: + $ref: '#/components/examples/BulkRateCenterGetResponseExample' + schema: + $ref: '#/components/schemas/BulkRateCenterTaskPayload' + description: >- + Successful response which retrieves information about bulk upsert task + with specified ID. + bulkRateCenterSuccessfulPostResponse: + content: + application/xml: + examples: + successfulPostBulkCoverageMatrix: + $ref: '#/components/examples/BulkRateCenterPostResponseExample' + schema: + $ref: '#/components/schemas/BulkRateCenterPayload' + description: >- + Successful response which starts the bulk upsert for provided rate + centers. rateCenter401Error: content: application/json: @@ -1277,7 +1468,7 @@ components: type: forbidden schema: $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' - description: Client is providing incorrect or invalid credentials. + description: Client does not have access rights to the content. rateCenter429Error: content: application/json: @@ -1316,9 +1507,9 @@ components: application/xml: examples: successfulGetCoverageResponseExample: - $ref: '#/components/examples/RateCenterGetCoverageResponseExample' + $ref: '#/components/examples/RateCenterCoverageResponseExample' schema: - $ref: '#/components/schemas/RateCenterCoverageSuccessfulResponseList' + $ref: '#/components/schemas/RateCenterCoverageList' description: Successful response with a rate center's coverage. rateCenterGetCoverageResponse400Error: content: @@ -1336,7 +1527,7 @@ components: application/xml: examples: successfulPostCoverageResponseExample: - $ref: '#/components/examples/RateCenterPostCoverageResponseExample' + $ref: '#/components/examples/RateCenterCoverageResponseExample' schema: $ref: '#/components/schemas/CoverageMatrixEntry' description: Successful response with the generating matrix entry. @@ -1348,9 +1539,7 @@ components: $ref: '#/components/examples/RateCenterPostCoverage400Error' schema: $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' - description: >- - Unsuccessful response due to a validation error. A LRN was provided for - offnet coverage. + description: Unsuccessful response due to a validation error. rateCenterPostCoverageResponse409Error: content: application/xml: @@ -1367,10 +1556,50 @@ components: application/xml: examples: successfulPutCoverageResponseExample: - $ref: '#/components/examples/RateCenterPutCoverageResponseExample' + $ref: '#/components/examples/RateCenterCoverageResponseExample' schema: $ref: '#/components/schemas/CoverageMatrixEntry' description: Successful response for the update of a coverage matrix entry. + regionsFindCoverageResponse404Error: + content: + application/xml: + examples: + unsuccessfulUpdateRateCenterCoverage: + $ref: '#/components/examples/RegionsFindCoverage404Error' + schema: + $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' + description: >- + Unsuccessful response due to an invalid rate center region and + abbreviation combination. + regionsFindCoverageWithVendorResponse404Error: + content: + application/xml: + examples: + unsuccessfulUpdateRateCenterCoverage: + $ref: '#/components/examples/RegionsFindCoverageWithVendor404Error' + schema: + $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' + description: >- + Unsuccessful response due to an invalid rate center region, + abbreviation, and vendor combination. + regionsRateCenterCoverageSuccessfulResponseExample: + content: + application/xml: + examples: + successfulRateCenterCoverageExample: + $ref: '#/components/examples/RateCenterCoverageResponseExample' + schema: + $ref: '#/components/schemas/CoverageMatrixEntry' + description: Successful response that returns the selected rate center coverage. + regionsUpdateRateCenterCoverageResponse400Error: + content: + application/xml: + examples: + unsuccessfulUpdateRateCenterCoverage: + $ref: '#/components/examples/RegionsUpdateRateCenterCoverage400Error' + schema: + $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' + description: Unsuccessful update of rate center coverage due to a validation error. removeImportedVoiceTnOrdersResponse: content: application/xml: @@ -3596,6 +3825,80 @@ components: ZipCode: type: string type: object + BulkRateCenterPayload: + description: >- + Payload returned when a new bulk coverage matrix task is created, + containing basic task information and rate center coverage data. + properties: + coverageList: + $ref: '#/components/schemas/RateCenterCoverageList' + status: + description: The current status of the bulk coverage matrix update task. + enum: + - PROCESSING + - PARTIAL + - COMPLETE + - FAILED + type: string + taskId: + description: The bulk coverage matrix update task id. + example: b05de7e6-0cab-4c83-81bb-9379cba8efd0 + type: string + type: object + BulkRateCenterTaskPayload: + description: >- + Full bulk coverage matrix task information with complete task details + and statuses of individual rate center coverages. + properties: + endTime: + description: Timestamp of bulk rate center task completion. + example: '2021-06-08 06:46:13.0' + format: date-time + type: string + errorList: + $ref: '#/components/schemas/RateCenterCoverageErrorList' + failedRateCenterCoverageCount: + description: >- + The number of unsuccessfully created/updated rate center coverages + during the task. + example: 1 + maximum: 5000 + minimum: 0 + type: number + startTime: + description: Timestamp of bulk rate center task creation. + example: '2021-06-08 06:45:13.0' + format: date-time + type: string + status: + description: The current status of the bulk coverage matrix update task. + enum: + - PROCESSING + - PARTIAL + - COMPLETE + - FAILED + type: string + successList: + $ref: '#/components/schemas/RateCenterCoverageList' + successfulRateCenterCoverageCount: + description: >- + The number of successfully created/updated rate center coverages + during the task. + example: 3 + maximum: 5000 + minimum: 0 + type: number + taskId: + description: The bulk coverage matrix update task id. + example: b05de7e6-0cab-4c83-81bb-9379cba8efd0 + type: string + totalRateCenterCoverageCount: + description: The total number of rate center coverages included for the task. + example: 4 + maximum: 5000 + minimum: 1 + type: number + type: object BwspidSystemValue: properties: Alias: @@ -4303,6 +4606,10 @@ components: description: A rate center's abbreviation. example: FARMVILLE type: string + Id: + description: A rate center coverage matrix id. + example: 123 + type: number Lata: description: A rate center's LATA. example: 951 @@ -9937,12 +10244,29 @@ components: type: integer type: object type: object - RateCenterCoverageSuccessfulResponseList: - description: A list of all coverage matrix entries returned by a GET endpoint. + RateCenterCoverageErrorList: + description: >- + A list of coverage matrix entries along with the errors when updating + them. + items: + description: Each data item, which includes a rate center coverage with an error. + maxItems: 5000 + minItems: 0 + properties: + coverage: + $ref: '#/components/schemas/RateCenterCoverageUnsuccessfulResponse' + error: + $ref: '#/components/schemas/CoverageMatrixEntry' + type: object + type: array + RateCenterCoverageList: + description: A list of coverage matrix entries. properties: data: items: $ref: '#/components/schemas/CoverageMatrixEntry' + maxItems: 5000 + minItems: 1 type: array required: - data @@ -10897,6 +11221,8 @@ components: properties: Address: $ref: '#/components/schemas/Address' + CallVerificationEnabled: + type: boolean CallingName: $ref: '#/components/schemas/SipPeerLineOptionDto' Description: @@ -10912,6 +11238,8 @@ components: type: integer PeerName: type: string + PindropEnabled: + type: boolean PremiseTrunks: type: string Products: @@ -11097,6 +11425,8 @@ components: properties: Address: $ref: '#/components/schemas/Address' + CallVerificationEnabled: + type: boolean CallingName: $ref: '#/components/schemas/SipPeerLineOptionDto' Description: @@ -11109,6 +11439,8 @@ components: $ref: '#/components/schemas/OriginationRoutePlan' PeerName: type: string + PindropEnabled: + type: boolean PremiseTrunks: type: string Products: @@ -16566,7 +16898,7 @@ paths: A maximum of 1,000 orders can be retrieved per request. If no date range or specific query parameter is provided, the order results will be limited to the last two years. Please visit Guides and + href='/docs/numbers/porting/port-ins/bulkPortIns'>Guides and Tutorials operationId: ListBulkPortins parameters: @@ -16740,7 +17072,7 @@ paths: of required fields in the child port-ins occurs when the bulk port-in is submitted (i.e. changed from a DRAFT status to IN_PROGRESS).

    Please visit Guides and + href='/docs/numbers/porting/port-ins/bulkPortIns'>Guides and Tutorials

    operationId: CreateBulkPortin parameters: @@ -16874,12 +17206,278 @@ paths: summary: Create bulk port-in order tags: - Bulk Port-In + /accounts/{accountId}/bulkPortins/{orderId}: + delete: + description: >- + Delete a bulk port-in order with child port-ins. Deleting a bulk + port-in is allowed for 'DRAFT' state only. Deleting a bulk port-in will + delete all DRAFT child port-ins associated with the bulk port-in. When + the bulk port-in is deleted, any child port-in orders that are not in a + draft status are dissociated from the bulk port-in, but not deleted. + Please visit Guides + and Tutorials + operationId: DeleteBulkOrder + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: '' + in: path + name: orderId + required: true + schema: + type: string + responses: + '200': + description: Bulk Port-in order has been successfully deleted. + '400': + content: + application/xml: + examples: + example: + description: example + value: |- + + + + + 7709 + Bulk port-in with id d88763f4-8914-4301-bdca-6f409e4cd811 cannot be deleted since it is not in + draft status. + + + + + schema: + $ref: '#/components/schemas/BulkPortinErrorResponse' + description: Bad request. Bulk Port-in order not in DRAFT state. + '404': + description: The indicated Bulk Port-in order could not be found. + summary: Delete bulk port-in order + tags: + - Bulk Port-In + get: + description: >- + Retrieves information associated with the bulk port-in order specified + by the orderId URI parameter. Please visit Guides and + Tutorials + operationId: RetrieveBulkOrder + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: '' + in: path + name: orderId + required: true + schema: + type: string + responses: + '200': + content: + application/xml: + examples: + example: + description: example + value: "\n \n\t \n\t\tOrder Id for all child orders\n\t\t2021-06-30T00:00:00.000Z\n\t\t14020 \n\t\t521434 \n\t\tDRAFT \n\t\t9900572 \n\t\tJYT01 \n\t\ttestuser \n\t\ttestuser \n\t\t2021-06-21T19:42:34.760Z\n\t\t2021-06-21T19:42:34.760Z \n\t \n" + schema: + $ref: '#/components/schemas/BulkPortinResponse' + description: >- + The information has been successfully retrieved and displayed in the + payload. + '404': + description: The indicated Bulk Port-in order could not be found. + summary: Retrieve bulk port-in order + tags: + - Bulk Port-In + patch: + description: >- +

    It is possible to change ("SUPP" in LNP terms) an existing Bulk + Port-in order. This is done via a PUT or PATCH on the existing + order-id. Since the Bulk Port-in + order acts as a template for port-in orders in DRAFT status, any record can be changed at any time. The PATCH replaces elements of the referenced Bulk Portin order, but it replaces only the records included in the request payload. Other elements will remain untouched.

    Changing the fields in a Bulk Port-in order causes the system to reapply all changed values to the child port-ins contained in the list of subtending port-in orders. Note that if the port-in orders contained within the Bulk Port are in DRAFT state, any field can be modified. If any child port-in order in the Bulk Port-in is in any other state, normal SUPP rules apply, and the list of appropriate fields is smaller.

    Changing the ProcessingStatus to 'IN_PROGRESS' causes all child port-ins to begin processing. This is only valid if child port-ins exist for the bulk port-in.

    Please visit Guides and Tutorials

    + operationId: PatchBulkOrder + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: '' + in: path + name: orderId + required: true + schema: + type: string + requestBody: + content: + application/xml: + examples: + In progress: + value: "\n\n\tIN_PROGRESS\n" + Simple Request: + value: "\n\n\tOrder Id for all child orders\n\t2021-06-30Z\n\tJYT99\n\t14020\n\t\n" + Updated requested FOC date: + value: "\n\n\t2021-06-22T11:30:00-04:00\n" + schema: + $ref: '#/components/schemas/BulkPortinPatchRequest' + responses: + '200': + content: + application/xml: + examples: + example: + description: example + value: "\n\n\t\n\t\tOrder Id for all child orders\n\t\t2021-06-30T00:00:00.000Z\n\t\t\n\t\t\tBUSINESS\n\t\t\tGoina B Rich\n\t\t\t\n\t\t\t\t123\n\t\t\t\tMaple Ave\n\t\t\t\tHometown\n\t\t\t\tMO\n\t\t\t\t54923\n\t\t\t\tUnited States\n\t\t\t\tService\n\t\t\t\n\t\t\n\t\t14020\n\t\tJYT01\n\t\t521434\n\t\tDRAFT\n\t\t9900572\n\t\ttestuser\n\t\ttestuser\n\t\t2021-06-22T14:25:24.487Z\n\t\t2021-06-21T19:42:34.760Z\n\t\n" + schema: + $ref: '#/components/schemas/BulkPortinResponse' + description: >- + The information has been successfully retrieved and displayed in the + payload. + '400': + content: + application/xml: + examples: + example: + description: example + value: |- + + + + Please check your input parameters. + + + + c358cb90-f1e6-4d72-92be-435411d50609 + + + The order cannot be modified because the order is awaiting a response from the losing carrier + 7300 + + + + + cb57e5a0-c70d-4f24-a450-bab62e908cc6 + + + Unable to modify processing status for AUTOMATED port type + 7367 + + + + + + schema: + $ref: '#/components/schemas/BulkPortinPatchErrorResponse' + description: Bad request. Invalid input. + '404': + description: The indicated Bulk Port-in order could not be found. + summary: Patch bulk port-in order + tags: + - Bulk Port-In + put: + description: >- + The PUT operation is available only for bulk port-in orders that are not + yet associated with subtending orders. Since this only occurs for bulk + port-in orders that are in one of the draft states, there are few + restrictions on what may be included. As with the POST, any data + associated with the bulk port-in will cascade to subtending orders when + they are created. (Subtending orders are created after telephone numbers + are added to the bulk port-in using the /tnList endpoint.) The PUT + completely replaces the existing Bulk Portin order with the payload of + the PUT. Please visit Guides and + Tutorials. + operationId: PutBulkOrder + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - description: '' + in: path + name: orderId + required: true + schema: + type: string + requestBody: + content: + application/xml: + examples: + example: + description: example + value: |- + + + Order Id for all child orders + 2021-06-30Z + + BUSINESS + Goina B Rich + + 123 + Maple Ave + Hometown + MO + 54923 + + + JYT01 + 14020 + 521434 + + schema: + $ref: '#/components/schemas/BulkPortinRequest' + responses: + '200': + content: + application/xml: + examples: + example: + description: example + value: "\n \n\t \n\t\tOrder Id for all child orders \n\t\t2021-06-30T00:00:00.000Z \n\t\t \n\t\t\tBUSINESS \n\t\t\tGoina B Rich \n\t\t\t \n\t\t\t\t123 \n\t\t\t\tMaple Ave \n\t\t\t\tHometown \n\t\t\t\tMO \n\t\t\t\t54923 \n\t\t\t\tUnited States \n\t\t\t\tService \n\t\t\t \n\t\t \n\t\t14020 \n\t\t521434 \n\t\tDRAFT \n\t\t9900572 \n\t\tJYT01 \n\t\ttestuser \n\t\ttestuser \n\t\t2021-06-21T20:24:36.616Z\n\t\t2021-06-21T19:42:34.760Z \n\t \n" + schema: + $ref: '#/components/schemas/BulkPortinResponse' + description: >- + The information has been successfully retrieved and displayed in the + payload. + '400': + content: + application/xml: + examples: + example: + description: example + value: |- + + + + Please check your input parameters. + + + + c358cb90-f1e6-4d72-92be-435411d50609 + + + The order cannot be modified because the order is awaiting a response from the losing carrier + 7300 + + + + + cb57e5a0-c70d-4f24-a450-bab62e908cc6 + + + Unable to modify processing status for AUTOMATED port type + 7367 + + + + + + schema: + $ref: '#/components/schemas/BulkPortinPatchErrorResponse' + description: Bad request. Invalid input. + '404': + description: The indicated Bulk Port-in order could not be found. + summary: Update bulk port-in order + tags: + - Bulk Port-In /accounts/{accountId}/bulkPortins/{orderId}/history: get: description: >- Retrieves the history of the specified bulk port-in order. Obtaining history for a draft bulk port-in is not supported.

    Please visit Guides and + href='/docs/numbers/porting/port-ins/bulkPortIns'>Guides and Tutorials

    operationId: GetBulkHistory parameters: @@ -17180,7 +17778,7 @@ paths: get: description: >- Retrieve all notes associated with the order. Please visit Guides and + href='/docs/numbers/porting/port-ins/bulkPortIns'>Guides and Tutorials operationId: ListBulkNotes parameters: @@ -17234,7 +17832,7 @@ paths: order causes a notification to be sent to Bandwidth Operations, so that they may assist as necessary. A note may be up to 500 characters in length. Please visit Guides and + href='/docs/numbers/porting/port-ins/bulkPortIns'>Guides and Tutorials operationId: CreateBulkNote parameters: @@ -17287,8 +17885,8 @@ paths: put: description: >- Update a specified note. Notes may only be updated, not deleted. Please - visit Guides - and Tutorials + visit Guides and + Tutorials operationId: UpdateBulkNote parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -17346,7 +17944,7 @@ paths: Retrieves a list of Port-in Orders that are all associated with the identified Bulk Port-in. This response is not paginated due to its inherently limited size. Please visit Guides and + href='/docs/numbers/porting/port-ins/bulkPortIns'>Guides and Tutorials operationId: ListBulkChildOrders parameters: @@ -17408,7 +18006,7 @@ paths: orders may only be added to a bulk port-in order while that bulk port-in order is still in a draft state.

    Child port-in orders may be dissociated from the bulk port-in at any time.

    Please visit Guides and + href='/docs/numbers/porting/port-ins/bulkPortIns'>Guides and Tutorials

    operationId: UpdateBulkChildList parameters: @@ -17548,7 +18146,7 @@ paths: -

    Please visit Guides and Tutorials

    +

    Please visit Guides and Tutorials

    operationId: ListBulkTns parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -17621,7 +18219,7 @@ paths: non-portable telephone numbers and PUT the tnList again to restart the validation step. The goal is to get to the VALID_DRAFT_TNS state, from which you can submit the bulk port-in order. -

    Please visit Guides and Tutorials

    +

    Please visit Guides and Tutorials

    operationId: UpdateBulkTnList parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -17682,273 +18280,6 @@ paths: summary: Update bulk port-in order tn list tags: - Bulk Port-In - /accounts/{accountId}/bulkPortins/{orderid}: - delete: - description: >- - Delete a bulk port-in order with child port-ins. Deleting a bulk - port-in is allowed for 'DRAFT' state only. Deleting a bulk port-in will - delete all DRAFT child port-ins associated with the bulk port-in. When - the bulk port-in is deleted, any child port-in orders that are not in a - draft status are dissociated from the bulk port-in, but not deleted. - Please visit Guides and - Tutorials - operationId: DeleteBulkOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: '' - in: path - name: orderId - required: true - schema: - type: string - responses: - '200': - description: Bulk Port-in order has been successfully deleted. - '400': - content: - application/xml: - examples: - example: - description: example - value: |- - - - - - 7709 - Bulk port-in with id d88763f4-8914-4301-bdca-6f409e4cd811 cannot be deleted since it is not in - draft status. - - - - - schema: - $ref: '#/components/schemas/BulkPortinErrorResponse' - description: Bad request. Bulk Port-in order not in DRAFT state. - '404': - description: The indicated Bulk Port-in order could not be found. - summary: Delete bulk port-in order - tags: - - Bulk Port-In - get: - description: >- - Retrieves information associated with the bulk port-in order specified - by the orderId URI parameter. Please visit Guides and - Tutorials - operationId: RetrieveBulkOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: '' - in: path - name: orderId - required: true - schema: - type: string - responses: - '200': - content: - application/xml: - examples: - example: - description: example - value: "\n \n\t \n\t\tOrder Id for all child orders\n\t\t2021-06-30T00:00:00.000Z\n\t\t14020 \n\t\t521434 \n\t\tDRAFT \n\t\t9900572 \n\t\tJYT01 \n\t\ttestuser \n\t\ttestuser \n\t\t2021-06-21T19:42:34.760Z\n\t\t2021-06-21T19:42:34.760Z \n\t \n" - schema: - $ref: '#/components/schemas/BulkPortinResponse' - description: >- - The information has been successfully retrieved and displayed in the - payload. - '404': - description: The indicated Bulk Port-in order could not be found. - summary: Retrieve bulk port-in order - tags: - - Bulk Port-In - patch: - description: >- -

    It is possible to change ("SUPP" in LNP terms) an existing Bulk - Port-in order. This is done via a PUT or PATCH on the existing - order-id. Since the Bulk Port-in - order acts as a template for port-in orders in DRAFT status, any record can be changed at any time. The PATCH replaces elements of the referenced Bulk Portin order, but it replaces only the records included in the request payload. Other elements will remain untouched.

    Changing the fields in a Bulk Port-in order causes the system to reapply all changed values to the child port-ins contained in the list of subtending port-in orders. Note that if the port-in orders contained within the Bulk Port are in DRAFT state, any field can be modified. If any child port-in order in the Bulk Port-in is in any other state, normal SUPP rules apply, and the list of appropriate fields is smaller.

    Changing the ProcessingStatus to 'IN_PROGRESS' causes all child port-ins to begin processing. This is only valid if child port-ins exist for the bulk port-in.

    Please visit Guides and Tutorials

    - operationId: PatchBulkOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: '' - in: path - name: orderId - required: true - schema: - type: string - requestBody: - content: - application/xml: - examples: - In progress: - value: "\n\n\tIN_PROGRESS\n" - Simple Request: - value: "\n\n\tOrder Id for all child orders\n\t2021-06-30Z\n\tJYT99\n\t14020\n\t\n" - Updated requested FOC date: - value: "\n\n\t2021-06-22T11:30:00-04:00\n" - schema: - $ref: '#/components/schemas/BulkPortinPatchRequest' - responses: - '200': - content: - application/xml: - examples: - example: - description: example - value: "\n\n\t\n\t\tOrder Id for all child orders\n\t\t2021-06-30T00:00:00.000Z\n\t\t\n\t\t\tBUSINESS\n\t\t\tGoina B Rich\n\t\t\t\n\t\t\t\t123\n\t\t\t\tMaple Ave\n\t\t\t\tHometown\n\t\t\t\tMO\n\t\t\t\t54923\n\t\t\t\tUnited States\n\t\t\t\tService\n\t\t\t\n\t\t\n\t\t14020\n\t\tJYT01\n\t\t521434\n\t\tDRAFT\n\t\t9900572\n\t\ttestuser\n\t\ttestuser\n\t\t2021-06-22T14:25:24.487Z\n\t\t2021-06-21T19:42:34.760Z\n\t\n" - schema: - $ref: '#/components/schemas/BulkPortinResponse' - description: >- - The information has been successfully retrieved and displayed in the - payload. - '400': - content: - application/xml: - examples: - example: - description: example - value: |- - - - - Please check your input parameters. - - - - c358cb90-f1e6-4d72-92be-435411d50609 - - - The order cannot be modified because the order is awaiting a response from the losing carrier - 7300 - - - - - cb57e5a0-c70d-4f24-a450-bab62e908cc6 - - - Unable to modify processing status for AUTOMATED port type - 7367 - - - - - - schema: - $ref: '#/components/schemas/BulkPortinPatchErrorResponse' - description: Bad request. Invalid input. - '404': - description: The indicated Bulk Port-in order could not be found. - summary: Patch bulk port-in order - tags: - - Bulk Port-In - put: - description: >- - The PUT operation is available only for bulk port-in orders that are not - yet associated with subtending orders. Since this only occurs for bulk - port-in orders that are in one of the draft states, there are few - restrictions on what may be included. As with the POST, any data - associated with the bulk port-in will cascade to subtending orders when - they are created. (Subtending orders are created after telephone numbers - are added to the bulk port-in using the /tnList endpoint.) The PUT - completely replaces the existing Bulk Portin order with the payload of - the PUT. Please visit Guides and - Tutorials. - operationId: PutBulkOrder - parameters: - - $ref: '#/components/parameters/AccountIdPathParam' - - description: '' - in: path - name: orderId - required: true - schema: - type: string - requestBody: - content: - application/xml: - examples: - example: - description: example - value: |- - - - Order Id for all child orders - 2021-06-30Z - - BUSINESS - Goina B Rich - - 123 - Maple Ave - Hometown - MO - 54923 - - - JYT01 - 14020 - 521434 - - schema: - $ref: '#/components/schemas/BulkPortinRequest' - responses: - '200': - content: - application/xml: - examples: - example: - description: example - value: "\n \n\t \n\t\tOrder Id for all child orders \n\t\t2021-06-30T00:00:00.000Z \n\t\t \n\t\t\tBUSINESS \n\t\t\tGoina B Rich \n\t\t\t \n\t\t\t\t123 \n\t\t\t\tMaple Ave \n\t\t\t\tHometown \n\t\t\t\tMO \n\t\t\t\t54923 \n\t\t\t\tUnited States \n\t\t\t\tService \n\t\t\t \n\t\t \n\t\t14020 \n\t\t521434 \n\t\tDRAFT \n\t\t9900572 \n\t\tJYT01 \n\t\ttestuser \n\t\ttestuser \n\t\t2021-06-21T20:24:36.616Z\n\t\t2021-06-21T19:42:34.760Z \n\t \n" - schema: - $ref: '#/components/schemas/BulkPortinResponse' - description: >- - The information has been successfully retrieved and displayed in the - payload. - '400': - content: - application/xml: - examples: - example: - description: example - value: |- - - - - Please check your input parameters. - - - - c358cb90-f1e6-4d72-92be-435411d50609 - - - The order cannot be modified because the order is awaiting a response from the losing carrier - 7300 - - - - - cb57e5a0-c70d-4f24-a450-bab62e908cc6 - - - Unable to modify processing status for AUTOMATED port type - 7367 - - - - - - schema: - $ref: '#/components/schemas/BulkPortinPatchErrorResponse' - description: Bad request. Invalid input. - '404': - description: The indicated Bulk Port-in order could not be found. - summary: Update bulk port-in order - tags: - - Bulk Port-In /accounts/{accountId}/campaignManagement/10dlc: get: description: >- @@ -18878,7 +19209,7 @@ paths: description: >- Retrieves the csr orders for the given account ID. - Please visit Guides and + Please visit Guides and Tutorials operationId: ReadCsrOrders parameters: @@ -25979,7 +26310,8 @@ paths: The fullcheck query parameter values control the components of the response payload that is returned. -

    Please visit Guides +

    Please visit Guides and Tutorials to learn more.

    operationId: RequestPortabilityInfo parameters: @@ -26191,7 +26523,7 @@ paths: parameter (marked by * below) is provided, the order results will be limited to the last two years. - Please visit Guides and + Please visit Guides and Tutorials operationId: ListLsrOrders parameters: @@ -26352,7 +26684,7 @@ paths: description: >- A POST creates a LSR order request to initiate a port-out action. - Please visit Guides and + Please visit Guides and Tutorials operationId: CreateLsrOrder parameters: @@ -26532,7 +26864,7 @@ paths: description: >- Retrieves the information associated with the specified LSR ID number. - Please visit Guides and + Please visit Guides and Tutorials operationId: ReadLsrOrder parameters: @@ -26607,7 +26939,7 @@ paths: description: >- Updates the information associated with the specified LSR. - Please visit Guides and + Please visit Guides and Tutorials. This is also used to cancel an order, by changing the order status field to cancelled. This is the only case where the status can be changed, and when this is done, all other fields are left as they @@ -26795,7 +27127,7 @@ paths: description: >- Retrieves the history of the specified LSR order. - Please visit Guides and + Please visit Guides and Tutorials operationId: ReadLsrOrderHistory parameters: @@ -26860,7 +27192,7 @@ paths: description: >- Retrieve all notes associated with the order. - Please visit Guides and + Please visit Guides and Tutorials operationId: ListLsrOrderNotes parameters: @@ -26920,7 +27252,7 @@ paths: they may nassist as necessary. A note may be up to 500 characters in length. - Please visit Guides and + Please visit Guides and Tutorials operationId: CreateLsrOrderNote parameters: @@ -26983,7 +27315,7 @@ paths: description: >- Update a specified note. Notes may only be updated, not deleted. - Please visit Guides and + Please visit Guides and Tutorials operationId: UpdateLsrOrderNote parameters: @@ -28962,11 +29294,11 @@ paths: description: >- Creates a port-in order for the specified telephone number(s) and account number.
    Please visit How to Create Port - in guide. Also you can find more information about port types and - numbers portability on How to check numbers - portability guide + href='/docs/numbers/porting/port-ins/stand-alone-port-ins'>How to Create + Port in guide. Also you can find more information about port types + and numbers portability on How + to check numbers portability guide operationId: CreatePortin parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -29336,10 +29668,11 @@ paths: validation of the ListOfPhoneNumbers, if at least 1 PhoneNumber is provided.
  • Submitting the parent bulk port-in will trigger the submission of child port-in orders.

    • Please visit How to Manage Port - in guide. Also you can find more information about port types on Port Types section of - this guide + href='/docs/numbers/porting/port-ins/stand-alone-port-ins'>How to Manage + Port in guide. Also you can find more information about port types + on Port + Types section of this guide operationId: UpdatePortin parameters: - $ref: '#/components/parameters/AccountIdPathParam' @@ -35734,6 +36067,8 @@ paths: - Zip - AddressType type: object + CallVerificationEnabled: + type: boolean CustomerTrafficAllowed: description: >- A TerminationHost can be configured to allow different @@ -35766,6 +36101,8 @@ paths: description: Mandatory name for the SIP Peer maxLength: 10 type: string + PindropEnabled: + type: boolean Port: description: >- Optional Port Number for Voice and Termination hosts. This @@ -35856,6 +36193,11 @@ paths:
  • 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
    • +
  • 13691 - CallVerificationEnabled must be a boolean: true or false
    • +
  • 13692 - PindropEnabled must be a boolean: true or false
    • +
  • 13693 - CallVerificationEnabled and PindropEnabled are mutually exclusive and may not be used together
    • +
  • 13694 - CallVerificationEnabled is not allowed on this account
    • +
  • 13695 - PindropEnabled is not allowed on this account
  • 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
    • @@ -36191,6 +36533,11 @@ paths:
  • 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
    • +
  • 13691 - CallVerificationEnabled must be a boolean: true or false
    • +
  • 13692 - PindropEnabled must be a boolean: true or false
    • +
  • 13693 - CallVerificationEnabled and PindropEnabled are mutually exclusive and may not be used together
    • +
  • 13694 - CallVerificationEnabled is not allowed on this account
    • +
  • 13695 - PindropEnabled is not allowed on this account
  • 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
    • @@ -43554,7 +43901,7 @@ tags: - description: Manage bulk port-in orders externalDocs: description: Bulk port-in guide - url: /docs/numbers/guides/porting/createBulkPortins + url: /docs/numbers/porting/port-ins/bulkPortIns name: Bulk Port-In - name: Callbacks - name: Cities @@ -43605,7 +43952,7 @@ tags: - description: '' externalDocs: description: Porting guide - url: /docs/numbers/guides/portingNumbers/ + url: /docs/numbers/porting/ name: Porting - name: Rate Centers - externalDocs: @@ -43627,6 +43974,5 @@ tags: - name: Tn Reservation - name: Tns - name: Admin Data - - name: Tn Vendor Assignment - description: Toll-Free Verification API guide name: Toll-Free Verification From 2a5a089ec7a329452f82d40a05da91699683d38b Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Mon, 17 Jul 2023 14:28:47 +0000 Subject: [PATCH 3/3] Add Code Snippets to Spec Files --- site/specs/voice.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/site/specs/voice.yml b/site/specs/voice.yml index 953ea507c..e7f126675 100644 --- a/site/specs/voice.yml +++ b/site/specs/voice.yml @@ -6917,6 +6917,7 @@ components: The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. + example: '2022-06-17T22:19:40.375Z' accountId: type: string description: The user account associated with the call.